delete
https://{subdomain}.myshoplaza.com/openapi/2025-06/carrier_services/
Allows users to remove an existing carrier service.
Requireswrite_productaccess scope. More access scope
The Delete CarrierService API allows users to remove an existing carrier service. This operation can occur either when the application actively requests deletion of the carrier service or when a merchant uninstalls a shipping-related application, ensuring the associated carrier services are also deleted to prevent users from using outdated shipping configurations.
This API is especially useful for:
- Proactively removing carrier services that are no longer required.
- Ensuring accurate shipping calculations when an application is uninstalled.
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 |
Response Explanation
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 |
Error Response
| Field | Type | Example | Description |
|---|---|---|---|
code | string | InvalidParameter | Error http message |
message | string | `` | Error message |