Create an order

How to create an order via API

To create a new order, send a POST request to the /api/orders endpoint, passing the resource arguments in the request body.

Request

POST https://yourdomain.commercelayer.io/api/orders

Arguments

Body Parameter

Type

Required

type

string

Required

attributes.number

string

Optional, default to numeric id

attributes.affiliate_code

string

Optional

attributes.autorefresh

boolean

Optional, default is 'true'

attributes.place_async

boolean

Optional, default is 'false'

attributes.guest

boolean

Optional

attributes.customer_email

string

Optional

attributes.customer_password

string

Optional

attributes.language_code

string

Optional, default is 'en'

attributes.freight_taxable

boolean

Optional, default is 'false' or set by tax calculator

attributes.payment_method_taxable

boolean

Optional, default is 'false' or set by tax calculator

attributes.adjustment_taxable

boolean

Optional, default is 'false' or set by tax calculator

attributes.gift_card_taxable

boolean

Optional, default is 'false' or set by tax calculator

attributes.shipping_country_code_lock

string

Optional

attributes.coupon_code

string

Optional

attributes.gift_card_code

string

Optional

attributes.cart_url

string

Optional

attributes.return_url

string

Optional

attributes.terms_url

string

Optional

attributes.privacy_url

string

Optional

attributes.reference

string

Optional

attributes.reference_origin

string

Optional

attributes.metadata

object

Optional

relationships.market

object

Required, unless in scope

relationships.customer

object

Optional

relationships.shipping_address

object

Optional

relationships.billing_address

object

Optional

relationships.store

object

Optional, set by scope

relationships.payment_method

object

Optional

relationships.payment_source

object

Optional

relationships.tags

array

Optional

Example

The following request creates a new order:

curl -g -X POST \
  'https://yourdomain.commercelayer.io/api/orders' \
  -H 'Accept: application/vnd.api+json' \
  -H 'Authorization: Bearer your-access-token' \
  -H 'Content-Type: application/vnd.api+json' \
  -d '{
  "data": {
    "type": "orders",
    "attributes": {
      "language_code": "it"
    }
  }
}'

On success, the API responds with a 201 Created status code, returning the created resource object:

{
  "data": {
    "id": "xYZkjABcde",
    "type": "orders",
    "links": {
      "self": "https://yourdomain.commercelayer.io/api/orders/xYZkjABcde"
    },
    "attributes": {
      "number": "1234",
      "affiliate_code": "xxxx-yyyy-zzzz",
      "autorefresh": true,
      "place_async": true,
      "status": "draft",
      "payment_status": "unpaid",
      "fulfillment_status": "unfulfilled",
      "guest": true,
      "editable": true,
      "customer_email": "john@example.com",
      "language_code": "it",
      "currency_code": "EUR",
      "tax_included": true,
      "tax_rate": 0.22,
      "freight_taxable": true,
      "payment_method_taxable": true,
      "adjustment_taxable": true,
      "gift_card_taxable": false,
      "requires_billing_info": false,
      "country_code": "IT",
      "shipping_country_code_lock": "IT",
      "coupon_code": "SUMMERDISCOUNT",
      "gift_card_code": "cc92c23e-967e-48b2-a323-59add603301f",
      "subtotal_amount_cents": 5000,
      "subtotal_amount_float": 50.0,
      "formatted_subtotal_amount": "€50,00",
      "shipping_amount_cents": 1200,
      "shipping_amount_float": 12.0,
      "formatted_shipping_amount": "€12,00",
      "payment_method_amount_cents": 0,
      "payment_method_amount_float": 0.0,
      "formatted_payment_method_amount": "€0,00",
      "discount_amount_cents": -500,
      "discount_amount_float": -5.0,
      "formatted_discount_amount": "-€5,00",
      "adjustment_amount_cents": 1500,
      "adjustment_amount_float": 15.0,
      "formatted_adjustment_amount": "€15,00",
      "gift_card_amount_cents": 1500,
      "gift_card_amount_float": 15.0,
      "formatted_gift_card_amount": "€15,00",
      "total_tax_amount_cents": 1028,
      "total_tax_amount_float": 10.28,
      "formatted_total_tax_amount": "€10,28",
      "subtotal_tax_amount_cents": 902,
      "subtotal_tax_amount_float": 9.02,
      "formatted_subtotal_tax_amount": "€9,02",
      "shipping_tax_amount_cents": 216,
      "shipping_tax_amount_float": 2.16,
      "formatted_shipping_tax_amount": "€2,16",
      "payment_method_tax_amount_cents": 0,
      "payment_method_tax_amount_float": 0.0,
      "formatted_payment_method_tax_amount": "€0,00",
      "adjustment_tax_amount_cents": 900,
      "adjustment_tax_amount_float": 9.0,
      "formatted_adjustment_tax_amount": "€9,00",
      "total_amount_cents": 5700,
      "total_amount_float": 57.0,
      "formatted_total_amount": "€57,00",
      "total_taxable_amount_cents": 4672,
      "total_taxable_amount_float": 46.72,
      "formatted_total_taxable_amount": "€46,72",
      "subtotal_taxable_amount_cents": 4098,
      "subtotal_taxable_amount_float": 40.98,
      "formatted_subtotal_taxable_amount": "€40,98",
      "shipping_taxable_amount_cents": 984,
      "shipping_taxable_amount_float": 9.84,
      "formatted_shipping_taxable_amount": "€9,84",
      "payment_method_taxable_amount_cents": 0,
      "payment_method_taxable_amount_float": 0.0,
      "formatted_payment_method_taxable_amount": "€0,00",
      "adjustment_taxable_amount_cents": 120,
      "adjustment_taxable_amount_float": 1.2,
      "formatted_adjustment_taxable_amount": "€1,20",
      "total_amount_with_taxes_cents": 5700,
      "total_amount_with_taxes_float": 57.0,
      "formatted_total_amount_with_taxes": "€57,00",
      "fees_amount_cents": 0,
      "fees_amount_float": 0.0,
      "formatted_fees_amount": "€0,00",