Inbound Consignment
POST /openapi/{version}/consignments/inbound_consignments/
This endpoint allows you to create a new inbound consignment. Please save the task_id returned in the response.
Note: Creation of Inbound Consignment Products is asynchronous in this API. This will return the task ID which is submitted to create the Inbound Consignment Products.
To know the status of the task, you can do one of the following:-,
-
Use Get Bulk Create or Update Status API by providing the task ID.
OR
-
Subscribe to the InboundProductBulkUploadStatus callback type in Seller Webhooks section.
<b>Example curl Request:</b>
curl --location '{{url}}/openapi/v2/consignments/inbound_consignments/' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{token}}' \
--data '{
"consignment_number": "Locad-OpenAPI-Test-13",
"consignment_date": "2024-11-13",
"address": "test address",
"tracking_number": "test tracking number",
"carrier_name": "test carrier name",
"tracking_url": "test tracking url",
"warehouse_id": 20,
"warehouse_transfer": false,
"products": [
{
"sku": "INV_SKU_ITEM00099",
"consignment_quantity": 10,
"expiry_date": "2026-12-01"
}
],
"asn_note": "test asn note"
}'
Request
- Base URLhttps://base_url
- Authnone declared
Path parameters
versionstring required
Request body
Response
Changes
No recorded changes to this operation across all 1 revision of this API.