Get all Orders
This endpoint allows you to get details of all orders based on the search and filters passed in the request, along with page and per page (number of order items to be fetched in a single request).
Below you will find the key bindings you have to use to retrieve the value in the response object. The keys will be passed as comma-separated strings against the "fields" parameter value.
For example, account,customerOrderNumber,vendorOrderNumber,orderDetails.isCod
Keys to retrieve | Datatype | Definition |
---|---|---|
objectID | String | Primary distinct identifier in Eshopbox. |
account | String | Slug of you Eshopbox workspace. |
customerOrderNumber | String | It is the unique ID generated by the channel for fulfillment purpose. |
serialNumber | String | Product serial number of order item. |
vendorOrderNumber | String | It is the unique ID generated by the channel to communicate with the customer. |
orderItemID | String | Unique ID assigned the each item of the order. For example: If an order has multiple items, each item will be assigned with a unique id. |
orderStatus | String | Forward journey order status of an order item. |
returnStatus | String | Reverse journey return status of an order item. |
inventoryItemCode | String | The unique item barcode processed by the FC against this order item. This is applicable only if you have item level traceability. |
onHold | Enum (0, 1) | On hold flag to denote if an item is on hold. If onHold is 1, means the the order is on hold. |
thirdPartyShipping | String | If third-party shipping is enabled. If third party is 0 (disabled), then shipping is managed by Eshopbox. |
customerDetails.shippingCustomerName | String | Shipping customer name. |
customerDetails.shippingContactPhone | String | Shipping contact phone number. |
customerDetails.shippingEmail | String | Shipping contact email address. |
customerDetails.shippingCity | String | Shipping city. |
customerDetails.shippingState | String | Shipping state. |
customerDetails.shippingPostalCode | String | Shipping pincode. |
customerDetails.billingCustomerName | String | Billing customer name. |
customerDetails.billingEmail | String | Billing contact phone number. |
customerDetails.billingContactPhone | String | Billing contact email address. |
customerDetails.billingCity | String | Billing city. |
customerDetails.billingState | String | Billing state. |
customerDetails.billingPostalCode | String | Billing pincode. |
orderDetails.portalName | String | Portal name. |
orderDetails.saleChannel | String | Sale channel code. |
orderDetails.isCod | Enum (0, 1) | Flag to denote whether order is Prepaid (0) or COD (1) |
orderDetails.orderDate | Long | Timestamp (in milliseconds) of when order was placed on the sales channel. |
orderItemDetails.productName | String | Name of the product. |
orderItemDetails.ean | String | EAN. |
orderItemDetails.hsn | String | HSN code |
orderItemDetails.combo | Enum (Yes, No) | If order item is a virtual kit. |
orderItemDetails.esin | String | ESIN (Unique product identifier in Eshopbox system). |
orderItemDetails.sku | String | SKU of the product. |
orderItemDetails.brand | String | Brand. |
orderItemDetails.mrp | String | Product MRP. |
shipmentDetails.facilityCode | String | Fulfillment center code. |
shipmentDetails.invoiceTotal | String | Invoice total of the order item. |
shipmentDetails.shipmentNumber | String | Shipment unique identifier in Eshopbox. |
shipmentDetails.region | String | Shipping zone. |
shipmentDetails.trackingId | String | Shipment tracking ID. |
shipmentDetails.courierName | String | Courier name. |
shipmentDetails.weight | String | Weight of the shipment in kilograms. |
shipmentDetails.invoiceNumber | String | Shipment invoice number. |
shipmentDetails.invoiceDate | String | Invoice date on channel. |
shipmentTrackingDetails.deliveredTimestamp | Long | Timestamp (in milliseconds) of when shipment was delivered. |
shipmentTrackingDetails.delayedDeliveryTag | Enum(On time, Delayed, Failed) | Tag denoting whether delivery was delayed or not |
shipmentTrackingDetails.location | String | Shipment current location. |
shipmentTrackingDetails.slaResolution | Enum(Yes, No, SLA not applicable) | SLA of shipment delivery. |
shipmentTrackingDetails.expectedDeliveryDate | Long | Expected date of delivery. |
shipmentTrackingDetails.packedTimestamp | Long | Timestamp (in milliseconds) of when items were packed. |
shipmentTrackingDetails.outForDeliveryAttempts | Integer | Number of delivery attempts. |
orderNewTimestamp | Long | When order item was set as New in Eshopbox workspace. |
orderProcessingTimestamp | Long | When order item was set as Processing in Eshopbox workspace. |
orderReadyToShipTimestamp | Long | When order item was set as ReadyToShip in Eshopbox workspace. |
orderOnTheWayTimestamp | Long | When order item was set as OnTheWay in Eshopbox workspace. |
orderOutForDeliveryTimestamp | Long | When order item was set as OutForDelivery in Eshopbox workspace. |
orderDeliveredTimestamp | Long | When order item was set as Delivered in Eshopbox workspace. |
rtsTag | String | Order ready to ship tag. |
expectedShipDate | Long | Expected date of ready to ship. |
orderReceivedOn | Long | When order was created in Eshopbox system. |
orderDeliveredOn | Long | When order item was set as Delivered in Eshopbox workspace. |
firstOnTheWayTimestamp | Long | When shipment was marked on the way for the first time. |
firstOFDTimestamp | Long | When shipment was marked out for delivery for the first time. |
firstRTSTimestamp | Long | When the shipment was marked ready to ship. |
returns.returnProcessingTimestamp | Long | When returns item was set as Processing in Eshopbox workspace. |
returns.returnRestockedTimestamp | Long | When returns item was set as Restocked in Eshopbox workspace. |
returns.returnDetails.shippingProvider | String | Return shipment courier name. |
returns.returnDetails.returnItemCondition | Enum(Sellable, Non sellable, Item missing) | Return item condition. |
returns.returnDetails.resolution | Enum(Exchange, Refund) | Return resolution of the return item. |
returns.returnDetails.returnItemAction | Enum(Restocked, Quarantined, Return Lost) | Return item action taken while processing in the warehouse. |
returns.returnDetails.trackingId | String | Return shipment tracking ID. |
returns.returnDetails.type | String | Type of return. |
returns.returnDetails.returnReason | String | Reason for return. |
returns.returnDetails.returnSubReason | String | Additonal reason/remarks for return. |
returns.returnDetails.reversePickupCode | String | Reverse RP code. |
returns.returnDetails.weight | Double | Weight of the return shipment. |
returns.returnDetails.length | Double | Length of the return shipment. |
returns.returnDetails.width | Double | Width of the return shipment. |
returns.returnDetails.height | Double | Height of the return shipment. |
returns.returnDetails.completedOnTimestamp | Long | Timestamp (in millisecond) when return item was processed in the warehouse. |
returns.returnDetails.receivedOnTimestamp | Long | Timestamp (in millisecond) when return item was received at the warhouse. |
returns.returnDetails.createdOnTimestamp | Long | Timestamp (in millisecond) when return on the item was created in Eshopbox. |
returns.returnDetails.totalItems | Integer | Total items in the return shipment. |
returns.returnTrackingDetails.slaResolution | String | SLA tag of return shipment delivery. |
returns.returnTrackingDetails.returnDeliveredOnTimestamp | Long | When returns item was set as Delivered by courier partner. |
returns.returnTrackingDetails.delayedPickupTag | String | Tag denoting whether pickup was delayed or not. |
returns.returnTrackingDetails.expectedPickupDate | Long | Expected pickup date of the return. |
updatedAt | Long | Timestamp (in millisecond) when order item was updated in Eshopbox system. |
currentOrderStatus | String | Current status of the order item. |
erpDetails.paymentId | String | Payment Id of the order. |
erpDetails.billFrom | String | Bill From. The ERP code configured in Eshopbox provided by you. |
erpDetails.billTo | String | Bill To. The ERP code configured in Eshopbox provided by you. |
erpDetails.stateGstCode | String | State code. |
erpDetails.invoiceTotal | Double | Invoice Total. |
erpDetails.shippingCharges | Double | Shipping Charges. |
erpDetails.sellingPrice | Double | Selling Price. |
erpDetails.taxRate | Double | Tax Rate. |
erpDetails.ugstAmt | Double | Ugst Amt. |
erpDetails.ugstRate | Double | Ugst Rate. |
erpDetails.sgstAmt | Double | Sgst Amt. |
erpDetails.sgstRate | Double | Sgst Rate. |
erpDetails.cgstAmt | Double | Cgst Amt. |
erpDetails.cgstRate | Double | Cgst Rate. |
erpDetails.igstAmt | Double | Igst Amt. |
erpDetails.igstRate | Double | Igst Rate. |
erpDetails.shippingAddress | String | Customer shipping address. |
erpDetails.billingAddress | String | Customer billing address. |
erpDetails.shippingStateGstCode | String | Shipping state GST code. |
erpDetails.billingStateGstCode | String | Billing state GST code. |
Get all Orders
GET
https://{{workspace}}.myeshopbox.com/api/v1/orders/erp
Query Parameters
Name | Type | Description |
---|---|---|
filters* | String | You can add a filter for filtered data |
page | String | The number of pages to offset the results by. |
per_page | Integer | The number of items to return per page. |
fields* | String | Exhaustive list of fields to be retrieved in response, in comma-separated string. |
search | String | Keyword which you'll want to search in records |
Headers
Name | Type | Description |
---|---|---|
Authentication* | String | Bearer token to grant access against API. |
Get Invoiced Orders.
GET
https://{{workspace}}.myeshopbox.com/api/v1/orders/erp
The below "filters" fetches Invoiced order items. You can add or remove the fields based on the requirement. This is a sample request for your reference.
Query Parameters
Name | Type | Description |
---|---|---|
filters* | String | (firstRTSTimestamp >= 1674671400000 AND firstRTSTimestamp <= 1674757799999) |
page | String | 0 |
per_page | Integer | 100 |
fields* | String | vendorOrderNumber,serialNumber,orderDetails.saleChannel,erpDetails.billTo,erpDetails.billFrom,customerDetails.shippingState,erpDetails.stateGstCode,shipmentDetails.courierName,orderDetails.isCod,shipmentDetails.trackingId,orderItemDetails.channelListingId,orderItemDetails.brand,erpDetails.invoiceTotal,erpDetails.sellingPrice,erpDetails.shippingCharges,orderItemID,shipmentDetails.warehouseName,customerDetails.shippingCity,customerDetails.shippingPostalCode,customerDetails.shippingContactPhone,orderReceivedOn,shipmentDetails.invoiceNumber,customerDetails.shippingCustomerName,orderItemDetails.hsn,customerOrderNumber,orderDetails.portalName,erpDetails.igstAmt,erpDetails.igstRate,erpDetails.cgstAmt,erpDetails.cgstRate,erpDetails.sgstAmt,erpDetails.sgstRate,erpDetails.ugstAmt,erpDetails.ugstRate,erpDetails.shippingAddress,erpDetails.billingAddress,erpDetails.shippingStateGstCode,erpDetails.billingStateGstCode |
search | String | John Doe |
Headers
Name | Type | Description |
---|---|---|
Authentication* | String | Bearer {{auth0Token}} |
Get Credit Note Orders.
GET
https://{{workspace}}.myeshopbox.com/api/v1/orders/erp
The below "filters" value fetches the Return processed (Credit Note) order items. You can add or remove the fields based on the requirements. This is a sample request for your reference.
Query Parameters
Name | Type | Description |
---|---|---|
filters* | String | (returns.returnDetails.completedOnTimestamp>=1674671400000)AND(returns.returnDetails.completedOnTimestamp<=1674757799999)AND( 'returns.returnDetails.returnItemCondition':'Non sellable' OR 'returns.returnDetails.returnItemCondition':'Sellable' ) |
page | String | 0 |
per_page | Integer | 100 |
fields* | String | vendorOrderNumber,serialNumber,orderDetails.saleChannel,erpDetails.billTo,erpDetails.billFrom,customerDetails.shippingState,erpDetails.stateGstCode,shipmentDetails.courierName,orderDetails.isCod,shipmentDetails.trackingId,orderItemDetails.channelListingId,orderItemDetails.brand,erpDetails.invoiceTotal,erpDetails.sellingPrice,erpDetails.shippingCharges,orderItemID,shipmentDetails.warehouseName,customerDetails.shippingCity,customerDetails.shippingPostalCode,customerDetails.shippingContactPhone,orderReceivedOn,shipmentDetails.invoiceNumber,customerDetails.shippingCustomerName,orderItemDetails.hsn,customerOrderNumber,orderDetails.portalName,erpDetails.igstAmt,erpDetails.igstRate,erpDetails.cgstAmt,erpDetails.cgstRate,erpDetails.sgstAmt,erpDetails.sgstRate,erpDetails.ugstAmt,erpDetails.ugstRate,erpDetails.shippingAddress,erpDetails.billingAddress,erpDetails.shippingStateGstCode,erpDetails.billingStateGstCode |
search | String | John Doe |
Headers
Name | Type | Description |
---|---|---|
Authentication* | String | Bearer {{auth0Token}} |
Last updated