[Fulfillment Inbound API v2024] Fetch Inbound Plan Details

Overview

This Selling Partner APIs (SP API) collection includes all the GET API operations. Use these APIs to fetch your inbound plans, shipments and much more using the new Fulfillment by Amazon (FBA) Inbound v2024 API operations.

This collection supports below operations,

Access token retrieval.

Complete FBA Inbound GET API requests, including listing all your inbound plans, details to specific inbound plan including its shipments, packing, placement, transportation and labels details.

Get Inbound Level Details

GETlist Inbound Plans

https://sellingpartnerapi-na.amazon.com/inbound/fba/2024-03-20/inboundPlans?status=ACTIVE&sortBy=LAST_UPDATED_TIME&sortOrder=ASC

Provides a list of inbound plans with minimal information.

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 table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.

HEADERS

application/json

x-amz-access-token

Atza|XXXXXXXXXXXXXXX

PARAMS

pageSize

The number of inbound plans to return in the response matching the given query.

paginationToken

A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the pagination returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.

status

ACTIVE

The status of an inbound plan.

sortBy

LAST_UPDATED_TIME

Sort by field.

sortOrder

ASC

The sort order.

Example Request

curl

curl --location 'https://sellingpartnerapi-na.amazon.com/inbound/fba/2024-03-20/inboundPlans?pageSize=10&paginationToken=%3Cstring%3E&status=ACTIVE&sortBy=LAST_UPDATED_TIME&sortOrder=ASC' \
--header 'Accept: application/json'

200 OK

Example Response

json

{
  "inboundPlans": [
    {
      "createdAt": "<dateTime>",
      "inboundPlanId": "6Q6avxM6Q6avxM6Q6avxM6Q6avxM6Q6avxM6Q6",
      "lastUpdatedAt": "<dateTime>",
      "marketplaceIds": [
        "<string>",
        "<string>"
      ],
      "name": "<string>",
      "sourceAddress": {
        "addressLine1": "<string>",
        "city": "<string>",
        "countryCode": "ZG",
        "name": "<string>",
        "postalCode": "<string>",
        "addressLine2": "<string>",
        "companyName": "<string>",
        "email": "<string>",
        "phoneNumber": "<string>",
        "stateOrProvinceCode": "<string>"
      },
      "status": "<string>"
    },
    {
      "createdAt": "<dateTime>",
      "inboundPlanId": "SvUtTawTzSvUtTawTzSvUtTawTzSvUtTawTzSv",
      "lastUpdatedAt": "<dateTime>",
      "marketplaceIds": [
        "<string>",
        "<string>"
      ],
      "name": "<string>",
      "sourceAddress": {
        "addressLine1": "<string>",
        "city": "<string>",
        "countryCode": "IO",
        "name": "<string>",
        "postalCode": "<string>",
        "addressLine2": "<string>",
        "companyName": "<string>",
        "email": "<string>",
        "phoneNumber": "<string>",
        "stateOrProvinceCode": "<string>"
      },
      "status": "<string>"
    }
  ],
  "pagination": {
    "nextToken": "<string>"
  }
}

Content-Type

application/json

x-amzn-RequestId

Unique request reference identifier.

x-amzn-RateLimit-Limit

Your rate limit (requests per second) for this operation.

GETget Inbound Plan

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

HEADERS

application/json

x-amz-access-token

Atza|XXXXXXXXXXXXXXX

PATH VARIABLES

inboundPlanId

wXXXXXXXXXXXXXXX

(Required) Identifier of an inbound plan.

Example Request

curl

curl --location 'https://sellingpartnerapi-na.amazon.com/inbound/fba/2024-03-20/inboundPlans/:inboundPlanId' \
--header 'Accept: application/json'

200 OK

Example Response

json

{
  "createdAt": "<dateTime>",
  "inboundPlanId": "13s13s13s13s13s13s13s13s13s13s13s13s13",
  "lastUpdatedAt": "<dateTime>",
  "marketplaceIds": [
    "<string>",
    "<string>"
  ],
  "name": "<string>",
  "sourceAddress": {
    "addressLine1": "<string>",
    "city": "<string>",
    "countryCode": "WA",
    "name": "<string>",
    "postalCode": "<string>",
    "addressLine2": "<string>",
    "companyName": "<string>",
    "email": "<string>",
    "phoneNumber": "<string>",
    "stateOrProvinceCode": "<string>"
  },
  "status": "<string>",
  "packingOptions": [
    {
      "packingOptionId": "jAumsjAumsjAumsjAumsjAumsjAumsjAumsjAu",
      "status": "<string>"
    },
    {
      "packingOptionId": "Z4obN80rZ4obN80rZ4obN80rZ4obN80rZ4obN8",
      "status": "<string>"
    }
  ],
  "placementOptions": [
    {
      "placementOptionId": "5CgQRKlK5CgQRKlK5CgQRKlK5CgQRKlK5CgQRK",
      "status": "<string>"
    },
    {
      "placementOptionId": "J4tVJ4tVJ4tVJ4tVJ4tVJ4tVJ4tVJ4tVJ4tVJ4",
      "status": "<string>"
    }
  ],
  "shipments": [
    {
      "shipmentId": "uA8UILuA8UILuA8UILuA8UILuA8UILuA8UILuA",
      "status": "<string>"
    },
    {
      "shipmentId": "jQZJ7H4RjQZJ7H4RjQZJ7H4RjQZJ7H4RjQZJ7H",
      "status": "<string>"
    }
  ]
}

Content-Type

application/json

x-amzn-RequestId

Unique request reference identifier.

x-amzn-RateLimit-Limit

Your rate limit (requests per second) for this operation.

GETlist Inbound Plan Items

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

Provides a paginated list of item packages in an inbound plan.

Usage Plan:

Rate (requests per second)	Burst
2	6

HEADERS

application/json

x-amz-access-token

Atza|XXXXXXXXXXXXXXX

PARAMS

pageSize

The number of items to return in the response matching the given query.

paginationToken

PATH VARIABLES

inboundPlanId

wXXXXXXXXXXXXXXX

(Required) Identifier of an inbound plan.

Example Request

curl

curl --location 'https://sellingpartnerapi-na.amazon.com/inbound/fba/2024-03-20/inboundPlans/:inboundPlanId/items?pageSize=10&paginationToken=%3Cstring%3E' \
--header 'Accept: application/json'

200 OK

Example Response

json

{
  "items": [
    {
      "asin": "<string>",
      "fnsku": "<string>",
      "labelOwner": "<string>",
      "msku": "<string>",
      "prepInstructions": [
        {
          "fee": {
            "amount": "<number>",
            "code": "<string>"
          },
          "prepOwner": "<string>",
          "prepType": "<string>"
        },
        {
          "fee": {
            "amount": "<number>",
            "code": "<string>"
          },
          "prepOwner": "<string>",
          "prepType": "<string>"
        }
      ],
      "quantity": "<integer>",
      "expiration": "6596-12-08",
      "manufacturingLotCode": "<string>"
    },
    {
      "asin": "<string>",
      "fnsku": "<string>",
      "labelOwner": "<string>",
      "msku": "<string>",
      "prepInstructions": [
        {
          "fee": {
            "amount": "<number>",
            "code": "<string>"
          },
          "prepOwner": "<string>",
          "prepType": "<string>"
        },
        {
          "fee": {
            "amount": "<number>",
            "code": "<string>"
          },
          "prepOwner": "<string>",
          "prepType": "<string>"
        }
      ],
      "quantity": "<integer>",
      "expiration": "3247-11-30",
      "manufacturingLotCode": "<string>"
    }
  ],
  "pagination": {
    "nextToken": "<string>"
  }
}

Content-Type

application/json

x-amzn-RequestId

Unique request reference identifier.

x-amzn-RateLimit-Limit

Your rate limit (requests per second) for this operation.