getInboundPlan

GET

/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}

Fulfillment Inbound

Last modified:2024-12-05 08:51:44

Maintainer:Not configured

Fetches the top level information about an inbound plan.

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.

Request

Path Params

inboundPlanId

string

required

Identifier of an inbound plan.

>= 38 characters<= 38 characters

Match pattern:

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

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

GetInboundPlan 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

Inbound plan containing details of the inbound workflow.

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.

inboundPlanId

string

required

Identifier of an inbound plan.

>= 38 characters<= 38 characters

Match pattern:

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

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.

marketplaceIds

array[string]

required

A list of marketplace IDs.

name

string

required

Human-readable name of the inbound plan.

packingOptions

array[object (PackingOptionSummary) {2}]

optional

Packing options for the inbound plan. This property will be populated when it has been generated via the corresponding operation. If there is a chosen placement option, only packing options for that placement option will be returned. If there are confirmed shipments, only packing options for those shipments will be returned. Query the packing option for more details.

packingOptionId

string

required

Identifier of a packing option.

>= 38 characters<= 38 characters

Match pattern:

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

status

string

required

The status of a packing option. Possible values: 'OFFERED', 'ACCEPTED', 'EXPIRED'.

>= 1 characters<= 1024 characters

placementOptions

array[object (PlacementOptionSummary) {2}]

optional

Placement options for the inbound plan. This property will be populated when it has been generated via the corresponding operation. If there is a chosen placement option, that will be the only returned option. Query the placement option for more details.

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-]*$

status

string

required

The status of a placement option. Possible values: OFFERED, ACCEPTED.

>= 1 characters<= 1024 characters

shipments

array[object (ShipmentSummary) {2}]

optional

A list of shipment IDs for the inbound plan. This property is populated when it has been generated with the confirmPlacementOptions operation. Only shipments from the chosen placement option are returned. Query the shipment for more details.

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-]*$

status

string

required

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

sourceAddress

object (Address)

required

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"}

addressLine1

string

required

First line of the address text.

addressLine2

string

optional

Optional second line of the address text.

addressLine3

string

optional

Optional third line of the address text.

city

string

optional

Optional city where this address is located.

countryCode

string

required

Two-digit, ISO 3166-1 alpha-2 formatted country code where this address is located.

county

string

optional

Optional county where this address is located.

Example:

Washington

district

string

optional

Optional district where this address is located.

name

string

required

Name of the person, business, or institution at this address.

phoneNumber

string

optional

Optional E.164-formatted phone number for an available contact at this address.

Example:

+14155552671

postalCode

string

optional

Optional postal code where this address is located.

stateOrRegion

string

required

State or region where this address is located. Note that this is contextual to the specified country code.

status

string

required

Current status of the inbound plan. Possible values: ACTIVE, VOIDED, SHIPPED, ERRORED.

>= 1 characters<= 1024 characters

Example

{
    "createdAt": "2024-03-20T12:01:00Z",
    "inboundPlanId": "wf1234abcd-1234-abcd-5678-1234abcd5678",
    "lastUpdatedAt": "2024-03-28T13:15:30Z",
    "marketplaceIds": [
        "A2EUQ1WTGCTBG2"
    ],
    "name": "FBA (03/20/2024, 12:01 PM)",
    "packingOptions": [],
    "placementOptions": [],
    "shipments": [],
    "sourceAddress": {
        "addressLine1": "123 example street",
        "addressLine2": "Floor 19",
        "city": "Toronto",
        "companyName": "Acme",
        "countryCode": "CA",
        "email": "email@email.com",
        "name": "name",
        "phoneNumber": "1234567890",
        "postalCode": "M1M1M1",
        "stateOrProvinceCode": "ON"
    },
    "status": "ACTIVE"
}

🟠400Bad Request

🟠403Forbidden

🟠404Record Not Found

🟠413413

🟠415415

🟠429429

🔴500Server Error

🔴503Service Unavailable

createInboundPlan

listInboundPlanBoxes