Create new order

post

https://api.omnisend.com/v3/orders

While posting new order email or/and phone or/and contactID must be provided.

Body Params

orderID

string

required

string

email or/and phone or contactID are required

phone

string

email or/and phone or contactID are required

contactID

string

email or/and phone or contactID are required

orderNumber

integer

cartID

string

shippingMethod

string

trackingCode

string

courierTitle

string

courierUrl

uri

orderUrl

uri

source

string

tags

discountCode

string

discountValue

integer

discountType

string

Can be percentage, fixedAmount or freeShippping

currency

string

required

length between 3 and 3

Currency ISO code

orderSum

integer

required

In cents

subTotalSum

integer

In cents

subTotalTaxIncluded

boolean

Whether subTotalSum includes taxes

discountSum

integer

In cents

taxSum

integer

In cents

shippingSum

integer

In cents

createdAt

date-time

required

Order creation date. ISO 8601 format. (example: 2017-05-30T14:11:12Z)

updatedAt

date-time

Order update date. ISO 8601 format. (example: 2017-05-30T14:11:12Z)

canceledDate

date-time

ISO 8601 format. (example: 2017-05-30T14:11:12Z)

cancelReason

string

paymentMethod

string

paymentStatus

string

Please view description for available statuses. You need to map your status with our statuses.

fulfillmentStatus

string

Please view description for available statuses. You need to map your status with our statuses.

contactNote

string

billingAddress

object

shippingAddress

object

products

array of objects

products

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200

400

401

403

404

408

422

429