Overview

Use this endpoint to retrieve detailed information about shipment product lines based on its unique shipment number.

Endpoint

HTTP Method: GET

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

Authentication: Required

Response Format (Successfully Retrieved)

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

Shipment Number
Shipment Status
Shipment Docs Id
Shipment Folder Details Id
Product List (in array).

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 in place of the Shipment Number for retrieval.

Example

Request

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

Response

{
    "shipment_no": "Impx-Demo",
    "shipment_status": "Created",
    "shipmentdocs_id": "5a8ef9c4-dfd-4b09-bf51-faad55d94c41",
    "shipmentfolderdetail_id": "c2b9fdf0-4453-4deb-9ed7-e3141f80260a",
    "product_list": [
        {
            "product_code": "0141300",
            "product_description": "FSH CHICK NOUT CTN #13X10",
            "no_of_pack_unit": "240",
            "pack_unit": "CT",
            "base_quantity": "2400",
            "base_uom": "BD",
            "quantity": "2400",
            "selling_uom": "BD",
            "displayed_selling_price": "5.81",
            
          //Product Details
        },
      //Additinal Product Lines
    ]
}

This example demonstrates a request to fetch the product lines details of a shipment with the provided shipment number. The response includes details such as the shipment number, shipment status, shipment docs id, shipment folder details ID, and product line information.