Versions Compared

Old Version 3

changes.mady.by.user Raghav Mehta

Saved on

compared with

New Version Current

changes.mady.by.user Raghav Mehta

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Outbound | POST  | {Client’s URL}

...

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

Description

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

Request

Code Block
languagejson
{
    "orderCode": "po123",
    "parentOrderCode": "parent123",
    "orderType":"PO/STO/RO "PO",
    "invoiceId": "invoice123",
    "awbNumber": "awb_01",
    "externalInvoiceDate": "2020-10-16T20:22:28.000+00:00",
    "partnerCodegateEntryCreatedAt":"partner1 "2020-09-16T20:22:28.000+00:00",
    "partnerLocationCodegateEntryId":"partnerLoc1" "gt234",
    "messageId": 12345,
    "locationCode": "l123",
   "messageId":12345 "partnerCode": "partnerCode",
    "partnerLocationCode": "partnerLocationCode",
    "asnCode": "asn1",
    "parentOrderCodegeneratedAsnId": "pOrder123genAsn1",
    "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": "oc1"null,
            "channelSkuCode": "100005736",
            "qcPassQuantity": 498,
            "qcFailQuantity": 32,
            "orderItemCustomAttributes": {
                "attribute1": "Value12",
                ":3attribute2": "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 value - STO (Stock Transfer Order), PO(Purchase Order), RO(Return Order),

SO, RTV, RPO,

RTV,

OPEN_PO, OPEN_RO

Yes

locationCode

String

This represents the location of the warehouse where the order will come.

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

ZonedDateTime

Time at which order was placed at the channel in UNIX (UTC)

yes

gateEntryCreatedAt

ZonedDateTime

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

will come

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

messageId

asnCode

Long

String

Unique

Identifier of a notification ( for de-duplication)

Yes

parentOrderCode

String

Parent order code

yes

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

uniquely

identify

an

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

Response

HttpStatus Code 200

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.channelMetaDat

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

Long

Qc pass quantity inwarded in order

No

skuQtyDetails.qcFailQty

Long

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

Code Block
languagejson
{
    "hasError":false,
    "errorMessage":"message"
}

 HttpStatus : 200