Get inbound plan - Seller Assistant API

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

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Successful response

Body

createdAt

string <date-time>

required

The time at which the inbound plan was created. In ISO 8601 datetime 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

packingOptions

array [object {2}] | null

optional

Packing options for the inbound plan.

packingOptionId

string

required

Identifier of a packing option.

>= 38 characters<= 38 characters

Example:

PACK1234567890ABCDEFGH1234567890ABCDEF

status

enum<string>

required

The status of a packing option.

>= 1 characters<= 1024 characters

Allowed values:

OFFEREDACCEPTEDEXPIRED

Example:

OFFERED

placementOptions

array [object {2}] | null

optional

Placement options for the inbound plan.

placementOptionId

string

required

The identifier of a placement option.

>= 38 characters<= 38 characters

Example:

PLACE1234567890ABCDEFGH1234567890ABCD

status

enum<string>

required

The status of a placement option.

>= 1 characters<= 1024 characters

Allowed values:

OFFEREDACCEPTED

Example:

OFFERED

shipments

array [object {2}] | null

optional

A list of shipment IDs for the inbound plan.

shipmentId

string

required

Identifier of a shipment.

>= 38 characters<= 38 characters

Example:

SHIP1234567890ABCDEFGH1234567890ABCDEF

status

enum<string>

required

The status of a shipment.

>= 1 characters<= 1024 characters

Allowed values:

ABANDONEDCANCELLEDCHECKED_INCLOSEDDELETEDDELIVEREDIN_TRANSITMIXEDREADY_TO_SHIPRECEIVINGSHIPPEDUNCONFIRMEDWORKING

Example:

UNCONFIRMED

sourceAddress

object (Address)

required

addressLine1

string

required

Street address information.

>= 1 characters<= 180 characters

Example:

123 Main St

addressLine2

string | null

optional

Additional street address information.

>= 1 characters<= 60 characters

Example:

Suite 100

city

string

required

The city.

>= 1 characters<= 30 characters

Example:

Seattle

companyName

string | null

optional

The name of the business.

>= 1 characters<= 50 characters

Example:

Acme Inc

countryCode

string

required

The country code in two-character ISO 3166-1 alpha-2 format.

>= 2 characters<= 2 characters

Example:

string | null

optional

The email address.

>= 1 characters<= 1024 characters

Example:

contact@example.com

name

string

required

The name of the individual who is the primary contact.

>= 1 characters<= 50 characters

Example:

John Doe

phoneNumber

string | null

optional

The phone number.

>= 1 characters<= 20 characters

Example:

+12065551234

postalCode

string

required

The postal code.

>= 1 characters<= 32 characters

Example:

98109

stateOrProvinceCode

string | null

optional

The state or province code.

>= 1 characters<= 64 characters

Example:

status

enum<string>

required

Current status of the inbound plan.

>= 1 characters<= 1024 characters

Allowed values:

ACTIVEVOIDEDSHIPPEDERRORED

Example:

ACTIVE

Example

{
    "createdAt": "2025-05-26T09:36:00Z",
    "inboundPlanId": "ABCDEFGH1234567890ABCDEFGH1234567890",
    "lastUpdatedAt": "2025-05-26T10:36:00Z",
    "marketplaceIds": [
        "ATVPDKIKX0DER"
    ],
    "name": "Summer 2025 Inventory Shipment",
    "packingOptions": [
        {
            "packingOptionId": "PACK1234567890ABCDEFGH1234567890ABCDEF",
            "status": "OFFERED"
        }
    ],
    "placementOptions": [
        {
            "placementOptionId": "PLACE1234567890ABCDEFGH1234567890ABCD",
            "status": "OFFERED"
        }
    ],
    "shipments": [
        {
            "shipmentId": "SHIP1234567890ABCDEFGH1234567890ABCDEF",
            "status": "ABANDONED"
        }
    ],
    "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"
}

🟠402402

🟠403Forbidden

🟠422Parameter Error

🟠429429

🔴500Server Error