Skip to content

orders

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History

orders

README.md

Group Orders

.orders

Use the orders resource to create, read, update and delete sales orders in a merchant's store, you can edit all order properties and also work with all order subresources directly at this resource

Order Object [/orders/schema.json]

:

JSON Schema [GET]

:

All Orders [/orders.json{?limit,offset,sort,fields}]

/orders.json?limit&offset&sort&fields&[field]

Authentication
GET: required

Use default URL parameters (metadata) for pagination and ordering, you can use any other parameter to query by particular object properties

List All Store Orders [GET /orders.json]

:

Pagination And Ordering [GET]

:

Find Orders [GET /orders.json{?code}]

:

New Order [/orders.json]

/orders.json

Authentication
POST: required

Request body must obey the specifications of this model

Create New Order [POST]

:

Specific Order [/orders/{_id}.json]

/orders/[_id].json

Authentication
GET: optional
PATCH, PUT, DELETE: required

In read requests, response body will follow this model, requests without authentication will receive order data without browser_ip, buyer, gift_to, shipping_lines, transactions, payments_history, fulfillments, hidden_metafields, private_metafields and staff_notes properties

For overwriting and editing, request body must obey the same specifications, but especially for edit requests there are no required fields

Read Order [GET /orders/{order}.json]

:

With Authentication [GET]

:

Edit Order [PATCH]

:

Overwrite Order [PUT]

:

Remove Order [DELETE]

: