Update carrier service

PUT 
/openapi/2025-06/carrier_services/:carrier_service_id

Allows users to update the details of an existing carrier service.

Request

Path Parameters

carrier_service_id stringrequired

Carrier service ID to update

application/json

Body

Bodyrequired

carrier_service objectrequired

Carrier service data to update

callback_urlstringrequired

Updated callback URL for shipping rate calculation

activebooleanrequired

Whether to enable the carrier service

Example

{
  "carrier_service": {
    "callback_url": "string",
    "active": true
  }
}

Responses

200

OK

application/json

Schema

Schema

codestring

error code

messagestring

error message

data object

carrier_service object

The updated carrier service

idstring

Carrier service ID

namestring

Name of the carrier service

activeboolean

Whether the carrier service is active

callback_urlstring

Callback URL for rate calculation

scopesstring

Permission scopes (comma-separated)

carrier_service_codestring

Carrier service code

logostring

Logo URL

short_descstring

Brief description of the carrier service

created_atstring

Creation time, in ISO-8601 format

updated_atstring

Last update time, in ISO-8601 format

Example

{
  "code": "string",
  "message": "string",
  "data": {
    "carrier_service": {
      "id": "string",
      "name": "string",
      "active": true,
      "callback_url": "string",
      "scopes": "string",
      "carrier_service_code": "string",
      "logo": "string",
      "short_desc": "string",
      "created_at": "string",
      "updated_at": "string"
    }
  }
}