Specific Shipping Method

This Additional Feature indicates that the relevant Provider has Specific Shipping Methods available.

Use Cases

These shipping methods can be used in the following functions/processes:

Consignment Creation (Domestic / International)

Available Values API

The available values differ for each provider. The following API must be used to retrieve these values.

Endpoint Information

Property	Value
URL	`{{APP_URL}}/api/v1/providers/{provider_id}/feature/shipping-methods`
HTTP Method	`GET`
Content Type	`application/json`
Authentication	`APIKEY` header

URL Query Parameters

Parameter Name	Parameter Type	Required	Description
`provider_id`	Integer	Required	Logistics Provider ID

Example API Request

Below is an example HTTP raw request for the API request.

GET {{APP_URL}}/api/v1/providers/7/feature/shipping-methods
Content-Type: application/json
APIKEY: {{APIKEY}}

API Response

{
    "status": true,
    "message": "Provider shipping methods retrieved successfully",
    "data": [
        "pttabroad_air_parcel",
        "pttabroad_ground_parcel"
    ]
}

Consignment Creation (Domestic / International) Usage

The specific_shipping_method parameter in the consignment creation content is used. You can use the values you retrieved from the available values list.