Outbound | POST | {Client’s URL}

Summary

This API will call the channel with GRN details per gate entry wise.

Description

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

{
  "orderCode": "po123",
  "parentOrderCode": "parent123",
  "orderType": "PO/STO/RO",
  "invoiceId": "invoice123",
  "awbNumber": "awb_01",
  "externalInvoiceDate": "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",
  "externalDocId": "EXT-DOC-1",
  "docType": "INVOICE",
  "asnCode": "asn1",
  "generatedAsnId": "genAsn1",
  "orderItems": [
    {
      "orderItemCode": "oc1",
      "channelSkuCode": "100005734",
      "qcPassQuantity": 500,
      "qcFailQuantity": 2,
      "batchDetails": [
        {
          "batchId": 567,
          "batchCode": "EXT-BATCH-001",
          "manufacturingDate": "2026-01-01",
          "expiryDate": "2027-01-01",
          "mrp": 299.99,
          "qcPassQuantity": 80,
          "qcFailQuantity": 3
        }
      ],
      "orderItemCustomAttributes": {
        "attribute1": "Value1",
        "attribute2": "Value2",
        "attribute3": "Value3",
        "attribute4": "Value4",
        "attribute5": "Value5",
        "attribute6": "Value6",
        "attribute7": "Value7",
        "attribute8": "Value8",
        "attribute9": "Value9",
        "attribute10": "Value10",
        "channelMetadata": {
          "totalCashOnDeliveryFee": 0,
          "department": "HR",
          "paymentMethod": "ccavenue",
          "status": "processing"
        }
      }
    },
    {
      "orderItemCode": null,
      "channelSkuCode": "100005736",
      "qcPassQuantity": 498,
      "qcFailQuantity": 32,
      "batchDetails": [
        {
          "batchId": 587,
          "batchCode": "EXT-BATCH-002",
          "manufacturingDate": "2026-01-01",
          "expiryDate": "2027-01-01",
          "mrp": 299.99,
          "qcPassQuantity": 80,
          "qcFailQuantity": 3
        }
      ],
      "orderItemCustomAttributes": {
        "attribute1": "Value12",
        "attribute2": "Value22",
        "attribute3": "Value32",
        "attribute4": "Value42",
        "attribute5": "Value52",
        "attribute6": "Value62",
        "attribute7": "Value72",
        "attribute8": "Value82",
        "attribute9": "Value92",
        "attribute10": "Value102"
      }
    }
  ],
  "orderCustomAttributes": {
    "attribute1": "Value1",
    "attribute2": "Value2",
    "attribute3": "Value3",
    "attribute4": "Value4",
    "attribute5": "Value5",
    "attribute6": "Value6",
    "attribute7": "Value7",
    "attribute8": "Value8",
    "attribute9": "Value9",
    "attribute10": "Value10",
    "channelMetadata": {
      "totalCashOnDeliveryFee": 0,
      "department": "HR",
      "paymentMethod": "ccavenue",
      "status": "processing"
    },
    "currency": "INR"
  },
  "gateEntryLevelBoxSkuDetails": {
    "boxSkuQtyData": [
      {
        "boxCode": "BOX123",
        "purpose": "Sample Purpose",
        "skuQtyDetails": [
          {
            "channelSkuCode": "SKU001",
            "qcPassQty": 10,
            "qcFailQty": 2
          }
        ]
      }
    ],
    "missingItems": {
      "itemDetail": [
        {
          "channelSkuCode": "SKU001",
          "itemCode": "ITEM123"
        }
      ]
    },
    "extraItems": {
      "itemDetail": [
        {
          "channelSkuCode": "SKU002",
          "itemCode": "ITEM456"
        }
      ]
    }
  }
}

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	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
`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
`externalDocId`	String	External document id	Yes
`docType`	String (`DocType`)	Document type enum: `INVOICE`, `DEBIT_NOTE`, `OTHER`	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
`items.batchDetails`	Object[]	Container object holding batch-level information and QC quantity breakdowns	No, Batch details will only be returned when client configuration flag `enableBatchDetailsInInventoryAPI` is enabled

Response

{
    "hasError":false,
    "errorMessage":"message"
}

HttpStatus : 200