Special Service

This is a feature used to define additional services that can be requested for consignments.

Use Cases

These additional services can be used in the following functions/processes:

  • Consignment Creation (Domestic / International)

Available Values API

The available values differ for each provider, so the following API must be queried.

Endpoint Information

Property Value
URL {{APP_URL}}/api/v1/providers/{provider_id}/feature/special-services
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

GET {{APP_URL}}/api/v1/providers/1/feature/special-services
Content-Type: application/json
APIKEY: {{APIKEY}}

API Response

{
    "status": true,
    "message": "Provider special services retrieved successfully",
    "data": [
        "CASH_ON_DELIVERY",
        "SHIPPING_FEE_ON_DELIVERY",
        "HOLD_AT_DEPARTMENT",
        "VALUED_SHIPMENT",
        "CONTROLLED_DELIVERY"
    ]
}

Consignment Creation (Domestic / International) Usage

Supported service_type values retrieved from the API can be added to the special_services field in the consignment creation content.

The following fields must be defined for each additional service:

  • service_type: The value specified on the documentation page for each service type must be used

  • details: Must be filled according to the parameter structure specific to the selected service type

  • Multiple additional services can be added to a consignment

    Structure

{
    "special_services": [
        {
            "service_type": "STRING",
            "details": {
                // Content varies by service type
            }
        }
    ]
}