Endpoints

Orders & products

Orders, their items and timeline, and the product catalog.

Os caminhos são relativos à URL base. Cada card lista a permissão que a chamada exige e todos os parâmetros, com tipo e limites.

GET

/orders

List orders, newest first.

Permissão: orders

Paginado

Parâmetros de query

statusopcionalenum
Fulfillment status.
Valores permitidos:unfulfilledshippeddeliveredcancelledfailed
payment_statusopcionalenum
Payment status.
Valores permitidos:pendingpaid
contact_idopcionalinteger
Orders of this contact.
created_sinceopcionalstring (ISO 8601 date-time with offset)
Orders created at or after this time.

GET

/orders/:id

Retrieve an order with its items.

Permissão: orders

Parâmetros de caminho

idobrigatóriointeger
Order ID.

POST

/orders

Create an order for a contact.

Permissão: orders

Corpo JSON

contact_idobrigatóriointeger
The customer.
itemsobrigatórioarray of objects
1–200 items. Each item: name (required), quantity (required), unit_price (required), product_id, sku.
currencyopcionalstring
Three-letter ISO 4217 code, e.g. "USD".
notesopcionalstring | null
Up to 2,000 characters.
statusopcionalenum
Fulfillment status.
Valores permitidos:unfulfilledshippeddeliveredcancelledfailed
payment_statusopcionalenum
Payment status.
Valores permitidos:pendingpaid
paid_amountopcionalnumber
≥ 0.
shipping_feeopcionalnumber
≥ 0.

PATCH

/orders/:id

Update order details. Send at least one field.

Permissão: orders

Parâmetros de caminho

idobrigatóriointeger
Order ID.

Corpo JSON

statusopcionalenum
Fulfillment status.
Valores permitidos:unfulfilledshippeddeliveredcancelledfailed
payment_statusopcionalenum
Payment status.
Valores permitidos:pendingpaid
paid_amountopcionalnumber
≥ 0.
shipping_feeopcionalnumber
≥ 0.
notesopcionalstring
Up to 2,000 characters.

PUT

/orders/:id/status

Change the fulfillment status.

Permissão: orders

Parâmetros de caminho

idobrigatóriointeger
Order ID.

Corpo JSON

statusobrigatórioenum
Fulfillment status.
Valores permitidos:unfulfilledshippeddeliveredcancelledfailed

POST

/orders/:id/items

Add an item to an order.

Permissão: orders

Parâmetros de caminho

idobrigatóriointeger
Order ID.

Corpo JSON

nameobrigatóriostring
Line name, 1–255 characters.
quantityobrigatóriointeger
1–100,000.
unit_priceobrigatórionumber
0–100,000,000, in the order currency.
product_idopcionalinteger | null
A product of this workspace (see GET /products).
skuopcionalstring | null
Up to 100 characters.

Items can only change while the order is unfulfilled and unpaid (409 order_not_editable).

PATCH

/orders/:id/items/:itemId

Change the quantity of an order item.

Permissão: orders

Parâmetros de caminho

idobrigatóriointeger
Order ID.
itemIdobrigatóriointeger
Order item ID.

Corpo JSON

quantityobrigatóriointeger
1–100,000.

Only while the order is unfulfilled and unpaid.

DELETE

/orders/:id/items/:itemId

Remove an item from an order.

Permissão: orders

Parâmetros de caminho

idobrigatóriointeger
Order ID.
itemIdobrigatóriointeger
Order item ID.

An order needs at least one item: removing the last one answers 409 (cancel the order instead).

POST

/orders/:id/timeline

Add a note to the order timeline.

Permissão: orders

Parâmetros de caminho

idobrigatóriointeger
Order ID.

Corpo JSON

noteobrigatóriostring
1–2,000 characters.

GET

/products

List catalog products, newest first.

Qualquer membro da equipe

Paginado

Parâmetros de query

searchopcionalstring
Matches the product name, up to 200 characters.
in_stockopcionalenum
Stock filter.
Valores permitidos:truefalse
sourceopcionalenum
Where the product came from.
Valores permitidos:manualshopifytrendyol

GET

/products/:id

Retrieve a product.

Qualquer membro da equipe

Parâmetros de caminho

idobrigatóriointeger
Product ID.

POST

/products

Create a product.

Permissão: business_pages

Corpo JSON

nameobrigatóriostring
1–500 characters.
descriptionopcionalstring | null
Up to 20,000 characters.
priceopcionalnumber | string | null
A number ≥ 0, or a price text up to 50 characters.
original_priceopcionalnumber | string | null
Price before discount. Same format as price.
currencyopcionalstring | null
Up to 10 characters, e.g. "USD".
skuopcionalstring | null
Up to 200 characters.
brandopcionalstring | null
Up to 200 characters.
in_stockopcionalboolean | null
Whether the product is available.
stock_quantityopcionalinteger | null
Units in stock, ≥ 0.
image_urlopcionalstring (URL) | null
Main image, up to 2,048 characters.
imagesopcionalarray of strings (URL)
Up to 50 image URLs.
urlopcionalstring (URL) | null
Product page URL.
tagsopcionalarray of strings
Up to 100 tags, 100 characters each.
categoriesopcionalarray of strings
Up to 100 categories, 100 characters each.

PATCH

/products/:id

Update a product. Send at least one field.

Permissão: business_pages

Parâmetros de caminho

idobrigatóriointeger
Product ID.

Corpo JSON

nameopcionalstring
1–500 characters.
descriptionopcionalstring | null
Up to 20,000 characters.
priceopcionalnumber | string | null
A number ≥ 0, or a price text up to 50 characters.
original_priceopcionalnumber | string | null
Price before discount. Same format as price.
currencyopcionalstring | null
Up to 10 characters, e.g. "USD".
skuopcionalstring | null
Up to 200 characters.
brandopcionalstring | null
Up to 200 characters.
in_stockopcionalboolean | null
Whether the product is available.
stock_quantityopcionalinteger | null
Units in stock, ≥ 0.
image_urlopcionalstring (URL) | null
Main image, up to 2,048 characters.
imagesopcionalarray of strings (URL)
Up to 50 image URLs.
urlopcionalstring (URL) | null
Product page URL.
tagsopcionalarray of strings
Up to 100 tags, 100 characters each.
categoriesopcionalarray of strings
Up to 100 categories, 100 characters each.

DELETE

/products/:id

Delete a product.

Permissão: business_pages

Parâmetros de caminho

idobrigatóriointeger
Product ID.