API reference | Shirtee Entwickler

API referencegateway.shirtee.cloud

Only enter production keys on your own computer. This page does not store them.

Loading reference …

The reference needs JavaScript. The guides work without it.API referenceAll endpoints of the Shirtee merchant API. The interactive reference needs JavaScript; here is the overview and the machine-readable spec.OpenAPI 3.1 (JSON) · llms-full.txt

Complaints

GET /api/complaints List complaints
POST /api/complaints Create a complaint draft
GET /api/complaints/{complaint_id} Get a complaint
DELETE /api/complaints/{complaint_id}/attachments/{attachment_id} Remove a photo from a complaint draft
POST /api/complaints/{complaint_id}/cancel Withdraw a complaint
POST /api/complaints/{complaint_id}/items/{item_id}/attachments Attach a photo to a complaint item
POST /api/complaints/{complaint_id}/submit Submit a complaint
POST /api/complaints/{complaint_id}/supplement Answer a complaint follow-up question
GET /api/orders/{order_id}/complaint-eligibility Complaint eligibility of an order

Invoices

GET /api/invoices/by-order/{order_id} List invoices and credit notes of an order
GET /api/invoices/user List invoices and credit notes
GET /api/invoices/user/{invoice_id}/pdf Get the PDF URL of an invoice

Orders

GET /api/orders List orders
POST /api/orders Create an order
GET /api/orders/by-external-reference/{external_reference} Get an order by external reference
POST /api/orders/preview Preview order creation
GET /api/orders/retention-reasons List retention reasons
GET /api/orders/retention-summary Order counts per retention reason
GET /api/orders/search Search orders
GET /api/orders/status-gates Order statuses that allow each action
GET /api/orders/{order_id} Get an order
PUT /api/orders/{order_id}/billing-address Correct the billing address
POST /api/orders/{order_id}/cancel Cancel an order
POST /api/orders/{order_id}/cancel/preview Preview order cancellation
PUT /api/orders/{order_id}/delivery-address Change the delivery address
POST /api/orders/{order_id}/delivery-address/preview Preview delivery address change
POST /api/orders/{order_id}/delivery-receipt Upload a delivery receipt insert
POST /api/orders/{order_id}/items Add an order item
POST /api/orders/{order_id}/items/preview Preview variant swap
PUT /api/orders/{order_id}/items/variants Swap the variants of several order items
DELETE /api/orders/{order_id}/items/{item_id} Remove an order item
PATCH /api/orders/{order_id}/items/{item_id} Swap the variant of an order item
POST /api/orders/{order_id}/reorder Reorder an existing order

Product Colors

GET /api/product-colors List product colors
GET /api/product-colors/{color_id} Get a product color

Product Sizes

GET /api/product-sizes List product sizes
GET /api/product-sizes/{size_id} Get a product size

Product Variants

GET /api/product-variants List product variants
GET /api/product-variants/by-sku/{sku} Get a product variant by SKU
GET /api/product-variants/paged List product variants (paged)
GET /api/product-variants/{variant_id} Get a product variant

Products

GET /api/products List products
GET /api/products/highlights Newest and best-selling public catalog products
GET /api/products/{product_id} Get a product

Warehouse Products

GET /api/warehouse/products List own warehouse products
POST /api/warehouse/products Create a warehouse product draft
GET /api/warehouse/products/{product_id} Get a warehouse product
PUT /api/warehouse/products/{product_id} Replace a warehouse product
POST /api/warehouse/products/{product_id}/submit Submit a warehouse product for review

Warehouse Safety Stock

GET /api/warehouse/products/{product_id}/safety-stock Get the safety stock of one own article
GET /api/warehouse/safety-stock Get own safety-stock default

Warehouse Shipments

GET /api/warehouse/shipments List inbound shipments
POST /api/warehouse/shipments Announce an inbound shipment
POST /api/warehouse/shipments/import Translate a shipping list into a shipment proposal
GET /api/warehouse/shipments/{shipment_id} Get an inbound shipment
PUT /api/warehouse/shipments/{shipment_id} Replace an inbound shipment
DELETE /api/warehouse/shipments/{shipment_id} Cancel an inbound shipment
POST /api/warehouse/shipments/{shipment_id}/documents Attach a document to an inbound shipment
DELETE /api/warehouse/shipments/{shipment_id}/documents/{document_id} Remove a shipment document
GET /api/warehouse/shipments/{shipment_id}/documents/{document_id}/url Get a signed download URL for a shipment document