get https://{shopdomain}.myshoplaza.com/openapi/2022-01/carrier_services
Requires
read_productaccess scope. More access scope
The Get CarrierService List API retrieves a list of all carrier services available for a store. This allows users to view all configured carrier services and their details.
This API is especially useful for:
- Listing all carrier services for managing or auditing purposes.
- Fetching details of active and inactive carrier services.
- Identifying carrier services available for shipping and calculation.
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 |
|---|---|---|---|
carrier_service.id | string | "1" | Unique identifier for the carrier service. |
carrier_service.cn_name | string | "shipzipservice1" | Carrier service name in Chinese (defaults to name). |
carrier_service.en_name | string | "DHL Express" | Carrier service name in English (defaults to name). |
carrier_service.store_id | string | "70808" | ID of the store associated with the carrier service. |
carrier_service.active | string | "true" | Status of the carrier service. true means active. |
carrier_service.callback_url | string | "http://example.com/calculate" | Endpoint URL for shipping rate calculations. |
carrier_service.scope | string | "calculateSeparately" | Scope of the carrier service. |
carrier_service.carrier_service_code | string | "shipzip" | The code representing the carrier service. |
carrier_service.logo | string | "http://example.com/logo.png" | URL of the carrier service's logo. |
carrier_service.short_desc | string | "Fast and secure shipping" | Brief description of the carrier service. |
carrier_service.create_at | string | "2024-07-01" | Timestamp of when the carrier service was created. |
carrier_service.update_at | string | "2024-07-02" | Timestamp of the last update to the carrier service. |
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 |