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:-,

  1. Use Get Bulk Create or Update Status API by providing the task ID.

    OR

  2. 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 URL
    https://base_url
  • Auth
    none declared

Path parameters

versionstring required

Request body

idinteger required
consignment_numberstring required

Consignment Number

consignment_datestring date required

Consignment Date

addressstring required

Shipper Address

tracking_numberstring

Tracking Number

carrier_namestring

Carrier Name

tracking_urlstring

Tracking URL

warehouse_idinteger required

Warehouse ID

warehouse_transferboolean

Warehouse transfer

estimated_arrival_datestring date nullable required

Estimated arrival date

asn_notestring nullable

ASN Note

warehouse_notestring nullable required

Warehouse Note

inbounded_atstring date-time nullable required

Inbounded at

total_consignment_quantitystring required
total_received_quantitystring required
completed_atstring required
total_usable_quantitystring required
total_unusable_quantitystring required
consignment_status'ASN_APPROVED' | 'ASN_DRAFT' | 'ASN_ON_HOLD' | 'ASN_PENDING' | 'ASN_REJECTED' | 'CANCELLED' | 'COMPLETED' | 'ERROR' | 'PENDING_APPROVAL' | 'PROCESSING' | 'QUALITY_CHECK' | 'STOCK_COUNT' | 'STOCK_INBOUNDED' | 'STOCK_RECEIVED' | 'UNKNOWN' | 'UNTRACKED' | 'VALIDATING' required
  • ASN_APPROVED - ASN_APPROVED
  • ASN_DRAFT - ASN_DRAFT
  • ASN_ON_HOLD - ASN_ON_HOLD
  • ASN_PENDING - ASN_PENDING
  • ASN_REJECTED - ASN_REJECTED
  • CANCELLED - CANCELLED
  • COMPLETED - COMPLETED
  • ERROR - ERROR
  • PENDING_APPROVAL - PENDING_APPROVAL
  • PROCESSING - PROCESSING
  • QUALITY_CHECK - QUALITY_CHECK
  • STOCK_COUNT - STOCK_COUNT
  • STOCK_INBOUNDED - STOCK_INBOUNDED
  • STOCK_RECEIVED - STOCK_RECEIVED
  • UNKNOWN - UNKNOWN
  • UNTRACKED - UNTRACKED
  • VALIDATING - VALIDATING
channel_statusstring required
is_draftboolean
created_atstring date-time required
updated_atstring date-time required

Response

successboolean
messagestring required

Changes

No recorded changes to this operation across all 1 revision of this API.