Skip to main content

Save Warehouse Mapping

PUT 
/api/shippo/instances/:integration_instance/warehouses/:warehouseId

Creates or replaces the Shippo sender (ship-from) address for a warehouse. The address is registered at Shippo and reused for rate quotes and label purchases. US addresses are validated by Shippo; its messages come back as warnings and never block saving.

Not yet available to API tokens

This endpoint currently requires session authentication; Personal Access Token scope support is in progress.

Body fields:

  • sender_name (string, required): sender (contact) name printed on labels. Max 255.
  • sender_company (string, nullable): company name. Max 255.
  • street1 (string, required): street address. Max 255.
  • street2 (string, nullable): address line 2. Max 255.
  • city (string, required). Max 255.
  • state (string, nullable): state/province code. Required when country is US. Max 100.
  • zip (string, required): ZIP/postal code. Max 20.
  • country (string, required): two-letter ISO country code (upper-cased automatically).
  • phone (string, nullable). Max 50.
  • email (string, nullable): valid email. Max 255.
  • enabled (boolean, optional): whether the mapping can be used for labels. Defaults to true.

Returns 200 with the mapping plus a warnings array (Shippo validation message texts). Returns 422 with field errors when validation fails or with a Shippo error code when Shippo rejects the request (invalid_token, rate_limited, api_error, unreachable). Returns 404 when the warehouse does not exist.

Authentication: Requires a Bearer token.

Request​

Responses​

OK

Response Headers
    Content-Type