Create carrier service

POST 
/openapi/2026-07/carrier_services

Enables users to create a new carrier service for calculating shipping rates.

Request

application/json

Body

Bodyrequired

carrier_service objectrequired

Carrier service data to create

namestringrequired

Carrier service name (used as both English and Chinese names internally)

callback_urlstringrequired

Callback URL for shipping rate calculation. Shoplazza will call this URL when calculating rates

carrier_codestringrequired

Unique code representing the carrier service, for example, "dhl"

activeboolean

Whether to enable the carrier service

logostring

URL of the carrier service's logo

short_descstring

Brief description of the carrier service

Example

{
  "carrier_service": {
    "name": "string",
    "callback_url": "string",
    "carrier_code": "string",
    "active": true,
    "logo": "string",
    "short_desc": "string"
  }
}

Responses

200

OK

application/json

Schema

Schema

codestring

error code

messagestring

error message

data object

carrier_service object

The created 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"
    }
  }
}