Inbound Consignment

PUT /openapi/{version}/consignments/inbound_consignments/{id}/

This endpoint allows you to update an existing inbound consignment. The following fields can be updated: - tracking_number, carrier_name, tracking_url, estimated_arrival_date, asn_note, and the existing list of products while creation. Please save the task_id returned in the response.

Note: Updation of Inbound Consignment Products is asynchronous in this API. This will return the task ID which is submitted to update 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 --request PUT '{{url}}/openapi/v2/consignments/inbound_consignments/17049' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{token}}' \
--data '{
    "tracking_number": "new-tracking-number",
    "carrier_name": "new-carrier-name",
    "tracking_url": "https://tracking-url.com",
    "estimated_arrival_date": "2024-12-01",
    "asn_note": "Updated ASN note",
    "products": [
        {
            "sku": "INV_SKU_ITEM00099",
            "consignment_quantity": 15,
            "expiry_date": "2026-12-01"
        }
    ]
}'

Request

  • Base URL
    https://base_url
  • Auth
    none declared

Path parameters

idstring required
versionstring required

Request body

tracking_numberstring

Tracking Number

carrier_namestring

Carrier Name

tracking_urlstring

Tracking URL

estimated_arrival_datestring date nullable

Estimated arrival date

asn_notestring nullable

ASN Note

Response

successboolean
messagestring required

Changes

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