Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

This API will call the channel with GRN information against a gate entry.This API call will be triggered only after the gate entry is closed.

Request

Code Block
languagejson
{
  "orderCode": "po123",
  "parentOrderCode": "parent123",
  "orderType": "PO/STO/RO",
  "invoiceId": "invoice123",
  "awbNumber": "awb_01",
  "invoiceDate": "2020-10-16T20:22:28.000+00:00",
  "gateEntryCreatedAt": "2020-09-16T20:22:28.000+00:00",
  "gateEntryId": "gt234",
  "messageId": 12345,
  "locationCode": "l123",
  "partnerCode": "partnerCode",
  "partnerLocationCode": "partnerLocationCode",
  "asnCode": "asn1",
  "generatedAsnId": "genAsn1",
  "orderItems": [
    {
      "orderItemCode": "oc1",
      "channelSkuCode": "100005734",
      "qcPassQuantity": 500,
      "qcFailQuantity": 2
    },
    {
      "orderItemCode": null,
      "channelSkuCode": "100005736",
      "qcPassQuantity": 498,
      "qcFailQuantity": 32
    }
  ]
}

Parameter Name

Data Type

Description

Mandatory

orderCode

String

Unique code used by the channel to identify the order

yes

parentOrderCode

String

Parent Order Code which was passed at the time of Inward Order Creation

No

yes

orderType

String

Possible value - STO (Stock Transfer Order), PO(Purchase Order), RO(Return Order),

SO, RTV, RPO, OPEN_PO, OPEN_RO

yes

locationCode

String

Code used by channels to identify a warehouse

Yes

invoiceId

String

Unique Id with which the shipment is arrived in the warehouse.

yes

awbNumber

String

Awb Number of the shipment received in the warehouse.

Yes

invoiceDate

externalInvoiceDate

String

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

yes

gateEntryCreatedAt

String

Time at which gate entry was created at the channel in UNIX (UTC)

yes

gateEntryId

String

Unique Id used to differentiate a gate entry

yes

messageId

Long

Unique Identifier of a message ( for de-duplication )

Yes

partnerCode

String

This represents the partner from which this inward order came.

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

Unique code to identify the corresponding advanced shipment notice(ASN)

No

generatedAsnId

String

Id of the ASN generated

No

orderItems

Object[]

List of items GRNed

yes

orderItems.orderItemCode

String

Code to identify the item in a particular order

No

orderItems.channelSkuCode

String

SKU code of order item

yes

orderItems.qcPassQuantity

Integer

Qc pass quantity inwarded in order

yes

orderItems.qcFailQuantity

Integer

Qc fail quantity inwarded in order

yes

 

Response

json
Code Block
language
{
    "hasError":false,
    "errorMessage":"message"
}

...