This document gives detail of Noetic LogistieX Shipping APIs: All-in-one workspace for your shipping requirements.

/serviceability/search

POST

The API allows to check the serviceability of shipment order for given input parameters

Request

Body Params application/json

Example

{
    "shipment_purpose": "SALE",
    "origin_postal_code": "122001",
    "destination_postal_code": "134002",
    "fragile": true,
    "dangerous": false,
    "essential": true,
    "payment_mode": "PREPAID",
    "dimensions": {
        "length": 9,
        "breadth": 3,
        "height": 9,
        "weight": 3
    },
    "value_added_services": {
        "exchange": true,
        "openBoxDelivery": true,
        "installation": true,
        "collectOnDelivery": true,
        "proofOfDelivery": true
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api-playground.logistiex.com/serviceability/search' \
--header 'Content-Type: application/json' \
--data-raw '{
    "shipment_purpose": "SALE",
    "origin_postal_code": "122001",
    "destination_postal_code": "134002",
    "fragile": true,
    "dangerous": false,
    "essential": true,
    "payment_mode": "PREPAID",
    "dimensions": {
        "length": 9,
        "breadth": 3,
        "height": 9,
        "weight": 3
    },
    "value_added_services": {
        "exchange": true,
        "openBoxDelivery": true,
        "installation": true,
        "collectOnDelivery": true,
        "proofOfDelivery": true
    }
}'

Responses

🟢200Successfully list of Serviceability option Objects

application/json

Body

Example

[
    {
        "courier_code": "ECOM",
        "expected_charges": "the expected charges for the shipment order",
        "expected_delivery_sla": {
            "start_time": "2019-08-24T14:15:22Z",
            "end_time": "2019-08-24T14:15:22Z"
        },
        "expected_pickup_sla": {},
        "recommended": true,
        "rank": 0,
        "supported_vas": {
            "collect_on_delivery": true,
            "proof_of_delivery": false,
            "exchange": true,
            "doorstep_qc": false,
            "open_box_delivery": true,
            "installation": true
        }
    }
]

🟠400Bad Request Error

🟠401JWT Access token is missing or invalid

🟠403Not Authorized to perform this operation

🟠404Not Found Error

🔴500Internal Service Error

🔴503Service Not Available

Modified at 2024-08-06 13:10:37

Welcome to Noetic Logistiex Pvt Ltd Universal API Hub

/shipmentorders