Get Shipment Status by Shipment Number

Overview

Use this endpoint to retrieve the status of a shipment based on its unique shipment number.

Endpoint

HTTP Method: GET

Endpoint URL: https://coreapi.impexdocs.com/api/v1/shipment/{shipmentdocs_id}/status

Authentication: Required

Response Format (Successfully Retrieved)

A successful retrieval will yield a JSON response containing the following details:

Shipment Number
Shipment Status
Shipment Docs Id
Shipment Folder Details Id

Request Parameters

To fetch shipment, provide the required field, which is the "Shipment Number" {shipment_no}. Alternatively, users can also pass the Shipment Docs Id {shipmentdocs_id} in place of the Shipment Number for retrieval.

Example

Request

GET https://coreapi.impexdocs.com/api/v1/shipment/{shipmentdocs_id}/status

Response

{
  "shipment_number": "ABC123",
  "shipment_status": "In Transit",
  "shipment_docs_id": "XYZ456",
  "shipment_folder_details_id": "123456"
}

This example demonstrates a request to fetch the status of a shipment with the provided shipment number. The response includes details such as the shipment status, associated documents ID, and folder details ID.