delete https://{shopdomain}.myshoplaza.com/openapi/2022-01/carrier_services/
Requires
write_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
| Name | Type | Required | Example | Description |
|---|---|---|---|---|
carrier_service_id | string | Yes | "123" | The unique identifier of the carrier service. |
Response Explanation
Public Response Parameters
Successful Response
| Name | Type | Example | Description |
|---|---|---|---|
status | integer | 0 | Status code indicating success or failure. |
msg | string | "OK" | Message confirming the operation outcome. |
Error Response
Error responses in the API can be represented using two different fields: errors and error. Both fields provide details about issues encountered during request processing. Below is an explanation of the fields with their respective examples and descriptions.
| Field | Type | Example | Description |
|---|---|---|---|
errors | Array | [ "invalid line_item id"] | A list of errors encountered during the request processing. |
| Field | Type | Example | Description |
|---|---|---|---|
error | String | "store is not active" | Indicates an error encountered during the process |
Error Detail
| Status Code | Message | Possible Reason | Example Response |
|---|---|---|---|
| 400 | Bad Request | Invalid input format or request structure (e.g., missing required fields or incorrect data types). | Bad Request |
| Unauthorized | The request is missing valid authentication credentials or the credentials provided are invalid. | Unauthorized |