Outward Sales Posting API (For ERP Systems) (Beta)

Parameter Name

Data Type

Description

Mandatory

partnerCode

String

This represents the partner to which order was shipped to.

If Order is of type SO/STO, this field represents customer’s code

If Order is of type RTV, this field represents vendor’s code

For Marketplaces Orders, this field will be having the erp channel name which is mapped in Increff Omni

Yes

partnerLocationCode

String

This represents the partner’s location to which order was shipped to.

If Order is of type SO/STO, this field represents customer location’s code

If Order is of type RTV, this field represents vendor location’s code

Yes

isPriority

Boolean

Flag to identify wether an order is of priority or not

Yes

locationCode

String

Warehouse location from which order was fulfilled

Yes

orderCode

String

Unique code used by the channel to identify order

Yes

parentOrderCode

String

Parent order code  which can be null or empty or some duplicate value across orders. 

No

channelName

String

Channel name of the marketplace.

Yes

orderTime

String

Time at which order was placed at the channel in UNIX (UTC)

Yes

orderType

String

Can be - SO(Sales Order)/STO(Stock Transfer Order)/RTV(Return To Vendor), RPO(Replacement)

Yes

messageId

Long

Unique Identifier of a notification (for De-duplication)

Yes

paymentMethod

String

Possible values - COD, NCOD

Yes

eventTime

String

Time of the event

Yes

eventType

String

Postings can be sent on the below triggers

• OUTWARD_ORDER_CREATE (Creation of order)

• OUTWARD_ORDER_CANCEL (Cancellation of order)

• OUTWARD_ORDER_PARTIAL_CANCEL(Partial cancellation of order)

• OUTWARD_ORDER_COMPLETE(Completion of order)

• OUTWARD_ORDER_SHIPMENT_DISPATCH(Shipment dispatch for order),

• OUTWARD_ORDER_SHIPMENT_DELIVER(Shipment delivery for order)

Yes

omsOrderId

Long

Internal order id of OMS

No

turnAroundTime

ZonedDateTime

Turnaround time

No

bundledSkuDefinitions

Object[]

List of bundled sku definitions

No

bundledSkuDefinitions.bundledParentBarcode

String

Unique barcode of bundled Sku

No

bundledSkuDefinitions.bundledParentChannelSkuId

String

Unique identifier of bundled Sku at channel

Yes

bundledSkuDefinitions.bundledParentClientSkuCode

String

Unique identifier for bundled parent sku code at client’s end

no

bundledSkuDefinitions.childSkus

Object[]

List of child SKUs

Yes

childSkus.barcode

String

Unique barcode of child sku

No

childSkus.clientSkuCode

String

Unique identifier for a child sku at client’s end.

No

childSkus.channelSkuCode

String

Unique identifier of child sku at channel

No

childSkus.qty

Integer

child sku quantity

No

orderItems

Object[]

List of order items

Yes

orderItems.orderItemCode

String

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

Yes

orderItems.channelskuCode

String

SKU code of order item

Yes

orderItems.orderedQuantity

int

Ordered Quantity

Yes

orderItems.cancelledQuantity

int

cancelledQuantity

Yes

orderItems.sellingPricePerUnit

double

sellingPricePerUnit

Yes

orderItems.customerCancelledQty

Integer

Customer cancelled quantity

No

orderItems.sellerCancelledQty

Integer

Seller cancelled quantity

No

orderItems.giftChargePerUnit

Double

giftChargePerUnit

No

orderItems.channelDiscount

Double

Discount provided by channel per unit

No

orderItems.sellerDiscount

Double

Discount provided by seller per unit

No

orderItems.omsItemId

Long

Internal item id of OMS

No

orderItems.barcode

String

Barcode to identify a product

no

orderItems.clientSkuCode

String

Code to uniquely identify an sku at client’s end

no

orderItems.orderItemCustomAttributes

Object

Custom attributes for order items

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

Objecg

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

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

shipments.qrCode

String

QR code

No

shipments.omsShipmentId

Integer

increff OMS shipment id

NO

shipments.shipmentStatus

String

Status of the shipment

No

shipments.awbNumber

String

AWB number of shipment

No

shipments.shipmentItems

Object[]

Items belonging to this shipment

Yes

shipmentItems.channelSkuCode

String

SKU code of order item

Yes

shipmentItems.orderItemCode

String

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

Yes

shipmentItems.netTaxAmountPerUnit

Double

Per unit tax applicable for the SKU.

Yes

shipmentItems.netTaxAmountTotal

Double

Total tax applicable for the SKU

Yes

shipmentItems.baseSellingPricePerUnit

Double

Per unit base selling price of the SKU

Yes

shipmentItems.baseSellingPriceTotal

Double

Total base selling price of SKU

Yes

shipmentItems.sellingPricePerUnit

Double

Per unit selling price of the SKU including tax

Yes

shipmentItems.sellingPriceTotal

Double

Total selling price of the SKU 

Yes

shipmentItems.quantity

Integer

Quantity of the sku in the shipment item.

Yes

shipmentItems.shippingChargePerUnit

Double

Shipping charge per unit for a shipment item

No

shipmentItems.channelDiscount

Double

Channel discount of item

No

shipmentItems.barcode

String

Scannable code to uniquely identify an sku

no

shipmentItems.clientSkuCode

String

Unique identifier for an sku at client’s end

no

shipmentItems.taxItems

Object

Distribution of tax with tax type

Yes

shipments.shipmentDetails

Object

Shipment details

No

shipmentDetails.length

Double

Length of the shipment

No

shipmentDetails.breadth

Double

Breadth of the shipment

No

shipmentDetails.height

Double

Height of the shipment

No

shipmentDetails.weight

Double

Weight of the shipment

No

shipmentDetails.shipmentId

Long

Id to uniquely identify a shipment

No

shipmentDetails.totalItemQuantity

Integer

Count of all the items in the shipment

No

shipmentDetails.packboxDetailsList

Object[]

Details of pack boxes

No

packboxDetailsList.length

Double

Length of the pack box in consideration

No

packboxDetailsList.breadth

Double

Breadth of the pack box in consideration

No

packboxDetailsList.height

Double

Height of the pack box in consideration

No

packboxDetailsList.weight

Double

Weight of the pack box in consideration

No

packboxDetailsList.boxId

Long

Id to uniquely identify a box

No

packboxDetailsList.awbNumber

String

AWB number of the box

No

packboxDetailsList.packBoxRemarks

String

Remarks for the pack box

No

packboxDetailsList.skuQuantityDataList

Object[]

Details of skus in a box

No

skuQuantityDataList.globalSkuId

Long

Id to uniquely identify a sku in increff’s system

No

skuQuantityDataList.clientSkuId

String

Id to uniquely identify a sku on client’s end

No

skuQuantityDataList.count

Integer

Count of a particular sku in a box

No

irn

String

Irn generated on Govt. portal while e-invoicing

No

qrCode

String

QrCode generated on Govt. portal while e-invoicing

No

shipmentStatus

String

Possible values: {OPEN,CLOSED, INVOICED, MANIFESTED, DISPATCHED, CANCELLED, DELIVERED}

No

taxItems.type

String

Type of tax applicable

Yes

taxItems.rate

Double

Tax rate for this tax type

Yes

taxItems.taxPerUnit

Double

Tax applicable for this type of tax per unit

Yes

taxItems.taxTotal

Double

Total tax applicable for this type of tax

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

No

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

No

billingAddress.phone

String

Phone Number of customer

No