post

/orders

Creates an Order. To learn more about creating or updating orders, see Orders Overview.

An order can be created with an existing catalog product or a custom product.

Required Fields

  • products
  • billing_address

Authorization

apiKey - X-Auth-Token
apiKey - X-Auth-Client

Request Parameters

2 Headers

Request Body

4 Examples
Schema
object

Products and Billing address only required for POST operation.

products
array[anyOf]
required
billing_address
object

Required to create an order.

required
shipping_addresses
object
1 validation
customer_id
integer

The ID of the customer placing the order; or 0 if it was a guest order.

1 validation
status_id
integer

The status ID of the order.

1 validation
subtotal_ex_tax
string

Override value for subtotal excluding tax. If specified, the field subtotal_inc_tax is also required. (Float, Float-As-String, Integer)

1 validation
subtotal_inc_tax
string

Override value for subtotal including tax. If specified, the field subtotal_ex_tax is also required. (Float, Float-As-String, Integer)

1 validation
base_shipping_cost
string

The value of the base shipping cost. (Float, Float-As-String, Integer)

1 validation
shipping_cost_ex_tax
string

The value of shipping cost, excluding tax. (Float, Float-As-String, Integer)

1 validation
shipping_cost_inc_tax
string

The value of shipping cost, including tax. (Float, Float-As-String, Integer)

1 validation
base_handling_cost
string

The value of the base handling cost. (Float, Float-As-String, Integer)

1 validation
handling_cost_ex_tax
string

The value of the handling cost, excluding tax. (Float, Float-As-String, Integer)

1 validation
handling_cost_inc_tax
string

The value of the handling cost, including tax. (Float, Float-As-String, Integer)

1 validation
base_wrapping_cost
string

The value of the base wrapping cost. (Float, Float-As-String, Integer)

1 validation
wrapping_cost_ex_tax
string

The value of the wrapping cost, excluding tax. (Float, Float-As-String, Integer)

1 validation
wrapping_cost_inc_tax
string

The value of the wrapping cost, including tax. (Float, Float-As-String, Integer)

1 validation
total_ex_tax
string

Override value for the total, excluding tax. If specified, the field total_inc_tax is also required. (Float, Float-As-String, Integer)

1 validation
total_inc_tax
string

Override value for the total, including tax. If specified, the field total_ex_tax is also required. (Float, Float-As-String, Integer)

1 validation
items_total
number

The total number of items in the order.

1 validation
items_shipped
number

The number of items that have been shipped.

1 validation
payment_method
string

The payment method for this order. Can be one of the following: Manual, Credit Card, cash, Test Payment Gateway, etc.

1 validation
payment_provider_id
string

The external Transaction ID/Payment ID within this order’s payment provider (if a payment provider was used).

1 validation
refunded_amount
string

The amount refunded from this transaction. (Float, Float-As-String, Integer)

1 validation
order_is_digital
boolean

Whether this is an order for digital products.

1 validation
gift_certificate_amount
string

A read-only value. Do not pass in a POST or PUT. (Float, Float-As-String, Integer)

1 validation
ip_address
string

IP Address of the customer, if known.

1 validation
geoip_country
string

The full name of the country where the customer made the purchase, based on the IP.

1 validation
geoip_country_iso2
string

The country where the customer made the purchase, in ISO2 format, based on the IP.

1 validation
staff_notes
string

Any additional notes for staff.

1 validation
customer_message
string

Message that the customer entered (number, optiona) -o the Order Comments box during checkout.

1 validation
discount_amount
string

Amount of discount for this transaction. (Float, Float-As-String, Integer)

1 validation
is_deleted
boolean

Indicates whether the order was deleted (archived). Set to to true, to archive an order.

1 validation
is_email_opt_in
boolean

Indicates whether the shopper has selected an opt-in check box (on the checkout page) to receive emails. A read-only value. Do not pass in a POST or PUT.

1 validation
ebay_order_id
string

If the order was placed through eBay, the eBay order number will be included. Otherwise, the value will be 0.

1 validation
external_source
string

For orders submitted or modified via the API, using a PUT or POST operation, you can optionally pass in a value identifying the system used to generate the order. For example: POS. Otherwise, the value will be null.

1 validation
external_id
integer

ID of the order in another system. For example, the Amazon Order ID if this is an Amazon order.This field can be updated in a /POST, but using a /PUT to update the order will return a 400 error. The field ‘external_id’ cannot be written to. Please remove it from your request before trying again. It can not be overwritten once set.

1 validation
channel_id
integer

Shows where the order originated. The channel_id will default to 1. Read-Only.

1 validation
tax_provider_id
string

BasicTaxProvider - Tax is set to manual.

AvaTaxProvider - This is for when the tax provider has been set to automatic and the order was NOT created by the API. Used for Avalara.

“” (blank) - When the tax provider is unknown. This includes legacy orders and orders previously created via API. This can be set when creating an order using a POST.

1 validation
date_created
string

The date this order was created. If not specified, will default to the current time. The date should be in RFC 2822 format.

Responses

Multiple Items – An order that contains mulitple products. The store it set to display prices excluding taxes. The tax rate is 8.95%.

2 Examples

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
$$.env
2 variables not set
store_hash
X-Auth-Token
X-Auth-Client