Map Warehouse
POST/api/shippit/instances/:integration_instance/warehouses/link
Links one of your warehouses to Shippit sender (pickup origin) details so despatches from that warehouse originate from the correct address. Idempotent upsert on the (instance, warehouse) pair: calling it again for an already-linked warehouse updates its sender details in place rather than creating a duplicate.
Request fields:
sku_warehouse_id(required, integer) — the id of the warehouse to link; must reference an existing warehouse.enabled(optional, boolean) — whether the mapping is active; defaults totrue.sender_name(optional, string, max 255) — display name for the sender/pickup origin.sender_address(optional, object) — free-form address object stored verbatim as the pickup origin override.
Returns 201 Created with the resulting mapping. Returns 422 when validation fails (e.g. missing or unknown warehouse).
Authentication: Requires Bearer token.
Request
Responses
- 201
- 401
- 403
- 404
- 422
- 429
Created
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Unprocessable Entity
Response Headers
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.