Specific Packaging

This Additional Feature explains that Packaging Types such as special boxes/cartons defined in the relevant Provider can be used.

Use Cases

These packaging types 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/packaging-types`
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/9/feature/packaging-types
Content-Type: application/json
APIKEY: {{APIKEY}}

API Response

{
    "status": true,
    "message": "Provider packaging types retrieved successfully",
    "data": [
        {
            "packagingType": "FEDEX_ENVELOPE",
            "description": "FedEx® Letters",
            "length": 24.1,
            "width": 31.8,
            "height": 0.1,
            "maxWeight": 0.5,
            "price": null,
            "dimensionUnit": "cm",
            "weightUnit": "KG"
        },
        {
            "packagingType": "FEDEX_BOX",
            "description": "FedEx® Box",
            "length": null,
            "width": null,
            "height": null,
            "maxWeight": 9,
            "price": null,
            "dimensionUnit": null,
            "weightUnit": "KG"
        }
    ]
}

Consignment Creation (Domestic / International) Usage

The packages.provider_packaging_type parameter in the consignment creation content is used. You can use the values you retrieved from the available values list (e.g., FEDEX_BOX) in this field.