Next Commerce
Orders

Orders List

Retrieve a list of orders.

GET
/orders/

Authorization

oauth2 orders:read
AuthorizationBearer <token>

Generate an Access Token through Settings > API Access for single store access or use the Authorization Code flow with your partner App Client ID. Use required permission scopes for API endpoint access. Example Authorization: Bearer 123

In: header

Scope: orders:read

Query Parameters

search_text?string
address?string
order_number?string

Order Number

name?string
product?array<array<integer>>

Filter by product ID (supports variant and parent product IDs)

location_id?array<integer>
sku?array<string|null>

Filter by SKU

status?array<>

Status

  • open - open
  • archived - archived
  • canceled - canceled
payment_method?array<string>

Payment Method

currency?string
fulfillment_status?array<>

Fulfillment Status

  • not_required - Not Required
  • unfulfilled - Unfulfilled
  • on_hold - On Hold
  • rejected - Rejected
  • processing - Processing
  • partially_fulfilled - Partially Fulfilled
  • fulfilled - Fulfilled
  • incomplete - Incomplete
delivery_status?array<>

Delivery Status

  • tracking_added - Tracking Added
  • in_transit - In Transit
  • out_for_delivery - Out For Delivery
  • attempted_delivery - Attempted Delivery
  • failed_delivery - Failed Delivery
  • delivered - Delivered
  • delayed - Delayed
payment_status?array<>

Payment Status

  • pending - Payment Pending
  • authorized - Authorized
  • expiring - Expiring
  • expired - Expired
  • paid - Paid
  • voided - Voided
  • refunded - Refunded
  • partially_paid - Partially Paid
  • partially_refunded - Partially Refunded
  • partially_voided - Partially Voided
subscription_lifecycle?string

Subscription Lifecycle

  • recurring - Recurring
  • non-recurring - Non-Recurring

Value in

  • "non-recurring"
  • "recurring"
date_placed_from?string

YYYY-MM-DD

Formatdate
date_placed_to?string

YYYY-MM-DD

Formatdate
coupon_code?array<Code>

Coupon code

tags?array<string>

Tags

offers?array<string>

Offers

countries?array<string>
funnels?array<string|null>

Funnels

sources?array<|>

Source

  • admin_api - Admin API
  • checkout - Checkout Flow
  • subscription - Subscription
  • dashboard - Dashboard
agents?array<|>

Agents

utm_source?string

UTM Source

utm_campaign?string

UTM Campaign

utm_term?string

UTM Term

utm_content?string

UTM Content

affiliate?string

Affiliate

subaffiliate1?string

Sub-Affiliate 1

subaffiliate2?string

Sub-Affiliate 2

subaffiliate3?string

Sub-Affiliate 3

subaffiliate4?string

Sub-Affiliate 4

subaffiliate5?string

Sub-Affiliate 5

is_disputed?boolean
has_outstanding_balance?boolean
has_split_fulfillment?boolean
is_test?boolean

Is Test Order

cursor?string

The pagination cursor value.

Header Parameters

X-29next-API-Version*"2023-02-10"
Default"2023-02-10"

Value in

  • "2023-02-10"

Response Body

application/json

curl -X GET "https://example.com/orders/" \  -H "X-29next-API-Version: 2023-02-10"
{  "next": "http://example.com",  "previous": "http://example.com",  "results": [    {      "attribution": {        "affiliate": "string",        "agent": {          "email": "user@example.com",          "first_name": "string",          "id": 0,          "last_name": "string"        },        "funnel": "string",        "gclid": "string",        "metadata": null,        "subaffiliate1": "string",        "subaffiliate2": "string",        "subaffiliate3": "string",        "subaffiliate4": "string",        "subaffiliate5": "string",        "utm_campaign": "string",        "utm_content": "string",        "utm_medium": "string",        "utm_source": "string",        "utm_term": "string"      },      "billing_address": {        "country": "string",        "first_name": "string",        "id": 0,        "last_name": "string",        "line1": "string",        "line2": "string",        "line3": "string",        "line4": "string",        "phone_number": "string",        "postcode": "string",        "state": "string"      },      "created_at": "2019-08-24T14:15:22Z",      "currency": "string",      "date_placed": "2019-08-24T14:15:22Z",      "display_taxes": "string",      "fulfillment_status": "not_required",      "is_test": true,      "lines": [        {          "created_at": "2019-08-24T14:15:22Z",          "id": 0,          "is_gift_card": true,          "is_upsell": true,          "metadata": null,          "price_currency": "string",          "price_excl_tax": "string",          "price_excl_tax_excl_discounts": "string",          "price_incl_tax": "string",          "price_incl_tax_excl_discounts": "string",          "product": {            "categories": [              {                "id": 0,                "name": "string",                "slug": "string"              }            ],            "id": 0,            "images": [              {                "attachment": "string",                "caption": "string",                "display_order": 0,                "file_name": "string",                "id": 0,                "src": "http://example.com"              }            ],            "title": "string",            "upc": "string",            "url": "http://example.com"          },          "properties": [            {              "key": "string",              "value": null            }          ],          "quantity": 0,          "stockrecord": {            "id": 0,            "low_stock_threshold": 0,            "num_allocated": -2147483648,            "num_in_stock": -2147483648,            "partner_sku": "string",            "price": "string",            "price_currency": "string",            "price_retail": "string"          },          "total_cost": "string",          "unit_cost": "string",          "updated_at": "2019-08-24T14:15:22Z"        }      ],      "metadata": null,      "number": "string",      "offer_discounts": [        {          "amount": "string",          "description": "string",          "name": "string"        }      ],      "order_status_url": "http://example.com",      "original_shipping_excl_tax": "string",      "original_shipping_incl_tax": "string",      "original_total_excl_tax": "string",      "original_total_incl_tax": "string",      "payment_status": "pending",      "shipping_address": {        "country": "string",        "first_name": "string",        "id": 0,        "last_name": "string",        "line1": "string",        "line2": "string",        "line3": "string",        "line4": "string",        "notes": "string",        "phone_number": "string",        "postcode": "string",        "state": "string"      },      "shipping_code": "string",      "shipping_excl_tax": "string",      "shipping_incl_tax": "string",      "shipping_method": "string",      "shipping_tax": "string",      "source": "string",      "status": "string",      "subscription_lifecycle": "string",      "subscriptions": [        {          "billing_cycle": 0,          "id": 0        }      ],      "tags": [        "string"      ],      "total_cost": "string",      "total_excl_tax": "string",      "total_incl_tax": "string",      "total_tax": "string",      "updated_at": "2019-08-24T14:15:22Z",      "user": {        "accepts_marketing": true,        "email": "user@example.com",        "first_name": "string",        "id": 0,        "ip": "string",        "language": "string",        "last_name": "string",        "phone_number": "string",        "user_agent": "string"      },      "voucher_discounts": [        {          "amount": "string",          "description": "string",          "name": "string"        }      ]    }  ]}

Orders Fulfillments RetrieveGET

Retrieve order fulfillments.

Orders Mark As Paid CreatePOST

Marks an order as paid. You can only mark an order as paid if it isn't already fully paid.