🔒
Requires write_product access scope. More access scope

The Create CarrierService API enables users to create a new carrier service for calculating shipping rates. It sends a request to the internal service layer to manage and register a new carrier service within Shoplazza's system.

This API is especially useful for:

Registering custom carrier services for store-specific shipping requirements.
Managing third-party integrations for shipping rate calculations.
Simplifying the carrier service lifecycle management with internal tools.

Request Parameters

Public Request Parameters

📘
Public Request Parameters

Body Parameters

Parameter	Type	Required	Description	Example
`carrier_service`	object	Yes	The carrier service configuration object	`{...}`
`carrier_service. name`	string	Yes	Carrier Service Name (used as both English and Chinese names internally)	`DHL Express`
`carrier_service. callback_url`	string	Yes	The endpoint URL Shoplazza calls to calculate shipping rates	`https://api. carrier.com/rates`
`carrier_service. carrier_code`	string	Yes	Unique code representing the carrier service (e.g., "dhl")	`dhl`
`carrier_service. active`	boolean	No	Indicates whether the carrier service is active. true enables the service	`true`
`carrier_service. logo`	string	No	URL of the carrier service's logo	`https://example.com /dhl-logo.png`
`carrier_service. short_desc`	string	No	Brief description of the carrier service	`Fast international shipping`

Response Explanation

Public Response Parameters

📘
Public Response Parameters

Successful Response

Parameter	Type	Example	Description
`code`	string	`200`	Error code (200 indicates success)
`message`	string	`Success`	Error message
`data`	object	`{...}`	Contains the carrier services data
`data.carrier_service`	object		carrier service object

Carrier Service Object Structure

Parameter	Type	Example	Description
`id`	string	`cs_123456`	Unique identifier for the carrier service
`name`	string	`FedEx Express`	Name of the carrier service
`active`	boolean	`true`	Whether the carrier service is active
`callback_url`	string	`https://carrier.example.com/callback`	URL for carrier service callbacks
`scopes`	string	`read_write`	Permissions scope for the carrier service
`carrier_service_code`	string	`fedex_express`	Code identifier for the carrier service
`logo`	string	`https://example.com/logo.png`	URL to the carrier service logo
`short_desc`	string	`Fast domestic shipping`	Brief description of the carrier service
`created_at`	string	`2023-01-15T10:00:00Z`	Timestamp when the carrier service was created
`updated_at`	string	`2023-06-20T15:30:00Z`	Timestamp when the carrier service was last updated

Error Response

Field	Type	Example	Description
`code`	string	`InvalidParameter`	Error http message
`message`	string	``	Error message

API Structure Overview