...
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 | ||
---|---|---|
| ||
{ "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", "asnCode": "asn1", "generatedAsnId": "genAsn1", "orderItems": [ { "orderItemCode": "oc1", "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": null, "channelSkuCode": "100005736", "qcPassQuantity": 498, "qcFailQuantity": 32, "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 |
| String | Unique code used by the channel to identify the order | yes |
| String | Parent Order Code which was passed at the time of Inward Order Creation | yes |
| String | Possible value - STO (Stock Transfer Order), PO(Purchase Order), RO(Return Order), SO, RTV, RPO, OPEN_PO, OPEN_RO | yes |
| String | Code used by channels to identify a warehouse | Yes |
| String | Unique Id with which the shipment is arrived in the warehouse. | yes |
| String | Awb Number of the shipment received in the warehouse. | Yes |
| String | Time at which order was placed at the channel in UNIX (UTC) | yes |
| String | Time at which gate entry was created at the channel in UNIX (UTC) | yes |
| String | Unique Id used to differentiate a gate entry | yes |
| Long | Unique Identifier of a message ( for de-duplication ) | Yes |
| 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 |
| 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 |
| String | Unique code to identify the corresponding advanced shipment notice(ASN) | No |
| String | Id of the ASN generated | No |
| Object[] | List of items GRNed | yes |
| String | Code to identify the item in a particular order | No |
| String | SKU code of order item | yes |
| Integer | Qc pass quantity inwarded in order | yes |
| Integer | Qc fail quantity inwarded in order | yes |
| Object | Custom attributes for order items | No |
| String | Custom attribute 1 | No |
| String | Custom attribute 2 | No |
| String | Custom attribute 3 | No |
| String | Custom attribute 4 | No |
| String | Custom attribute 5 | No |
| String | Custom attribute 6 | No |
| String | Custom attribute 7 | No |
| String | Custom attribute 8 | No |
| String | Custom attribute 9 | No |
| String | Custom attribute 10 | No |
| Object | meta data fields as an object which is to be parsed at the channel’s end | no |
| Object | Custom attributes for an order | No |
| Object | meta data fields as an object which is to be parsed at the channel’s end | No |
| String | Currency | No |
| String | Custom attribute 1 | No |
| String | Custom attribute 2 | No |
| String | Custom attribute 3 | No |
| String | Custom attribute 4 | No |
| String | Custom attribute 5 | No |
| String | Custom attribute 6 | No |
| String | Custom attribute 7 | No |
| String | Custom attribute 8 | No |
| String | Custom attribute 9 | No |
| String | Custom attribute 10 | No |
| Object | Box Sku Details at gate entry level | no |
| Object | Box Sku Quantity data | no |
| Object | Missing Items | no |
| Object | Extra Items | no |
| String | Code to uniquely identify a box in a grn | no |
| String | Purpose | no |
| Object[] | Details of all skus in a box | no |
| String | Code to uniquely identify an sku on channel | no |
| Integer | Qc pass quantity inwarded in order | no |
| Integer | Qc fail quantity inwarded in order | no |
| Object[] | Details of all items | no |
| String | Code to uniquely identify an sku on channel | no |
| String | Code to uniquely identify an item | no |
| Object[] | Details of all items | no |
| String | Code to uniquely identify an sku on channel | no |
| String | Code to uniquely identify an item | no |
Response
Code Block |
---|
{ "hasError":false, "errorMessage":"message" } |
...