List orders (offset pagination, status / customer facets)

GET

/admin/v1/orders

const url = 'https://your-store.example.com/admin/v1/orders?page=1&pageSize=20&status=pending_payment';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://your-store.example.com/admin/v1/orders?page=1&pageSize=20&status=pending_payment'

Parameters

Query Parameters

page

integer

default: 1 >= 1 <= 9007199254740991

pageSize

integer

default: 20 >= 1 <= 200

status

string

Allowed values: pending_payment paid fulfilled shipped delivered completed cancelled refunded partially_refunded

customerId

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

List orders (offset pagination, status / customer facets)

Parameters

Query Parameters

Responses

200