🔒
Requires write_product access scope. More access scope

The Update CarrierService API allows users to update the details of an existing carrier service. This enables modifying specific attributes such as the carrier's active status, callback URL, and other properties.

This API is especially useful for:

Updating carrier service configurations when details change.
Modifying carrier service status (e.g., enabling or disabling).
Maintaining up-to-date third-party integrations.

Request Parameters

Public Request Parameters

📘
Public Request Parameters

Path Parameters

Parameter	Type	Required	Description	Example
`carrier_service_id`	string	Yes	The unique identifier of the carrier service to update	`cs_123456`

Body Parameters

Parameter	Type	Required	Description	Example
`carrier_service.callback_url`	string	Yes	The endpoint URL Shoplazza calls to calculate shipping rates	`https://api.carrier.com/rates`
`carrier_service.active`	boolean	Yes	Indicates whether the carrier service is active. true enables the service	`true`

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