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

/shipmentorders/{shipment_order_id}/shipmentcontrolevents

POST

Async API for posting updates to the existing shipment order

Request

Path Params

Body Params application/json

Example

{
    "shipment_instructions": [
        "CANCEL"
    ],
    "notes": "Bought wrong item"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api-playground.logistiex.com/shipmentorders//shipmentcontrolevents' \
--header 'Content-Type: application/json' \
--data-raw '{
    "shipment_instructions": [
        "CANCEL"
    ],
    "notes": "Bought wrong item"
}'

Responses

🟢202Successfully accepted shipment control event

application/json

Body

Example

{
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "shipment_instructions": [
        "NOTES"
    ],
    "notes": "string",
    "alternate_contact_person": "string",
    "alternate_contact_number": "string",
    "alternate_delivery_address": {
        "contact_person": "string",
        "address_line1": "string",
        "address_line2": "string",
        "city": "string",
        "postal_code": "string",
        "state": "string",
        "country": "st",
        "latitude": 28.7041,
        "longitude": 77.2167,
        "address_type": "OFFICE"
    },
    "alternate_pickup_address": {
        "contact_person": "string",
        "address_line1": "string",
        "address_line2": "string",
        "city": "string",
        "postal_code": "string",
        "state": "string",
        "country": "st",
        "latitude": 28.7041,
        "longitude": 77.2167,
        "address_type": "OFFICE"
    },
    "alternate_delivery_slot": {
        "start_time": "2019-08-24T14:15:22Z",
        "end_time": "2019-08-24T14:15:22Z"
    },
    "alternate_pickup_slot": {},
    "escalated": true,
    "cash_to_be_collected": 0
}

🟠400Bad Request Error

🟠401JWT Access token is missing or invalid

🟠403Not Authorized to perform this operation

🔴500Internal Service Error

🔴503Service Not Available

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

/status

/shipmentcontrolevents