Parameter Name

Data Type

Description

Mandatory

invoiceCode

String

External invoiceId provided at the time of Gate entry creation

Yes

invoiceId

Long

Internal invoiceId generated at the time of GRN

Yes

gateEntryId

Long

Gate entry Id created at the time of GRN

Yes

invoiceDocumentUrl

String

Invoice document provided at the time of Gate entry creation is available via the Url

Yes

stateTaxDocumentUrl

String

State tax document provided at the time of Gate entry creation is available via the Url

Yes

shippingLabelDocumentUrl

String

Shipping label document provided at the time of Gate entry creation is available via the Url

Yes

transporter

String

Transporter which delivered the goods to warehouse

Yes

vehicleNumber

String

Vehicle Number which delivered the goods to warehouse

Yes

gateEntryCreatedAt

String

Time at which gate entry was created in Increff Omni

Yes

externalInvoiceDate

String

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

yes

awbNumber

String

Awb number of shipment which is getting inwarded

Yes

orderCode

String

Unique code used by the channel to identify the order

Yes

orderType

 String

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

Yes

locationCode

String

Code used by channels to identify a warehouse

Yes

messageId

Long

Unique Identifier of a notification ( for de-duplication)

Yes

billOfEntry

String

Bill of entry of GRN

no

entryDeclarationNumber

String

Entry declaration number

no

parentOrderCode

String

Parent order code

yes

partnerCode

String

This represents the partner from which order will come.

If Order is of type PO/STO, this field represents vendor's code

If Order is of type RO, this field represents customer’s code

yes

partnerLocationCode

String

This represents the partner’s location from which order will come.

If Order is of type PO/STO, this field represents vendor location’s code

If Order is of type RO, this field represents customer location’s code

Yes

asnCode

String

External code for the corresponding ASN

no

generatedAsnId

String

Internal code for the corresponding ASN

no

items

Object[]

List of items being GRN’ed

Yes

items.orderItemCode

String

Code of an item in a particular order

no

items.channelSkuCode

String

SKU code of order item

Yes

items.qcPassAbsoluteQuantity

Integer

Total Qc pass quantity GRNed in order for the SKU

Yes

items.qcFailAbsoluteQuantity

Integer

Total Qc fail quantity GRNed in order for the SKU

Yes

items.qcPassDeltaQuantity

Integer

Qc pass quantity GRNed in order for the SKU since the last notification to ERP for the order.

Yes

items.qcFailDeltaQuantity

Integer

Qc fail quantity GRNed in order for the SKU since the last notification to ERP for the order.

Yes

items.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.attribute10

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

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

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