Aller au contenu
Développeurs

Endpoints

Orders & products

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

Les chemins sont relatifs à l’URL de base. Chaque carte indique la permission requise par l’appel et chaque paramètre, avec son type et ses limites.

GET
/orders

List orders, newest first.

Permission : orders
Paginé

Paramètres de requête

  • statusfacultatifenum

    Fulfillment status.

    Valeurs autorisées :unfulfilledshippeddeliveredcancelledfailed

  • payment_statusfacultatifenum

    Payment status.

    Valeurs autorisées :pendingpaid

  • contact_idfacultatifinteger

    Orders of this contact.

  • created_sincefacultatifstring (ISO 8601 date-time with offset)

    Orders created at or after this time.

GET
/orders/:id

Retrieve an order with its items.

Permission : orders

Paramètres de chemin

  • idobligatoireinteger

    Order ID.

POST
/orders

Create an order for a contact.

Permission : orders

Corps JSON

  • contact_idobligatoireinteger

    The customer.

  • itemsobligatoirearray of objects

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

  • currencyfacultatifstring

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

  • notesfacultatifstring | null

    Up to 2,000 characters.

  • statusfacultatifenum

    Fulfillment status.

    Valeurs autorisées :unfulfilledshippeddeliveredcancelledfailed

  • payment_statusfacultatifenum

    Payment status.

    Valeurs autorisées :pendingpaid

  • paid_amountfacultatifnumber

    ≥ 0.

  • shipping_feefacultatifnumber

    ≥ 0.

PATCH
/orders/:id

Update order details. Send at least one field.

Permission : orders

Paramètres de chemin

  • idobligatoireinteger

    Order ID.

Corps JSON

  • statusfacultatifenum

    Fulfillment status.

    Valeurs autorisées :unfulfilledshippeddeliveredcancelledfailed

  • payment_statusfacultatifenum

    Payment status.

    Valeurs autorisées :pendingpaid

  • paid_amountfacultatifnumber

    ≥ 0.

  • shipping_feefacultatifnumber

    ≥ 0.

  • notesfacultatifstring

    Up to 2,000 characters.

PUT
/orders/:id/status

Change the fulfillment status.

Permission : orders

Paramètres de chemin

  • idobligatoireinteger

    Order ID.

Corps JSON

  • statusobligatoireenum

    Fulfillment status.

    Valeurs autorisées :unfulfilledshippeddeliveredcancelledfailed

POST
/orders/:id/items

Add an item to an order.

Permission : orders

Paramètres de chemin

  • idobligatoireinteger

    Order ID.

Corps JSON

  • nameobligatoirestring

    Line name, 1–255 characters.

  • quantityobligatoireinteger

    1–100,000.

  • unit_priceobligatoirenumber

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

  • product_idfacultatifinteger | null

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

  • skufacultatifstring | 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.

Permission : orders

Paramètres de chemin

  • idobligatoireinteger

    Order ID.

  • itemIdobligatoireinteger

    Order item ID.

Corps JSON

  • quantityobligatoireinteger

    1–100,000.

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

Remove an item from an order.

Permission : orders

Paramètres de chemin

  • idobligatoireinteger

    Order ID.

  • itemIdobligatoireinteger

    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.

Permission : orders

Paramètres de chemin

  • idobligatoireinteger

    Order ID.

Corps JSON

  • noteobligatoirestring

    1–2,000 characters.

GET
/products

List catalog products, newest first.

Tout membre de l’équipe
Paginé

Paramètres de requête

  • searchfacultatifstring

    Matches the product name, up to 200 characters.

  • in_stockfacultatifenum

    Stock filter.

    Valeurs autorisées :truefalse

  • sourcefacultatifenum

    Where the product came from.

    Valeurs autorisées :manualshopifytrendyol

GET
/products/:id

Retrieve a product.

Tout membre de l’équipe

Paramètres de chemin

  • idobligatoireinteger

    Product ID.

POST
/products

Create a product.

Permission : business_pages

Corps JSON

  • nameobligatoirestring

    1–500 characters.

  • descriptionfacultatifstring | null

    Up to 20,000 characters.

  • pricefacultatifnumber | string | null

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

  • original_pricefacultatifnumber | string | null

    Price before discount. Same format as price.

  • currencyfacultatifstring | null

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

  • skufacultatifstring | null

    Up to 200 characters.

  • brandfacultatifstring | null

    Up to 200 characters.

  • in_stockfacultatifboolean | null

    Whether the product is available.

  • stock_quantityfacultatifinteger | null

    Units in stock, ≥ 0.

  • image_urlfacultatifstring (URL) | null

    Main image, up to 2,048 characters.

  • imagesfacultatifarray of strings (URL)

    Up to 50 image URLs.

  • urlfacultatifstring (URL) | null

    Product page URL.

  • tagsfacultatifarray of strings

    Up to 100 tags, 100 characters each.

  • categoriesfacultatifarray of strings

    Up to 100 categories, 100 characters each.

PATCH
/products/:id

Update a product. Send at least one field.

Permission : business_pages

Paramètres de chemin

  • idobligatoireinteger

    Product ID.

Corps JSON

  • namefacultatifstring

    1–500 characters.

  • descriptionfacultatifstring | null

    Up to 20,000 characters.

  • pricefacultatifnumber | string | null

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

  • original_pricefacultatifnumber | string | null

    Price before discount. Same format as price.

  • currencyfacultatifstring | null

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

  • skufacultatifstring | null

    Up to 200 characters.

  • brandfacultatifstring | null

    Up to 200 characters.

  • in_stockfacultatifboolean | null

    Whether the product is available.

  • stock_quantityfacultatifinteger | null

    Units in stock, ≥ 0.

  • image_urlfacultatifstring (URL) | null

    Main image, up to 2,048 characters.

  • imagesfacultatifarray of strings (URL)

    Up to 50 image URLs.

  • urlfacultatifstring (URL) | null

    Product page URL.

  • tagsfacultatifarray of strings

    Up to 100 tags, 100 characters each.

  • categoriesfacultatifarray of strings

    Up to 100 categories, 100 characters each.

DELETE
/products/:id

Delete a product.

Permission : business_pages

Paramètres de chemin

  • idobligatoireinteger

    Product ID.