Sign in

v1

latestOpenAPI 3.0.0Apache License 2.02026-07-263171,5614.1 MB
External Fulfillment Shipping v2024-09-11

updatePackageStatus

Updates the status of the packages.

patch/externalFulfillment/2024-09-11/shipments/{shipmentId}/packages/{packageId}

Path parameters

shipmentIdstring required

The ID of the shipment to which the package belongs.

packageIdstring required

The ID of the package whose status you want to update.

Query parameters

status'SHIPPED'

DEPRECATED. Do not use. Package status is defined in the body parameter.

Request body

subStatus'OUT_FOR_DELIVERY' | 'DELIVERED' | 'NOT_DELIVERED' | 'UNDELIVERABLE'

The sub-status of a package.

reasonstring

The reason for the sub-status.

Example request

{
  "status": "DELIVERED",
  "subStatus": "DELIVERED",
  "reason": "Delivered Successfully"
}

Response

Success.