Outbound | POST | {Client’s URL}
Summary
This API will call the channel with return order processing details.
Description
This API will call the channel with return order processing details.This API will only get triggered after the return order is received and processed.
Here shipments object mention in payload represents the foward order information.
Request
| Code Block | ||
|---|---|---|
| ||
{
"partnerCode": "AZ123",
"locationCode": "ABCDEF",
"partnerLocationCode": "AZ1234",
"channelName": "AMAZON",
"returnOrderCode": "H893RUOT123",
"forwardOrderCode": "Dx784si",
"forwardParentOrderCode":"Dx784si",
"returnCreationTime": "2020-10-16T20:22:28.000+00:00",
"returnGateEntryCreationTime": "2020-10-16T20:22:28.000+00:00",
"messageId": 12345,
"paymentMethod": "COD",
"returnOrderType": "RETURN_TO_ORIGIN",
"eventTime": "2020-10-16T20:22:28.000+00:00",
"consignmentNumber": "con1",
"awbNumber": "awb1",
"items": [
{
"itemCode": "ic123",
"returnReason": "size misfit",
"channelSkuCode": "100007542",
"returnOrderItemStatus": "CREATED",
"channelDiscount":10,
"sellerDiscount":10,
"giftChangePerUnit":10,
"qcStatus": "FAIL",
"qcReason": "DAMAGED",
"imageUrls": [
"https://mydomain.com/img.jpg",
"https://mydomain.com/img2.jpg"
],
"sellingPricePerUnit": 20.0,
"isExcess": true,
"returnOrderItemAttributes": {
"virtualSkuChildItemReturnPostingsattribute1": ["string",
{
"attribute10": "string",
"omsReturnItemIdattribute2": "oms_124A43string",
"returnOrderItemStatusattribute3": "CREATEDstring",
"channelSkuCodeattribute4": "1234string",
"qcStatusattribute5": "FAILstring",
"qcReasonattribute6": "DAMAGEDstring",
"barcodeattribute7": "bar1string",
}
"attribute8": "string",
], "attribute9": "string",
"bundledSkuChildItemReturnPostings": [ "channelMetadata": "string"
{ },
"barcodevirtualSkuChildItemReturnPostings": "string",[
{
"channelSkuCode": "string", "omsReturnItemId": 0"oms_124A43",
"qcReasonreturnOrderItemStatus": "stringCREATED",
"qcStatuschannelSkuCode": "PASS1234",
"returnOrderItemStatusqcStatus": "CREATEDFAIL",
} "qcReason": "DAMAGED",
] } ], "shipmentsbarcode": ["bar1",
{ "shipmentCodeclientSkuCode": "UIfd897ClientSkuCode1",
"locationCode": "loc1", }
"generatedInvoiceId": "AR105044395", ],
"generatedInvoiceDatebundledSkuChildItemReturnPostings": "2020-10-16T20:22:28.000+00:00", [
{
"externalInvoiceId": "FK56556GH45", "externalInvoiceDatebarcode": "2020-10-16T20:22:28.000+00:00string",
"invoiceDocumentUrlclientSkuCode": "https://mybrand.com/invoice123.pdfClientSkuCode1",
"irn "channelSkuCode": "a429746e34d844c9d2cb2a6f68997d1c2af23987cc834f3b55da45d1b0bc27c0string",
"qrCode "omsReturnItemId": "eyJhbGciOiJSUzI1NiIs",0,
"shippingLabelDocumentUrlqcReason": "https://mybrand.com/sldoc.pdfstring",
"shipmentStatus "qcStatus": "MANIFESTEDPASS",
"shipmentItemsreturnOrderItemStatus": "CREATED"
[ }
{ ]
}
],
"channelSkuCodeshipments": [
"100000789702", {
"orderItemCodeshipmentCode": "item123UIfd897",
"locationCode": "loc1",
"channelDiscount": 122.45, "generatedInvoiceId": "AR105044395",
"netTaxAmountPerUnitgeneratedInvoiceDate": 60,
"2020-10-16T20:22:28.000+00:00",
"netTaxAmountTotalexternalInvoiceId": 120,
"FK56556GH45",
"baseSellingPricePerUnitexternalInvoiceDate": 500"2020-10-16T20:22:28.000+00:00",
"invoiceDocumentUrl": "https://mybrand.com/invoice123.pdf",
"baseSellingPriceTotal": 1000, "irn": "a429746e34d844c9d2cb2a6f68997d1c2af23987cc834f3b55da45d1b0bc27c0",
"sellingPricePerUnitqrCode": 560,
"eyJhbGciOiJSUzI1NiIs",
"sellingPriceTotalshippingLabelDocumentUrl": 1120"https://mybrand.com/sldoc.pdf",
"quantity"shipmentStatus": 2"MANIFESTED",
"taxItems"shipmentItems": [
{
{ "channelSkuCode": "100000789702",
"typeorderItemCode": "SGSTitem123",
"channelDiscount": 122.45,
"rate": 6, "netTaxAmountPerUnit": 60,
"taxPerUnitnetTaxAmountTotal": 30120,
"baseSellingPricePerUnit": 500,
"taxTotal": 60 "baseSellingPriceTotal": 1000,
}, "sellingPricePerUnit": 560,
{ "sellingPriceTotal": 1120,
"typequantity": "CGST"2,
"taxItems": [
"rate": 6, {
"taxPerUnit": 30, "type": "SGST",
"taxTotal": 60 "rate": 6,
} ]
"taxPerUnit": 30,
}, "taxTotal": 60
{ "channelSkuCode": "100000734701" },
"orderItemCode": "item124", {
"netTaxAmountPerUnit": 60, "type": "CGST",
"netTaxAmountTotal": 120, "baseSellingPricePerUnitrate": 5006,
"baseSellingPriceTotal": 1000, "taxPerUnit": 30,
"sellingPricePerUnit": 560, "taxTotal": 60
"sellingPriceTotal": 1120, }
"quantity": 2, ]
"shippingChargePerUnit": 10.0, },
"taxItems": [ {
{ "channelSkuCode": "100000734701",
"typeorderItemCode": "SGSTitem124",
"netTaxAmountPerUnit": 60,
"rate": 6, "netTaxAmountTotal": 120,
"taxPerUnit": 30, "baseSellingPricePerUnit": 500,
"taxTotalbaseSellingPriceTotal": 601000,
"sellingPricePerUnit": 560,
}, "sellingPriceTotal": 1120,
{ "quantity": 2,
"type": "CGST", "shippingChargePerUnit": 10.0,
"ratetaxItems": 6,[
{
"taxPerUnit": 30, "type": "SGST",
"taxTotal": 60 "rate": 6,
} ] "taxPerUnit": 30,
} ] "taxTotal": 60
} ], "virtualSkuDefinitions": [ {},
"virtualParentChannelSkuId": "ch_sku", "virtualParentBarcode": "bar", {
"childSkus": [ { "channelSkuCodetype": "ch_skuCGST",
"qty": 47, "barcoderate": "shoe14h124"6,
} ] } "taxPerUnit": 30,
], "bundledSkuDefinitions": [ { "childSkus": [ "taxTotal": {60
"barcode": "string", "channelSkuCode": "string", }
"qty": 0 } ]
], "bundledParentBarcode": "string", }
"bundledParentChannelSkuId": "string" } ],
"shippingAddress": { }
],
"name": "Sender's Name", "virtualSkuDefinitions": [
"line1": "Line Address 1", {
"line2virtualParentChannelSkuId": "Line Address 2ch_sku",
"line3virtualParentBarcode": "Line Address 3bar",
"cityvirtualParentClientSkuCode": "cityVPClientSkuCode1",
"statechildSkus": "state", [
{
"zip": "zip", "countrychannelSkuCode": "countrych_sku",
"emailqty": "abc@gmail.com",47,
"phonebarcode": "9999999999shoe14h124",
}, "billingAddressclientSkuCode": { "ClientSkuCode1"
}
"name": "customer", ]
"line1": "address line}
1", ],
"line2bundledSkuDefinitions": "address[
line 2", {
"line3childSkus": "address[
line 3", {
"city": "Bengaluru", "statebarcode": "Karnatakastring",
"zipchannelSkuCode": "560076string",
"countryclientSkuCode": "INDIAClientSkuCode1",
"emailqty": "abc@gmail.com",0
}
"phone": "9999999999" }],
"orderCustomAttributesbundledParentBarcode": {"string",
"attribute1bundledParentChannelSkuId": "1string",
"attribute2bundledParentClientSkuCode": "2",
BPClientSkuCode1"
}
],
"attribute3shippingAddress": "3",{
"attribute4name": "4Sender's Name",
"attribute5line1": "5Line Address 1",
"attribute6line2": "6Line Address 2",
"attribute7line3": "7Line Address 3",
"attribute8city": "8city",
"attribute9state": "9state",
"attribute10zip": "10zip",
"channelMetadatacountry": "ggcountry",
"currencyemail": "INRabc@gmail.com"
,
}, "orderItemCustomAttributesphone": ["9999999999"
},
{ "billingAddress": {
"barcodename": "stringcustomer",
"channelSkuCodeline1": "stringaddress line 1",
"orderItemCodeline2": "stringaddress line 2",
"orderItemCustomAttributesline3": {"address line 3",
"attribute1"city": "1Bengaluru",
"state": "Karnataka",
"attribute2zip": "2560076",
"country": "INDIA",
"attribute3email": "3abc@gmail.com",
"attribute4"phone": "49999999999",
},
"orderCustomAttributes": {
"attribute5attribute1": "51",
"attribute2": "2",
"attribute6attribute3": "63",
"attribute4": "4",
"attribute7attribute5": "75",
"attribute6": "6",
"attribute8attribute7": "87",
"attribute8": "8",
"attribute9": "9",
"attribute10": "10",
"channelMetadata": "gg",
"channelMetadatacurrency": "ggINR"
},
"orderItemCustomAttributes": [
} {
} ]
} |
...
Parameter Name
...
Data Type
...
Description
...
Mandatory
...
partnerCode
...
String
...
This is customer code in channel
...
yes
...
partnerLocationCode
...
String
...
This is the code of the location of the customer in the channel.
...
yes
...
locationCode
...
String
...
Location code of the warehouse where the return order will be received.
...
yes
...
channelName
...
String
...
This is marketplace name
...
yes
...
forwardOrderCode
...
String
...
Unique code used by the channel to identify the forward order
...
yes
...
returnOrderCode
...
String
...
Unique code used by the channel to identify the return order
...
yes
...
messageId
...
Long
...
Unique Identifier of a notification ( for de-duplication)
...
Yes
...
paymentMethod
...
String
...
Possible values - COD, NCOD
...
yes
...
returnOrderType
...
String
...
Possible values- RETURN_TO_ORIGIN,CUSTOMER_RETURN,SELF_SHIP
...
yes
...
eventTime
...
ZonedDateTime
...
Time of event creation
...
yes
...
returnCreationTime
...
ZonedDateTime
...
Time of return order creation
...
Yes
...
returnGateEntryCreationTime
...
ZonedDateTime
...
Time of return gate entry creation
Note: The value of returnCreationTime will be null in case the return orders are processed without the return order expectation created by Marketplaces or the user manually from CIMS.
...
no
...
items
...
Object[]
...
List of return items processed.
...
yes
...
items.itemCode
...
String
...
This is provided by the ERP to uniquely identify each order item.
...
yes
...
items.returnReason
...
String
...
Reason of return.
...
no
...
items.channelSkuCode
...
String
...
SKU code of return order item
...
yes
...
items.returnOrderItemStatus
...
String
...
Status of the item. Possible values :
CREATED, PROCESSING, MISSING, RECEIVED, CANCELLED,PARTIAL_MISSING_COMBO.
...
yes
...
items.qcStatus
...
String
...
The qcStatus of the return Item.
Possible values : PASS , FAIL
...
yes
...
items.qcReason
...
String
...
The reason due to which this return item has been market qc fail
...
no
...
items.imageUrls
...
String[]
...
It contains the list of urls of the images of the return items .It will only be populated in case that item has been marked as fail.
...
no
...
items.sellingPricePerUnit
...
Double
...
Selling price per unit of the item
...
yes
...
items.isExcess
...
Boolean
...
Flag to identify if the item is an excess item
...
no
...
items.virtualSkuChildItemReturnPostings
...
Object[]
...
List of virtual SKU child items
...
no
...
items.virtualSkuChildItemReturnPostings.omsReturnItemId
...
Long
...
Increff return item id of the child SKU
...
no
...
items.virtualSkuChildItemReturnPostings.returnOrderItemStatus
...
String
...
Possible values:
CREATED,PROCESSING,MISSING,PARTIAL_MISSING_COMBO,RECEIVED,CANCELLED
...
no
...
items.virtualSkuChildItemReturnPostings.channelSkuCode
...
String
...
Channel SKU code of the child SKU
...
no
...
items.virtualSkuChildItemReturnPostings.qcStatus
...
String
...
qc status of the child SKU
Possible values:
PASS,FAIL
...
no
...
items.virtualSkuChildItemReturnPostings.qcReason
...
String
...
qc reason of the child SKU
...
no
...
items.virtualSkuChildItemReturnPostings.barcode
...
String
...
barcode of the child SKU
...
yes
...
items.bundledSkuChildItemReturnPostings
...
Object[]
...
List of bundled SKU child items
...
no
...
items.bundledSkuChildItemReturnPostings.barcode
...
String
...
barcode of the child SKU
...
yes
...
items.bundledSkuChildItemReturnPostings.omsReturnItemId
...
Long
...
Increff return item id of the child SKU
...
yes
...
items.bundledSkuChildItemReturnPostings.qcReason
...
String
...
qc reason of the child SKU
...
no
...
items.bundledSkuChildItemReturnPostings.qcStatus
...
String
...
qc status of the child SKU
Possible values:
PASS,FAIL
...
yes
...
items.bundledSkuChildItemReturnPostings.returnOrderItemStatus
...
String
...
ReturnOrderItemStatus
(CREATED,PROCESSING,MISSING,PARTIAL_MISSING_COMBO,RECEIVED,CANCELLED)
...
yes
...
consignmentNumber
...
String
...
The consignment number associated with the return order
...
no
...
awbNumber
...
String
...
Return order AWB
...
no
...
virtualSkuDefinitions
...
Object[]
...
List of virtual sku definitions
...
no
...
virtualSkuDefinitions.virtualParentChannelSkuId
...
String
...
Channel SKU code of parent SKU
...
no
...
virtualSkuDefinitions.virtualParentBarcode
...
String
...
Barcode of parent SKU
...
no
...
virtualSkuDefinitions.childSkus
...
Object[]
...
List if child SKU associated with parent SKU
...
no
...
virtualSkuDefinitions.childSkus.channelSkuCode
...
String
...
Channel SKU code of child SKU
...
no
...
virtualSkuDefinitions.childSkus.qty
...
Integer
...
Quantity of child SKU, the parent SKU comprises of
...
no
...
virtualSkuDefinitions.childSkus.barcode
...
String
...
Barcode of child SKU
...
no
...
bundledSkuDefinitions
...
Object[]
...
List of bundled sku definitions
...
yes
...
bundledSkuDefinitions.bundledParentBarcode
...
String
...
Unique barcode of bundled Sku
...
no
...
bundledSkuDefinitions.bundledParentChannelSkuId
...
String
...
Unique identifier of bundled Sku at channel
...
yes
...
bundledSkuDefinitions.childSkus
...
Object[]
...
List of child SKUs
...
yes
...
childSkus.barcode
...
String
...
Unique barcode of child sku
...
no
...
childSkus.channelSkuCode
...
String
...
Unique identifier of child sku at channel
...
no
...
childSkus.qty
...
Integer
...
child sku quantity
...
no
...
shipments
...
Object[]
...
List of shipments in forward order
...
no
...
shipments.shipmentCode
...
String
...
Forward Shipment code
...
no
...
shipments.generatedInvoiceId
...
String
...
Invoice id generated for the Forward shipment
...
no
...
shipments.generatedInvoiceDate
...
ZonedDateTime
...
Invoice date generated for the Forward shipment
...
no
...
shipments.invoiceDocumentUrl
...
String
...
Url of the Forward invoice document
...
no
...
shipments.shippingLabelDocumentUrl
...
String
...
Url of the Forward shipping label doc
...
no
...
shipments.externalInvoiceId
...
String
...
Unique Forward invoice id provided by channel
...
no
...
shipments.externalInvoiceDate
...
ZonedDateTime
...
Forward Invoice date provided by channel
...
no
...
shipments.irn
...
String
...
IRN code of Forward shipment
...
no
...
shipments.qrCode
...
String
...
qr code of Forward shipment
...
no
...
shipments.shipmentStatus
...
String
...
Possible values:
OPEN,CLOSED,INVOICED,MANIFESTED,DISPATCHED,CANCELLED,DELIVERED
...
no
...
shipments.locationCode
...
String
...
Location code of Forwardshipment
...
no
...
shipments.shipmentItems
...
Object[]
...
List of Forward shipment items
...
yes
...
shipments.shipmentItems.channelSkuCode
...
String
...
Channel SKU code
...
yes
...
shipments.shipmentItems.orderItemCode
...
String
...
Order item code
...
yes
...
shipments.shipmentItems.channelDiscount
...
Double
...
Channel discount on SKU
...
no
...
shipments.shipmentItems.netTaxAmountPerUnit
...
Double
...
Per unit tax applicable for the SKU.
...
yes
...
shipments.shipmentItems.netTaxAmountTotal
...
Double
...
Total tax applicable for the SKU
...
yes
...
shipments.shipmentItems.baseSellingPricePerUnit
...
Double
...
Per unit base selling price of the SKU
...
yes
...
shipments.shipmentItems.baseSellingPriceTotal
...
Double
...
Total base selling price of SKU
...
yes
...
shipments.shipmentItems.sellingPricePerUnit
...
Double
...
Per unit selling price of the SKU including tax
...
yes
...
shipments.shipmentItems.sellingPriceTotal
...
Double
...
Total selling price of the SKU
...
yes
...
shipments.shipmentItems.quantity
...
Integer
...
Quantity of the sku in the shipment item.
...
yes
...
shipments.shipmentItems.shippingChargePerUnit
...
Double
...
Shipping charge per unit for a shipment item
...
no
...
shipments.shipmentItems.taxItems
...
Object[]
...
Distribution of tax with tax type
...
yes
...
shipments.shipmentItems.taxItems.type
...
String
...
Type of tax applicable
...
yes
...
shipments.shipmentItems.taxItems.rate
...
Double
...
Tax rate for this tax type
...
yes
...
shipments.shipmentItems.taxItems.taxPerUnit
...
Double
...
Tax applicable for this type of tax per unit
...
yes
...
shipments.shipmentItems.taxItems.taxTotal
...
Double
...
Total tax applicable for this type of tax
...
yes
...
shippingAddress
...
Object
...
Shipping address of the customer
...
yes
...
"barcode": "string",
"clientSkuCode":"ClientSkuCode1",
"channelSkuCode": "string",
"orderItemCode": "string",
"orderItemCustomAttributes": {
"attribute1": "1",
"attribute2": "2",
"attribute3": "3",
"attribute4": "4",
"attribute5": "5",
"attribute6": "6",
"attribute7": "7",
"attribute8": "8",
"attribute9": "9",
"attribute10": "10",
"channelMetadata": "gg"
}
}
],
"returnOrderAttributes": {
"attribute1": "string",
"attribute10": "string",
"attribute2": "string",
"attribute3": "string",
"attribute4": "string",
"attribute5": "string",
"attribute6": "string",
"attribute7": "string",
"attribute8": "string",
"attribute9": "string",
"channelMetadata": "string"
}
} |
Parameter Name | Data Type | Description | Mandatory |
| String | This is customer code in channel | yes |
| String | This is the code of the location of the customer in the channel. | yes |
| String | Location code of the warehouse where the return order will be received. | yes |
| String | This is marketplace name | yes |
| String | Unique code used by the channel to identify the forward order | yes |
| String | Unique code used by the channel to identify the return order | yes |
| Long | Unique Identifier of a notification ( for de-duplication) | Yes |
| String | Possible values - COD, NCOD | yes |
| String | Possible values- RETURN_TO_ORIGIN,CUSTOMER_RETURN,SELF_SHIP | yes |
| ZonedDateTime | Time of event creation | yes |
| ZonedDateTime | Time of return order creation | Yes |
| ZonedDateTime | Time of return gate entry creation Note: The value of | no |
| Object[] | List of return items processed. | yes |
| String | This is provided by the ERP to uniquely identify each order item. | yes |
| String | Reason of return. | no |
| String | SKU code of return order item | yes |
| discount provided by channel per unit | no | |
| discount provided by seller per unit | no | |
| Per unit gift charge | no | |
| String | Status of the item. Possible values : CREATED, PROCESSING, MISSING, RECEIVED, CANCELLED, | yes |
| String | The qcStatus of the return Item. Possible values : PASS , FAIL | yes |
| String | The reason due to which this return item has been market qc fail | no |
| String[] | It contains the list of urls of the images of the return items .It will only be populated in case that item has been marked as fail. | no |
| Double | Selling price per unit of the item | yes |
| Boolean | Flag to identify if the item is an excess item | no |
| Object[] | List of virtual SKU child items | no |
| Long | Increff return item id of the child SKU | no |
| String | Possible values:
| no |
| String | Channel SKU code of the child SKU | no |
| String | qc status of the child SKU
| no |
| String | qc reason of the child SKU | no |
| String | barcode of the child SKU | no |
| String | Unique identifier for a virtual child sku at client’s end | no |
| Object[] | List of bundled SKU child items | no |
| String | barcode of the child SKU | no |
| String | Unique identifier for bundled child sku at client’s end | no |
| Long | Increff return item id of the child SKU | yes |
| String | qc reason of the child SKU | no |
| String | qc status of the child SKU
| yes |
| String | ReturnOrderItemStatus | yes |
| Object[] | Custom attributes of order item | no |
| Object | List of attributes for the 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 | meta data fields as an object which is to be parsed at the channel’s end | no |
| String | The consignment number associated with the return order | no |
| String | Return order AWB | no |
| Object[] | List of virtual sku definitions | no |
| String | Channel SKU code of parent SKU | no |
| String | Barcode of parent SKU | no |
| String | Unique identifier for a parent virtual sku at client’s end | no |
| Object[] | List if child SKU associated with parent SKU | no |
| String | Channel SKU code of child SKU | no |
| Integer | Quantity of child SKU, the parent SKU comprises of | no |
| String | Barcode of child SKU | no |
| String | Unique identifier for the child sku at client’s end | no |
| Object[] | List of bundled sku definitions | yes |
| String | Unique barcode of bundled Sku | no |
| String | Unique identifier of bundled sku at client’s end | no |
| String | Unique identifier of bundled Sku at channel | yes |
| Object[] | List of child SKUs | yes |
| String | Unique barcode of child sku | no |
| String | Unique identifier of child sku at channel | no |
| Integer | child sku quantity | no |
| Object[] | List of shipments in forward order | no |
| String | Forward Shipment code | no |
| String | Invoice id generated for the Forward shipment | no |
| ZonedDateTime | Invoice date generated for the Forward shipment | no |
| String | Url of the Forward invoice document | no |
| String | Url of the Forward shipping label doc | no |
| String | Unique Forward invoice id provided by channel | no |
| ZonedDateTime | Forward Invoice date provided by channel | no |
| String | IRN code of Forward shipment | no |
| String | qr code of Forward shipment | no |
| String | Possible values:
| no |
| String | Location code of Forwardshipment | no |
| Object[] | List of Forward shipment items | yes |
| String | Channel SKU code | yes |
| String | Order item code | yes |
| Double | Channel discount on SKU | no |
| Double | Per unit tax applicable for the SKU. | yes |
| Double | Total tax applicable for the SKU | yes |
| Double | Per unit base selling price of the SKU | yes |
| Double | Total base selling price of SKU | yes |
| Double | Per unit selling price of the SKU including tax | yes |
| Double | Total selling price of the SKU | yes |
| Integer | Quantity of the sku in the shipment item. | yes |
| Double | Shipping charge per unit for a shipment item | no |
| 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 |
| Double | Total tax applicable for this type of tax | yes |
| Object | Shipping address of the customer | yes |
| String | Name of customer (Not sent when channel does not send these details eg: Amazon) | no |
| String | 1st line of customer’s address (Not sent when channel does not send these details eg: Amazon) | no |
| String | 2nd line of customer’s address | no |
| String | 3rd line of customer’s address | no |
| String | City of customer (Not sent when channel does not send these details eg: Amazon) | no |
| String | State of customer (Not sent when channel does not send these details eg: Amazon) | no |
| String | ZIP/Pin code of customer | yes |
| String | Country of customer | yes |
| String | Email of customer | no |
| String | Phone Number of customer | no |
| Object | Billing address of the customer | yes |
| String | Name of customer (Not sent when channel does not send these details eg: Amazon) | no |
| String | 1st line of customer’s address (Not sent when channel does not send these details eg: Amazon) | no |
| String | 2nd line of customer’s address | no |
| String | 3rd line of customer’s address | no |
| String | City of customer (Not sent when channel does not send these details eg: Amazon) | no |
|
String
State of customer
(Not sent when channel does not send these details eg: Amazon)String | State of customer | no |
| String | ZIP/Pin code of customer | yes |
| String | Country of customer | yes |
| String | Email of customer | no |
| String | Phone Number of customer | no |
billingAddressbillingAddress.name
String
Name of customer
(Not sent when channel does not send these details eg: Amazon)
no
billingAddress.line1
String
1st line of customer’s address
(Not sent when channel does not send these details eg: Amazon)
no
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
(Not sent when channel does not send these details eg: Amazon)
no
billingAddress.state
String
State of customer
no
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
orderCustomAttributes
Object
Custom attributes of order
no
| Object |
Billing address of the customer
yes
Custom attributes of order | no | ||
| String | Custom attribute 1 | no |
| String | Custom attribute 2 | 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 | Currency | no |
| Object | meta data fields as an object which is to be parsed at the channel’s end | no |
| Object[] | Custom attributes of order item | no |
| Object | List of attributes for the order item | no |
| String | Custom attribute 1 | no |
| String | Custom attribute 2 | no |
orderCustomAttributes.attribute2
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
orderCustomAttributes.currency
String
Currency
no
orderCustomAttributes.channelMetaData
Object
no | |||
| Object | meta data fields as an object which is to be parsed at the channel’s end | no |
| String | Unique barcode of the order item | no |
| String | Code to identify an sku uniquely at client’s end | no |
| String | Unique sku code of the order item identifiable at channel’s end | no |
|
Object[]
String | Unique item code of the order item identifiable in omni | no |
orderItemCustomAttributes.orderItemCustomAttributes
| Object [] |
Custom attributes of |
the forward order |
no |
| String | Custom attribute 1 | no |
| String | Custom attribute 2 | 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 | meta data fields as an object which is to be parsed at the channel’s end |
no
orderItemCustomAttributes.barcode
String
Unique barcode of the order item
no
orderItemCustomAttributes.channelSkuCode
String
Unique sku code of the order item identifiable at channel’s end
no
orderItemCustomAttributes.orderItemCode
String
no |
Response
| Code Block |
|---|
Empty Body{ "hasError": false, "errorMessage": "Sample error message" } |