Parameter Name

Data Type

Description

Mandatory

parentOrderCode

String

Represents code of parent order of the order

no

locationCode

String

Location code of warehouse from where this order will get fulfilledyes

no(Location code should be provided in case the isSplitRequired field is false and not provided when the isSplitRequired field is true.)

orderCode

String

Unique code used by channel to identify the order

yes

orderTime

String

Time at which order got placed by customer

yes

orderType

String

Possible value - SO (Sales Order), STO (Stock Transfer Order), RTV (Return To Vendor), RPO(Replacement)

yes

isPriority

Boolean

This flag is true in case order is HIGH priority than normal orders.

no

gift

Boolean

This flag is true in case order is a gift and needs to be gift wrapped.

no

onHold

Boolean

This flag is true in case order has to be kept on hold. Processing starts only after call is made to unhold the order

yes

dispatchByTime

String

Time by which the order is expected to get dispatched

yes

startProcessingTime

String

Time by which the order processing is expected to get started

yes

paymentMethod

String

Possible values - COD, NCOD

yes

isSplitRequired

Boolean

This flag is true when WMS has to split the order . If this variable is TRUE , then LocationCode should be send as NULL

yes

taxBreakupForms

Object[ ]

Tax break up for the items(if this is sent, al the fields of the object should be sent)

no

taxBreakupForms.channelSkuId

String

Channel Sku id

yes

taxBreakupForms.baseSellingPricePerUnit

Double

Base selling price per unit of the Sku

yes

taxBreakupForms.taxItemForms

Object[ ]

Distribution of tax with tax type

yes

taxItemForms.type

String

Type of tax applicable

yes

taxItemForms.rate

Double

Tax rate for this tax type

yes

taxItemForms.taxPerUnit

Double

Tax applicable for this type of tax per unit

yes

packType

String

Possible values - PIECE/BULK

no

qcStatus

String

Possible values - PASS, FAIL

By default value : PASS

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

yes

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

yes

billingAddress.phone

String

Phone Number of customer

no

orderItems

Object[]

List of items for which order is being placed

yes

orderItems.channelSkuCode

String

SKU code of order item

yes

orderItems.orderItemCode

String

This is provided by the channel to uniquely identify each order item.

yes

orderItems.quantity

Integer

Quantity of SKU in the order placed

yes

orderItems.sellerDiscountPerUnit

Double

Discount given by seller on SKU per unit

no

orderItems.channelDiscountPerUnit

Double

Discount given by channel on SKU per unit

no

orderItems.sellingPricePerUnit

Double

Unit price of SKU including tax

yes

orderItems.shippingChargePerUnit

Double

Shipping charge on item per unit

no

orderItems.minExpiry

String

Minimum expiry date for the item to be shipped

no

orderItems.giftOptions

Object

Contains gift details of the item

no

giftOptions.giftwrapRequired

Boolean

To specify if gift wrap is required

yes

giftOptions.giftMessage

String

Gift message 

no

giftOptions.giftChargePerUnit

Double

Gift charge on item per unit

no

giftOptions.giftDocument

String

Base64 encoded string

no

giftOptions.giftDocumentFormat

String

Possible values PDF, ZPL,PNG. To be populated if document is present

no