Frequently asked questions

Is there a sandbox for testing?

No. Write calls take effect in the live system. Check changes first with the preview endpoints (…/preview), which write nothing and show what would happen.

How do I authenticate?

Create an API key with exactly the permissions you need in the merchant portal and send it with every request as a bearer token in the Authorization header. The base address is https://gateway.shirtee.cloud.

How do I avoid duplicate orders when retrying?

Send the Idempotency-Key header on POST /api/orders. Retrying with the same key and the same body returns the first order. A different body with the same key is rejected with 422 and IDEMPOTENCY_KEY_REUSED.

How many requests are allowed?

Currently 300 requests per minute per key. The value can change. Rely on the RateLimit-Limit, RateLimit-Remaining and RateLimit-Reset headers, and on a 429 wait at least RateLimit-Reset seconds.

Are there webhooks for status changes?

No. Status is polled. How often and with what is described in the guide "Polling instead of webhooks".

How do I handle errors?

Evaluate the extra.error field, not detail. The message texts can change, the codes stay.

Can I manage warehouse products and inbound shipments via API?

Yes. You create warehouse products, announce inbound shipments, import shipping lists and attach documents. The flow is in the guide "Announce an inbound shipment".

Can I use the API with AI agents such as Claude Code or Codex?

Yes. There is the public OpenAPI 3.1 spec, llms.txt and llms-full.txt, and an instruction snippet for your repository. See the guide "Working with AI agents".

Where do I ask questions?

Write to [email protected].