getInboundPlan

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

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.

Responses

Response body

object

createdAt

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

length between 38 and 38

Identifier of an inbound plan.

lastUpdatedAt

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 of strings

required

A list of marketplace IDs.

marketplaceIds*

name

string

required

Human-readable name of the inbound plan.

packingOptions

array of objects

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.

packingOptions

object

packingOptionId

string

required

length between 38 and 38

Identifier of a packing option.

status

string

required

length between 1 and 1024

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

placementOptions

array of objects

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.

placementOptions

object

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.

status

string

required

length between 1 and 1024

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

shipments

array of objects

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.

shipments

object

shipmentId

string

required

length between 38 and 38

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

status

string

required

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

sourceAddress

object

required

Specific details to identify a place.

addressLine1

string

required

length between 1 and 180

Street address information.

addressLine2

string

length between 1 and 60

Additional street address information.

city

string

required

length between 1 and 30

The city.

companyName

string

length between 1 and 50

The name of the business.

countryCode

string

required

length between 2 and 2

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

string

length between 1 and 1024

The email address.

name

string

required

length between 1 and 50

The name of the individual who is the primary contact.

phoneNumber

string

length between 1 and 20

The phone number.

postalCode

string

required

length between 1 and 32

The postal code.

stateOrProvinceCode

string

length between 1 and 64

The state or province code.

status

string

required

length between 1 and 1024

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

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 \
3
     --header 'accept: application/json'


xxxxxxxxxx
25
 
1
{
2
  "createdAt": "2024-03-20T12:01:00Z",
3
  "inboundPlanId": "wf1234abcd-1234-abcd-5678-1234abcd5678",
4
  "lastUpdatedAt": "2024-03-28T13:15:30Z",
5
  "marketplaceIds": [
6
    "A2EUQ1WTGCTBG2"
7
  ],
8
  "name": "FBA (03/20/2024, 12:01 PM)",
9
  "packingOptions": [],
10
  "placementOptions": [],
11
  "shipments": [],
12
  "sourceAddress": {
13
    "addressLine1": "123 example street",
14
    "addressLine2": "Floor 19",
15
    "city": "Toronto",
16
    "companyName": "Acme",
17
    "countryCode": "CA",
18
    "email": "email@email.com",
19
    "name": "name",
20
    "phoneNumber": "1234567890",
21
    "postalCode": "M1M1M1",
22
    "stateOrProvinceCode": "ON"
23
  },
24
  "status": "ACTIVE"
25
}

200GetInboundPlan 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.