Authentication
Authentication
Use an API key issued by your new Shipbuy workspace for the V2 API. Send the complete key in X-API-Key. App login tokens and V1 JWTs are not accepted. Your key fixes the account, environment and permissions; selecting a documentation version does not change them. Standalone shipping requires allowStandaloneShipping. With selected warehouses, it needs warehouseId and a matching shipFrom. Only explicit warehouses.all allows any origin. A resource without a store needs stores.all, and an unassigned fulfillment needs allowUnassignedFulfillments; pure standalone shipping does not require those two flags.
Content-Type: application/json X-API-Key: <your-v2-api-key>Manage V2 API keys
Integration notes
Save a new or rotated key when it is shown once. Keep it in your server-side secret storage. Keys default to 365 days, with an explicit permanent option; pause, revoke and rotate from the key page. Rotation defaults to a 24-hour overlap and permits at most 7 days. Manage test data in Settings → Developer → Sandbox; production availability follows the operation status shown here.
V2 write commands require Idempotency-Key. PATCH also requires If-Match. Preserve the same key, payload and original If-Match when retrying an uncertain write. IDs and money amounts are strings; date/time values are UTC. Quote expiry, business guards and conditional permissions still apply.