Inbound | POST | /orders/outward/partner-code
...
This API is used to create new outward orders in Increff Omni using partner codes.
Description
This API will create outward orders in Increff Omni using the partner codes provided in the payload.
One payload will create only one order and one SKU can be present only once.
The number of order items in an order should not be more than 2500.
Request
| Code Block | ||
|---|---|---|
| ||
{
"parentOrderCode": "132",
"locationCode": "Wid234",
"orderCode": "H19304030003",
"orderTime": "2020-10-16T20:22:28.000+05:30",
"orderType": "SO/STO/RTV",
"onHold": false,
"dispatchByTime": "2020-10-16T20:22:28.000+05:30",
"startProcessingTime": "2020-10-16T20:22:28.000+05:30",
"paymentMethod": "COD",
"isSplitRequired": false,
"taxBreakupForms": [
{
"channelSkuId": "sky1",
"baseSellingPricePerUnit": 100.8,
"taxItemForms": [
{
{
"type": "VAT",
"rate": 1.2,
"taxPerUnit": 27.5
}
]
}
}]
}],
"packType": "PIECE",
"qcStatus": "PASS",
"partnerCode": "partnerCode",
"partnerLocationCode": "partnerLocationCode",
"orderItems": [
{
"channelSkuCode": "100005643",
"orderItemCode": "item123",
"quantity": 2,
"sellerDiscountPerUnit": 75,
"channelDiscountPerUnit": 150,
"sellingPricePerUnit": 1500,
"shippingChargePerUnit": 50,
"minExpiry": "2021-08-11",
"giftOptions": {
"giftwrapRequired": false,
"giftMessage": "",
"giftChargePerUnit": 0,
"giftDocument": "abc",
"giftDocumentFormat": "PDF"
},
"orderItemCustomAttributes": {
"attribute1": "giftDocument"Value1",
"attribute2": "abcValue2",
"attribute3": "Value3",
"attribute4": "Value4",
"attribute5": "Value5",
"attribute6": "Value6",
"giftDocumentFormatattribute7": "PDFValue7",
"attribute8": "Value8",
"attribute9": "Value9",
"attribute10": "Value10"
}
},
{
{
"channelSkuCode": "100005644",
"orderItemCode": "item124",
"quantity": 2,
"sellerDiscountPerUnit": 50,
"channelDiscountPerUnit": 100,
"sellingPricePerUnit": 1000,
"shippingChargePerUnit": 40,
"minExpiry": "2021-08-11",
"giftOptions": {
"giftwrapRequired": false,
"giftMessage": "",
"giftChargePerUnit": 0,
"giftDocument": "abc",
"giftwrapRequiredgiftDocumentFormat": false"PDF"
},
"orderItemCustomAttributes": {
"attribute1": "Value12",
"attribute2": "Value22",
"attribute3": "Value32",
"giftMessageattribute4": "Value42",
"attribute5": "Value52",
"attribute6": "Value62",
"attribute7": "Value72",
"attribute8": "Value82",
"giftChargePerUnitattribute9": 0"Value92",
"attribute10": "Value102"
}
}
],
"orderCustomAttributes": {
"attribute1": "Value1",
"giftDocumentattribute2": "abcValue2",
"attribute3": "Value3",
"attribute4": "Value4",
"attribute5": "Value5",
"attribute6": "Value6",
"giftDocumentFormatattribute7": "PDFValue7",
"attribute8": "Value8",
"attribute9": "Value9",
"attribute10": }
}
]
}"Value10",
"channelMetadata": "Sample Metadata",
"currency": "INR"
}
} |
Parameter Name | Data Type | Description | Mandatory |
| String | Represents |
the parent order of the order |
. This can be a additional identifier mapped to channelOrderCode | No | |
| String | Location code of warehouse from where this order will get fulfilled. Location Code is non-mandatory when Increff OMS is doing |
splitting and routing of the orders , else it’s a mandatory field. |
No | |||
| String | Unique code used by channel to identify the order. | yes |
| String | Time at which |
the Order got placed by customer or at the channel | yes | |
| String | Possible value |
→
|
|
| yes | ||
| Boolean |
| yes |
| String | Time by which the order is expected to get dispatched from Store/Warehouse | yes |
| String | Time by which the order processing is expected to get started | yes |
| String | Possible values |
→ COD |
/NCOD | yes | |
|
| This flag is true when WMS has to split the order . If this variable is |
True, then LocationCode should be |
sent as NULL | yes | ||
| Object[ ] | Tax break up for the items (if this is sent, al the fields of the object should be sent) | no |
| String | Channel |
SKU ID → Product identifier at channel | 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 |
| String | Possible values |
→ PIECE/BULK | no | ||
| Double | Discount given by seller on SKU per unit | no |
| Double | Discount given by channel on SKU per unit | no |
| String | This is provided by the channel to uniquely identify each order item. | yes |
| Double | Unit price of SKU including tax | yes |
| Double | Shipping charge on item per unit | no |
| String | Minimum expiry date for the item to be shipped | no |
| Object | Contains gift details of the item | no |
| Boolean | To specify if gift wrap is required | yes |
| String | Gift message | no |
| Double | Gift charge on item per unit | no |
| String | Base64 encoded string | no |
| String | Possible values |
→ PDF/ZP/PNG. (To be populated if document is present) | no | ||
| 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 | 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 | ChannelMetaData | no |
| String | Currency | no |
Response
Empty Body
HttpStatus Code
200