Перейти к содержимому
Разработчикам

Endpoints

Orders & products

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

Пути указаны относительно базового URL. В каждой карточке указано, какое разрешение нужно для вызова, и перечислены все параметры с типами и ограничениями.

GET
/orders

List orders, newest first.

Разрешение: orders
Постраничный

Параметры запроса

  • statusнеобязательноenum

    Fulfillment status.

    Допустимые значения:unfulfilledshippeddeliveredcancelledfailed

  • payment_statusнеобязательноenum

    Payment status.

    Допустимые значения:pendingpaid

  • contact_idнеобязательноinteger

    Orders of this contact.

  • created_sinceнеобязательноstring (ISO 8601 date-time with offset)

    Orders created at or after this time.

GET
/orders/:id

Retrieve an order with its items.

Разрешение: orders

Параметры пути

  • idобязательноinteger

    Order ID.

POST
/orders

Create an order for a contact.

Разрешение: orders

Тело JSON

  • contact_idобязательноinteger

    The customer.

  • itemsобязательноarray of objects

    1–200 items. Each item: name (required), quantity (required), unit_price (required), product_id, sku.

  • currencyнеобязательноstring

    Three-letter ISO 4217 code, e.g. "USD".

  • notesнеобязательноstring | null

    Up to 2,000 characters.

  • statusнеобязательноenum

    Fulfillment status.

    Допустимые значения:unfulfilledshippeddeliveredcancelledfailed

  • payment_statusнеобязательноenum

    Payment status.

    Допустимые значения:pendingpaid

  • paid_amountнеобязательноnumber

    ≥ 0.

  • shipping_feeнеобязательноnumber

    ≥ 0.

PATCH
/orders/:id

Update order details. Send at least one field.

Разрешение: orders

Параметры пути

  • idобязательноinteger

    Order ID.

Тело JSON

  • statusнеобязательноenum

    Fulfillment status.

    Допустимые значения:unfulfilledshippeddeliveredcancelledfailed

  • payment_statusнеобязательноenum

    Payment status.

    Допустимые значения:pendingpaid

  • paid_amountнеобязательноnumber

    ≥ 0.

  • shipping_feeнеобязательноnumber

    ≥ 0.

  • notesнеобязательноstring

    Up to 2,000 characters.

PUT
/orders/:id/status

Change the fulfillment status.

Разрешение: orders

Параметры пути

  • idобязательноinteger

    Order ID.

Тело JSON

  • statusобязательноenum

    Fulfillment status.

    Допустимые значения:unfulfilledshippeddeliveredcancelledfailed

POST
/orders/:id/items

Add an item to an order.

Разрешение: orders

Параметры пути

  • idобязательноinteger

    Order ID.

Тело JSON

  • nameобязательноstring

    Line name, 1–255 characters.

  • quantityобязательноinteger

    1–100,000.

  • unit_priceобязательноnumber

    0–100,000,000, in the order currency.

  • product_idнеобязательноinteger | null

    A product of this workspace (see GET /products).

  • skuнеобязательноstring | 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.

Разрешение: orders

Параметры пути

  • idобязательноinteger

    Order ID.

  • itemIdобязательноinteger

    Order item ID.

Тело JSON

  • quantityобязательноinteger

    1–100,000.

  • Only while the order is unfulfilled and unpaid.
DELETE
/orders/:id/items/:itemId

Remove an item from an order.

Разрешение: orders

Параметры пути

  • idобязательноinteger

    Order ID.

  • itemIdобязательноinteger

    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.

Разрешение: orders

Параметры пути

  • idобязательноinteger

    Order ID.

Тело JSON

  • noteобязательноstring

    1–2,000 characters.

GET
/products

List catalog products, newest first.

Любой участник команды
Постраничный

Параметры запроса

  • searchнеобязательноstring

    Matches the product name, up to 200 characters.

  • in_stockнеобязательноenum

    Stock filter.

    Допустимые значения:truefalse

  • sourceнеобязательноenum

    Where the product came from.

    Допустимые значения:manualshopifytrendyol

GET
/products/:id

Retrieve a product.

Любой участник команды

Параметры пути

  • idобязательноinteger

    Product ID.

POST
/products

Create a product.

Разрешение: business_pages

Тело JSON

  • nameобязательноstring

    1–500 characters.

  • descriptionнеобязательноstring | null

    Up to 20,000 characters.

  • priceнеобязательноnumber | string | null

    A number ≥ 0, or a price text up to 50 characters.

  • original_priceнеобязательноnumber | string | null

    Price before discount. Same format as price.

  • currencyнеобязательноstring | null

    Up to 10 characters, e.g. "USD".

  • skuнеобязательноstring | null

    Up to 200 characters.

  • brandнеобязательноstring | null

    Up to 200 characters.

  • in_stockнеобязательноboolean | null

    Whether the product is available.

  • stock_quantityнеобязательноinteger | null

    Units in stock, ≥ 0.

  • image_urlнеобязательноstring (URL) | null

    Main image, up to 2,048 characters.

  • imagesнеобязательноarray of strings (URL)

    Up to 50 image URLs.

  • urlнеобязательноstring (URL) | null

    Product page URL.

  • tagsнеобязательноarray of strings

    Up to 100 tags, 100 characters each.

  • categoriesнеобязательноarray of strings

    Up to 100 categories, 100 characters each.

PATCH
/products/:id

Update a product. Send at least one field.

Разрешение: business_pages

Параметры пути

  • idобязательноinteger

    Product ID.

Тело JSON

  • nameнеобязательноstring

    1–500 characters.

  • descriptionнеобязательноstring | null

    Up to 20,000 characters.

  • priceнеобязательноnumber | string | null

    A number ≥ 0, or a price text up to 50 characters.

  • original_priceнеобязательноnumber | string | null

    Price before discount. Same format as price.

  • currencyнеобязательноstring | null

    Up to 10 characters, e.g. "USD".

  • skuнеобязательноstring | null

    Up to 200 characters.

  • brandнеобязательноstring | null

    Up to 200 characters.

  • in_stockнеобязательноboolean | null

    Whether the product is available.

  • stock_quantityнеобязательноinteger | null

    Units in stock, ≥ 0.

  • image_urlнеобязательноstring (URL) | null

    Main image, up to 2,048 characters.

  • imagesнеобязательноarray of strings (URL)

    Up to 50 image URLs.

  • urlнеобязательноstring (URL) | null

    Product page URL.

  • tagsнеобязательноarray of strings

    Up to 100 tags, 100 characters each.

  • categoriesнеобязательноarray of strings

    Up to 100 categories, 100 characters each.

DELETE
/products/:id

Delete a product.

Разрешение: business_pages

Параметры пути

  • idобязательноinteger

    Product ID.