Endpoints
Orders & products
Orders, their items and timeline, and the product catalog.
Pfade sind relativ zur Basis-URL. Jede Karte zeigt die Berechtigung, die der Aufruf braucht, und jeden Parameter mit Typ und Grenzen.
/ordersList orders, newest first.
Query-Parameter
- statusoptionalenum
Fulfillment status.
Erlaubte Werte:
unfulfilledshippeddeliveredcancelledfailed - payment_statusoptionalenum
Payment status.
Erlaubte Werte:
pendingpaid - contact_idoptionalinteger
Orders of this contact.
- created_sinceoptionalstring (ISO 8601 date-time with offset)
Orders created at or after this time.
/orders/:idRetrieve an order with its items.
Pfadparameter
- iderforderlichinteger
Order ID.
/ordersCreate an order for a contact.
JSON-Body
- contact_iderforderlichinteger
The customer.
- itemserforderlicharray of objects
1–200 items. Each item: name (required), quantity (required), unit_price (required), product_id, sku.
- currencyoptionalstring
Three-letter ISO 4217 code, e.g. "USD".
- notesoptionalstring | null
Up to 2,000 characters.
- statusoptionalenum
Fulfillment status.
Erlaubte Werte:
unfulfilledshippeddeliveredcancelledfailed - payment_statusoptionalenum
Payment status.
Erlaubte Werte:
pendingpaid - paid_amountoptionalnumber
≥ 0.
- shipping_feeoptionalnumber
≥ 0.
/orders/:idUpdate order details. Send at least one field.
Pfadparameter
- iderforderlichinteger
Order ID.
JSON-Body
- statusoptionalenum
Fulfillment status.
Erlaubte Werte:
unfulfilledshippeddeliveredcancelledfailed - payment_statusoptionalenum
Payment status.
Erlaubte Werte:
pendingpaid - paid_amountoptionalnumber
≥ 0.
- shipping_feeoptionalnumber
≥ 0.
- notesoptionalstring
Up to 2,000 characters.
/orders/:id/statusChange the fulfillment status.
Pfadparameter
- iderforderlichinteger
Order ID.
JSON-Body
- statuserforderlichenum
Fulfillment status.
Erlaubte Werte:
unfulfilledshippeddeliveredcancelledfailed
/orders/:id/itemsAdd an item to an order.
Pfadparameter
- iderforderlichinteger
Order ID.
JSON-Body
- nameerforderlichstring
Line name, 1–255 characters.
- quantityerforderlichinteger
1–100,000.
- unit_priceerforderlichnumber
0–100,000,000, in the order currency.
- product_idoptionalinteger | null
A product of this workspace (see GET /products).
- skuoptionalstring | null
Up to 100 characters.
- Items can only change while the order is unfulfilled and unpaid (409 order_not_editable).
/orders/:id/items/:itemIdChange the quantity of an order item.
Pfadparameter
- iderforderlichinteger
Order ID.
- itemIderforderlichinteger
Order item ID.
JSON-Body
- quantityerforderlichinteger
1–100,000.
- Only while the order is unfulfilled and unpaid.
/orders/:id/items/:itemIdRemove an item from an order.
Pfadparameter
- iderforderlichinteger
Order ID.
- itemIderforderlichinteger
Order item ID.
- An order needs at least one item: removing the last one answers 409 (cancel the order instead).
/orders/:id/timelineAdd a note to the order timeline.
Pfadparameter
- iderforderlichinteger
Order ID.
JSON-Body
- noteerforderlichstring
1–2,000 characters.
/productsList catalog products, newest first.
Query-Parameter
- searchoptionalstring
Matches the product name, up to 200 characters.
- in_stockoptionalenum
Stock filter.
Erlaubte Werte:
truefalse - sourceoptionalenum
Where the product came from.
Erlaubte Werte:
manualshopifytrendyol
/products/:idRetrieve a product.
Pfadparameter
- iderforderlichinteger
Product ID.
/productsCreate a product.
JSON-Body
- nameerforderlichstring
1–500 characters.
- descriptionoptionalstring | null
Up to 20,000 characters.
- priceoptionalnumber | string | null
A number ≥ 0, or a price text up to 50 characters.
- original_priceoptionalnumber | string | null
Price before discount. Same format as price.
- currencyoptionalstring | null
Up to 10 characters, e.g. "USD".
- skuoptionalstring | null
Up to 200 characters.
- brandoptionalstring | null
Up to 200 characters.
- in_stockoptionalboolean | null
Whether the product is available.
- stock_quantityoptionalinteger | null
Units in stock, ≥ 0.
- image_urloptionalstring (URL) | null
Main image, up to 2,048 characters.
- imagesoptionalarray of strings (URL)
Up to 50 image URLs.
- urloptionalstring (URL) | null
Product page URL.
- tagsoptionalarray of strings
Up to 100 tags, 100 characters each.
- categoriesoptionalarray of strings
Up to 100 categories, 100 characters each.
/products/:idUpdate a product. Send at least one field.
Pfadparameter
- iderforderlichinteger
Product ID.
JSON-Body
- nameoptionalstring
1–500 characters.
- descriptionoptionalstring | null
Up to 20,000 characters.
- priceoptionalnumber | string | null
A number ≥ 0, or a price text up to 50 characters.
- original_priceoptionalnumber | string | null
Price before discount. Same format as price.
- currencyoptionalstring | null
Up to 10 characters, e.g. "USD".
- skuoptionalstring | null
Up to 200 characters.
- brandoptionalstring | null
Up to 200 characters.
- in_stockoptionalboolean | null
Whether the product is available.
- stock_quantityoptionalinteger | null
Units in stock, ≥ 0.
- image_urloptionalstring (URL) | null
Main image, up to 2,048 characters.
- imagesoptionalarray of strings (URL)
Up to 50 image URLs.
- urloptionalstring (URL) | null
Product page URL.
- tagsoptionalarray of strings
Up to 100 tags, 100 characters each.
- categoriesoptionalarray of strings
Up to 100 categories, 100 characters each.
/products/:idDelete a product.
Pfadparameter
- iderforderlichinteger
Product ID.