Update Warehouse Transfer

PUT 
/api/warehouses/transfers/:transfer

Updates a warehouse transfer. Accepts the same fields as Create Warehouse Transfer (all optional) plus tags (array of tag names to sync). The products array replaces the transfer's line items; include existing line ids to keep them.

Required scope: warehouses:write

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Transfers to an Amazon FBA warehouse can only be edited while in draft status. Returns 422 when editing a line that has already been shipped or when stock is insufficient.

Authentication: Requires Bearer token.

Request

Responses

201

Created

Response Headers

Content-Type

401

Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.

403

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.

404

Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.

422

Unprocessable Entity

Response Headers

Content-Type

429

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.