List plan shipments

Request

Path Params

inboundPlanId

required

Inbound Plan id (Workflow Id).

Example:

wf64bdf98e-986d-4bbe-8e20-7196e3aaa1d2

Query Params

domain

optional

Amazon marketplace domain. Domain amazon.com is used by default if domain and marketplaceId are not provided. If both domain and marketplaceId are chosen, domain has bigger priority. Options: amazon.com, amazon.ca, amazon.co.uk, amazon.de, amazon.es, amazon.it, amazon.fr, amazon.in, amazon.com.mx, amazon.com.br.

Example:

amazon.com

marketplaceId

optional

Amazon marketplace id. Domain amazon.com is used by default if domain and marketplaceId are not provided. If both domain and marketplaceId are chosen, domain has bigger priority. See all options here.

Example:

ATVPDKIKX0DER

Responses

🟢200OK

application/json

Successful response

Body

inboundPlan

object (InboundPlanSummary)

optional

createdAt

string <date-time>

required

The time at which the inbound plan was created. In ISO 8601 datetime format with pattern yyyy-MM-ddTHH:mm:ssZ.

Example:

2025-05-26T09:36:00Z

inboundPlanId

string

required

Identifier of an inbound plan.

>= 38 characters<= 38 characters

Example:

ABCDEFGH1234567890ABCDEFGH1234567890

lastUpdatedAt

string <date-time>

required

The time at which the inbound plan was last updated. In ISO 8601 datetime format with pattern yyyy-MM-ddTHH:mm:ssZ.

Example:

2025-05-26T10:36:00Z

marketplaceIds

array[string]

required

A list of marketplace IDs.

Example:

["ATVPDKIKX0DER"]

name

string

required

Human-readable name of the inbound plan.

Example:

Summer 2025 Inventory Shipment

sourceAddress

object (Address)

required

status

enum<string>

required

The current status of the inbound plan.

>= 1 characters<= 1024 characters

Allowed values:

ACTIVEVOIDEDSHIPPEDERRORED

Example:

ACTIVE

shipments

array[object (ShipmentSummary) {14}]

optional

amazonReferenceId

string | null

optional

A unique identifier created by Amazon that identifies this Amazon-partnered shipment.

>= 1 characters<= 1024 characters

contactInformation

object | null

optional

dates

object | null

optional

destination

object

optional

freightInformation

object | null

optional

placementOptionId

string

optional

The identifier of a placement option.

>= 38 characters<= 38 characters

selectedDeliveryWindow

object | null

optional

selectedTransportationOptionId

string | null

optional

>= 38 characters<= 38 characters

selfShipAppointmentDetails

array [object {3}] | null

optional

shipmentConfirmationId

string | null

optional

>= 1 characters<= 1024 characters

shipmentId

string

optional

Identifier of a shipment.

>= 38 characters<= 38 characters

source

object

optional

status

enum<string> | enum<null>

optional

>= 1 characters<= 1024 characters

Allowed values:

ABANDONEDCANCELLEDCHECKED_INCLOSEDDELETEDDELIVEREDIN_TRANSITMIXEDREADY_TO_SHIPRECEIVINGSHIPPEDUNCONFIRMEDWORKING

trackingDetails

object | null

optional

Example

{
    "inboundPlan": {
        "createdAt": "2025-05-26T09:36:00Z",
        "inboundPlanId": "ABCDEFGH1234567890ABCDEFGH1234567890",
        "lastUpdatedAt": "2025-05-26T10:36:00Z",
        "marketplaceIds": [
            "ATVPDKIKX0DER"
        ],
        "name": "Summer 2025 Inventory Shipment",
        "sourceAddress": {
            "addressLine1": "123 Main St",
            "addressLine2": "Suite 100",
            "city": "Seattle",
            "companyName": "Acme Inc",
            "countryCode": "US",
            "email": "contact@example.com",
            "name": "John Doe",
            "phoneNumber": "+12065551234",
            "postalCode": "98109",
            "stateOrProvinceCode": "WA"
        },
        "status": "ACTIVE"
    },
    "shipments": [
        {
            "amazonReferenceId": "string",
            "contactInformation": {
                "email": "string",
                "name": "string",
                "phoneNumber": "string"
            },
            "dates": {
                "readyToShipWindow": {
                    "editableUntil": "2019-08-24T14:15:22Z",
                    "end": "2019-08-24T14:15:22Z",
                    "start": "2019-08-24T14:15:22Z"
                }
            },
            "destination": {
                "address": {
                    "addressLine1": "123 Main St",
                    "addressLine2": "Suite 100",
                    "city": "Seattle",
                    "companyName": "Acme Inc",
                    "countryCode": "US",
                    "email": "contact@example.com",
                    "name": "John Doe",
                    "phoneNumber": "+12065551234",
                    "postalCode": "98109",
                    "stateOrProvinceCode": "WA"
                },
                "destinationType": "AMAZON_OPTIMIZED",
                "warehouseId": "string"
            },
            "freightInformation": {
                "declaredValue": {
                    "amount": 10.5,
                    "code": "USD"
                },
                "freightClass": "NONE",
                "name": "string"
            },
            "placementOptionId": "stringstringstringstringstringstringst",
            "selectedDeliveryWindow": {
                "availabilityType": "AVAILABLE",
                "deliveryWindowOptionId": "stringstringstringstringstringstring",
                "editableUntil": "2019-08-24T14:15:22Z",
                "endDate": "2019-08-24T14:15:22Z",
                "startDate": "2019-08-24T14:15:22Z"
            },
            "selectedTransportationOptionId": "stringstringstringstringstringstringst",
            "selfShipAppointmentDetails": [
                {
                    "appointmentId": 0,
                    "appointmentSlotTime": {
                        "endTime": "2019-08-24T14:15:22Z",
                        "startTime": "2019-08-24T14:15:22Z"
                    },
                    "appointmentStatus": "string"
                }
            ],
            "shipmentConfirmationId": "string",
            "shipmentId": "stringstringstringstringstringstringst",
            "source": {
                "address": {
                    "addressLine1": "123 Main St",
                    "addressLine2": "Suite 100",
                    "city": "Seattle",
                    "companyName": "Acme Inc",
                    "countryCode": "US",
                    "email": "contact@example.com",
                    "name": "John Doe",
                    "phoneNumber": "+12065551234",
                    "postalCode": "98109",
                    "stateOrProvinceCode": "WA"
                },
                "sourceType": "SELLER_FACILITY"
            },
            "status": "ABANDONED",
            "trackingDetails": {
                "ltlTrackingDetail": {
                    "billOfLadingNumber": "string",
                    "freightBillNumber": [
                        "string"
                    ]
                },
                "spdTrackingDetail": {
                    "spdTrackingItems": [
                        {
                            "boxId": "string",
                            "trackingId": "string",
                            "trackingNumberValidationStatus": "VALIDATED"
                        }
                    ]
                }
            }
        }
    ]
}

🟠402402

🟠403Forbidden

🟠422Parameter Error

🟠429429

🔴500Server Error

Request

Request samples

Responses