Orders
This API simplifies order management with features that enable effortless creation of quick orders, swift shipment requests, and automatic generation of shipping labels.
Order
POST {domain}/api/v1/shipping/order
This API is used to enable quick order and shipment creation and automatic shipping label generation.
Headers
Content-Type
application/json
Authorization
Bearer <token>
Body
channelId
No
Unique identifier for the sales channel. If not provided, Eshopbox will create order on the custom sales channel.
string
customerOrderId
No
Identifier for the order.
string
shipmentId
Yes
Unique identifier for the shipment.
string
orderDate
No
Date when the order was placed.
datetime
isCOD
Yes
Indicates if the order is Cash on Delivery (COD). 1 if order is COD, 0 if order is prepaid
string
invoiceTotal
Yes
Total amount of the invoice
number
invoice.number
No
Invoice number
string
invoice.date
No
Date of the invoice
datetime
ewaybillNumber
No
E-way bill number for the shipment
string
shippingMode
No
Mode of shipping (e.g., standard, express). If not provided, Eshopbox will assign on the basis of shipping mode rules configured in your workspace.
string
balanceDue
No
Amount due for payment. Mandatory for Cash on delivery (COD) orders
number
shippingAddress.customerName
Yes
Name of the customer
string
shippingAddress.addressLine1
Yes
First line of the shipping address
string
shippingAddress.addressLine2
No
Second line of the shipping address
string
shippingAddress.city
Yes
City of the shipping address
string
shippingAddress.state
Yes
State of the shipping address
string
shippingAddress.pincode
Yes
Pincode of the shipping address
string
shippingAddress.country
Yes
Country of the shipping address. Example: India.
string
shippingAddress.email
No
Email of the customer
string
shippingAddress.gstin
No
GSTIN of the customer in case of a B2B order
string
billingIsShipping
No
Mandatory if you want to keep the billing address same as the shipping address
string
billingAddress.customerName
No
Name of the customer
string
billingAddress.addressLine1
No
First line of the billing address
string
billingAddress.addressLine2
No
Second line of the billing address
string
billingAddress.city
No
City of the billing address
string
billingAddress.state
No
State of the billing address
string
billingAddress.pincode
Yes
pincode of the billing address
string
billingAddress.country
No
country of the billing address
string
billingAddress.email
No
Email of the billing address
string
billingAddress.gstin
No
gstin of the billing address
string
items.itemID
Yes
Unique identifier for the item like sku, ESIN, EAN etc
string
items.productTitle
Yes
Title of the product
string
items.quantity
Yes
Quantity of the item ordered
number
items.itemTotal
Yes
Total price for the item (inclusive of taxes)
number
items.hsn
No
HSN code for the item
string
items.mrp
No
Maximum Retail Price (MRP) of the item
number
items.discount
No
Discount applied to the item
number
items.taxPercentage
No
Tax percentage applied to the item
number
items.itemLength
No
Length of the item (in cm)
number
items.itemBreadth
No
Breadth of the item (in cm)
number
items.itemHeight
No
Height of the item (in cm)
number
items.productImageUrl
yes
Image of item
string
items.itemWeight
No
Weight of the item (in gram)
string
shipmentLength
Yes
Length of the shipment (in cm)
string
shipmentBreadth
Yes
Breadth of the shipment (in cm)
string
shipmentHeight
Yes
Height of the shipment (in cm)
string
shipmentWeight
Yes
Weight of the shipment (in gram)
string
pickupLocation.locationCode
Yes
Code for the pickup location. It is unique for each location.
string
pickupLocation.locationName
No
Name of the pickup location. *Mandatory if location code is blank or location is not created in Eshopbox.
string
pickupLocation.companyName
No
Name of the company. *Mandatory if location code is blank or location is not created in Eshopbox.
string
pickupLocation.contactPerson
No
Contact person at the pickup location. *Mandatory if location code is blank or location is not created in Eshopbox.
string
pickupLocation.contactNumber
No
Contact number of the pickup location. *Mandatory if location code is blank or location is not created in Eshopbox.
string
pickupLocation.addressLine1
No
First line of the pickup location address. *Mandatory if location code is blank or location is not created in Eshopbox.
string
pickupLocation.addressLine2
No
Second line of the pickup location address. *Mandatory if location code is blank or location is not created in Eshopbox.
string
pickupLocation.city
No
City of the pickup location. *Mandatory if location code is blank or location is not created in Eshopbox.
string
pickupLocation.state
No
State of the pickup location. *Mandatory if location code is blank or location is not created in Eshopbox.
string
pickupLocation.pincode
No
Pincode of the pickup location. *Mandatory if location code is blank or location is not created in Eshopbox.
string
pickupLocation.contactPhone
No
Phone contact for the pickup location. *Mandatory if location code is blank or location is not created in Eshopbox.
string
package.code
No
Code for the package
string
package.type
No
Type of the package. (e.g. box, flyer)
string
package.description
No
Description of the package
string
package.length
No
Length of the package (in cm)
string
package.breadth
No
Breadth of the package (in cm)
string
package.height
No
Height of the package (in cm)
string
package.weight
No
Weight of the package (in gram)
string
Response
Last updated