HomeDocumentationCode SamplesAPI ReferenceAnnouncementsModelsRelease NotesFAQGitHubVideos
Developer HubAPI StatusSupport
API Reference
Developer HubAPI StatusSupport

createShipment

Create a shipment with the information provided.

Usage Plan:

Rate (requests per second)Burst
22

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that are applied to the requested operation when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the SP-API.

Body Params

The request schema for the CreateShipment operation.

ShipmentRequestDetails
object
required

Shipment information required for requesting shipping service offers or for creating a shipment.

string
required

An Amazon-defined shipping service identifier.

string

Identifies a shipping service order made by a carrier.

string

Hazardous materials options for a package. Consult the terms and conditions for each carrier for more information on hazardous materials.

Show Details
NoneThe package does not contain hazardous material.
LQHazmatThe package contains limited quantities of hazardous material.
LabelFormatOption
object

Whether to include a packing slip.

ShipmentLevelSellerInputsList
array of objects

A list of additional seller input pairs required to purchase shipping.

ShipmentLevelSellerInputsList
Responses

Response body
object
payload
object

The details of a shipment. Includes the shipment status.

string
required

An Amazon-defined shipment identifier.

string
required

An Amazon-defined order identifier, in 3-7-7 format.

string
length ≤ 64

A seller-defined order identifier.

ItemList
array of objects
required

The list of items you want to include in a shipment.

ItemList*
object
string
required

An Amazon-defined identifier for an individual item in an order.

int32
required

The number of items.

ItemWeight
object

The weight.

string

The description of the item.

TransparencyCodeList
array of strings

A list of transparency codes.

TransparencyCodeList
ItemLevelSellerInputsList
array of objects

A list of additional seller input pairs required to purchase shipping.

ItemLevelSellerInputsList
object
string
required

The name of the additional input field.

AdditionalSellerInput
object
required

Additional information required to purchase shipping.

LiquidVolume
object

Liquid volume.

boolean

When true, the item qualifies as hazardous materials (hazmat). Defaults to false.

DangerousGoodsDetails
object

Details related to any dangerous goods or items that are shipped.

ShipFromAddress
object
required

The postal address information.

ShipToAddress
object
required

The postal address information.

PackageDimensions
object
required

The dimensions of a package contained in a shipment.

Weight
object
required

The weight.

Insurance
object
required

Currency type and amount.

ShippingService
object
required

A shipping service offer made by a carrier.

Label
object
required

Data for creating a shipping label and dimensions for printing the label.

string
required

The shipment status.

Purchased RefundPending RefundRejected RefundApplied

Show Details
PurchasedThe seller purchased a label by calling the `createShipment` operation.
RefundPendingThe seller requested a label refund by calling the `cancelShipment` operation, and the refund request is being processed by the carrier. Note: A seller can create a new shipment for an order while `Status = RefundPending` for a canceled shipment. After you request a label refund (by calling `cancelShipment`), the status of the order remains `Shipped`.
RefundRejectedThe label refund request is rejected by the carrier. A refund request is rejected because the cancellation window has expired or the carrier has already accepted the shipment for delivery. Cancellation policies vary by carrier. For more information about carrier cancellation policies, refer to the Seller Central Help for your marketplace.
RefundAppliedThe refund has been approved and credited to the seller's account.
string

The shipment tracking identifier provided by the carrier.

date-time
required

Date-time formatted timestamp.

date-time

Date-time formatted timestamp.

errors
array of objects

A list of error responses returned when a request is unsuccessful.

errors
object
string
required

An error code that identifies the type of error that occurred.

string
required

A message that describes the error condition in a human-readable form.

string

Additional details that can help the caller understand or fix the issue.

Headers
object
string

Your rate limit (requests per second) for this operation.

string

Unique request reference identifier.

Language