Outbound | POST | {Client’s URL}

Summary

This API will call the channel with consolidated GRN details for an inward order.

Description

This API will call the channel with consolidated GRN information for an entire inward order. This API call will be triggered when the inward order is closed, providing aggregated quantities across all gate entries.

Request

{
    "orderCode": "po123",
    "parentOrderCode": "parent123",
    "orderType": "PO",
    "locationCode": "l123",
    "messageId": 12345,
    "partnerCode": "partnerCode",
    "partnerLocationCode": "partnerLocationCode",
    "orderItems": [
        {
            "orderItemCode": "oc1",
            "barcode": "barcode123",
            "clientSkuCode": "clientSku001",
            "channelSkuCode": "100005734",
            "qcPassQuantity": 500,
            "qcFailQuantity": 2,
            "batchDetails": [
                {
                    "batchId": 567,
                    "batchCode": "EXT-BATCH-001",
                    "manufacturingDate": "2026-01-01T00:00:00.000+00:00",
                    "expiryDate": "2027-01-01T00:00:00.000+00:00",
                    "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": 547,
                    "batchCode": "EXT-BATCH-002",
                    "manufacturingDate": "2026-01-01T00:00:00.000+00:00",
                    "expiryDate": "2027-01-01T00:00:00.000+00:00",
                    "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": "CROSS_DOCK",
                "skuQtyDetails": [
                    {
                        "channelSkuCode": "SKU001",
                        "qcPassQty": 10,
                        "qcFailQty": 2
                    }
                ]
            }
        ],
        "missingItems": [
            {
                "channelSkuCode": "SKU002",
                "itemCode": "Item123"
            }
        ],
        "extraItems": [
            {
                "channelSkuCode": "SKU003",
                "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 values - 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
`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
`orderItems`	Object[]	List of items GRNed (consolidated across all gate entries)	Yes
`orderItems.orderItemCode`	String	Identifier for the item in a particular order	No
`orderItems.barcode`	String	Barcode of the item	No
`orderItems.clientSkuCode`	String	Client's SKU code	No
`orderItems.channelSkuCode`	String	SKU code of order item	Yes
`orderItems.qcPassQuantity`	Integer	Total QC pass quantity inwarded across all gate entries	Yes
`orderItems.qcFailQuantity`	Integer	Total QC fail quantity inwarded across all gate entries	Yes
`orderItems.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