Parameter Name

Data Type

Description

Mandatory

parentOrderCode

String

Represents code of parent order of the order

no

locationCode

String

Location code of warehouse/store from where this order will get fulfilled.

Location Code is non-mandatory when Increff OMS is doing splittin splitting and routing of the orders , else it’s a mandatory field.

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

StringPossible value - SO (Sales Order), STO (

Denotes the type of order. Possible values

• SO for Sales Order

• STO for Stock Transfer Order

• RTV

• for Return To Vendor

yes

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

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.orderItemCode

String

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

yes

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. Required only for Perishable SKUs. Don't send if SKU is non perishable.

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

orderItems.orderItemCustomAttributes

Object

Custom attributes for an order Item

no

orderItemCustomAttributes.attribute1

String

Custom attribute 1

no

orderItemCustomAttributes.attribute2

String

Custom attribute 2

no

orderItemCustomAttributes.attribute3

String

Custom attribute 3

no

orderItemCustomAttributes.attribute4

String

Custom attribute 4

no

orderItemCustomAttributes.attribute5

String

Custom attribute 5

no

orderItemCustomAttributes.attribute6

String

Custom attribute 6

no

orderItemCustomAttributes.attribute7

String

Custom attribute 7

no

orderItemCustomAttributes.attribute8

String

Custom attribute 8

no

orderItemCustomAttributes.attribute9

String

Custom attribute 9

no

orderItemCustomAttributes.attribute10

String

Custom attribute 10

no

orderItemCustomAttributes.channelMetaData

Object

These are additonal fields which can be sent to Increff system and can be used in subsequent Posting workflows

no

orderCustomAttributes

Object

Custom attributes for an order

no

orderCustomAttributes.attribute1

String

Custom attribute 1

no

orderCustomAttributes.attribute2

String

Custom attribute 2

no

orderCustomAttributes.attribute3

String

Custom attribute 3

no

orderCustomAttributes.attribute4

String

Custom attribute 4

no

orderCustomAttributes.attribute5

String

Custom attribute 5

no

orderCustomAttributes.attribute6

String

Custom attribute 6

no

orderCustomAttributes.attribute7

String

Custom attribute 7

no

orderCustomAttributes.attribute8

String

Custom attribute 8

no

orderCustomAttributes.attribute9

String

Custom attribute 9

no

orderCustomAttributes.attribute10

String

Custom attribute 10

no

orderCustomAttributes.channelMetaData

Object

These are additonal fields which can be sent to Increff system and can be used in subsequent Posting workflows

no

orderCustomAttributes.currency

String

Currency

no