...
Request
| Code Block | ||
|---|---|---|
| ||
{
"parentOrderCode "locationCode": "132Wid234",
"orderTimeorderCode": "H19304030003",
"orderCustomAttributes"2020-10-16T20:22:28.000+05:30",
"orderType": "OPEN_PO",
"orderCode": "sap123",
"locationCode": "locationCode",
"partnerCode": "partnerCode",
"partnerLocationCode": "partnerLocationCode",
"taxBreakupForms": [{
"channelSkuId": "sky1",
"baseSellingPricePerUnit": 100.8,
"taxItemForms": [{
"type": "VAT",
"rate": 1.2,
"taxPerUnit": 27.5
}]
}],
"orderItems": [{
"channelSkuCode": "tshirt134",
"quantity": 500,
"sellingPricePerUnit": 230.00,
"orderItemCode": "item1",
"orderItemCustomAttributes": {
: {
"attribute1": "Value1",
"attribute2": "Value2",
"attribute3": "Value3",
"attribute4": "Value4",
"attribute5": "Value5",
"attribute6": "Value6",
"attribute7": "Value7",
"attribute8": "Value8",
"attribute9": "Value9",
"attribute10": "Value10",
"channelMetadata": {
"totalCashOnDeliveryFee": 0,
"department": "HR",
"paymentMethod": "ccavenue",
"status": "processing"
},
"currency": "INR"
},
"orderItems": [
{
"channelSkuCode": "100005643",
"orderItemCode": "item123",
"orderItemCustomAttributes": {
"attribute1": "Value1",
"attribute2": "Value2",
"attribute3": "Value3",
"attribute4": "Value4",
"attribute5": "Value5",
"attribute6": "Value6",
"attribute7": "Value7",
"attribute8": "Value8",
"attribute9": "Value9",
"attribute10": "Value10"
}
},
{
"channelSkuCode": "jeans123",
"quantity": 500,
"sellingPricePerUnit": 230.00,
"orderItemCode": "item2",
"orderItemCustomAttributes": {
"attribute1": "Value12",
"attribute2": "Value22",
"attribute3": "Value32",
"attribute4": "Value42",
"attribute5": "Value52",
"attribute6": "Value62",
"attribute7": "Value72",
"attribute8": "Value82",
"attribute9": "Value92",
"attribute10": "Value102"
}
}
],
"orderCustomAttributes": {
"attribute1": "Value1",
"attribute2": "Value2",
"attribute3": "Value3",
"attribute4": "Value4",
"attribute5": "Value5",
"attribute6": "Value6",
"attribute7": "Value7",
"attribute8": "Value8",
"attribute9": "Value9",
"attribute10": "Value10",
"channelMetadata": "Sample Metadata",
"currency": "INR"
},
"channelMetadata": {
"totalCashOnDeliveryFee": 0,
"department": "HR",
"paymentMethod": "ccavenue",
"status": "processing"
}
},
"quantity": 2,
"sellingPricePerUnit": 1500
}
],
"orderTime": "2020-10-16T20:22:28.000+05:30",
"orderType": "SO/STO/RTV/RPO",
"parentOrderCode": "132",
"partnerCode": "PUSH112",
"partnerLocationCode": "UIH786",
"taxBreakupForms": [
{
"channelSkuId": "sky1",
"baseSellingPricePerUnit": 100.8,
"taxItemForms": [
{
"type": "CGST",
"rate": 1.2,
"taxPerUnit": 27.5
}
]
}
]
} |
Parameter Name | Data Type | Description | Mandatory |
| String | Represents code of parent order of the order | No |
| String | Time at which order got placed by customer | Yes |
| String | Possible values
| Yes |
| String | Unique code used by channel to identify the order | Yes |
| String | Location code of the warehouse from where the order will get fulfilled | Yes |
| String | This represents the partner from which order will come. If Order is of type PO/STO, this field represents vendor's code If Order is of type RO, this field represents customer’s code | Yes |
| String | This represents the partner’s location from which order will come. If Order is of type PO/STO, this field represents vendor location’s code If Order is of type RO, this field represents customer location’s code | Yes |
| Object[ ] | Tax break up for the items (if object is sent, all the fields of the object should be sent) | No |
| String | Channel Sku id | Yes |
| Double | Base selling price per unit of the Sku | Yes |
| Object[ ] | Distribution of tax with tax type | Yes |
| String | Type of tax applicable | Yes |
| Double | Tax rate for this tax type | Yes |
| Double | Tax applicable for this type of tax per unit | Yes |
| Object[ ] | Order Items list if order type is OPEN_PO or OPEN_RO then non mandatory else mandatory If this object is sent then all children fields must also be sent. | Conditional |
| String | Channel SKUs expected to arrive | Yes |
| Int | qty expected to arrive | Yes |
| Double | price per unit | Yes |
| String | Unique order item code of the item(This should be unique in an order) | Yes |
| Object | Custom attributes for an order item | No |
| String | Custom attribute 1 | No |
| String | Custom attribute 2 | No |
| String | Custom attribute 3 | No |
| String | Custom attribute 4 | No |
| String | Custom attribute 5 | No |
| String | Custom attribute 6 | No |
| String | Custom attribute 7 | No |
| String | Custom attribute 8 | No |
| String | Custom attribute 9 | No |
| String | Custom attribute 10 | No |
| Object | This is an object of extra metadata fields which can be used in subsequent flows | No |
| Object | Custom attributes for an order | No |
| String | Custom attribute 1 | No |
| String | Custom attribute 2 | No |
| String | Custom attribute 3 | No |
| String | Custom attribute 4 | No |
| String | Custom attribute 5 | No |
| String | Custom attribute 6 | No |
| String | Custom attribute 7 | No |
| String | Custom attribute 8 | No |
| String | Custom attribute 9 | No |
| String | Custom attribute 10 | No |
|
String
Object | This is an object of extra metadata fields which can be used in subsequent flows | No | |
| String | Currency | No |
Response
Empty Body
HttpStatus Code
...