Page Comparison

Parameter Name

Data Type

Description

Mandatory

orderCode

String

Unique code used by the channel to identify the order.

yes

locationCode

String

Code used by channels to identify a warehouse

Yes

channelName

String

Code used to identify a channel

Yes

packageSku

String

SKU of the package material used for packing

no

weight

Double

Weight of the package in grams

no

fulfillmentType

String

Enum with possible values:
BLOCK_COMPLETE,SINGLE_SHIPMENT_PARTIAL,MULTI_SHIPMENT_PARTIAL,PARTIAL;

no

packageDetails

Object

Dimensions of the packed shipment

no

packageDetails.length

Double

length of shipment box

no

packageDetails.breadth

Double

breadth of shipment box

no

packageDetails.height

Double

height of shipment box

no

shipmentItems

Object[]

List of items corresponding to shipment

yes

shipmentItems.channelSkuCode

String

SKU code of order item

yes

shipmentItems.quantityToPack

Integer

Quantity of SKU in shipment

yes

shipmentItems.externalSerialCodes

String[]

These are the external serial ids for the item

no

Parameter Name

Data Type

Description

Mandatory

orderCode

String

Unique code used by the channel to identify the order.

yes

locationCode

String

Code used by channels to identify a warehouse

Yes

channelIdchannelName

String

Code used to identify a channel

Yes

shipmentId

Long

Shipment id of Increff Omni system 

yes

shipmentCode

String

Unique code used by the channel to identify the shipment

yes

shippingLabel

Object

Shipping Label Details

no

shippingLabel.shippingLabelUrl

String

Downloadable pdf url of the shipping label document(either of shippingLabel and shippingLabelUrl is mandatory)

no

shippingLabel.awbNumber

String

Tracking number provided by the courier partner

yes

shippingLabel.shippingLabel

String

Base64 encoded string of the shipping label(either of shippingLabel and shippingLabelUrl is mandatory)

no

shippingLabel.transporter

String

Courier partner name

yes

invoiceCode

String

Invoice Number that is printed on the invoice PDF

Yes

invoiceUrl

String

Downloadable pdf url of the invoice document(either of invoice and invoice Url is mandatory)

no

invoiceDetails

Object[]

Tax Details of the invoice.

• If invoice details are being sent, then taxItems are mandatory.

No

invoiceDate

String

Date of invoice generated by Increff Omni

Yes

invoice

String

Base64 encoded string of invoice PDF(either of invoice and invoice Url is mandatory)

no

invoiceDetails.channelSkuCode

String

SKU code of order item

Yes

invoiceDetails.netTaxAmountPerUnit

Double

Per unit tax applicable for the SKU

Yes

invoiceDetails.netTaxAmountTotal

Double

Total tax applicable for the SKU

Yes

invoiceDetails.baseSellingPricePerUnit

Double

Per unit base selling price of the SKU 

Yes

invoiceDetails.baseSellingPriceTotal

Double

Total base selling price of the SKU

Yes

invoiceDetails.actualSellingPricePerUnit

Double

Per unit actual selling price of the SKU 

Yes

invoiceDetails.actualSellingPriceTotal

Double

Total actual selling price of the SKU

Yes

invoiceDetails.quantity

Integer

Total quantity of a sku for a line item

Yes

invoiceDetails.taxItems

Object[]

Distribution of tax with tax type

• If invoice details are being sent, then taxItems are mandatory.

Yes

invoiceDetails.taxItems.type

String

Type of tax applicable

Yes

invoiceDetails.taxItems.rate

Double

Tax rate for this tax type

Yes

invoiceDetails.taxItems.taxPerUnit

Double

Per unit tax applicable for this type of tax 

Yes

invoiceDetails.taxItems.taxTotal

Double

Total tax applicable for this type of tax

Yes