Inbound | POST | /shipment/gatepass

Summary

This API is used to create gate pass in Omni.

Description

This API is used to create gate pass in Omni.

Request

{
    "gatePassCode": "AF349YR",
    "locationCode": "RTOU53S",
    "shipmentDetails": [
        {
            "orderCode": "AEW34YU",
            "shipmentCode": "AUTR562"
        }
    ]
}

Parameter Name	Data Type	Description	Mandatory
`gatePassCode`	String	Code used by channel to identify an gate pass	yes
`locationCode`	String	Location code of the warehouse for which the gate pass will be created	yes
`shipmentDetails`	Object[]	shipments to be included in a gate pass	yes
`shipmentDetails.orderCode`	String	Unique code used by channel to identify the order	yes
`shipmentDetails.shipmentCode`	String	Unique code used by the channel to identify shipment	yes

(Note: For a client gatePassCode must be unique for a specific locationCode but it might be same for a different locationCode)

Response

EmptyBody

HttpStatus : 200

Increff Omni Standard APIs

Create Gate Pass (Beta)

Analytics

Inbound | POST | /shipment/gatepass

Summary

Description

Request

Response

Related content