Creating the Order Object
- Order object must be in
JSON
format. The order contains basic information, the products included in the order and some information about these products. Each parameter is explained separately below.
Parameters
Order Parameters
Parameter | Description | Type |
---|---|---|
CustomerName | Name of the user who placed the order | string |
CustomerSurname | Last name of the user who placed the order | string |
CustomerId | ID of the user registered to your system, otherwise leave blank | string |
CustomerPhone | Phone number of the user who placed the order | string |
CustomerPhone2 | 2nd phone number of the user who placed the order | string |
Address | The address of the user who placed the order | string |
AddressDescription | Address description of the user who placed the order | string |
Region | District-district information of the user who placed the order | string |
city | City information of the user who placed the order | string |
PaymentMethodId | Payment type information | int |
PaymentNote | Payment note | string |
Discount | Total discount amount in the order | int |
OrderNote | Order note | string |
ExternalId | Order ID in your own system | string |
OrderTotal | Order Total Amount | int |
ParentId | ID of the main product | int |
OrderDetails Parameters
Based on the product list taken from the Products API, you need to choose only one of the ProductUnitId or ProductCode fields in the product details of the orders you will create. When creating the product list in the order, you only need to fill in one of these fields and send the other without null or no value.
Parameter | Description | Type |
---|---|---|
Quantity | Quantity of product in order | int |
ProductUnitId | Id of the unit in the order | int |
ProductCode | Product code in order | string |
OrderDetailNote | Product note | string |
Features | Feature list of the product in the order | List<Object> |
IsMenu | Information on whether the product in the order is a menu | boolean |
MenuId | Menu Id of the product in the order | int |
ParentId | ID of the main product in the order | int |
Example Order Object
{
"CustomerName": "Christian",
"CustomerSurname": "Luyindama",
"CustomerId": "44545",
"CustomerPhone": "5554443444",
"CustomerPhone2": "5554443441",
"Address": "adres bilgisi...",
"AddressDescription": "adres tarif",
"Region": "Ataşehir",
"City": "İstanbul",
"PaymentMethodId": "3",
"PaymentNote": "temassız çalışmıyorr",
"Discount": "20",
"OrderNote": "ıslak mendil getirin",
"WebOrderId": "746364",
"OrderTotal": "20.00",
"OrderDetails":
[
{
"Quantity": 4,
"ProductUnitId": 43455,
"OrderDetailNote": "çıtır olsun",
"Features":
[
{
"Name": "Soğansız",
"FeatureId": "322343"
} ,{...},{...}
],
"IsMenu": "true/false",
"MenuId": "1",
"ParentId": "1"
}
]
}