updateSandboxShipment

patch

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

Updates a sandbox shipment on marketplace behalf. Supports status changes, invoice availability, and transport capacity updates.

Path Params

shipmentId

string

required

The unique identifier of the shipment to update.

Body Params

The request body for updating a sandbox shipment.

The request object for updating a sandbox shipment. The updates object is required for SHIPMENT_STATUS_CHANGE and TRANSPORT_CAPACITY_CHANGE update types, and must not be provided for INVOICE_AVAILABILITY_CHANGE.

updateType

string

enum

required

The type of update to apply to the shipment.

Show Details

SHIPMENT_STATUS_CHANGE	Update the shipment status or sub-status. Provide either `status` or `subStatus` in the `updates` object (mutually exclusive).
INVOICE_AVAILABILITY_CHANGE	Mark the invoice as available for the shipment. No `updates` object is needed.
TRANSPORT_CAPACITY_CHANGE	Update the Expected Pickup Date (EPD) for the shipment. Provide `timestamp` in the `updates` object.

Allowed:

updates

object

The update details for the sandbox shipment. For SHIPMENT_STATUS_CHANGE, provide either status or subStatus (mutually exclusive). For TRANSPORT_CAPACITY_CHANGE, provide timestamp as the Expected Pickup Date (EPD).

Responses

Language

Loading…

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.

413The request size exceeded the maximum accepted size.

415The request payload is in an unsupported format.

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.