Update ShipMyOrders Integration Instance
PUT/api/shipmyorders/integration-instances/:integration_instance
Updates a ShipMyOrders integration instance. Every field is optional; only the keys you send change.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
name(string, unique across integration instances)integration_id(integer, must exist)connection_settings(object) — merged over the stored settings:username,password,clientId. Omitpasswordto keep the stored one.integration_settings(object) — merged over the stored settings:connection_name,enable_fulfillment,pass_tags,fulfillment_cost_financial_line_type_id(must exist; changing it re-types the fulfillment cost lines already recorded from this provider in the background; sendnullto clear),is_deliver_by_date_required.is_automatic_sync_enabled(boolean)
Returns the updated instance in the same shape as Get, with secrets redacted.
Requires the integrations.update permission.
Authentication: Bearer token (Personal Access 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 — 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.