...
Postings can be sent on below triggers
OUTWARDSUBORDER_ORDER_CREATEOUTWARD
SUBORDER_ORDER_CANCELOUTWARD
SUBORDER_ORDER_COMPLETE
OUTWARDSUBORDER_ORDER_PARTIAL_CANCEL
Request
Code Block | ||
---|---|---|
| ||
{ "billingAddress": { "city": "Bangalore", "country": "IN", "email": "ad******@gmail.com", "line1": "Shanti Nagar Kent", "line2": "South vihar colony", "line3": "string", "name": "Abhinav Singh", "phone": "98******78", "state": "KARNATAKA", "zip": "560102" }, "channelName": "NYKAA", "channelType": "ERP", "createdAt": "23-08-2023T12:07:18", "credentials": {}, "eventTime": "23-08-2023T12:09:18", "eventType": "OUTWARD_ORDERSUBORDER_CANCEL", "isPriority": true, "locationCode": "1120004561", "messageId": 786651, "omsSubOrderId": 128876, "orderCode": "NYK-128839-1992", "orderTime": "23-08-2023T12:06:18", "orderType": "SALES", "parentOrderCode": "NYK-128839-1992", "paymentMethod": "COD", "shippingAddress": { "city": "Bangalore", "country": "IN", "email": "ad******@gmail.com", "line1": "Shanti Nagar Kent", "line2": "South vihar colony", "line3": "string", "name": "Abhinav Singh", "phone": "98******78", "state": "KARNATAKA", "zip": "560102" }, "shippingCharges": 0, "subOrderItems": [ { "barcode": "BAR00091", "cancelledQuantity": 0, "channelDiscount": 23.0, "channelSkuCode": "BAR00091", "fulfilledQuantity": 1, "giftChargePerUnit": 0, "hoppedQuantity": 0, "omsSubOrderItemId": 16624, "orderItemCodes": [ "ITEM001" ], "orderedQuantity": 1, "sellerDiscount": 0, "sellingPricePerUnit": 1200, "shippingCharge": 0, "externalItemCodes": [ "BAR00091" ] } ], "turnAroundTime": "23-10-2023T12:09:08", "virtualSkuDefinitions": [ { "childSkus": [ { "barcode": "BAR00091", "channelSkuCode": "BAR00091", "qty": 1 } ], "virtualParentBarcode": "BAR00091", "virtualParentChannelSkuId": "BAR00091" } ] } |
...
Parameter | Data Type | Description | Mandatory |
---|---|---|---|
| Object of type address | Billing Address | yes |
| String | City name | yes |
| String | Country Name | yes |
| String | yes | |
| String | address line 1 | yes |
| String | address line 2 | no |
| String | address line 3 | no |
| String | Name | yes |
| String | state name | yes |
| String | zip code | yes |
| String | phone number | yes |
| String | channel name | yes |
| “ERP” | channel type | yes |
| String | created at time | yes |
| list of credentials | credentials | no |
| String | time of the event | yes |
eventType | String | Postings can be sent on below triggers
| yes |
| String | Can be - SO(Sales Order)/STO(Stock Transfer Order)/RTV(Return To Vendor), RPO(Replacement) | yes |
| Boolean | Flag to identify wether an order is of priority or not | yes |
| String | Warehouse location from which order was fulfilled | yes |
| Long | Unique Identifier of a notification (for De-duplication) | yes |
| Long | Internal sub order id of OMS | yes |
| String | order code from channel | yes |
| String | parent order code from channel | no |
| String | possible values- COD/NCOD | yes |
| Object of type Address | Address | yes |
| String | City name | yes |
| String | Country name | yes |
| String | address line 1 | yes |
| String | address line 2 | no |
| String | address line 3 | no |
| String | name | yes |
| String | state name | yes |
| String | pin code | yes |
| String | email address | yes |
| String | phone nymber | yes |
| Double | Shipping charge | no |
| yes | ||
| String | barcode | yes |
| Integer | cancelled quantity | yes |
| Double | discount from the channel | no |
| String | Sku Code on channel side | yes |
| Long | fulfilled quantity | yes |
| Double |
| no |
| Long |
| yes |
| Long | sub order item id in oms | yes |
| List<String> | list of order item codes | yes |
| Long | ordered quantity | yes |
| Double | seller discount | no |
| Double | selling price per item | no |
| Double | shipping charde | no |
| List of String | list of item codes | no |
| String | turn around time | no |
| no | ||
| List | List of child skus | no |
| String | Virtual Parent barcode | no |
| String | Virtual Parent channel SKU id | yes |
| String | barcode | no |
| Integer | quantity | no |
| String | channel SKU code | no |
...