get
https://{subdomain}.myshoplaza.com/openapi/2025-06/carrier_services
Retrieves a list of all carrier services available for a store.
Requiresread_productaccess 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
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 |
carrier_services | array of object | List of carrier service objects |
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 |