Overview
Use this endpoint to retrieve detailed information about a shipment based on its unique shipment number.
Endpoint
HTTP Method: GET
Endpoint URL: https://coreapi.impexdocs.com/api/v1/shipment/{shipmentdocs_id}/summary
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
- Shipment Summary Details (e.g., Exporter Reference, Buyer Code, Consignee Code, Order Date, Invoice no, Currency, etc.)
- Shipment Product Lines (Returned in an array if there are multiple product lines)
Request Parameters
To fetch a 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}/summary
Response
{
"shipment_number": "ABC123",
"shipment_status": "In Transit",
"shipment_docs_id": "XYZ456",
"shipment_folder_details_id": "123456",
"shipment_summary_details": {
"exporter_reference": "EXP001",
"buyer_code": "BUY123",
"consignee_code": "CON456",
"order_date": "02/11/2023",
"invoice_no": "INV789",
"currency": "USD",
// Additional summary details
},
"product_details": [
{
"product_code": "Product 1",
"product_description": "FSH CHICK NOUT CTN #13X10",
"unit_price": 10.50
},
// Additional product lines
]
}
This example demonstrates a request to fetch the summary of a shipment with the provided shipment number. The response includes details such as the shipment status, associated documents ID, folder details ID, shipment summary details, and an array of product lines if applicable.