Skip to main content
PUT
Update service provider config

Authorizations

Authorization
string
header
required

Sign in to the admin dashboard and use the resulting ID token for a store and operation you can access. The authenticated dashboard cookie is accepted when the Authorization header is absent. Missing or insufficient access returns 401.

Path Parameters

id
string
required

service provider id

Body

application/json
api_credentials
object

Credential values keyed by input_field_name. Send ******** to preserve a saved value; this returns 400 when no value is saved for that key. Other supplied values replace the saved value.

warehouse_id
string[]
write-only
shipping_zone_id
string[]
write-only
channels
string[]

Payment providers only: IDs of the sales channels the store offers this provider on; an empty list, or none, offers it on every channel. Each must be one of the store's storefront channels.

is_forward_shipping
boolean
is_return_shipping
boolean
status
enum<string>
Available options:
active,
inactive

Response

OK

message
string
required
success
boolean
required
content
object
required