Update Integration Settings
PUT/api/shippo/instances/:integration_instance/settings
Saves integration settings only (no name or token). Partial payloads are merged over the current settings — only keys present in the body change. Settings may also be sent nested under an integration_settings object.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Body fields (all optional):
- auto_push_orders (boolean): automatically push fulfillment orders to Shippo as orders.
- record_shipping_costs (boolean): record purchased label costs as shipping costs on the fulfillment.
- label_file_type (string): default label format. One of PDF_4x6, PDF, PDF_A4, PDF_A5, PDF_A6, PNG, ZPLII.
- sync_start_date (date, nullable): earliest date the order/label syncs import from (Y-m-d).
- is_automatic_sync_enabled (boolean): enable scheduled background syncs.
Returns 200 with the updated instance. Returns 422 with field errors when validation fails, 404 for an unknown instance.
Authentication: Requires a Bearer token.
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 429
OK
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
Response Headers
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.