...
Code Block | ||
---|---|---|
| ||
{ "locationCodebillingAddress": "IN132", { "messageIdcity": 12345"Bangalore", "orderCodecountry": "flipkart1234IN", "parentOrderCodeemail": "flipkart1221ad******@gmail.com", "orderTimeline1": "2020-10-16T20:22:28.000+00:00",Shanti Nagar Kent", "orderTypeline2": "SO/STO/RTVSouth vihar colony", "paymentMethodline3": "CODstring", "isPriorityname": "Abhinav falseSingh", "channelNamephone": "flipkart98******78", "channelTypestate": "ERP/MARKETPLACEKARNATAKA", "eventTypezip": "OUTWARD_ORDER_COMPLETE"560102" }, "eventTimechannelName": "2020-10-16T20:22:28.000+00:00NYKAA", "shippingChargeschannelType": 20"ERP", "virtualSkuDefinitionscreatedAt": ["23-08-2023T12:07:18", "credentials": {}, "eventTime": "23-08-2023T12:09:18", "virtualParentChannelSkuIdeventType": "abc1OUTWARD_ORDER_CANCEL", "isPriority": true, "virtualParentBarcodelocationCode": "barcode11120004561" , "messageId": 786651, "childSkusomsSubOrderId": [128876, "orderCode": "NYK-128839-1992", "orderTime": { "23-08-2023T12:06:18", "orderType": "SALES", "parentOrderCode": "NYK-128839-1992", "channelSkuCodepaymentMethod": "xyzCOD", "shippingAddress": { "qtycity": 2"Bangalore", "country": "IN", "barcodeemail": "bar1"ad******@gmail.com", "line1": "Shanti Nagar }Kent", "line2": "South vihar colony", { "line3": "string", "channelSkuCodename": "xyz1Abhinav Singh", "phone": "98******78", "qtystate": 1"KARNATAKA", "barcode"zip": "bar2560102" }, ] } ]"shippingCharges": 0, "orderItemssubOrderItems": [ { "orderItemCodebarcode": "item123BAR00091", "channelSkuCodecancelledQuantity": "1000889888"0, "orderedQuantitychannelDiscount": 223.0, "cancelledQuantitychannelSkuCode": 1"BAR00091", "channelDiscountfulfilledQuantity": 501, "sellingPricePerUnitgiftChargePerUnit": 5000, "giftChargePerUnithoppedQuantity": 100, "sellerDiscountomsSubOrderItemId": 516624, "shippingChargeorderItemCodes": 0 [ "ITEM001" } ], "shippingAddressorderedQuantity": {1, "namesellerDiscount": "Customer's Name",0, "line1sellingPricePerUnit": "Line1200, Address 1", "line2shippingCharge": "Line0, Address 2", "line3externalItemCodes": [ "Line Address 3", "cityBAR00091": "city", "state": "state",] "zip": "zip", "country": "country",} ], "emailturnAroundTime": "abc@gmail.com23-10-2023T12:09:08", "phonevirtualSkuDefinitions": "9999999999"[ }, { "billingAddress": { "namechildSkus": "customer",[ "line1": "address line 1", { "line2": "address line 2", "line3barcode": "address line 3","BAR00091", "citychannelSkuCode": "BengaluruBAR00091", "stateqty": "Karnataka",1 "zip": "560076",} "country": "INDIA", ], "emailvirtualParentBarcode": "abc@gmail.comBAR00091", "phonevirtualParentChannelSkuId": "9999999999BAR00091" } ] } |
Parameter |
---|
Data Type | Description | Mandatory |
---|
locationCode
String
Location from which order was fulfilled
Yes
orderCode
String
Unique code used by the channel to identify order
yes
parentOrderCode
String
Parent order code which can be null or empty or some duplicate value across orders.
no
channelName
String
Channel name of the marketplace.
yes
channelType
String
Type of the channel.Possible values: ERP/MARKETPLACE
yes
orderTime
String
| 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 |
| 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 |
paymentMethod
Possible values - COD, NCOD
|
String
Long | Internal sub order id of OMS | yes |
isPriority
|
Boolean
This flag is true in case order is HIGH priority than normal orders.
yes
virtualSkuDefinitions
Object
List of virtual SKU definitions
no
virtualSkuDefinitions.virtualParentChannelSkuId
String
SKU code of virtual SKU
no
virtualSkuDefinitions.virtualParentBarcode
String
Barcode of parent SKU
no
virtualSkuDefinitions.childSkus
Object[]
List of child SKUs
no
childSkus.channelSkuCode
String
SKU code of child SKU
no
childSkus.qty
Integer
Quantity of child SKU
no
childSkus.barcode
String
Barcode of child SKU
no
orderItems
Object[]
List of order items
yes
orderItems.orderItemCode
String
This is provided by the channel to uniquely identify each order item.
yes
orderItems.channelskuCode
String
SKU code of order item
yes
orderItems.orderedQuantity
int
Ordered Quantity
yes
orderItems.cancelledQuantity
int
cancelledQuantity
yes
orderItems.sellingPricePerUnit
double
sellingPricePerUnit
no
orderItems.giftChargePerUnit
Double
giftChargePerUnit
no
orderItems.channelDiscount
Double
Discount provided by channel per unit
no
orderItems.sellerDiscount
Double
Discount provided by seller per unit
no
orderItems.shippingCharge
Double
Shipping charges on item
no
eventType
String
Possible values : { SUBORDER_CREATE, SUBORDER_PARTICAL_CANCEL, SUBORDER_CANCEL, SUBORDER_COMPLETE}
yes
eventTime
String
Time of event creation
yes
shippingAddress
Object
Shipping address of the customer
yes
shippingAddress.name
String
Name of customer
yes
shippingAddress.line1
String
1st line of customer’s address
yes
shippingAddress.line2
String
2nd line of customer’s address
no
shippingAddress.line3
String
3rd line of customer’s address
no
shippingAddress.city
String
City of customer
yes
shippingAddress.state
String
State of customer
yes
shippingAddress.zip
String
ZIP/Pin code of customer
yes
shippingAddress.country
String
Country of customer
yes
shippingAddress.email
String
Email of customer
no
shippingAddress.phone
String
Phone Number of customer
no
billingAddress
Object
Billing address of the customer
yes
billingAddress.name
String
Name of customer
yes
billingAddress.line1
String
1st line of customer’s address
yes
billingAddress.line2
String
2nd line of customer’s address
no
billingAddress.line3
String
3rd line of customer’s address
no
billingAddress.city
String
City of customer
yes
billingAddress.state
String
State of customer
yes
billingAddress.zip
String
ZIP/Pin code of customer
yes
billingAddress.country
String
Country of customer
yes
billingAddress.email
String
Email of customer
no
billingAddress.phone
String
Phone Number of customer
no
Response
...
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 |
Response
Code Block | ||
---|---|---|
| ||
{ "hasError": false, "errorMessage":"message" } |
...