[
    {
        "code": "ZWL",
        "name": "Zimbabwean Dollar"
    },
    {
        "code": "ZMW",
        "name": "Zambian Kwacha"
    },
    {
        "code": "ZAR",
        "name": "South African Rand"
    },
    {
        "code": "YER",
        "name": "Yemeni Rial"
    }
]

[
    {
        "code": "ZWL",
        "name": "Zimbabwean Dollar"
    },
    {
        "code": "ZMW",
        "name": "Zambian Kwacha"
    },
    {
        "code": "ZAR",
        "name": "South African Rand"
    },
    {
        "code": "YER",
        "name": "Yemeni Rial"
    }
]

{
      "error": "Resource not found"
}

{
      "error": "Internal server error"
}

1. The currency data provided by this API is based on the latest available information and may be subject to updates or changes.
2. It is recommended to handle potential errors and exceptions gracefully in your application when consuming this API.

GET: Carrier by Provider

The Get Carrier by Provider API provides information about shipping carriers based on their provider. It returns a list of carriers with details such as carrier code, name, description, tracking URL, and supported label file types. Use this API to gather information about carriers, their tracking URLs, and supported label file types.

Endpoint

GET /{{BaseURL}}/MetaData/Carrier/{provider}

- {provider}: The name of the provider for which you want to retrieve the list of carriers. 

Response

The API returns a JSON array containing objects representing each carrier's information. Each object includes the following attributes: 

1. id: The unique identifier of the carrier.
2. code: The code associated with the carrier.
3. carrier: The name of the carrier.
4. provider: The provider of the carrier.
5. name: The display name of the carrier.
6. logo: The URL of the carrier's logo.
7. description: A brief description of the carrier.
8. trackingUrl: The URL for tracking shipments with the carrier.
9. supportedLabelFileTypes: An array of supported label file types.

Example Response

[
    {
        "id": "64beb187bd39b3fdbb34a8b9",
        "code": "Ekart",
        "carrier": "Ekart",
        "provider": "Native",
        "name": "Ekart",
        "logo": "",
        "description": "Ekart - Native",
        "trackingUrl": "https://ekartlogistics.com/shipmenttrack/",
        "supportedLabelFileTypes": ["PDF"]
    },
    {
        "id": "63ad6325fdd1694fd6758996",
        "code": "USPS",
        "carrier": "USPS",
        "provider": "Native",
        "name": "USPS",
        "logo": "",
        "description": "USPS - Native",
        "trackingUrl": "",
        "supportedLabelFileTypes": ["PDF"]
    },
    {
        "id": "63ad5f0e8fa4fd7f87d6b803",
        "code": "Borzo",
        "carrier": "Borzo",
        "provider": "Native",
        "name": "Borzo",
        "logo": "",
        "description": "Borzo - Native",
        "trackingUrl": "",
        "supportedLabelFileTypes": ["PDF"]
    },
    {
        "id": "63ad5ed16cc42987d5e46709",
        "code": "XpressBees",
        "carrier": "XpressBees",
        "provider": "Native",
        "name": "XpressBees",
        "logo": "",
        "description": "XpressBees - Native",
        "trackingUrl": "https://www.xpressbees.com/track/",
        "supportedLabelFileTypes": ["PDF"]
    },
    {
        "id": "63ad5ebfeabacbebb85fbefb",
        "code": "Delhivery",
        "carrier": "Delhivery",
        "provider": "Native",
        "name": "Delhivery",
        "logo": "",
        "description": "Delhivery - Native",
        "trackingUrl": "https://www.delhivery.com/track/package/",
        "supportedLabelFileTypes": ["PDF"]
    },
    {
        "id": "63ad5d6d694ebc79012d06b2",
        "code": "Dunzo",
        "carrier": "Dunzo",
        "provider": "Native",
        "name": "Dunzo",
        "logo": "",
        "description": "Dunzo - Native",
        "trackingUrl": "",
        "supportedLabelFileTypes": []
    }
]

Error Codes

404 Not Found: If the provided provider does not exist or there are no carriers associated with it.

GET: Service by Provider

The Get Service by Provider API allows you to retrieve a list of available services offered by different carriers for a specific provider. This API endpoint provides information about various shipping services such as service name, carrier, carrier-specific codes, service status, and more.

Endpoint

GET /BaseURL}}/MetaData/Service/{provider_name}

Replace `{provider_name}` with the name of the desired provider for which you want to retrieve the available services.

Response 

The API response will be a JSON array containing objects with the following attributes for each service:

1. `id` (string): The unique identifier for the service.
2. `service` (string): The type of service (e.g., "Surface", "Express", "Local").
3. `carrier` (string): The name of the carrier associated with the service.
4. `provider` (string): The provider offering the service.
5. `status` (string): The status of the service (e.g., "Public").
6. `carrierSpecificCode` (object): An object containing carrier-specific code details:
7. `name` (string): The name of the carrier-specific code (e.g., "ECONOMY").
8. `code` (string): The code associated with the carrier-specific code (if available).
9. `name` (string): The name of the service.
10. `isInternational` (boolean): Indicates whether the service is international (true) or not (false).
11. `maxSupportedWeight` (number): The maximum supported weight for the service (in an appropriate unit).
12. `iconText` (string): Text associated with the service icon.
13. `bannerText` (string): Text associated with the service banner.

Example Response

[
    {
        "id": "64beb1e2bd39b3fdbb34a8ba",
        "service": "Surface",
        "carrier": "Ekart",
        "provider": "Native",
        "status": "Public",
        "carrierSpecificCode": {
            "name": "ECONOMY",
            "code": "ECONOMY"
        },
        "name": "Ekart Surface",
        "isInternational": false,
        "maxSupportedWeight": 0,
        "iconText": "",
        "bannerText": ""
    },
    {
        // ... (other service objects)
    }
]

Additional Notes

1. The `maxSupportedWeight` attribute is provided as a numerical value, where appropriate units should be considered based on your use case.
2. If the `code` attribute within the `carrierSpecificCode` object is empty, it means no specific code is available for that service.
3. The `iconText` and `bannerText` attributes may be utilized for displaying additional information about the service, such as icons or banners.
4. Ensure to replace placeholders such as `{provider_name}` and adapt the API endpoint and response as needed for your application.

GET: Special Service by Provider

The "Get Special Service by Provider" API allows you to retrieve a list of special services offered by different carriers and providers. Special services are additional features or options that can be added to shipping or delivery orders. This API provides information about special services, such as their names, carriers, and provider-specific codes.

Endpoint

GET /{{BaseURL}}/MetaData/SpecialService/{provider}

Replace `{provider}` with the name of the provider for which you want to retrieve the list of special services.

Response

The API response will be a JSON array containing objects representing each special service available for the specified provider. Each object has the following properties: 

1. `id` (string): The unique identifier for the special service.
2. `specialService` (string): The name of the special service.
3. `service` (string): The type of service (e.g., "Surface", "Express", "Local") to which the special service belongs.
4. `carrier` (string): The name of the carrier associated with the special service.
5. `provider` (string): The name of the provider offering the special service.
6. `status` (string): The status of the special service (e.g., "Public").
7. `carrierSpecificCode` (object): An object containing carrier-specific information about the special service.
8. `name` (string): The name of the carrier-specific code.
9. `code` (string): The carrier-specific code associated with the special service.
10. `iconText` (string): A placeholder for icon text related to the special service.
11. `bannerText` (string): A placeholder for banner text related to the special service.

Response Example

[
    {
        "id": "64ccfb3a1c6eb99948b0b18d",
        "specialService": "Essential Goods",
        "service": "Surface",
        "carrier": "Ekart",
        "provider": "Native",
        "status": "Public",
        "carrierSpecificCode": {
            "name": "ESSENTIAL",
            "code": "ESSENTIAL"
        },
        "iconText": "",
        "bannerText": ""
    },
    {
        "id": "64ccf2f41c6eb99948b0b18a",
        "specialService": "Dangerous Goods",
        "service": "Surface",
        "carrier": "Ekart",
        "provider": "Native",
        "status": "Public",
        "carrierSpecificCode": {
            "name": "isDangerous",
            "code": "isDangerous"
        },
        "iconText": "",
        "bannerText": ""
    },
    // ... (other special service objects)
]

Error Responses

HTTP Status Code: 404 Not Found

  - Response Body: `{ "error": "Provider not found" }`

  - Description: Returned when the specified provider does not exist in the system.

Rate Limiting

This API does not have rate limiting implemented, but it is recommended to use it responsibly to avoid overloading the server.

GET: Country, States by Country Code 

The Get Country States by Country Code API allows you to retrieve information about various states and union territories in the country along with their respective codes and display names. This information can be useful for mapping and displaying state-related data in your application.

Endpoint

GET /{{BaseURL}}/MetaData/States/Country/{providerId}

providerId: The ID of the provider for which you want to retrieve the list of states and union territories. To get the country code, make use of the Get Countries.

Request Parameters

This API does not require any request parameters.

Response

The response will be a JSON array containing objects with the following fields:

1. code: The code representing the state or union territory.
2. name: The name of the state or union territory.
3. displayName: The display name of the state or union territory in the format "Code - Name".

Example Response

[
    {
        "code": "AN",
        "name": "Andaman and Nicobar Islands",
        "displayName": "AN - Andaman and Nicobar Islands"
    },
    {
        "code": "AP",
        "name": "Andhra Pradesh",
        "displayName": "AP - Andhra Pradesh"
    },
    {
        // ... Other state/union territory objects ...
    }
]

Example Usage 

Response

[
    {
        "code": "AN",
        "name": "Andaman and Nicobar Islands",
        "displayName": "AN - Andaman and Nicobar Islands"
    },
    {
        "code": "AP",
        "name": "Andhra Pradesh",
        "displayName": "AP - Andhra Pradesh"
    },
    {
        // ... Other state/union territory objects ...
    }
]

Rate Limiting