Outbound | POST | {Client’s URL}

Summary

This API will call the channel with GRN details.

Description

This API will call the channel with GRN information against an inward order.This API call will be triggered only after the inward order against a PO is closed.

Request

{
    "orderCode": "po123",
    "orderType": "PO",
    "partnerCode": "partner1",
    "partnerLocationCode": "partnerLoc1",
    "locationCode": "l123",
    "messageId": 12345,
    "parentOrderCode": "pOrder123",
    "orderItems": [
        {
            "orderItemCode": null,
            "channelSkuCode": "100005734",
            "qcPassQuantity": 500,
            "qcFailQuantity": 2,
            "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": "oc1",
            "channelSkuCode": "100005736",
            "qcPassQuantity": 498,
            "qcFailQuantity": 3,
            "orderItemCustomAttributes": null
        }
    ],
    "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": "STORAGE",
                "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
`orderType`	String	Possible value - STO (Stock Transfer Order), PO(Purchase Order), RO(Return Order),SO, RTV, OPEN_PO, OPEN_RO	Yes
`locationCode`	String	This represents the location of the warehouse where the order will come.	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
`messageId`	Long	Unique Identifier of a notification ( for de-duplication)	Yes
`parentOrderCode`	String	Parent order code	Yes
`orderItems`	Object[]	List of items GRNed	Yes
`orderItems.orderItemCode`	String	Code to uniquely identify an 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
`orderItem.qcFailQuantity`	Integer	Qc fail quantity inwarded in order	Yes
`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	meta data fields as an object which is to be parsed at the channel’s end	No
`orderCustomAttributes`	Object	Custom attributes for an order	No
`orderCustomAttributes.channelMetaData`	Object	meta data fields as an object which is to be parsed at the channel’s end	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
`gateEntryLevelBoxSkuDetails`	Object	Box Sku Details at gate entry level	No
`gateEntryLevelBoxSkuDetails.boxSkuQtyData`	Object	Box Sku Quantity data	No
`gateEntryLevelBoxSkuDetails.missingItems`	Object	Missing Items	No
`gateEntryLevelBoxSkuDetails.extraItems`	Object	Extra Items	No
`boxSkuQtyData.boxCode`	String	Code to uniquely identify a box in a grn	No
`boxSkuQtyData.purpose`	String	Purpose(CROSS_DOCK/STORAGE)	No
`boxSkuQtyData.skuQtyDetails`	Object[]	Details of all skus in a box	No
`skuQtyDetails.channelSkuCode`	String	Code to uniquely identify an sku on channel	No
`skuQtyDetails.qcPassQty`	Integer	Qc pass quantity inwarded in order	No
`skuQtyDetails.qcFailQty`	Integer	Qc fail quantity inwarded in order	No
`missingItems.channelSkuCode`	String	Code to uniquely identify an sku on channel	No
`missingItems.itemCode`	String	Code to uniquely identify an item	No
`extraItems.channelSkuCode`	String	Code to uniquely identify an sku on channel	No
`extraItems.itemCode`	String	Code to uniquely identify an item	No

Response

HttpStatus Code 200

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

Increff Omni Standard APIs

GRN Posting API (Order)