createInboundPlan - Amazon SP API

Creates an inbound plan. An inbound plan contains all the necessary information to send shipments into Amazon's fufillment network.

Usage Plan:

Rate (requests per second)	Burst
2	2

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

Body Params application/json

The `createInboundPlan` request.

destinationMarketplaces

array[string]

required

Marketplaces where the items need to be shipped to. Currently only one marketplace can be selected in this request.

>= 1 items<= 1 items

items

array[object (ItemInput) {6}]

required

Items included in this plan.

>= 1 items<= 2000 items

expiration

string

optional

The expiration date of the MSKU. In ISO 8601 datetime format with pattern YYYY-MM-DD. Items with the same MSKU but different expiration dates cannot go into the same box.

Match pattern:

^([0-9]{4})-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$

labelOwner

enum<string>

required

Specifies who will label the items. Options include AMAZON, SELLER or NONE.

Allowed values:

AMAZONSELLERNONE

manufacturingLotCode

string

optional

The manufacturing lot code.

>= 1 characters<= 256 characters

msku

string

required

The merchant SKU, a merchant-supplied identifier of a specific SKU.

>= 1 characters<= 40 characters

prepOwner

enum<string>

required

The owner of the preparations, if special preparations are required.

Allowed values:

AMAZONSELLERNONE

quantity

integer

required

The number of units of the specified MSKU that will be shipped.

>= 1<= 10000

name

string

optional

Name for the Inbound Plan. If one isn't provided, a default name will be provided.

>= 1 characters<= 40 characters

sourceAddress

object (AddressInput)

required

Specific details to identify a place.

Example:

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

addressLine1

string

required

Street address information.

>= 1 characters<= 180 characters

addressLine2

string

optional

Additional street address information.

>= 1 characters<= 60 characters

city

string

required

The city.

>= 1 characters<= 30 characters

companyName

string

optional

The name of the business.

>= 1 characters<= 50 characters

countryCode

string

required

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

>= 2 characters<= 2 characters

Match pattern:

^[A-Z]{2}$

string

optional

The email address.

>= 1 characters<= 1024 characters

name

string

required

The name of the individual who is the primary contact.

>= 1 characters<= 50 characters

phoneNumber

string

required

The phone number.

>= 1 characters<= 20 characters

postalCode

string

required

The postal code.

>= 1 characters<= 32 characters

stateOrProvinceCode

string

optional

The state or province code.

>= 1 characters<= 64 characters

Example

{
    "destinationMarketplaces": [
        "ATVPDKIKX0DER"
    ],
    "items": [
        {
            "expiration": "2024-01-01",
            "labelOwner": "AMAZON",
            "manufacturingLotCode": "manufacturingLotCode",
            "msku": "Sunglasses",
            "prepOwner": "AMAZON",
            "quantity": 10
        }
    ],
    "name": "My inbound plan",
    "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"
    }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢202Accepted

application/json

CreateInboundPlan 202 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

The `createInboundPlan` response.

inboundPlanId

string

required

Identifier of an inbound plan.

>= 38 characters<= 38 characters

Match pattern:

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

operationId

string

required

UUID for the given operation.

>= 36 characters<= 38 characters

Match pattern:

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

Example

{
    "inboundPlanId": "stringstringstringstringstringstringst",
    "operationId": "stringstringstringstringstringstring"
}

🟠400Bad Request

🟠403Forbidden

🟠404Record Not Found

🟠413413

🟠415415

🟠429429

🔴500Server Error

🔴503Service Unavailable