Create an Order

create order api

create order

POST https://wms.eshopbox.com/api/order

This endpoint allows you to create order

Headers

Name	Type	Description
Authentication	string	Bearer Token to grant access to the api

Name

Type

Description

Authentication

string

Bearer Token to grant access to the api

Request Body

Name	Type	Description
externalChannelID	string	Sales channel name of client
customerOrderNumber	string	Unique number against each sales channel
shipMethod	string	Shipping method
orderDate	string	Order created date time eg: 2020-03-13 00:00:00
expectedShipDate	string	expected date on which order should be shipped from facility eg: 2020-03-13 00:00:00
promiseDeliveryDate	string	Delivery date on which order should be delivered eg: 2020-03-13 00:00:00
isCOD	string	1 if order is COD, 0 if order is prepaid
paymentType	string	Payment method of order e.g : COD, credit card etc
taxAmount	number	Tax amount of order
shipChargeAmount	number	Total shipping charge on order
subtotal	number	Total sum of all lineItemTotal
orderTotal	number	Invoice total of order
balanceDue	number	Amount the customer has to pay
thirdPartyShipping	boolean	true= if shipping is arranged by marketplace,false = if shipping is arranged by vendor
shippingAddress	object	Shipping address object
shippingAddress.customerName	string	Shipping address customer name
shippingAddress.addressLine1	string	First Line of shipping address
shippingAddress.addressLine2	string	Second line of shipping address
shippingAddress.city	string	Shipping city
shippingAddress.state	string	Shipping state
shippingAddress.postalCode	string	Shipping postal code
shippingAddress.countryCode	string	Shipping country code
shippingAddress.countryName	string	Shipping country name
shippingAddress.contactPhone	string	Shipping address contact number
shippingAddress.email	string	Shipping address email Id
billingAddress	object	Billing address object
billingAddress.customerName	string	Billing name of customer
billingAddress.addressLine1	string	First line of billing address
billingAddress.addressLine2	string	Second line of billing address
billingAddress.city	string	Billing city
billingAddress.state	string	Billing state
billingAddress.postalCode	string	Billing postal code
billingAddress.countryCode	string	Billing country code
billingAddress.countryName	string	Billing country name
billingAddress.contactPhone	string	Billing person contact number
billingAddress.email	string	Billing person email Id
items	array	The order items object

Name

Type

Description

externalChannelID

string

Sales channel name of client

customerOrderNumber

string

Unique number against each sales channel

shipMethod

string

Shipping method

orderDate

string

Order created date time eg: 2020-03-13 00:00:00

expectedShipDate

string

expected date on which order should be shipped from facility eg: 2020-03-13 00:00:00

promiseDeliveryDate

string

Delivery date on which order should be delivered eg: 2020-03-13 00:00:00

isCOD

string

1 if order is COD, 0 if order is prepaid

paymentType

string

Payment method of order e.g : COD, credit card etc

taxAmount

number

Tax amount of order

shipChargeAmount

number

Total shipping charge on order

subtotal

number

Total sum of all lineItemTotal

orderTotal

number

Invoice total of order

balanceDue

number

Amount the customer has to pay

thirdPartyShipping

boolean

true= if shipping is arranged by marketplace,false = if shipping is arranged by vendor

shippingAddress

object

Shipping address object

shippingAddress.customerName

string

Shipping address customer name

shippingAddress.addressLine1

string

First Line of shipping address

shippingAddress.addressLine2

string

Second line of shipping address

shippingAddress.city

string

Shipping city

shippingAddress.state

string

Shipping state

shippingAddress.postalCode

string

Shipping postal code

shippingAddress.countryCode

string

Shipping country code

shippingAddress.countryName

string

Shipping country name

shippingAddress.contactPhone

string

Shipping address contact number

shippingAddress.email

string

Shipping address email Id

billingAddress

object

Billing address object

billingAddress.customerName

string

Billing name of customer

billingAddress.addressLine1

string

First line of billing address

billingAddress.addressLine2

string

Second line of billing address

billingAddress.city

string

Billing city

billingAddress.state

string

Billing state

billingAddress.postalCode

string

Billing postal code

billingAddress.countryCode

string

Billing country code

billingAddress.countryName

string

Billing country name

billingAddress.contactPhone

string

Billing person contact number

billingAddress.email

string

Billing person email Id

items

array

The order items object

{
    "id": 1497564,
    "externalChannelID": "TATA CLIQ VELOCY KAPAS KRAFT",
    "customerOrderNumber": "OD119208447831346000",
    "vendorOrderNumber": "11920832654052201",
    "shipMethod": "STD",
    "orderDate": "2020-02-29 15:39:11",
    "expectedShipDate": "2020-03-02 15:00:00",
    "promiseDeliveryDate": "0000-00-00 00:00:00",
    "isCOD": "0",
    "paymentType": "DebitCard",
    "taxAmount": 0,
    "shipChargeAmount": 0,
    "subtotal": 4049.09,
    "orderTotal": 4049.09,
    "balanceDue": 0,
    "thirdPartyShipping": true,
    "onHold": false,
    "created_at": "2020-02-24 15:48:27",
    "updated_at": "2020-03-01 13:01:10",
    "shippingAddress": {
        "customerName": "John Doe",
        "addressLine1": "Kapas Kraft Apparels Limited",
        "addressLine2": "Banglore",
        "city": "bengluru",
        "state": "Karnataka",
        "postalCode": "560005",
        "countryCode": "IN",
        "countryName": "India",
        "contactPhone": "9998889998",
        "email": "johndoe@gmail.com"
    },
    "billingAddress": {
        "customerName": "John Doe",
        "addressLine1": "Kapas Kraft Apparels Limited",
        "addressLine2": "Banglore",
        "city": "bengluru",
        "state": "Karnataka",
        "postalCode": "560005",
        "countryCode": "IN",
        "countryName": "India",
        "contactPhone": "9998889998",
        "email": "johndoe@gmail.com"
    },
    "items": [
        {
            "lineItemSequenceNumber": 112988,
            "orderItemID": "11920832654052201",
            "itemID": "DB9U03FMGWZ",
            "sku": "1234_S",
            "productName": "Pace Barnes",
            "quantity": 1,
            "customerPrice": 4499,
            "discount": 449.89,
            "lineItemTotal": 4049.09,
            "taxRate": 0,
            "taxAmount": 0,
            "returnPolicyCode": "",
            "cancellationPolicyCode": "",
            "productAdditionalInfo": {
                "size": "",
                "color": ""
            },
            "productUrl":"https://montecarlo.auperator.co/product/edit-product/BBAPLMC144105_44 ",
            "productImageUrl": "https://s3-eu-west-1.amazonaws.com/imagebucketeshopbox/Uzip/219045371-1-40/1.JPG"
        }
    ]
}

curl -X POST https://wms.eshopbox.com/api/order \
-H "Authorization: Bearer XXXX" \
    -H "Content-Type: application/json" \
    -d $'{
     
    "externalChannelID": "TATA CLIQ VELOCY KAPAS KRAFT",
   "customerOrderNumber": "OD119208447831346000",
    "shipMethod": "STD",
    "orderDate": "2020-02-29 15:39:11",
    "expectedShipDate": "2020-03-02 15:00:00",
    "promiseDeliveryDate": "0000-00-00 00:00:00",
    "isCOD": "0",
    "paymentType": "DebitCard",
    "taxAmount": 0,
    "shipChargeAmount": 0,
    "subtotal": 4049.09,
    "orderTotal": 4049.09,
    "balanceDue": 0,
    "thirdPartyShipping": true,
    "onHold": false,
    "shippingAddress": {
        "customerName": "John Doe",
        "addressLine1": "Kapas Kraft Apparels Limited",
        "addressLine2": "Banglore",
        "city": "bengluru",
        "state": "Karnataka",
        "postalCode": "560005",
        "countryCode": "IN",
        "countryName": "India",
        "contactPhone": "9998889998",
        "email": "johndoe@gmail.com"
    },
    "billingAddress": {
        "customerName": "John Doe",
        "addressLine1": "Kapas Kraft Apparels Limited",
        "addressLine2": "Banglore",
        "city": "bengluru",
        "state": "Karnataka",
        "postalCode": "560005",
        "countryCode": "IN",
        "countryName": "India",
        "contactPhone": "9998889998",
        "email": "johndoe@gmail.com"
    },
    "items": [
        {
            "lineItemSequenceNumber": 112988,
            "orderItemID": "11920832654052201",
            "itemID": "DB9U03FMGWZ",
            "productName": "Pace Barnes",
            "quantity": 1,
            "customerPrice": 4499,
            "discount": 449.89,
            "lineItemTotal": 4049.09,
            "taxRate": 0,
            "taxAmount": 0,
            "returnPolicyCode": "",
            "cancellationPolicyCode": "",
            "productAdditionalInfo": {
                "size": "",
                "color": ""
            },
           "productUrl":"https://montecarlo.auperator.co/product/edit-product/BBAPLMC144105_44 ",
            "productImageUrl": "https://s3-eu-west-1.amazonaws.com/imagebucketeshopbox/Uzip/219045371-1-40/1.JPG"
        }
    ]

      
 }

PreviousGet an Order NextHow invoicing works

Last updated 3 years ago