List all orders

How to fetch a collection of orders via API

To fetch a collection of orders, send a GET request to the /api/orders endpoint.

Request

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

Example

The following request fetches a collection of orders:

curl -g -X GET \
  'https://yourdomain.commercelayer.io/api/orders/' \
  -H 'Accept: application/vnd.api+json' \
  -H 'Authorization: Bearer your-access-token'

Remember that when you fetch a list of resources you get paginated result.

Sortable fields

The list of orders can be sorted by the following fields:

Attributes

  • number

  • place_async

  • status

  • payment_status

  • fulfillment_status

  • guest

  • language_code

  • currency_code

  • tax_included

  • tax_rate

  • country_code

  • coupon_code

  • gift_card_code

  • subtotal_amount_cents

  • shipping_amount_cents

  • payment_method_amount_cents

  • discount_amount_cents

  • adjustment_amount_cents

  • gift_card_amount_cents

  • total_tax_amount_cents

  • subtotal_tax_amount_cents

  • total_amount_cents

  • fees_amount_cents

  • duty_amount_cents

  • placed_at

  • approved_at

  • cancelled_at

  • payment_updated_at

  • fulfillment_updated_at

  • refreshed_at

  • archived_at

  • subscription_created_at

  • id

  • circuit_state

  • circuit_failure_count

  • created_at

  • updated_at

  • reference

  • reference_origin

Relationships

  • market

  • customer

Filterable fields

The list of orders can be filtered by the following fields:

Attributes

  • number

  • place_async

  • status

  • payment_status

  • fulfillment_status

  • guest

  • customer_email

  • language_code

  • currency_code

  • tax_included

  • tax_rate

  • country_code

  • coupon_code

  • gift_card_code

  • subtotal_amount_cents

  • shipping_amount_cents

  • payment_method_amount_cents

  • discount_amount_cents

  • adjustment_amount_cents

  • gift_card_amount_cents

  • total_tax_amount_cents

  • subtotal_tax_amount_cents

  • total_amount_cents

  • fees_amount_cents

  • duty_amount_cents

  • token

  • placed_at

  • approved_at

  • cancelled_at

  • payment_updated_at

  • fulfillment_updated_at

  • refreshed_at

  • archived_at

  • subscription_created_at

  • id

  • circuit_state

  • circuit_failure_count

  • created_at

  • updated_at

  • reference

  • reference_origin

  • metadata

Relationships

  • market

  • customer

  • shipping_address

  • billing_address

  • payment_method

  • payment_source

  • line_items

  • line_item_options

  • stock_reservations

  • stock_line_items

  • stock_transfers

  • shipments

  • payment_options

  • transactions

  • authorizations

  • captures

  • voids

  • refunds

  • returns

  • order_subscription

  • order_subscriptions

  • order_copies

  • recurring_order_copies

  • attachments

  • links

  • resource_errors

  • events

  • tags

Last updated