This API sends near real-time GRN Notifications to ERP. The feature will help to keep the ERP systems notified about all the GRN’s happening for a client.
This API sends all the GRN notifications order-wise for the orders for which items have been GRN’ed since the time the job last ran and synced notifications successfully to ERP. Frequency of this job is configurable.
{
"orderCode": "po123",
"partnerCode": "partner1",
"partnerLocationCode": "partnerLoc1",
"locationCode": "l123",
"messageId": 12345,
"parentOrderCode": "pOrder123",
"asnCode": "asn1",
"generatedAsnId": "genAsn1",
"items": [{
"orderItemCode": null,
"channelSkuCode": "100005734",
"qcPassAbsoluteQuantity": 500,
"qcFailAbsoluteQuantity": 2,
"qcFailDeltaQuantity": 1,
"qcPassDeltaQuantity": 1,
"orderItemCustomAttributes": {
"attribute1": "Value1",
"attribute2": "Value2",
"attribute3": "Value3",
"attribute4": "Value4",
"attribute5": "Value5",
"attribute6": "Value6",
"attribute7": "Value7",
"attribute8": "Value8",
"attribute9": "Value9",
"attribute10": "Value10",
"channelMetadata": {
"totalCashOnDeliveryFee": 0.0,
"department": "HR",
"paymentMethod": "ccavenue",
"status": "processing"
}
}
},
{
"orderItemCode": "oc1",
"channelSkuCode": "100005736",
"qcPassAbsoluteQuantity": 400,
"qcFailAbsoluteQuantity": 2,
"qcFailDeltaQuantity": 2,
"qcPassDeltaQuantity": 2,
"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.0,
"department": "HR",
"paymentMethod": "ccavenue",
"status": "processing"
},
"currency": "INR"
}
}
| Parameter Name | Data Type | Description | Mandatory |
|---|---|---|---|
orderCode |
String | Unique code used by the channel to identify the order | 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 | ||
locationCode |
String | Code used by channels to identify a warehouse | Yes |
messageId |
Long | Unique Identifier of a notification ( for de-duplication ) | Yes |
parentOrderCode |
String | Parent order code | yes |
asnCode |
String | Code to identify an ASN created | no |
generatedAsnId |
String | Code to identify the generated ASN | no |
items |
Object[] | List of items GRNed | Yes |
items.orderItemCode |
String | Code to identify an item in a particular order | no |
items.channelSkuCode |
String | SKU code of order item | Yes |
items.qcPassAbsoluteQuantity |
Integer | Total Qc pass quantity GRNed in order for the SKU | Yes |
items.qcFailAbsoluteQuantity |
|||
| Integer | Total Qc fail quantity GRNed in order for the SKU | Yes | |
items.qcPassDeltaQuantity |
Integer | Qc pass quantity GRNed in order for the SKU since the last notification to ERP for the order. | Yes |
items.qcFailDeltaQuantity |
Integer | Qc fail quantity GRNed in order for the SKU since the last notification to ERP for the order. | Yes |
items.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 | These are additonal fields which can be sent to Increff system and can be used in subsequent Posting workflows | No |
orderCustomAttributes |
Object | Custom attributes for an order | No |
orderCustomAttributes.channelMetaData |
Object | These are additonal fields which can be sent to Increff system and can be used in subsequent Posting workflows | 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 |
HttpStatus Code
200
{
"hasError":false,
"errorMessage":"message"
}