GET - Special services

• The Get Special Service API allows you to retrieve a list of special services available for different carriers and providers. Special services are additional features or options that can be added to shipments, such as insurance, fragile handling, reverse pickup, etc. This API provides information about various special services along with their corresponding details. 
• Use this API to gather information about special services that can be added to shipments to meet specific requirements.

Endpoint details

cURL:

curl --location 'https://api-ppd.kloudship.com:960/api/v1/MetaData/SpecialService' \
--header 'Authorization: ••••••'

Request Body:

Do not required any request parameter to get MetaData Special Services

Response fields

Each special service object has the following attributes:

1. `id` (string): The unique identifier for the special service.
2. `code` (string): The code associated with the carrier-specific code.
3. `name` (string): The name of the carrier-specific code.
4. `parameters` (array): Contains two string fields "code" and "name"
5. `service` (string): The type of service the special service is applicable to (e.g., Surface, Express, Local).
6. `carrier` (string): The carrier associated with the special service.
7. `provider` (string): The provider associated with the special service.
8. `status` (string): The status of the special service (e.g., "Public").

Example Response:

The response is a JSON array containing objects representing different special services available.

[
    {
        "id": "68b6ae9e7c736de5e3b08e62",
        "code": "COD",
        "name": "COD",
        "parameters": [
            {
                "code": "Amount",
                "name": "Amount"
            }
        ],
        "service": "Surface",
        "carrier": "Borzo",
        "provider": "Native",
        "status": "Public"
    },
    {
        "id": "68945fde8b3513e37e681992",
        "code": "COD",
        "name": "COD",
        "parameters": [
            {
                "code": "Amount",
                "name": "Amount"
            }
        ],
        "service": "Surface",
        "carrier": "EkartElite",
        "provider": "Native",
        "status": "Public"
    },
//...Other special services
]