Orders
Orders List
Retrieve a list of orders.
Authorization
oauth2 orders:readAuthorizationBearer <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<>
location_id?array<>
sku?array<|>
SKU
status?array<>
Status
open- openarchived- archivedcanceled- canceled
payment_method?array<>
Payment Method
currency?string
fulfillment_status?array<>
Fulfillment Status
not_required- Not Requiredunfulfilled- Unfulfilledon_hold- On Holdrejected- Rejectedprocessing- Processingpartially_fulfilled- Partially Fulfilledfulfilled- Fulfilledincomplete- Incomplete
delivery_status?array<>
Delivery Status
tracking_added- Tracking Addedin_transit- In Transitout_for_delivery- Out For Deliveryattempted_delivery- Attempted Deliveryfailed_delivery- Failed Deliverydelivered- Delivereddelayed- Delayed
payment_status?array<>
Payment Status
pending- Payment Pendingauthorized- Authorizedexpiring- Expiringexpired- Expiredpaid- Paidvoided- Voidedrefunded- Refundedpartially_paid- Partially Paidpartially_refunded- Partially Refundedpartially_voided- Partially Voided
subscription_lifecycle?string
Subscription Lifecycle
recurring- Recurringnon-recurring- Non-Recurring
Value in
"non-recurring" | "recurring"date_placed_from?string
YYYY-MM-DD
Format
datedate_placed_to?string
YYYY-MM-DD
Format
datecoupon_code?array<>
Coupon code
tags?array<>
Tags
offers?array<>
Offers
countries?array<>
funnels?array<|>
Funnels
sources?array<|>
Source
admin_api- Admin APIcheckout- Checkout Flowsubscription- Subscriptiondashboard- 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*string
Default
"unstable"Value in
"unstable"Response Body
application/json
curl -X GET "https://example.29next.store/api/admin/orders/" \ -H "X-29next-API-Version: unstable"{
"next": "http://api.example.org/accounts/?cursor=cD00ODY%3D\"",
"previous": "http://api.example.org/accounts/?cursor=cj0xJnA9NDg3",
"results": [
{
"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,
"metadata": {},
"number": "string",
"order_status_url": "http://example.com",
"original_shipping_excl_tax": "string",
"original_shipping_incl_tax": "string",
"original_total_discount": "string",
"original_total_excl_tax": "string",
"original_total_incl_tax": "string",
"payment_status": "pending",
"shipping_code": "string",
"shipping_excl_tax": "string",
"shipping_incl_tax": "string",
"shipping_method": "string",
"shipping_tax": "string",
"source": "string",
"status": "string",
"total_cost": "string",
"total_discount": "string",
"total_excl_tax": "string",
"total_incl_tax": "string",
"total_outstanding": "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"
}
}
]
}