updatePackageStatus

patch

https://sellingpartnerapi-na.amazon.com/externalFulfillment/2024-09-11/shipments/{shipmentId}/packages/{packageId}

Updates the status of the packages.

Path Params

shipmentId

string

required

The ID of the shipment to which the package belongs.

packageId

string

required

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

Query Params

status

string

enum

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

Allowed:

Body Params

The body of the request.

status

string

enum

The status of a package.

Show Details

CREATED	The package is created.
PICKUP_SLOT_RETRIEVED	The pickup slot is retrieved.
INVOICE_GENERATED	The invoice is generated.
SHIPLABEL_GENERATED	The shipping label is generated.
SHIPPED	The package is shipped.
DELIVERED	The package is delivered.

Allowed:

subStatus

string

enum

The sub-status of a package.

Show Details

OUT_FOR_DELIVERY	The package is out for delivery.
DELIVERED	The package is delivered.
NOT_DELIVERED	The package is not delivered.
UNDELIVERABLE	The package is undeliverable.

Allowed:

reason

string

length ≤ 128

The reason for the sub-status.

Responses

Language

Response

Choose an example:

application/json

204Success.

400Request has missing or invalid parameters and cannot be parsed.

403Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.

404The resource specified does not exist.

409The resource specified conflicts with the current state

413The request size exceeded the maximum accepted size.

415The request payload is in an unsupported format.

422Unprocessable Entity. Unable to process the contained instructions

429The frequency of requests was greater than allowed.

500An unexpected condition occurred that prevented the server from fulfilling the request.

503Temporary overloading or maintenance of the server.