QUICKSTART
API Quick Start
Authentication
SignString
Rate Limit
Body Envelope
Request Errors
CHANGELOG
Changelog
REFERENCE
API Overview
v1
Orders
Create an order
post
List Orders
get
Get an order
get
Update an order
patch
Products
Create a product
post
Get a product
get
Update a product
patch
Stores
Create a store
post
List Stores
get
Get a store
get
Update a store
patch
Webhook Server Overview
v1
GDPR
Receive GDPR webhooks
post
Model
Envelope
Meta
v1
Error
v1
Pagination
v1
Primitive
Address
v1
Customer
v1
Money
v1
Shipment
v1
Weight
v1
StoreAddress
v1
Resource
Order
v1
OrderItem
v1
Product
v1
Store
v1
Support
Contact Support

get-orders

get
/orders

list orders

Request

Query Parameters

limit
integer

The maximum number of results to show on a page. Default is 10.

>= 1<= 50
page
integer

Current page of the collection. Default is 1.

>= 1<= 200
sort
string

Sort the results list by the given value. Default is '-source_created_at' .

Allowed values:
-source_created_at+source_created_at-source_updated_at+source_updated_at
Example:
-source_created_at
source_ids[]
array

Each element should be less than 32 characters. Count of the elements should be less than 50. Every source_id should be used as an independent query param, as the following url example shows: https://api.aftership.com/commerce/v1/orders?source_ids[]=5247009653041&source_ids[]=5081836323059

Headers

as-store-id
string

The identifier of your store. You need to generate it yourself. Note that this value must consist of numbers and letters (A-Z, a-z, 0-9), and special characters can only be hyphens (-) or underscores (_). For example, if you have a store called "soft life", you can fill in soft-life or soft_life for the value.

Auth
:
Parameters
:
:
:
:
: