createSandboxShipment

post

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

Creates a sandbox shipment to simulate order creation in the test environment. This operation is available only in the sandbox environment. The shipment is created with the specified configuration including shipping type and order type.

Body Params

The request body for creating a sandbox shipment.

The request object for creating a sandbox shipment.

locationId

string

required

length between 1 and 36

The location identifier for the shipment.

marketplaceId

string

required

The identifier for the marketplace. Refer to Marketplace IDs for the full list of supported marketplace IDs.

marketplaceChannel

string

enum

required

The marketplace channel.

Allowed:

shippingType

string

enum

required

The shipping type for the sandbox shipment.

Allowed:

orderType

array of strings

length ≥ 1

The order type attributes for the sandbox shipment.

orderType

lineItemCount

string

enum

The number of line items in the shipment.

Allowed:

quantityCount

string

enum

The quantity count per line item.

Allowed:

Responses

Language

Loading…

Response

Choose an example:

application/json

201Successfully created a sandbox shipment.

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.