Overview
The merchant API lets your own software drive your Shirtee account: create and track orders, read the catalog, fetch invoices, file complaints and plan warehouse inbound shipments. It is a REST interface using JSON.
Base URL
Section titled “Base URL”https://gateway.shirtee.cloudAll paths start with /api, for example GET /api/orders. Connections use HTTPS only. Requests and responses are JSON; file uploads (delivery receipt, complaint photos, inbound documents, shipping list) use multipart/form-data.
What you can do
Section titled “What you can do”| Area | What is possible |
|---|---|
| Orders | Check an order with a preview and create it, read status and history, cancel, change addresses and items, re-order, upload a delivery receipt |
| Catalog | Read products, variants, colors and sizes, find a variant by SKU, check availability |
| Invoices | List invoices and credit notes, fetch the PDF |
| Complaints | Create a complaint draft with photos, submit it, answer follow-up questions, withdraw it |
| Warehouse | Plan and change inbound shipments, import a shipping list, upload documents, maintain warehouse products, read safety stock |
The API reference documents every operation with parameters, examples and all response codes.
Getting started
Section titled “Getting started”What does not exist
Section titled “What does not exist”Prerequisites
Section titled “Prerequisites”You need a merchant account with a portal login. Which functions your keys may use depends on the enablement of your account, see Scopes and enablement.
Postman
Section titled “Postman”For quick experiments there is a Postman collection with all requests. Set the variable apiKey to your API key. Write requests take effect live, see above.