getShipment

Rate (requests per second)	Burst
2	6

Rate (requests per second)

Burst

Request

Path Params

inboundPlanId

string

required

Identifier of an inbound plan.

>= 38 characters<= 38 characters

Match pattern:

^[a-zA-Z0-9-]*$

shipmentId

string

required

Identifier of a shipment. A shipment contains the boxes and units being inbounded.

>= 38 characters<= 38 characters

Match pattern:

^[a-zA-Z0-9-]*$

Responses

🟢200OK

application/json

GetShipment 200 response

Headers

x-amzn-RequestId

string

optional

Unique request reference identifier.

x-amzn-RateLimit-Limit

string

optional

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

Body

Contains information pertaining to a shipment in an inbound plan.

amazonReferenceId

string

optional

A unique identifier created by Amazon that identifies this Amazon-partnered, Less Than Truckload/Full Truckload (LTL/FTL) shipment.

>= 1 characters<= 1024 characters

contactInformation

object (ContactInformation)

optional

The seller's contact information.

Example:

{"email":"email@email.com","name":"name","phoneNumber":"1234567890"}

string

optional

The email address.

>= 1 characters<= 1024 characters

name

string

required

The contact's name.

>= 1 characters<= 50 characters

phoneNumber

string

required

The phone number.

>= 1 characters<= 20 characters

dates

object (Dates)

optional

Specifies the date that the seller expects their shipment will be shipped.

Example:

{"readyToShipWindow":{"end":"2024-01-06T14:48:00.000Z","start":"2024-01-05T14:48:00.000Z"}}

readyToShipWindow

object (Window)

optional

Contains a start and end DateTime representing a time range.

Example:

{"editableUntil":"2024-01-05T20:00:00.000Z","end":"2024-01-05T20:00:00.000Z","start":"2024-01-05T14:00:00.000Z"}

destination

object (ShipmentDestination)

required

The Amazon fulfillment center address and warehouse ID.

address

object (Address)

optional

Shipping address that represents the origin or destination location.

Example:

{"addressLine1":"address_1","addressLine2":"address_2","addressLine3":"address_3","city":"Seattle","countryCode":"US","county":"Washington","district":"District1","name":"address_name","phoneNumber":"+14155552671","postalCode":"123456","stateOrRegion":"Washington"}

destinationType

string

required

The type of destination for this shipment. Possible values: AMAZON_OPTIMIZED, AMAZON_WAREHOUSE.

>= 1 characters<= 1024 characters

warehouseId

string

optional

The warehouse that the shipment should be sent to. Empty if the destination type is AMAZON_OPTIMIZED.

>= 1 characters<= 1024 characters

freightInformation

object (FreightInformation)

optional

Freight information describes the skus being transported. Freight carrier options and quotes will only be returned if the freight information is provided.

Example:

{"declaredValue":{"amount":5.5,"code":"CAD"},"freightClass":"FC_50"}

declaredValue

object (Currency)

optional

The type and amount of currency.

freightClass

string

optional

Freight class.

Possible values: NONE, FC_50, FC_55, FC_60, FC_65, FC_70, FC_77_5, FC_85, FC_92_5, FC_100, FC_110, FC_125, FC_150, FC_175, FC_200, FC_250, FC_300, FC_400, FC_500.

>= 1 characters<= 1024 characters

name

string

optional

The name of the shipment.

placementOptionId

string

required

The identifier of a placement option. A placement option represents the shipment splits and destinations of SKUs.

>= 38 characters<= 38 characters

Match pattern:

^[a-zA-Z0-9-]*$

selectedDeliveryWindow

object (SelectedDeliveryWindow)

optional

Selected delivery window attributes.

Example:

{"availabilityType":"AVAILABLE","deliveryWindowOptionId":"dw1234abcd-1234-abcd-5678-1234abcd5678","editableUntil":"2024-01-05T20:00:00.000Z","endDate":"2024-01-05T20:00:00.000Z","startDate":"2024-01-05T14:00:00.000Z"}

availabilityType

string

required

Identifies type of Delivery Window Availability. Values: AVAILABLE, CONGESTED

deliveryWindowOptionId

string

required

Identifier of a delivery window option. A delivery window option represent one option for when a shipment is expected to be delivered.

>= 36 characters<= 38 characters

Match pattern:

^[a-zA-Z0-9-]*$

editableUntil

string <date-time>

optional

The timestamp at which this Window can no longer be edited.

endDate

string <date-time>

required

The end timestamp of the window.

startDate

string <date-time>

required

The start timestamp of the window.

selectedTransportationOptionId

string

optional

Identifier of a transportation option. A transportation option represent one option for how to send a shipment.

>= 38 characters<= 38 characters

Match pattern:

^[a-zA-Z0-9-]*$

selfShipAppointmentDetails

array[object (SelfShipAppointmentDetails) {3}]

optional

List of self ship appointment details.

appointmentId

number

optional

Identifier for appointment.

appointmentSlotTime

object (AppointmentSlotTime)

optional

An appointment slot time with start and end.

appointmentStatus

string

optional

Status of the appointment.

>= 1 characters<= 1024 characters

shipmentConfirmationId

string

optional

The confirmed shipment ID which shows up on labels (for example, FBA1234ABCD).

>= 1 characters<= 1024 characters

shipmentId

string

required

Identifier of a shipment. A shipment contains the boxes and units being inbounded.

>= 38 characters<= 38 characters

Match pattern:

^[a-zA-Z0-9-]*$

source

object (ShipmentSource)

required

Specifies the 'ship from' address for the shipment.

address

object (Address)

optional

Shipping address that represents the origin or destination location.

Example:

sourceType

string

required

The type of source for this shipment. Possible values: SELLER_FACILITY.

>= 1 characters<= 1024 characters

status

string

optional

The status of a shipment. The state of the shipment will typically start as UNCONFIRMED, then transition to WORKING after a placement option has been confirmed, and then to READY_TO_SHIP once labels are generated.

Possible values: ABANDONED, CANCELLED, CHECKED_IN, CLOSED, DELETED, DELIVERED, IN_TRANSIT, MIXED, READY_TO_SHIP, RECEIVING, SHIPPED, UNCONFIRMED, WORKING

>= 1 characters<= 1024 characters

trackingDetails

object (TrackingDetails)

optional

Representation of tracking metadata.

trackingId

string

optional

A string of up to 255 characters.

>= 1 characters<= 255 characters

Example

{
    "destination": {
        "destinationType": "AMAZON_OPTIMIZED"
    },
    "freightInformation": {
        "declaredValue": {
            "amount": 5.5,
            "code": "CAD"
        },
        "freightClass": "FC_50"
    },
    "inboundPlanId": "wf1234abcd-1234-abcd-5678-1234abcd5678",
    "placementOptionId": "pl1234abcd-1234-abcd-5678-1234abcd5678",
    "selectedDeliveryWindow": {
        "availabilityType": "AVAILABLE",
        "deliveryWindowOptionId": "dw1234abcd-1234-abcd-5678-1234abcd5678",
        "editableUntil": "2024-01-05T20:00:00.000Z",
        "endDate": "2024-01-05T20:00:00.000Z",
        "startDate": "2024-01-05T14:00:00.000Z"
    },
    "shipmentConfirmationId": "shipmentConfirmationId",
    "shipmentId": "sh1234abcd-1234-abcd-5678-1234abcd5678",
    "source": {
        "sourceType": "SELLER_FACILITY"
    }
}

🟠400Bad Request

🟠403Forbidden

🟠404Record Not Found

🟠413413

🟠415415

🟠429429

🔴500Server Error

🔴503Service Unavailable

Request

Request samples

Responses