Fulfillment Inbound v2024-03-20
listInboundPlans
Provides a list of inbound plans with minimal information.
get/inbound/fba/2024-03-20/inboundPlans
Query parameters
pageSizeinteger
The number of inbound plans to return in the response matching the given query.
paginationTokenstring
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' | 'VOIDED' | 'SHIPPED'
The status of an inbound plan.
sortBy'LAST_UPDATED_TIME' | 'CREATION_TIME'
Sort by field.
sortOrder'ASC' | 'DESC'
The sort order.
Response
ListInboundPlans 200 response
Example response
{
"inboundPlans": [
{
"createdAt": "2023-03-08T13:15:30Z",
"inboundPlanId": "wf1234abcd-1234-abcd-5678-1234abcd5678",
"lastUpdatedAt": "2023-03-08T13:15:30Z",
"marketplaceIds": [
"A2EUQ1WTGCTBG2"
],
"name": "FBA (03/08/2023, 01:15 PM)",
"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"
}
]
}