This API will return the custom order and order line item attribute details corresponding to an orderCode and locationCode
This API will take orderCode and locationCode as input and return all custom order attributes.
Parameters
| Parameter Name | Data Type | Description | Mandatory |
|---|---|---|---|
| orderCode | String | order code whose details needs to be fetched | Yes |
| locationCode | String | location to which that order belongs to | Yes |
{
"orderCode": "ORD-123456",
"orderStatus": "CREATED",
"locationCode": "WAREHOUSE-001",
"channelName": "flipkart",
"parentOrderCode": "PARENT-ORD-789",
"orderTime": "2024-02-13T09:45:00Z",
"orderType": "SO",
"onHold": false,
"isPriority": true,
"gift": true,
"isSplitRequired": false,
"dispatchByTime": "2024-02-15T14:30:00Z",
"startProcessingTime": "2024-02-13T10:00:00Z",
"paymentMethod": "COD",
"deliveryType": "NORMAL",
"packType": "PIECE",
"qcStatus": "PASS",
"omsOrderId": 100001,
"shippingCharges": 50,
"shippingAddress": {
"name": "Jane Smith",
"line1": "456 Oak Street",
"line2": "Suite 789",
"line3": "Tower D",
"phone": "+1-555-987-6543",
"email": "[email protected]",
"city": "Gotham",
"state": "NY",
"zip": "10001",
"country": "United States",
"longitude": -73.9857,
"latitude": 40.7484,
"openLocationCode": "87G8Q2JM+QV"
},
"billingAddress": {
"name": "John Doe",
"line1": "123 Main Street",
"line2": "Apt 456",
"line3": "Building C",
"phone": "+1-555-123-4567",
"email": "[email protected]",
"city": "Metropolis",
"state": "CA",
"zip": "90001",
"country": "United States",
"longitude": -118.2437,
"latitude": 34.0522,
"openLocationCode": "8553XJ2R+PV"
},
"orderCustomAttributes": {
"attribute1": "test_4e10f67e0585",
"attribute2": "test_df7f45161dbf",
"attribute3": "test_511554245071",
"attribute4": "test_285ab90a9a26",
"attribute5": "test_c9902353bd62",
"attribute6": "test_29bf877ad20e",
"attribute7": "test_f05c5ee7bda0",
"attribute8": "test_f05c5ee7bda1",
"attribute9": "test_913b35f805f0",
"attribute10": "test_e3af29b52cda",
"channelMetadata": "serializedMetadataString",
"currency": "test_ad35da54ae2f"
},
"orderItems": [
{
"orderItemCode": "item123",
"channelSkuCode": "SKU-001",
"orderedQuantity": 2,
"cancelledQuantity": 0,
"channelDiscount": 5.00,
"sellerDiscount": 3.00,
"sellingPrice": 20.00,
"orderItemCustomAttributes": {
"attribute1": "test_9500ccd4855f",
"attribute2": "test_957207fbdbb0",
"attribute3": "test_e9c4494fc055",
"attribute4": "test_2c6670838f48",
"attribute5": "test_09156554f500",
"attribute6": "test_20ab8d00c447",
"attribute7": "test_f0c3e77287ae",
"attribute8": "test_f05c5ee7bda1",
"attribute9": "test_691c1f899bb8",
"attribute10": "test_1e7511fe9fc8",
"channelMetadata": "serializedMetadataString"
}
}
],
"shipments": [
{
"shipmentCode": "SHIP-001",
"locationCode": "WAREHOUSE-001",
"status": "PACKED",
"omsShipmentId": 120001,
"generatedInvoiceId": "GEN-INV-001",
"generatedInvoiceDate": "2024-02-14T10:00:00Z",
"invoiceDocumentUrl": "<https://example.com/invoice.pdf>",
"irn": "IRN987654321",
"qrCode": "QRCodeString",
"shippingLabelDocumentUrl": "<https://example.com/label.pdf>",
"invoiceCode": "INV-001",
"externalInvoiceDate": "2024-02-14T10:00:00Z",
"externalInvoiceId": "EXT-INV-001",
"packageSku": "PKG-SKU-001",
"awbNumber": "AWB123456",
"transporter": "BLUEDART",
"vehicleNumber": "KA01AB1234",
"lrNumber": "LR123",
"lrDocumentId": "LR-DOC-001",
"ewayBillDocumentId": "EWAY-001",
"remarks": "Handle with care",
"deliveredAt": "2024-02-16T14:00:00Z",
"packedAt": "2024-02-14T12:00:00Z",
"shipmentItems": [
{
"clientSkuCode": "CLIENT-SKU-001",
"orderItemCode": "item123",
"channelSkuCode": "SKU-001",
"quantity": 2,
"netTaxAmountPerUnit": 30.0,
"netTaxAmountTotal": 60.0,
"baseSellingPricePerUnit": 500.0,
"baseSellingPriceTotal": 1000.0,
"sellingPricePerUnit": 560.0,
"sellingPriceTotal": 1120.0,
"shippingCharge": 100.0,
"shippingChargePerUnit": 50.0,
"barcode": "1234567890",
"channelDiscount": 5,
"taxItems": [
{
"type": "SGST",
"rate": 6.0,
"taxPerUnit": 15.0,
"taxTotal": 30.0
}
]
}
],
"shipmentDetails": {
"shipmentId": 120001,
"totalItemQuantity": 2,
"length": 12.0,
"breadth": 6.0,
"height": 8.0,
"weight": 13.0,
"packboxDetailsList": []
}
}
]
}
HttpStatus : 200
| Field | Data Type | Description |
|---|---|---|
orderCode |
String | Unique code used by channel to identify the order |
orderStatus |
String | Possible values → (CREATED, CANCELLED, DELIVERED) |
locationCode |
String | Location code of warehouse from where this order will get fulfilled |
channelName |
String | Name of the channel from which order was placed |
parentOrderCode |
String | Represents code of parent order of the order |
orderTime |
String | Time at which order got placed by customer |
orderType |
String | Denotes the type of order (e.g., SO, STO, RTV, CRD) |
onHold |
Boolean | True if order is on hold |
isPriority |
Boolean | True if order has high priority |
gift |
Boolean | True if order is a gift |
isSplitRequired |
Boolean | True if WMS has to split the order |
dispatchByTime |
String | Time by which the order is expected to get dispatched |
startProcessingTime |
String | Time by which the order processing is expected to start |
paymentMethod |
String | Possible values → COD/NCOD |
deliveryType |
String | Type of delivery (e.g., NORMAL, EXPRESS, CLICK_AND_COLLECT) |
packType |
String | Possible values → PIECE/BULK |
qcStatus |
String | Possible values → PASS, FAIL |
omsOrderId |
Integer | OMS internal order ID |
shippingCharges |
Integer | Shipping charges for the order |
shippingAddress |
Object | Shipping address of the customer |
shippingAddress.name |
String | Name of customer |
shippingAddress.line1 |
String | 1st line of customer's address |
shippingAddress.line2 |
String | 2nd line of customer's address |
shippingAddress.line3 |
String | 3rd line of customer's address |
shippingAddress.phone |
String | Phone number of customer |
shippingAddress.email |
String | Email of customer |
shippingAddress.city |
String | City of customer |
shippingAddress.state |
String | State of customer |
shippingAddress.zip |
String | ZIP/Pin code of customer |
shippingAddress.country |
String | Country of customer |
shippingAddress.longitude |
Double | Longitude of the address |
shippingAddress.latitude |
Double | Latitude of the address |
shippingAddress.openLocationCode |
String | Open Location Code (Plus Code) of the address |
billingAddress |
Object | Billing address of the customer |
billingAddress.name |
String | Name of customer |
billingAddress.line1 |
String | 1st line of customer's address |
billingAddress.line2 |
String | 2nd line of customer's address |
billingAddress.line3 |
String | 3rd line of customer's address |
billingAddress.phone |
String | Phone number of customer |
billingAddress.email |
String | Email of customer |
billingAddress.city |
String | City of customer |
billingAddress.state |
String | State of customer |
billingAddress.zip |
String | ZIP/Pin code of customer |
billingAddress.country |
String | Country of customer |
billingAddress.longitude |
Double | Longitude of the address |
billingAddress.latitude |
Double | Latitude of the address |
billingAddress.openLocationCode |
String | Open Location Code (Plus Code) of the address |
orderCustomAttributes |
Object | Custom attributes for an order |
orderCustomAttributes.attribute1 |
String | Custom attribute 1 |
orderCustomAttributes.attribute2 |
String | Custom attribute 2 |
orderCustomAttributes.attribute3 |
String | Custom attribute 3 |
orderCustomAttributes.attribute4 |
String | Custom attribute 4 |
orderCustomAttributes.attribute5 |
String | Custom attribute 5 |
orderCustomAttributes.attribute6 |
String | Custom attribute 6 |
orderCustomAttributes.attribute7 |
String | Custom attribute 7 |
orderCustomAttributes.attribute8 |
String | Custom attribute 8 |
orderCustomAttributes.attribute9 |
String | Custom attribute 9 |
orderCustomAttributes.attribute10 |
String | Custom attribute 10 |
orderCustomAttributes.channelMetadata |
String | Serialized metadata string for additional fields |
orderCustomAttributes.currency |
String | Currency |
orderItems |
Object[] | List of items for which order is placed |
orderItems.orderItemCode |
String | This is provided by the channel to uniquely identify each order item. This should be unique in an order |
orderItems.channelSkuCode |
String | SKU code of order item |
orderItems.orderedQuantity |
Integer | Ordered quantity of ordered item |
orderItems.cancelledQuantity |
Integer | Cancelled quantity for this sku |
orderItems.channelDiscount |
Double | Discount given by channel on SKU |
orderItems.sellerDiscount |
Double | Discount given by seller on SKU |
orderItems.sellingPrice |
Double | Unit price of SKU including tax |
orderItems.orderItemCustomAttributes |
Object | Order Item custom attributes |
orderItemCustomAttributes.attribute1 |
String | Custom attribute 1 |
orderItemCustomAttributes.attribute2 |
String | Custom attribute 2 |
orderItemCustomAttributes.attribute3 |
String | Custom attribute 3 |
orderItemCustomAttributes.attribute4 |
String | Custom attribute 4 |
orderItemCustomAttributes.attribute5 |
String | Custom attribute 5 |
orderItemCustomAttributes.attribute6 |
String | Custom attribute 6 |
orderItemCustomAttributes.attribute7 |
String | Custom attribute 7 |
orderItemCustomAttributes.attribute8 |
String | Custom attribute 8 |
orderItemCustomAttributes.attribute9 |
String | Custom attribute 9 |
orderItemCustomAttributes.attribute10 |
String | Custom attribute 10 |
orderItemCustomAttributes.channelMetadata |
String | Serialized metadata string for additional fields |
shipments |
Object[] | List of shipments for the order |
shipments.shipmentCode |
String | Unique code for the shipment |
shipments.locationCode |
String | Location code of the warehouse |
shipments.status |
String | Shipment status |
shipments.omsShipmentId |
Long | OMS internal shipment ID |
shipments.generatedInvoiceId |
String | System generated invoice ID |
shipments.generatedInvoiceDate |
String | System generated invoice date |
shipments.invoiceDocumentUrl |
String | URL of the invoice document |
shipments.irn |
String | IRN generated on Govt. portal after e-invoicing |
shipments.qrCode |
String | QR code generated on Govt. portal after e-invoicing |
shipments.shippingLabelDocumentUrl |
String | URL of the shipping label document |
shipments.invoiceCode |
String | Invoice code |
shipments.externalInvoiceDate |
String | External invoice date |
shipments.externalInvoiceId |
String | External invoice ID |
shipments.packageSku |
String | SKU of the package material |
shipments.awbNumber |
String | Airway bill number |
shipments.transporter |
String | Transporter name |
shipments.vehicleNumber |
String | Vehicle number |
shipments.lrNumber |
String | LR number |