get https://{shopdomain}.myshoplaza.com/openapi/2022-01/tracking-codes
This interface returns a list of all logistics providers supported by Shoplazza Fulfillment.
Requires
read_orderaccess scope.
The List Tracking Codes API returns a list of all logistics providers supported by Shoplazza Fulfillment.
This API is especially useful for:
- Retrieving the list of supported logistics carriers.
- Displaying available shipping providers for customers.
- Facilitating shipment tracking and management workflows.
Request Parameters
Public Request Parameters
Response Explanation
Public Response Parameters
Successful Response
| Field | Type | Example | Description |
|---|---|---|---|
tracking_carriers | array | List of supported tracking carriers. | |
tracking_carriers[].code | string | "swiship-uk" | Unique code for the logistics provider. |
tracking_carriers[].en_name | string | "Swiship UK" | English name of the logistics provider. |
tracking_carriers[].cn_name | string | "Swiship UK" | Chinese name of the logistics provider. |
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 | [ "Collection not found"] | 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 |