Page Comparison

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 fulfilled

No

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 values →

• SO (Sales Order)

• STO (Stock Transfer Order)

• RTV (Return To Vendor)

• RPO(Replacement)

Yes

isPriority

Boolean

This flag is true in case order is having 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

yesYes

dispatchByTime

String

Time by which the order is expected to get dispatched

yesYes

startProcessingTime

String

Time by which the order processing is expected to get started

yesYes

paymentMethod

String

Possible values → COD/NCOD

yesYes

isSplitRequired

Boolean

This flag is true when WMS has to split the order.

yesYes

taxBreakupForms

Object[ ]

Tax break up for the items

(if this is sent, all the fields of the object should be sent)

noNo

taxBreakupForms.channelSkuId

String

Channel SKU ID

yesYes

taxBreakupForms.baseSellingPricePerUnit

Double

Base selling price per unit of the SKU

yesYes

taxBreakupForms.taxItemForms

Object[ ]

Distribution of tax with tax type

yesYes

taxItemForms.type

String

Type of tax applicable

yesYes

taxItemForms.rate

Double

Tax rate for this tax type

yesYes

taxItemForms.taxPerUnit

Double

Tax applicable for this type of tax per unit

yesYes

packType

String

Possible values → PIECE/BULK

noNo

qcStatus

String

Possible values → PASS, FAIL

By default value will be PASS

Yes

shippingAddress

Object

Shipping address of the customer

yesYes

shippingAddress.name

String

Name of customer

yesYes

shippingAddress.line1

String

1st line of customer’s address

yesYes

shippingAddress.line2

String

2nd line of customer’s address

noNo

shippingAddress.line3

String

3rd line of customer’s address

noNo

shippingAddress.city

String

City of customer

yesYes

shippingAddress.state

String

State of customer

yesYes

shippingAddress.zip

String

ZIP/Pin code of customer

yesYes

shippingAddress.country

String

Country of customer

yesYes

shippingAddress.email

String

Email of customer

yesYes

shippingAddress.phone

String

Phone Number of customer

noNo

billingAddress

Object

Billing address of the customer

yesYes

billingAddress.name

String

Name of customer

yesYes

billingAddress.line1

String

1st line of customer’s address

yesYes

billingAddress.line2

String

2nd line of customer’s address

noNo

billingAddress.line3

String

3rd line of customer’s address

noNo

billingAddress.city

String

City of customer

yesYes

billingAddress.state

String

State of customer

yesYes

billingAddress.zip

String

ZIP/Pin code of customer

yesYes

billingAddress.country

String

Country of customer

yesYes

billingAddress.email

String

Email of customer

yesYes

billingAddress.phone

String

Phone Number of customer

noNo

orderItems

Object[]

List of items for which order is being placed

yesYes

orderItems.channelSkuCode

String

SKU code of order item

yesYes

orderItems.orderItemCode

String

This is provided by the channel to uniquely identify each order item.
This should be unique in an order

yesYes

orderItems.quantity

Integer

Quantity of SKU in the order placed

yesYes

orderItems.sellerDiscountPerUnit

Double

Discount given by seller on SKU per unit

noNo

orderItems.channelDiscountPerUnit

Double

Discount given by channel on SKU per unit

noNo

orderItems.sellingPricePerUnit

Double

Unit price of SKU including tax

yesYes

orderItems.shippingChargePerUnit

Double

Shipping charge on item per unit

noNo

orderItems.minExpiry

String

Minimum expiry date for the item to be shipped

noNo

orderItems.giftOptions

Object

Contains gift details of the item

noNo

giftOptions.giftwrapRequired

Boolean

To specify if gift wrap is required

yesYes

giftOptions.giftMessage

String

Gift message 

noNo

giftOptions.giftChargePerUnit

Double

Gift charge on item per unit

noNo

giftOptions.giftDocument

String

Base64 encoded string

noNo

giftOptions.giftDocumentFormat

String

Possible values →

PDF/ ZPL / PNG.

(To be populated if document is present)

noNo

orderItems.orderItemCustomAttributes

Object

Custom attributes for an order Item

noNo

orderItemCustomAttributes.attribute1

String

Custom attribute 1

noNo

orderItemCustomAttributes.attribute2

String

Custom attribute 2

noNo

orderItemCustomAttributes.attribute3

String

Custom attribute 3

noNo

orderItemCustomAttributes.attribute4

String

Custom attribute 4

noNo

orderItemCustomAttributes.attribute5

String

Custom attribute 5

noNo

orderItemCustomAttributes.attribute6

String

Custom attribute 6

noNo

orderItemCustomAttributes.attribute7

String

Custom attribute 7

noNo

orderItemCustomAttributes.attribute8

String

Custom attribute 8

noNo

orderItemCustomAttributes.attribute9

String

Custom attribute 9

noNo

orderItemCustomAttributes.attribute10

String

Custom attribute 10

noNo

orderCustomAttributes

Object

Custom attributes for an order

noNo

orderCustomAttributes.attribute1

String

Custom attribute 1

noNo

orderCustomAttributes.attribute2

String

Custom attribute 2

noNo

orderCustomAttributes.attribute3

String

Custom attribute 3

noNo

orderCustomAttributes.attribute4

String

Custom attribute 4

noNo

orderCustomAttributes.attribute5

String

Custom attribute 5

noNo

orderCustomAttributes.attribute6

String

Custom attribute 6

noNo

orderCustomAttributes.attribute7

String

Custom attribute 7

noNo

orderCustomAttributes.attribute8

String

Custom attribute 8

noNo

orderCustomAttributes.attribute9

String

Custom attribute 9

noNo

orderCustomAttributes.attribute10

String

Custom attribute 10

noNo

orderCustomAttributes.channelMetaData

String

ChannelMetaData

noNo

orderCustomAttributes.currency

String

Currency

noNo