Skip to main content
POST
Configure a service provider

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.

Body

application/json
service_provider_id
string
required
api_credentials
object
required

json object in key & value pair. Keys must match with params specified in required_credentials_params object (input_field_name). Send ******** only to keep an existing saved value; a masked value without a saved credential returns 400.

warehouse_id
string[]
required
write-only
shipping_zone_id
string[]
required
write-only
is_forward_shipping
boolean
required
is_return_shipping
boolean
required

Response

OK

message
string
required
success
boolean
required
content
object
required