getShipment

get https://sellingpartnerapi-na.amazon.com/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}

Provides the full details for a specific shipment within an inbound plan. The transportationOptionId inside acceptedTransportationSelection can be used to retrieve the transportation details for the shipment.

Usage Plan:

Rate (requests per second)	Burst
2	6

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains 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 Selling Partner API.

Responses

Response body

object

amazonReferenceId

string

length between 1 and 1024

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

contactInformation

object

The seller's contact information.

string

length between 1 and 1024

The email address.

name

string

required

length between 1 and 50

The contact's name.

phoneNumber

string

required

length between 1 and 20

The phone number.

dates

object

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

readyToShipWindow

object

Contains a start and end DateTime representing a time range.

destination

object

required

The Amazon fulfillment center address and warehouse ID.

address

object

Specific details to identify a place.

destinationType

string

required

length between 1 and 1024

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

warehouseId

string

length between 1 and 1024

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

freightInformation

object

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

declaredValue

object

The type and amount of currency.

freightClass

string

length between 1 and 1024

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.

name

string

The name of the shipment.

placementOptionId

string

required

length between 38 and 38

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

selectedDeliveryWindow

object

Selected delivery window attributes.

availabilityType

string

required

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

deliveryWindowOptionId

string

required

length between 36 and 38

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

editableUntil

date-time

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

endDate

date-time

required

The end timestamp of the window.

startDate

date-time

required

The start timestamp of the window.

selectedTransportationOptionId

string

length between 38 and 38

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

selfShipAppointmentDetails

array of objects

List of self ship appointment details.

selfShipAppointmentDetails

object

appointmentId

number

Identifier for appointment.

appointmentSlotTime

object

An appointment slot time with start and end.

appointmentStatus

string

length between 1 and 1024

Status of the appointment.

shipmentConfirmationId

string

length between 1 and 1024

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

shipmentId

string

required

length between 38 and 38

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

source

object

required

Specifies the 'ship from' address for the shipment.

address

object

Specific details to identify a place.

sourceType

string

required

length between 1 and 1024

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

status

string

length between 1 and 1024

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

trackingDetails

object

Tracking information for Less-Than-Truckload (LTL) and Small Parcel Delivery (SPD) shipments.

ltlTrackingDetail

object

Contains information related to Less-Than-Truckload (LTL) shipment tracking.

spdTrackingDetail

object

Contains information related to Small Parcel Delivery (SPD) shipment tracking.

Headers

object

x-amzn-RequestId

string

Unique request reference identifier.

x-amzn-RateLimit-Limit

string

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

Language


xxxxxxxxxx
1
curl --request GET \
2
     --url https://sellingpartnerapi-na.amazon.com/inbound/fba/2024-03-20/inboundPlans/inboundPlanId/shipments/shipmentId \
3
     --header 'accept: application/json'


xxxxxxxxxx
26
}
1
{
2
  "destination": {
3
    "destinationType": "AMAZON_OPTIMIZED"
4
  },
5
  "freightInformation": {
6
    "declaredValue": {
7
      "amount": 5.5,
8
      "code": "CAD"
9
    },
10
    "freightClass": "FC_50"
11
  },
12
  "inboundPlanId": "wf1234abcd-1234-abcd-5678-1234abcd5678",
13
  "placementOptionId": "pl1234abcd-1234-abcd-5678-1234abcd5678",
14
  "selectedDeliveryWindow": {
15
    "availabilityType": "AVAILABLE",
16
    "deliveryWindowOptionId": "dw1234abcd-1234-abcd-5678-1234abcd5678",
17
    "editableUntil": "2024-01-05T20:00:00.000Z",
18
    "endDate": "2024-01-05T20:00:00.000Z",
19
    "startDate": "2024-01-05T14:00:00.000Z"
20
  },
21
  "shipmentConfirmationId": "shipmentConfirmationId",
22
  "shipmentId": "sh1234abcd-1234-abcd-5678-1234abcd5678",
23
  "source": {
24
    "sourceType": "SELLER_FACILITY"
25
  }

200GetShipment 200 response

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.