Get all Orders

GET 
/v2/orders

This endpoint returns all orders with custom flow fields. The pagination offset is set to fetch a maximum of 10,000 orders. If the store has 10,000 orders and you fetch the orders without using filters, an error is returned. Use a filter to view orders when the order is beyond the 10,000 mark.

note

• Pass the X-Moltin-Customer-Token header to limit orders to a specific customer. See Customer Tokens.
• Pass the EP-Account-Management-Authentication-Token header to limit orders to a specific account. See Account Management Token.
• You can use pagination with this resource. For more information, see pagination.

Filtering

The following operators and attributes are available for filtering orders.

Attribute	Type	Operator	Example
status	string	eq	eq(status,complete)
payment	string	eq	eq(payment,paid)
shipping	string	eq	eq(shipping,unfulfilled)
name (customer.name)	string	eq / like	like(name,Brad*)
email (customer.email)	string	eq / like	like(email,*@elasticpath.com)
customer_id	string	eq / like	eq(customer_id, e5a0d684-a4af-4919-a348-f66b0b4955e0)
account_id	string	eq / like	eq(account_id,3d7200c9-a9bc-4085-9822-63e80fd94a09)
account_member_id	string	eq / like	eq(account_member_id,2a8a3a92-2ccd-4b2b-a7af-52d3896eaecb)
contact.name	string	eq / like	eq(name,John Doe)
contact.email	string	eq / like	eq(email,John Doe)
shipping_postcode	string	eq / like	like(shipping_postcode,117*)
billing_postcode	string	eq / like	like(billing_postcode,117*)
with_tax	integer	gt/ge/lt/le	ge(with_tax,10000)
without_tax	integer	gt/ge/lt/le	ge(without_tax,10000)
currency	string	eq	eq(currency,USD)
product_id	string	eq	eq(product_id,6837058c-ae42-46db-b3c6-7f01e0c34b40)
product_sku	string	eq	eq(product_sku,deck-shoe-001)
created_at	date	eq / gt / ge/ le / lt	gt(created_at,YYYY-MM-DD)
updated_at	date	eq / gt / ge/ le/ lt	lt(updated_at,YYYY-MM-DD)
external_ref	string	eq / like	like(external_ref, 16be*)
order_number	string	eq / like	like(order_number, 123*)

Request

Header Parameters

x-moltin-customer-token string

A customer token to access a specific customer's orders.

Responses

200

Response Headers

application/json

Schema

Schema

data object[]
Array [
type string
Specifies the type of object being returned. You must use order.
order_number string
Specifies a user-managed, optional field used as an alternative to the existing order_id. If provided, the order-number will be sent to Authorize.net instead of the order_id, and will appear as the invoice number in Authorize.net transactions.
external_ref string
An optional external ID reference for an order. It can contain alphanumeric characters, special characters, and spaces, and is not required to be unique. The maximum allowed length is 64 characters. It can be used to include an external reference from a separate company system.
id uuid
Specifies the unique identifier of the order.
status string
Specifies the status of the order, such as incomplete, complete, processing, or cancelled.
payment string
Specifies the status of the payment, such as unpaid, authorized, paid, or refunded.
shipping string
Specifies the status of the shipment, such as fulfilled or unfulfilled.
anonymized boolean
Specifies if the order is anonymized.
meta object
timestamps object
created_at string
The date this was created.
updated_at
The date this was last updated.
with_tax object
amount number
The raw total of this cart.
currency string
The currency set for this cart.
formatted string
The tax inclusive formatted total based on the currency.
without_tax object
amount number
The raw total of this cart.
currency string
The currency set for this cart.
formatted string
The tax inclusive formatted total based on the currency.
tax object
amount number
The raw total of this cart.
currency string
The currency set for this cart.
formatted string
The tax inclusive formatted total based on the currency.
discount object
amount number
The raw total of this cart.
currency string
The currency set for this cart.
formatted string
The tax inclusive formatted total based on the currency.
paid object
amount number
The raw total of this cart.
currency string
The currency set for this cart.
formatted string
The tax inclusive formatted total based on the currency.
authorized object
amount number
The raw total of this cart.
currency string
The currency set for this cart.
formatted string
The tax inclusive formatted total based on the currency.
without_discount object
amount number
The raw total of this cart.
currency string
The currency set for this cart.
formatted string
The tax inclusive formatted total based on the currency.
billing_address object
first_name stringrequired
First name of the billing recipient.
last_name stringrequired
Last name of the billing recipient.
company_name stringrequired
Company name of the billing recipient.
line_1 stringrequired
First line of the billing address.
line_2 stringrequired
Second line of the billing address.
city stringrequired
City of the billing address.
postcode stringrequired
Postcode of the billing address.
county stringrequired
County of the billing address.
country stringrequired
Country of the billing address.
region stringrequired
State, province, or region of the billing address.
contact object
email string
The email address of the contact.
name string
The name of the contact.
shipping_address object
first_name stringrequired
First name of the shipping recipient.
last_name stringrequired
Last name of the shipping recipient.
phone_number stringrequired
Phone number of the shipping recipient.
company_name stringrequired
Company of the shipping recipient.
line_1 stringrequired
First line of the shipping address.
line_2 stringrequired
Second line of the shipping address.
city stringrequired
City of the shipping address.
postcode stringrequired
Post code of the shipping address.
county stringrequired
County of the shipping address.
country stringrequired
Country of the shipping address.
region stringrequired
State, province, or region of the shipping address.
instructions stringrequired
Delivery instructions.
]
links object

current string

Always the current page.

first string

Always the first page.

last string

If there is only one page, it is null.

next string

If there is only one page, it is null.

prev string

if the user is on the first page, it is null.

meta object

page object

current integer

The current page.

limit integer

The maximum number of records per page for this response. You can set this value up to 100.

offset integer

The current offset by number of records, not pages. Offset is zero-based.

total integer

The total page count.

results object

total integer

The total page count.

Example (from schema)

{
  "data": [
    {
      "type": "string",
      "order_number": "string",
      "external_ref": "string",
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "status": "string",
      "payment": "string",
      "shipping": "string",
      "anonymized": true,
      "meta": {
        "timestamps": {
          "created_at": "string"
        },
        "with_tax": {
          "amount": 0,
          "currency": "string",
          "formatted": "string"
        },
        "without_tax": {
          "amount": 0,
          "currency": "string",
          "formatted": "string"
        },
        "tax": {
          "amount": 0,
          "currency": "string",
          "formatted": "string"
        },
        "discount": {
          "amount": 0,
          "currency": "string",
          "formatted": "string"
        },
        "paid": {
          "amount": 0,
          "currency": "string",
          "formatted": "string"
        },
        "authorized": {
          "amount": 0,
          "currency": "string",
          "formatted": "string"
        },
        "without_discount": {
          "amount": 0,
          "currency": "string",
          "formatted": "string"
        }
      },
      "billing_address": {
        "first_name": "string",
        "last_name": "string",
        "company_name": "string",
        "line_1": "string",
        "line_2": "string",
        "city": "string",
        "postcode": "string",
        "county": "string",
        "country": "string",
        "region": "string"
      },
      "contact": {
        "email": "string",
        "name": "string"
      },
      "shipping_address": {
        "first_name": "string",
        "last_name": "string",
        "phone_number": "string",
        "company_name": "string",
        "line_1": "string",
        "line_2": "string",
        "city": "string",
        "postcode": "string",
        "county": "string",
        "country": "string",
        "region": "string",
        "instructions": "string"
      }
    }
  ],
  "links": {
    "current": "string",
    "first": "string",
    "last": "string",
    "next": "string",
    "prev": "string"
  },
  "meta": {
    "page": {
      "current": 0,
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "results": {
      "total": 0
    }
  }
}

401

Unauthorized

application/json

Schema

Schema

detail string
status string
title string

Example (from schema)

[
  null
]

Example

{
  "errors": {
    "status": 401,
    "title": "Unauthorized"
  }
}

Loading...