Fulfillment Inbound API v2024-03-20 Reference
Create and update inbound inventory to Amazon's fulfillment network.
Overview
The Selling Partner API for Fulfillment By Amazon (FBA) Inbound. The FBA Inbound API enables building inbound workflows to create, manage, and send shipments into Amazon's fulfillment network. The API has interoperability with the Send-to-Amazon user interface.
Version information
Version : 2024-03-20
Contact information
Contact : Selling Partner API Developer Support
Contact URL : https://sellercentral.amazon.com/gp/mws/contactus.html
License information
License : Apache License 2.0
License URL : http://www.apache.org/licenses/LICENSE-2.0
URI scheme
Host : sellingpartnerapi-na.amazon.com
Schemes : HTTPS
Consumes
application/json
Produces
application/json
Operations
listInboundPlans
createInboundPlan
getInboundPlan
listInboundPlanBoxes
cancelInboundPlan
listInboundPlanItems
updateInboundPlanName
listPackingGroupBoxes
listPackingGroupItems
setPackingInformation
listPackingOptions
generatePackingOptions
confirmPackingOption
listInboundPlanPallets
listPlacementOptions
generatePlacementOptions
confirmPlacementOption
getShipment
listShipmentBoxes
listShipmentContentUpdatePreviews
generateShipmentContentUpdatePreviews
getShipmentContentUpdatePreview
confirmShipmentContentUpdatePreview
getDeliveryChallanDocument
listDeliveryWindowOptions
generateDeliveryWindowOptions
confirmDeliveryWindowOptions
listShipmentItems
updateShipmentName
listShipmentPallets
cancelSelfShipAppointment
getSelfShipAppointmentSlots
generateSelfShipAppointmentSlots
scheduleSelfShipAppointment
updateShipmentSourceAddress
updateShipmentTrackingDetails
listTransportationOptions
generateTransportationOptions
confirmTransportationOptions
listItemComplianceDetails
updateItemComplianceDetails
createMarketplaceItemLabels
listPrepDetails
setPrepDetails
getInboundOperationStatus
Paths
GET /inbound/fba/2024-03-20/inboundPlans
Operation: listInboundPlans
Description
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 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.
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Query | pageSize optional | The number of inbound plans to return in the response matching the given query. Minimum : 1 Maximum : 30 | integer | 10 |
Query | paginationToken optional | 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.minLength : 0 maxLength : 1024 | string | - |
Query | status optional | The status of an inbound plan. | enum (Status) | - |
Query | sortBy optional | Sort by field. | enum (SortBy) | - |
Query | sortOrder optional | The sort order. | enum (SortOrder) | - |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 | ListInboundPlans 200 response Headers : x-amzn-RequestId (string) : Unique request reference identifier. x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. | ListInboundPlansResponse |
For error status codes, descriptions and schemas, see Error responses and schemas.
Produces
application/json
POST /inbound/fba/2024-03-20/inboundPlans
Operation: createInboundPlan
Description
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.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body | body required | The body of the request to createInboundPlan . | CreateInboundPlanRequest |
Responses
HTTP Code | Description | Schema |
---|---|---|
202 | CreateInboundPlan 202 response Headers : x-amzn-RequestId (string) : Unique request reference identifier. x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. | CreateInboundPlanResponse |
For error status codes, descriptions and schemas, see Error responses and schemas.
Consumes
application/json
Produces
application/json
Example HTTP request
Request body
{
"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 protected]",
"name" : "name",
"phoneNumber" : "1234567890",
"postalCode" : "M1M1M1",
"stateOrProvinceCode" : "ON"
}
}
GET /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}
Operation: getInboundPlan
Description
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.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path | inboundPlanId required | Identifier of an inbound plan. minLength : 38 maxLength : 38 | string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 | GetInboundPlan 200 response Headers : x-amzn-RequestId (string) : Unique request reference identifier. x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. | InboundPlan |
For error status codes, descriptions and schemas, see Error responses and schemas.
Produces
application/json
Example HTTP response
Response 200
{
"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 protected]",
"name" : "name",
"phoneNumber" : "1234567890",
"postalCode" : "M1M1M1",
"stateOrProvinceCode" : "ON"
},
"status" : "ACTIVE"
}
GET /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/boxes
Operation: listInboundPlanBoxes
Description
Provides a paginated list of box packages in 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.
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path | inboundPlanId required | Identifier of an inbound plan. minLength : 38 maxLength : 38 | string | - |
Query | pageSize optional | The number of boxes to return in the response matching the given query. Minimum : 1 Maximum : 1000 | integer | 10 |
Query | paginationToken optional | 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.minLength : 0 maxLength : 1024 | string | - |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 | ListInboundPlanBoxes 200 response Headers : x-amzn-RequestId (string) : Unique request reference identifier. x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. | ListInboundPlanBoxesResponse |
For error status codes, descriptions and schemas, see Error responses and schemas.
Produces
application/json
PUT /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/cancellation
Operation: cancelInboundPlan
Description
Cancels an Inbound Plan. Charges may apply if the cancellation is performed outside of a void window. The window for Amazon Partnered Carriers is 24 hours for Small Parcel Delivery (SPD) and one hour for Less-Than-Truckload (LTL) carrier shipments.
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.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path | inboundPlanId required | Identifier of an inbound plan. minLength : 38 maxLength : 38 | string |
Responses
HTTP Code | Description | Schema |
---|---|---|
202 | CancelInboundPlan 202 response Headers : x-amzn-RequestId (string) : Unique request reference identifier. x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. | CancelInboundPlanResponse |
For error status codes, descriptions and schemas, see Error responses and schemas.
Produces
application/json
GET /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/items
Operation: listInboundPlanItems
Description
Provides a paginated list of item packages in 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.
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path | inboundPlanId required | Identifier of an inbound plan. minLength : 38 maxLength : 38 | string | - |
Query | pageSize optional | The number of items to return in the response matching the given query. Minimum : 1 Maximum : 1000 | integer | 10 |
Query | paginationToken optional | 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.minLength : 0 maxLength : 1024 | string | - |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 | ListInboundPlanItems 200 response Headers : x-amzn-RequestId (string) : Unique request reference identifier. x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. | ListInboundPlanItemsResponse |
For error status codes, descriptions and schemas, see Error responses and schemas.
Produces
application/json
PUT /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/name
Operation: updateInboundPlanName
Description
Updates the name of an existing inbound plan.
Usage Plan:
Rate (requests per second) | Burst |
---|---|
2 | 30 |
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.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path | inboundPlanId required | Identifier of an inbound plan. minLength : 38 maxLength : 38 | string |
Body | body required | The body of the request to updateInboundPlanName . | UpdateInboundPlanNameRequest |
Responses
HTTP Code | Description | Schema |
---|---|---|
204 | UpdateInboundPlanName 204 response Headers : x-amzn-RequestId (string) : Unique request reference identifier. x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. | No Content |
For error status codes, descriptions and schemas, see Error responses and schemas.
Consumes
application/json
Produces
application/json
Example HTTP request
Request body
{
"name" : "name"
}
GET /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/packingGroups/{packingGroupId}/boxes
Operation: listPackingGroupBoxes
Description
Retrieves a page of boxes from a given packing group. These boxes were previously provided through the setPackingInformation
operation. This API is used for workflows where boxes are packed before Amazon determines shipment splits.
Usage Plan:
Rate (requests per second) | Burst |
---|---|
2 | 30 |
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.
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path | inboundPlanId required | Identifier of an inbound plan. minLength : 38 maxLength : 38 | string | - |
Path | packingGroupId required | Identifier of a packing group. minLength : 38 maxLength : 38 | string | - |
Query | pageSize optional | The number of packing group boxes to return in the response matching the given query. Minimum : 1 Maximum : 100 | integer | 10 |
Query | paginationToken optional | 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.minLength : 0 maxLength : 1024 | string | - |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 | ListPackingGroupBoxes 200 response Headers : x-amzn-RequestId (string) : Unique request reference identifier. x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. | ListPackingGroupBoxesResponse |
For error status codes, descriptions and schemas, see Error responses and schemas.
Produces
application/json
GET /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/packingGroups/{packingGroupId}/items
Operation: listPackingGroupItems
Description
Retrieves a page of items in a given packing group. Packing options must first be generated by the corresponding operation before packing group items can be listed.
Usage Plan:
Rate (requests per second) | Burst |
---|---|
2 | 30 |
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.
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path | inboundPlanId required | Identifier of an inbound plan. minLength : 38 maxLength : 38 | string | - |
Path | packingGroupId required | Identifier of a packing group. minLength : 38 maxLength : 38 | string | - |
Query | pageSize optional | The number of packing group items to return in the response matching the given query. Minimum : 1 Maximum : 100 | integer | 10 |
Query | paginationToken optional | 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.minLength : 0 maxLength : 1024 | string | - |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 | ListPackingGroupItems 200 response Headers : x-amzn-RequestId (string) : Unique request reference identifier. x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. | ListPackingGroupItemsResponse |
For error status codes, descriptions and schemas, see Error responses and schemas.
Produces
application/json
POST /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/packingInformation
Operation: setPackingInformation
Description
Sets packing information for an inbound plan. This should be called after an inbound plan is created to populate the box level information required for planning and transportation estimates.
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.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path | inboundPlanId required | Identifier of an inbound plan. minLength : 38 maxLength : 38 | string |
Body | body required | The body of the request to setPackingInformation . | SetPackingInformationRequest |
Responses
HTTP Code | Description | Schema |
---|---|---|
202 | SetPackingInformation 202 response Headers : x-amzn-RequestId (string) : Unique request reference identifier. x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. | SetPackingInformationResponse |
For error status codes, descriptions and schemas, see Error responses and schemas.
Consumes
application/json
Produces
application/json
Example HTTP request
Request body
{
"packageGroupings" : [ {
"boxes" : [ {
"contentInformationSource" : "BOX_CONTENT_PROVIDED",
"dimensions" : {
"height" : 5,
"length" : 3,
"unitOfMeasurement" : "CM",
"width" : 4
},
"items" : [ {
"expiration" : "2024-01-01",
"labelOwner" : "AMAZON",
"manufacturingLotCode" : "manufacturingLotCode",
"msku" : "Sunglasses",
"prepOwner" : "AMAZON",
"quantity" : 10
} ],
"quantity" : 2,
"weight" : {
"unit" : "KG",
"value" : 5.5
}
} ],
"packingGroupId" : "pg1234abcd-1234-abcd-5678-1234abcd5678",
"shipmentId" : "sh1234abcd-1234-abcd-5678-1234abcd5678"
} ]
}
GET /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/packingOptions
Operation: listPackingOptions
Description
Retrieves a list of all packing options for an inbound plan. Packing options must first be generated by the corresponding operation before becoming available.
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.
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path | inboundPlanId required | Identifier of an inbound plan. minLength : 38 maxLength : 38 | string | - |
Query | pageSize optional | The number of packing options to return in the response matching the given query. Minimum : 1 Maximum : 20 | integer | 10 |
Query | paginationToken optional | 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.minLength : 0 maxLength : 1024 | string | - |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 | ListPackingOptions 200 response Headers : x-amzn-RequestId (string) : Unique request reference identifier. x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. | ListPackingOptionsResponse |
For error status codes, descriptions and schemas, see Error responses and schemas.
Produces
application/json
POST /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/packingOptions
Operation: generatePackingOptions
Description
Generates available packing options for the inbound plan.
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.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path | inboundPlanId required | Identifier of an inbound plan. minLength : 38 maxLength : 38 | string |
Responses
HTTP Code | Description | Schema |
---|---|---|
202 | GeneratePackingOptions 202 response Headers : x-amzn-RequestId (string) : Unique request reference identifier. x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. | GeneratePackingOptionsResponse |
For error status codes, descriptions and schemas, see Error responses and schemas.
Produces
application/json
POST /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/packingOptions/{packingOptionId}/confirmation
Operation: confirmPackingOption
Description
Confirms the packing option for an inbound plan.
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.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path | inboundPlanId required | Identifier of an inbound plan. minLength : 38 maxLength : 38 | string |
Path | packingOptionId required | Identifier of a packing option. minLength : 38 maxLength : 38 | string |
Responses
HTTP Code | Description | Schema |
---|---|---|
202 | ConfirmPackingOption 202 response Headers : x-amzn-RequestId (string) : Unique request reference identifier. x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. | ConfirmPackingOptionResponse |
For error status codes, descriptions and schemas, see Error responses and schemas.
Produces
application/json
GET /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/pallets
Operation: listInboundPlanPallets
Description
Provides a paginated list of pallet packages in an inbound plan. An inbound plan will have pallets when the related details are provided after generating Less-Than-Truckload (LTL) carrier shipments.
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.
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path | inboundPlanId required | Identifier of an inbound plan. minLength : 38 maxLength : 38 | string | - |
Query | pageSize optional | The number of pallets to return in the response matching the given query. Minimum : 1 Maximum : 1000 | integer | 10 |
Query | paginationToken optional | 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.minLength : 0 maxLength : 1024 | string | - |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 | ListInboundPlanPallets 200 response Headers : x-amzn-RequestId (string) : Unique request reference identifier. x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. | ListInboundPlanPalletsResponse |
For error status codes, descriptions and schemas, see Error responses and schemas.
Produces
application/json
GET /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/placementOptions
Operation: listPlacementOptions
Description
Provides a list of all placement options for an inbound plan. Placement options must first be generated by the corresponding operation before becoming available.
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.
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path | inboundPlanId required | Identifier of an inbound plan. minLength : 38 maxLength : 38 | string | - |
Query | pageSize optional | The number of placement options to return in the response matching the given query. Minimum : 1 Maximum : 20 | integer | 10 |
Query | paginationToken optional | 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.minLength : 0 maxLength : 1024 | string | - |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 | ListPlacementOptions 200 response Headers : x-amzn-RequestId (string) : Unique request reference identifier. x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. | ListPlacementOptionsResponse |
For error status codes, descriptions and schemas, see Error responses and schemas.
Produces
application/json
POST /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/placementOptions
Operation: generatePlacementOptions
Description
Generates placement options for the inbound plan.
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.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path | inboundPlanId required | Identifier of an inbound plan. minLength : 38 maxLength : 38 | string |
Body | body required | The body of the request to generatePlacementOptions . | GeneratePlacementOptionsRequest |
Responses
HTTP Code | Description | Schema |
---|---|---|
202 | GeneratePlacementOptions 202 response Headers : x-amzn-RequestId (string) : Unique request reference identifier. x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. | GeneratePlacementOptionsResponse |
For error status codes, descriptions and schemas, see Error responses and schemas.
Consumes
application/json
Produces
application/json
Example HTTP request
Request body
{
"customPlacement" : [ {
"items" : [ {
"expiration" : "2024-01-01",
"labelOwner" : "AMAZON",
"manufacturingLotCode" : "manufacturingLotCode",
"msku" : "Sunglasses",
"prepOwner" : "AMAZON",
"quantity" : 10
} ],
"warehouseId" : "YYZ14"
} ]
}
POST /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/placementOptions/{placementOptionId}/confirmation
Operation: confirmPlacementOption
Description
Confirms the placement option for an inbound plan. Once confirmed, it cannot be changed for the Inbound Plan.
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.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path | inboundPlanId required | Identifier of an inbound plan. minLength : 38 maxLength : 38 | string |
Path | placementOptionId required | The identifier of a placement option. A placement option represents the shipment splits and destinations of SKUs. minLength : 38 maxLength : 38 | string |
Responses
HTTP Code | Description | Schema |
---|---|---|
202 | ConfirmPlacementOption 202 response Headers : x-amzn-RequestId (string) : Unique request reference identifier. x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. | ConfirmPlacementOptionResponse |
For error status codes, descriptions and schemas, see Error responses and schemas.
Produces
application/json
GET /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}
Operation: getShipment
Description
Provides the full details for a specific shipment within an inbound plan. The transportationOptionId
inside acceptedTransportationSelection
can be used to retrieve the transportation details for the shipment.
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.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path | inboundPlanId required | Identifier of an inbound plan. minLength : 38 maxLength : 38 | string |
Path | shipmentId required | Identifier of a shipment. A shipment contains the boxes and units being inbounded. minLength : 38 maxLength : 38 | string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 | GetShipment 200 response Headers : x-amzn-RequestId (string) : Unique request reference identifier. x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. | Shipment |
For error status codes, descriptions and schemas, see Error responses and schemas.
Produces
application/json
Example HTTP response
Response 200
{
"destination" : {
"destinationType" : "AMAZON_OPTIMIZED"
},
"freightInformation" : {
"declaredValue" : {
"amount" : 5.5,
"code" : "CAD"
},
"freightClass" : "FC_50"
},
"inboundPlanId" : "wf1234abcd-1234-abcd-5678-1234abcd5678",
"placementOptionId" : "pl1234abcd-1234-abcd-5678-1234abcd5678",
"selectedDeliveryWindow" : {
"availabilityType" : "AVAILABLE",
"deliveryWindowOptionId" : "dw1234abcd-1234-abcd-5678-1234abcd5678",
"editableUntil" : "2024-01-05T20:00:00.000Z",
"endDate" : "2024-01-05T20:00:00.000Z",
"startDate" : "2024-01-05T14:00:00.000Z"
},
"shipmentConfirmationId" : "shipmentConfirmationId",
"shipmentId" : "sh1234abcd-1234-abcd-5678-1234abcd5678",
"source" : {
"sourceType" : "SELLER_FACILITY"
}
}
GET /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/boxes
Operation: listShipmentBoxes
Description
Provides a paginated list of box packages in a shipment.
Usage Plan:
Rate (requests per second) | Burst |
---|---|
2 | 30 |
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.
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path | inboundPlanId required | Identifier of an inbound plan. minLength : 38 maxLength : 38 | string | - |
Path | shipmentId required | Identifier of a shipment. A shipment contains the boxes and units being inbounded. minLength : 38 maxLength : 38 | string | - |
Query | pageSize optional | The number of boxes to return in the response matching the given query. Minimum : 1 Maximum : 1000 | integer | 10 |
Query | paginationToken optional | 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.minLength : 0 maxLength : 1024 | string | - |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 | ListShipmentBoxes 200 response Headers : x-amzn-RequestId (string) : Unique request reference identifier. x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. | ListShipmentBoxesResponse |
For error status codes, descriptions and schemas, see Error responses and schemas.
Produces
application/json
GET /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/contentUpdatePreviews
Operation: listShipmentContentUpdatePreviews
Description
Retrieve a paginated list of shipment content update previews for a given shipment. The shipment content update preview is a summary of the requested shipment content changes along with the transportation cost implications of the change that can only be confirmed prior to the expiry date specified.
Usage Plan:
Rate (requests per second) | Burst |
---|---|
2 | 30 |
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.
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path | inboundPlanId required | Identifier of an inbound plan. minLength : 38 maxLength : 38 | string | - |
Path | shipmentId required | Identifier of a shipment. A shipment contains the boxes and units being inbounded. minLength : 38 maxLength : 38 | string | - |
Query | pageSize optional | The number of content update previews to return. Minimum : 1 Maximum : 20 | integer | 10 |
Query | paginationToken optional | 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.minLength : 0 maxLength : 1024 | string | - |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 | ListShipmentContentUpdatePreviews 200 response Headers : x-amzn-RequestId (string) : Unique request reference identifier. x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. | ListShipmentContentUpdatePreviewsResponse |
For error status codes, descriptions and schemas, see Error responses and schemas.
Produces
application/json
POST /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/contentUpdatePreviews
Operation: generateShipmentContentUpdatePreviews
Description
Generate a shipment content update preview given a set of intended boxes and/or items for a shipment with a confirmed carrier. The shipment content update preview will be viewable with the updated costs and contents prior to confirmation.
Usage Plan:
Rate (requests per second) | Burst |
---|---|
2 | 30 |
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.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path | inboundPlanId required | Identifier of an inbound plan. minLength : 38 maxLength : 38 | string |
Path | shipmentId required | Identifier of a shipment. A shipment contains the boxes and units being inbounded. minLength : 38 maxLength : 38 | string |
Body | body required | The body of the request to generateShipmentContentUpdatePreviews . | GenerateShipmentContentUpdatePreviewsRequest |
Responses
HTTP Code | Description | Schema |
---|---|---|
202 | GenerateShipmentContentUpdatePreviews 202 response Headers : x-amzn-RequestId (string) : Unique request reference identifier. x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. | GenerateShipmentContentUpdatePreviewsResponse |
For error status codes, descriptions and schemas, see Error responses and schemas.
Consumes
application/json
Produces
application/json
Example HTTP request
Request body
{
"boxes" : [ {
"contentInformationSource" : "BOX_CONTENT_PROVIDED",
"dimensions" : {
"height" : 5,
"length" : 3,
"unitOfMeasurement" : "CM",
"width" : 4
},
"items" : [ {
"expiration" : "2024-01-01",
"labelOwner" : "AMAZON",
"manufacturingLotCode" : "manufacturingLotCode",
"msku" : "Sunglasses",
"prepOwner" : "AMAZON",
"quantity" : 10
} ],
"packageId" : "pk1234abcd-1234-abcd-5678-1234abcd5678",
"quantity" : 2,
"weight" : {
"unit" : "KG",
"value" : 5.5
}
} ],
"items" : [ {
"expiration" : "2024-01-01",
"labelOwner" : "AMAZON",
"manufacturingLotCode" : "manufacturingLotCode",
"msku" : "Sunglasses",
"prepOwner" : "AMAZON",
"quantity" : 10
} ]
}
GET /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/contentUpdatePreviews/{contentUpdatePreviewId}
Operation: getShipmentContentUpdatePreview
Description
Retrieve a shipment content update preview which provides a summary of the requested shipment content changes along with the transportation cost implications of the change that can only be confirmed prior to the expiry date specified.
Usage Plan:
Rate (requests per second) | Burst |
---|---|
2 | 30 |
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.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path | inboundPlanId required | Identifier of an inbound plan. minLength : 38 maxLength : 38 | string |
Path | shipmentId required | Identifier of a shipment. A shipment contains the boxes and units being inbounded. minLength : 38 maxLength : 38 | string |
Path | contentUpdatePreviewId required | Identifier of a content update preview. minLength : 38 maxLength : 38 | string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 | GetShipmentContentUpdatePreview 200 response Headers : x-amzn-RequestId (string) : Unique request reference identifier. x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. | ContentUpdatePreview |
For error status codes, descriptions and schemas, see Error responses and schemas.
Produces
application/json
POST /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/contentUpdatePreviews/{contentUpdatePreviewId}/confirmation
Operation: confirmShipmentContentUpdatePreview
Description
Confirm a shipment content update preview and accept the changes in transportation cost.
Usage Plan:
Rate (requests per second) | Burst |
---|---|
2 | 30 |
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.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path | inboundPlanId required | Identifier of an inbound plan. minLength : 38 maxLength : 38 | string |
Path | shipmentId required | Identifier of a shipment. A shipment contains the boxes and units being inbounded. minLength : 38 maxLength : 38 | string |
Path | contentUpdatePreviewId required | Identifier of a content update preview. minLength : 38 maxLength : 38 | string |
Responses
HTTP Code | Description | Schema |
---|---|---|
202 | ConfirmShipmentContentUpdatePreview 202 response Headers : x-amzn-RequestId (string) : Unique request reference identifier. x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. | ConfirmShipmentContentUpdatePreviewResponse |
For error status codes, descriptions and schemas, see Error responses and schemas.
Produces
application/json
GET /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/deliveryChallanDocument
Operation: getDeliveryChallanDocument
Description
Provide delivery challan document for PCP transportation in IN marketplace.
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.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path | inboundPlanId required | Identifier of an inbound plan. minLength : 38 maxLength : 38 | string |
Path | shipmentId required | Identifier of a shipment. A shipment contains the boxes and units being inbounded. minLength : 38 maxLength : 38 | string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 | GetDeliveryChallanDocument 200 response Headers : x-amzn-RequestId (string) : Unique request reference identifier. x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. | GetDeliveryChallanDocumentResponse |
For error status codes, descriptions and schemas, see Error responses and schemas.
Produces
application/json
GET /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/deliveryWindowOptions
Operation: listDeliveryWindowOptions
Description
Retrieves all delivery window options for a shipment. Delivery window options must first be generated by the generateDeliveryWindowOptions
operation before becoming available.
Usage Plan:
Rate (requests per second) | Burst |
---|---|
2 | 30 |
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.
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path | inboundPlanId required | Identifier of an inbound plan. minLength : 38 maxLength : 38 | string | - |
Path | shipmentId required | The shipment to get delivery window options for. minLength : 38 maxLength : 38 | string | - |
Query | pageSize optional | The number of delivery window options to return in the response matching the given query. Minimum : 1 Maximum : 100 | integer | 10 |
Query | paginationToken optional | 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.minLength : 0 maxLength : 1024 | string | - |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 | ListDeliveryWindowOptions 200 response Headers : x-amzn-RequestId (string) : Unique request reference identifier. x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. | ListDeliveryWindowOptionsResponse |
For error status codes, descriptions and schemas, see Error responses and schemas.
Produces
application/json
POST /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/deliveryWindowOptions
Operation: generateDeliveryWindowOptions
Description
Generates available delivery window options for a given shipment.
Usage Plan:
Rate (requests per second) | Burst |
---|---|
2 | 30 |
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.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path | inboundPlanId required | Identifier of an inbound plan. minLength : 38 maxLength : 38 | string |
Path | shipmentId required | The shipment to generate delivery window options for. minLength : 38 maxLength : 38 | string |
Responses
HTTP Code | Description | Schema |
---|---|---|
202 | GenerateDeliveryWindowOptions 202 response Headers : x-amzn-RequestId (string) : Unique request reference identifier. x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. | GenerateDeliveryWindowOptionsResponse |
For error status codes, descriptions and schemas, see Error responses and schemas.
Produces
application/json
POST /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/deliveryWindowOptions/{deliveryWindowOptionId}/confirmation
Operation: confirmDeliveryWindowOptions
Description
Confirms the delivery window option for chosen shipment within an inbound plan. A placement option must be confirmed prior to use of this API. Once confirmed, new delivery window options cannot be generated, but the chosen delivery window option can be updated before shipment closure. The window is used to provide the expected time when a shipment will arrive at the warehouse. All transportation options which have the program CONFIRMED_DELIVERY_WINDOW
require a delivery window to be confirmed prior to transportation option confirmation.
Usage Plan:
Rate (requests per second) | Burst |
---|---|
2 | 30 |
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.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path | inboundPlanId required | Identifier of an inbound plan. minLength : 38 maxLength : 38 | string |
Path | shipmentId required | The shipment to confirm the delivery window option for. minLength : 38 maxLength : 38 | string |
Path | deliveryWindowOptionId required | The id of the delivery window option to be confirmed. minLength : 36 maxLength : 38 | string |
Responses
HTTP Code | Description | Schema |
---|---|---|
202 | ConfirmDeliveryWindowOptions 202 response Headers : x-amzn-RequestId (string) : Unique request reference identifier. x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. | ConfirmDeliveryWindowOptionsResponse |
For error status codes, descriptions and schemas, see Error responses and schemas.
Produces
application/json
Example HTTP response
Response 202
{
"operationId" : "1234abcd-1234-abcd-5678-1234abcd5678"
}
GET /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/items
Operation: listShipmentItems
Description
Provides a paginated list of item packages in a shipment.
Usage Plan:
Rate (requests per second) | Burst |
---|---|
2 | 30 |
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.
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path | inboundPlanId required | Identifier of an inbound plan. minLength : 38 maxLength : 38 | string | - |
Path | shipmentId required | Identifier of a shipment. A shipment contains the boxes and units being inbounded. minLength : 38 maxLength : 38 | string | - |
Query | pageSize optional | The number of items to return in the response matching the given query. Minimum : 1 Maximum : 1000 | integer | 10 |
Query | paginationToken optional | 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.minLength : 0 maxLength : 1024 | string | - |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 | ListShipmentItems 200 response Headers : x-amzn-RequestId (string) : Unique request reference identifier. x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. | ListShipmentItemsResponse |
For error status codes, descriptions and schemas, see Error responses and schemas.
Produces
application/json
PUT /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/name
Operation: updateShipmentName
Description
Updates the name of an existing shipment.
Usage Plan:
Rate (requests per second) | Burst |
---|---|
2 | 30 |
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.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path | inboundPlanId required | Identifier of an inbound plan. minLength : 38 maxLength : 38 | string |
Path | shipmentId required | Identifier of a shipment. A shipment contains the boxes and units being inbounded. minLength : 38 maxLength : 38 | string |
Body | body required | The body of the request to updateShipmentName . | UpdateShipmentNameRequest |
Responses
HTTP Code | Description | Schema |
---|---|---|
204 | UpdateShipmentName 204 response Headers : x-amzn-RequestId (string) : Unique request reference identifier. x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. | No Content |
For error status codes, descriptions and schemas, see Error responses and schemas.
Consumes
application/json
Produces
application/json
Example HTTP request
Request body
{
"name" : "name"
}
GET /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/pallets
Operation: listShipmentPallets
Description
Provides a paginated list of pallet packages in a shipment. A palletized shipment will have pallets when the related details are provided after generating Less-Than-Truckload (LTL) carrier shipments.
Usage Plan:
Rate (requests per second) | Burst |
---|---|
2 | 30 |
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.
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path | inboundPlanId required | Identifier of an inbound plan. minLength : 38 maxLength : 38 | string | - |
Path | shipmentId required | Identifier of a shipment. A shipment contains the boxes and units being inbounded. minLength : 38 maxLength : 38 | string | - |
Query | pageSize optional | The number of pallets to return in the response matching the given query. Minimum : 1 Maximum : 1000 | integer | 10 |
Query | paginationToken optional | 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.minLength : 0 maxLength : 1024 | string | - |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 | ListShipmentPallets 200 response Headers : x-amzn-RequestId (string) : Unique request reference identifier. x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. | ListShipmentPalletsResponse |
For error status codes, descriptions and schemas, see Error responses and schemas.
Produces
application/json
PUT /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/selfShipAppointmentCancellation
Operation: cancelSelfShipAppointment
Description
Cancels a self-ship appointment slot against a shipment.
Usage Plan:
Rate (requests per second) | Burst |
---|---|
2 | 30 |
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.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path | inboundPlanId required | Identifier of an inbound plan. minLength : 38 maxLength : 38 | string |
Path | shipmentId required | Identifier of a shipment. A shipment contains the boxes and units being inbounded. minLength : 38 maxLength : 38 | string |
Body | body required | The body of the request to cancelSelfShipAppointment . | CancelSelfShipAppointmentRequest |
Responses
HTTP Code | Description | Schema |
---|---|---|
202 | CancelSelfShipAppointment 202 response Headers : x-amzn-RequestId (string) : Unique request reference identifier. x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. | CancelSelfShipAppointmentResponse |
For error status codes, descriptions and schemas, see Error responses and schemas.
Consumes
application/json
Produces
application/json
Example HTTP request
Request body
{
"reasonComment" : "OTHER"
}
GET /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/selfShipAppointmentSlots
Operation: getSelfShipAppointmentSlots
Description
Retrieves a list of available self-ship appointment slots used to drop off a shipment at a warehouse.
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.
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path | inboundPlanId required | Identifier of an inbound plan. minLength : 38 maxLength : 38 | string | - |
Path | shipmentId required | Identifier of a shipment. A shipment contains the boxes and units being inbounded. minLength : 38 maxLength : 38 | string | - |
Query | pageSize optional | The number of self ship appointment slots to return in the response matching the given query. Minimum : 1 Maximum : 100 | integer | 10 |
Query | paginationToken optional | 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.minLength : 0 maxLength : 1024 | string | - |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 | GetSelfShipAppointmentSlots 200 response Headers : x-amzn-RequestId (string) : Unique request reference identifier. x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. | GetSelfShipAppointmentSlotsResponse |
For error status codes, descriptions and schemas, see Error responses and schemas.
Produces
application/json
POST /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/selfShipAppointmentSlots
Operation: generateSelfShipAppointmentSlots
Description
Initiates the process of generating the appointment slots list.
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.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path | inboundPlanId required | Identifier of an inbound plan. minLength : 38 maxLength : 38 | string |
Path | shipmentId required | Identifier of a shipment. A shipment contains the boxes and units being inbounded. minLength : 38 maxLength : 38 | string |
Body | body required | The body of the request to generateSelfShipAppointmentSlots . | GenerateSelfShipAppointmentSlotsRequest |
Responses
HTTP Code | Description | Schema |
---|---|---|
201 | GenerateSelfShipAppointmentSlots 201 response Headers : x-amzn-RequestId (string) : Unique request reference identifier. x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. | GenerateSelfShipAppointmentSlotsResponse |
For error status codes, descriptions and schemas, see Error responses and schemas.
Consumes
application/json
Produces
application/json
Example HTTP request
Request body
{
"desiredEndDate" : "2024-01-06T14:48:00.000Z",
"desiredStartDate" : "2024-01-05T14:48:00.000Z"
}
POST /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/selfShipAppointmentSlots/{slotId}/schedule
Operation: scheduleSelfShipAppointment
Description
Confirms or reschedules a self-ship appointment slot against a shipment.
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.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path | inboundPlanId required | Identifier of an inbound plan. minLength : 38 maxLength : 38 | string |
Path | shipmentId required | Identifier of a shipment. A shipment contains the boxes and units being inbounded. minLength : 38 maxLength : 38 | string |
Path | slotId required | An identifier to a self-ship appointment slot. minLength : 38 maxLength : 38 | string |
Body | body required | The body of the request to scheduleSelfShipAppointment . | ScheduleSelfShipAppointmentRequest |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 | ScheduleSelfShipAppointment 200 response Headers : x-amzn-RequestId (string) : Unique request reference identifier. x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. | ScheduleSelfShipAppointmentResponse |
For error status codes, descriptions and schemas, see Error responses and schemas.
Consumes
application/json
Produces
application/json
Example HTTP request
Request body
{
"reasonComment" : "OTHER"
}
Example HTTP response
Response 200
{
"selfShipAppointmentDetails" : {
"appointmentId" : 1000,
"appointmentSlotTime" : {
"endTime" : "2023-03-09T13:15:30Z",
"startTime" : "2023-03-08T13:15:30Z"
},
"appointmentStatus" : "ARRIVAL_SCHEDULED"
}
}
PUT /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/sourceAddress
Operation: updateShipmentSourceAddress
Description
Updates the source address of an existing shipment. The shipment source address can only be updated prior to the confirmation of the shipment carriers. As a result of the updated source address, existing transportation options will be invalidated and will need to be regenerated to capture the potential difference in transportation options and quotes due to the new source address.
Usage Plan:
Rate (requests per second) | Burst |
---|---|
2 | 30 |
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.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path | inboundPlanId required | Identifier of an inbound plan. minLength : 38 maxLength : 38 | string |
Path | shipmentId required | Identifier of a shipment. A shipment contains the boxes and units being inbounded. minLength : 38 maxLength : 38 | string |
Body | body required | The body of the request to updateShipmentSourceAddress . | UpdateShipmentSourceAddressRequest |
Responses
HTTP Code | Description | Schema |
---|---|---|
202 | UpdateShipmentSourceAddress 202 response Headers : x-amzn-RequestId (string) : Unique request reference identifier. x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. | UpdateShipmentSourceAddressResponse |
For error status codes, descriptions and schemas, see Error responses and schemas.
Consumes
application/json
Produces
application/json
Example HTTP request
Request body
{
"address" : {
"addressLine1" : "123 example street",
"addressLine2" : "Floor 19",
"city" : "Toronto",
"companyName" : "Acme",
"countryCode" : "CA",
"email" : "[email protected]",
"name" : "name",
"phoneNumber" : "1234567890",
"postalCode" : "M1M1M1",
"stateOrProvinceCode" : "ON"
}
}
PUT /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/trackingDetails
Operation: updateShipmentTrackingDetails
Description
Updates a shipment's tracking details.
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.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path | inboundPlanId required | Identifier of an inbound plan. minLength : 38 maxLength : 38 | string |
Path | shipmentId required | Identifier of a shipment. A shipment contains the boxes and units being inbounded. minLength : 38 maxLength : 38 | string |
Body | body required | The body of the request to updateShipmentTrackingDetails . | UpdateShipmentTrackingDetailsRequest |
Responses
HTTP Code | Description | Schema |
---|---|---|
202 | UpdateShipmentTrackingDetails 202 response Headers : x-amzn-RequestId (string) : Unique request reference identifier. x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. | UpdateShipmentTrackingDetailsResponse |
For error status codes, descriptions and schemas, see Error responses and schemas.
Consumes
application/json
Produces
application/json
Example HTTP request
Request body
{
"trackingDetails" : {
"spdTrackingDetail" : {
"spdTrackingItems" : [ {
"boxId" : "FBA10ABC0YY100001",
"trackingId" : "FBA10002000"
} ]
}
}
}
GET /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/transportationOptions
Operation: listTransportationOptions
Description
Retrieves all transportation options for a shipment. Transportation options must first be generated by the generateTransportationOptions
operation before becoming available.
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.
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path | inboundPlanId required | Identifier of an inbound plan. minLength : 38 maxLength : 38 | string | - |
Query | pageSize optional | The number of transportation options to return in the response matching the given query. Minimum : 1 Maximum : 20 | integer | 10 |
Query | paginationToken optional | 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.minLength : 0 maxLength : 1024 | string | - |
Query | placementOptionId optional | The placement option to get transportation options for. Either placementOptionId or shipmentId must be specified.minLength : 38 maxLength : 38 | string | - |
Query | shipmentId optional | The shipment to get transportation options for. Either placementOptionId or shipmentId must be specified.minLength : 38 maxLength : 38 | string | - |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 | ListTransportationOptions 200 response Headers : x-amzn-RequestId (string) : Unique request reference identifier. x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. | ListTransportationOptionsResponse |
For error status codes, descriptions and schemas, see Error responses and schemas.
Produces
application/json
POST /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/transportationOptions
Operation: generateTransportationOptions
Description
Generates available transportation options for a given placement option.
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.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path | inboundPlanId required | Identifier of an inbound plan. minLength : 38 maxLength : 38 | string |
Body | body required | The body of the request to generateTransportationOptions . | GenerateTransportationOptionsRequest |
Responses
HTTP Code | Description | Schema |
---|---|---|
202 | GenerateTransportationOptions 202 response Headers : x-amzn-RequestId (string) : Unique request reference identifier. x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. | GenerateTransportationOptionsResponse |
For error status codes, descriptions and schemas, see Error responses and schemas.
Consumes
application/json
Produces
application/json
Example HTTP request
Request body
{
"placementOptionId" : "pl1234abcd-1234-abcd-5678-1234abcd5678",
"shipmentTransportationConfigurations" : [ {
"contactInformation" : {
"email" : "[email protected]",
"name" : "John Smithy",
"phoneNumber" : "1234567890"
},
"freightInformation" : {
"declaredValue" : {
"amount" : 5.5,
"code" : "CAD"
},
"freightClass" : "FC_50"
},
"pallets" : [ {
"dimensions" : {
"height" : 5,
"length" : 3,
"unitOfMeasurement" : "CM",
"width" : 4
},
"quantity" : 2,
"stackability" : "STACKABLE",
"weight" : {
"unit" : "KG",
"value" : 5.5
}
} ],
"readyToShipWindow" : {
"start" : "2024-01-01T00:00Z"
},
"shipmentId" : "sh1234abcd-1234-abcd-5678-1234abcd5678"
} ]
}
POST /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/transportationOptions/confirmation
Operation: confirmTransportationOptions
Description
Confirms all the transportation options for an inbound plan. A placement option must be confirmed prior to use of this API. Once confirmed, new transportation options can not be generated or confirmed for the Inbound Plan.
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.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path | inboundPlanId required | Identifier of an inbound plan. minLength : 38 maxLength : 38 | string |
Body | body required | The body of the request to confirmTransportationOptions . | ConfirmTransportationOptionsRequest |
Responses
HTTP Code | Description | Schema |
---|---|---|
202 | ConfirmTransportationOptions 202 response Headers : x-amzn-RequestId (string) : Unique request reference identifier. x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. | ConfirmTransportationOptionsResponse |
For error status codes, descriptions and schemas, see Error responses and schemas.
Consumes
application/json
Produces
application/json
Example HTTP request
Request body
{
"transportationSelections" : [ {
"contactInformation" : {
"email" : "[email protected]",
"name" : "John Smithy",
"phoneNumber" : "1234567890"
},
"deliveryWindow" : {
"start" : "2024-01-01T00:00Z"
},
"shipmentId" : "sh1234abcd-1234-abcd-5678-1234abcd5678",
"transportationOptionId" : "to1234abcd-1234-abcd-5678-1234abcd5678"
} ]
}
GET /inbound/fba/2024-03-20/items/compliance
Operation: listItemComplianceDetails
Description
List the inbound compliance details for MSKUs in a given marketplace.
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.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query | mskus required | A list of merchant SKUs, a merchant-supplied identifier of a specific SKU. Min count : 1 Max count : 100 | < string > array(multi) |
Query | marketplaceId required | The Marketplace ID. For a list of possible values, refer to Marketplace IDs. minLength : 1 maxLength : 20 | string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 | ListItemComplianceDetails 200 response Headers : x-amzn-RequestId (string) : Unique request reference identifier. x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. | ListItemComplianceDetailsResponse |
For error status codes, descriptions and schemas, see Error responses and schemas.
Produces
application/json
PUT /inbound/fba/2024-03-20/items/compliance
Operation: updateItemComplianceDetails
Description
Update compliance details for a list of MSKUs. The details provided here are only used for the India (IN - A21TJRUUN4KGV) marketplace compliance validation.
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.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query | marketplaceId required | The Marketplace ID. For a list of possible values, refer to Marketplace IDs. minLength : 1 maxLength : 20 | string |
Body | body required | The body of the request to updateItemComplianceDetails . | UpdateItemComplianceDetailsRequest |
Responses
HTTP Code | Description | Schema |
---|---|---|
202 | UpdateItemComplianceDetails 202 response Headers : x-amzn-RequestId (string) : Unique request reference identifier. x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. | UpdateItemComplianceDetailsResponse |
For error status codes, descriptions and schemas, see Error responses and schemas.
Consumes
application/json
Produces
application/json
Example HTTP request
Request body
{
"msku" : "Sunglasses",
"taxDetails" : {
"declaredValue" : {
"amount" : 5.5,
"code" : "CAD"
},
"hsnCode" : "hsnCode"
}
}
POST /inbound/fba/2024-03-20/items/labels
Operation: createMarketplaceItemLabels
Description
For a given marketplace - creates labels for a list of MSKUs.
Usage Plan:
Rate (requests per second) | Burst |
---|---|
2 | 30 |
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.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body | body required | The body of the request to createMarketplaceItemLabels . | CreateMarketplaceItemLabelsRequest |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 | CreateMarketplaceItemLabels 200 response Headers : x-amzn-RequestId (string) : Unique request reference identifier. x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. | CreateMarketplaceItemLabelsResponse |
For error status codes, descriptions and schemas, see Error responses and schemas.
Consumes
application/json
Produces
application/json
Example HTTP request
Request body
{
"height" : 25,
"labelType" : "STANDARD_FORMAT",
"localeCode" : "en_US",
"marketplaceId" : "A2EUQ1WTGCTBG2",
"mskuQuantities" : [ {
"msku" : "msku",
"quantity" : 5
} ],
"pageType" : "A4_21",
"width" : 100
}
GET /inbound/fba/2024-03-20/items/prepDetails
Operation: listPrepDetails
Description
Get preparation details for a list of MSKUs in a specified marketplace.
Usage Plan:
Rate (requests per second) | Burst |
---|---|
2 | 30 |
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.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query | marketplaceId required | The marketplace ID. For a list of possible values, refer to Marketplace IDs. minLength : 1 maxLength : 20 | string |
Query | mskus required | A list of merchant SKUs, a merchant-supplied identifier of a specific SKU. Min count : 1 Max count : 100 | < string > array(multi) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 | ListPrepDetails 200 response Headers : x-amzn-RequestId (string) : Unique request reference identifier. x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. | ListPrepDetailsResponse |
For error status codes, descriptions and schemas, see Error responses and schemas.
Produces
application/json
POST /inbound/fba/2024-03-20/items/prepDetails
Operation: setPrepDetails
Description
Set the preparation details for a list of MSKUs in a specified marketplace.
Usage Plan:
Rate (requests per second) | Burst |
---|---|
2 | 30 |
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.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body | body required | The body of the request to setPrepDetails . | SetPrepDetailsRequest |
Responses
HTTP Code | Description | Schema |
---|---|---|
202 | SetPrepDetails 202 response Headers : x-amzn-RequestId (string) : Unique request reference identifier. x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. | SetPrepDetailsResponse |
For error status codes, descriptions and schemas, see Error responses and schemas.
Consumes
application/json
Produces
application/json
Example HTTP request
Request body
{
"marketplaceId" : "A2EUQ1WTGCTBG2",
"mskuPrepDetails" : [ {
"msku" : "msku",
"prepCategory" : "NONE",
"prepTypes" : [ "ITEM_NO_PREP" ]
} ]
}
GET /inbound/fba/2024-03-20/operations/{operationId}
Operation: getInboundOperationStatus
Description
Gets the status of the processing of an asynchronous API call.
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.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path | operationId required | Identifier of an asynchronous operation. minLength : 36 maxLength : 38 | string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 | GetInboundOperationStatus 200 response Headers : x-amzn-RequestId (string) : Unique request reference identifier. x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. | InboundOperationStatus |
For error status codes, descriptions and schemas, see Error responses and schemas.
Produces
application/json
Error Responses and Schemas
This table contains HTTP status codes and associated information for error responses.
HTTP Code | Description | Schema |
---|---|---|
400 | Request has missing or invalid parameters and cannot be parsed. Headers: x-amzn-RequestId (string):Unique request reference identifier. x-amzn-RateLimit-Limit (string):Your rate limit (requests per second) for this operation. | ErrorList |
403 | Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature. Headers: x-amzn-RequestId (string):Unique request reference identifier. | ErrorList |
404 | The resource specified does not exist. Headers: x-amzn-RequestId (string):Unique request reference identifier. x-amzn-RateLimit-Limit (string):Your rate limit (requests per second) for this operation. | ErrorList |
413 | The request size exceeded the maximum accepted size. Headers: x-amzn-RequestId (string):Unique request reference identifier. | ErrorList |
415 | The request payload is in an unsupported format. Headers: x-amzn-RequestId (string):Unique request reference identifier. | ErrorList |
429 | The frequency of requests was greater than allowed. Headers: x-amzn-RequestId (string):Unique request reference identifier. | ErrorList |
500 | An unexpected condition occurred that prevented the server from fulfilling the request. Headers: x-amzn-RequestId (string):Unique request reference identifier. | ErrorList |
503 | Temporary overloading or maintenance of the server. Headers: x-amzn-RequestId (string):Unique request reference identifier. | ErrorList |
Definitions
Address
Specific details to identify a place.
Name | Description | Schema |
---|---|---|
addressLine1 required | Street address information. minLength : 1 maxLength : 180 | string |
addressLine2 optional | Additional street address information. minLength : 1 maxLength : 60 | string |
city required | The city. minLength : 1 maxLength : 30 | string |
companyName optional | The name of the business. minLength : 1 maxLength : 50 | string |
countryCode required | The country code in two-character ISO 3166-1 alpha-2 format. minLength : 2 maxLength : 2 Pattern : "^[A-Z]{2}$" | string |
email optional | The email address. minLength : 1 maxLength : 1024 | string |
name required | The name of the individual who is the primary contact. minLength : 1 maxLength : 50 | string |
phoneNumber optional | The phone number. minLength : 1 maxLength : 20 | string |
postalCode required | The postal code. minLength : 1 maxLength : 32 | string |
stateOrProvinceCode optional | The state or province code. minLength : 1 maxLength : 64 | string |
AddressInput
Specific details to identify a place.
Name | Description | Schema |
---|---|---|
addressLine1 required | Street address information. minLength : 1 maxLength : 180 | string |
addressLine2 optional | Additional street address information. minLength : 1 maxLength : 60 | string |
city required | The city. minLength : 1 maxLength : 30 | string |
companyName optional | The name of the business. minLength : 1 maxLength : 50 | string |
countryCode required | The country code in two-character ISO 3166-1 alpha-2 format. minLength : 2 maxLength : 2 Pattern : "^[A-Z]{2}$" | string |
email optional | The email address. minLength : 1 maxLength : 1024 | string |
name required | The name of the individual who is the primary contact. minLength : 1 maxLength : 50 | string |
phoneNumber required | The phone number. minLength : 1 maxLength : 20 | string |
postalCode required | The postal code. minLength : 1 maxLength : 32 | string |
stateOrProvinceCode optional | The state or province code. minLength : 1 maxLength : 64 | string |
AllOwnersConstraint
A constraint that applies to all owners. If no constraint is specified, defer to any individual owner constraints.
Type : enum
Value | Description |
---|---|
MUST_MATCH | All owners must match. |
AppointmentSlot
The fulfillment center appointment slot for the transportation option.
Name | Description | Schema |
---|---|---|
slotId required | An identifier to a self-ship appointment slot. minLength : 38 maxLength : 38 Pattern : "^[a-zA-Z0-9-]*$" | string |
slotTime required | An appointment slot time with start and end. | AppointmentSlotTime |
AppointmentSlotTime
An appointment slot time with start and end.
Name | Description | Schema |
---|---|---|
endTime required | The end timestamp of the appointment in UTC. | string (date-time) |
startTime required | The start timestamp of the appointment in UTC. | string (date-time) |
Box
Contains information about a box that is used in the inbound plan. The box is a container that holds multiple items.
Name | Description | Schema |
---|---|---|
boxId optional | The ID provided by Amazon that identifies a given box. This ID is comprised of the external shipment ID (which is generated after transportation has been confirmed) and the index of the box. minLength : 1 maxLength : 1024 | string |
contentInformationSource optional | Indication of how box content is meant to be provided. | BoxContentInformationSource |
destinationRegion optional | Representation of a location used within the inbounding experience. | Region |
dimensions optional | Measurement of a package's dimensions. | Dimensions |
items optional | Items contained within the box. | < Item > array |
packageId required | Primary key to uniquely identify a Package (Box or Pallet). minLength : 38 maxLength : 38 Pattern : "^[a-zA-Z0-9-]*$" | string |
quantity optional | The number of containers where all other properties like weight or dimensions are identical. Minimum value : 1 Maximum value : 10000 | integer |
templateName optional | Template name of the box. minLength : 1 maxLength : 1024 | string |
weight optional | The weight of a package. | Weight |
BoxContentInformationSource
Indication of how box content is meant to be provided.
Type : enum
Value | Description |
---|---|
BOX_CONTENT_PROVIDED | Box contents have been provided by the seller. |
MANUAL_PROCESS | Box contents will be manually processed during receive. This service incurs charges. |
BARCODE_2D | Box contents information is provided by a barcode on the shipment. For more information, refer to Using 2D barcodes for box content information on Seller Central. |
BoxInput
Input information for a given box.
Name | Description | Schema |
---|---|---|
contentInformationSource required | Indication of how box content is meant to be provided. | BoxContentInformationSource |
dimensions required | Measurement of a package's dimensions. | Dimensions |
items optional | The items and their quantity in the box. This must be empty if the box contentInformationSource is BARCODE_2D or MANUAL_PROCESS . | < ItemInput > array |
quantity required | The number of containers where all other properties like weight or dimensions are identical. Minimum value : 1 Maximum value : 10000 | integer |
weight required | The weight of a package. | Weight |
BoxUpdateInput
Input information for updating a box
Name | Description | Schema |
---|---|---|
contentInformationSource required | Indication of how box content is meant to be provided. | BoxContentInformationSource |
dimensions required | Measurement of a package's dimensions. | Dimensions |
items optional | The items and their quantity in the box. This must be empty if the box contentInformationSource is BARCODE_2D or MANUAL_PROCESS . | < ItemInput > array |
packageId optional | Primary key to uniquely identify a Box Package. PackageId must be provided if the intent is to update an existing box. Adding a new box will not require providing this value. Any existing PackageIds not provided will be treated as to-be-removed minLength : 38 maxLength : 38 Pattern : "^[a-zA-Z0-9-]*$" | string |
quantity required | The number of containers where all other properties like weight or dimensions are identical. Minimum value : 1 Maximum value : 10000 | integer |
weight required | The weight of a package. | Weight |
CancelInboundPlanResponse
The cancelInboundPlan
response.
Name | Description | Schema |
---|---|---|
operationId required | UUID for the given operation. minLength : 36 maxLength : 38 Pattern : "^[a-zA-Z0-9-]*$" | string |
CancelSelfShipAppointmentRequest
The cancelSelfShipAppointment
request.
Name | Description | Schema |
---|---|---|
reasonComment optional | Reason for cancelling or rescheduling a self-ship appointment. | ReasonComment |
CancelSelfShipAppointmentResponse
The CancelSelfShipAppointment
response.
Name | Description | Schema |
---|---|---|
operationId required | UUID for the given operation. minLength : 36 maxLength : 38 Pattern : "^[a-zA-Z0-9-]*$" | string |
Carrier
The carrier for the inbound shipment.
Name | Description | Schema |
---|---|---|
alphaCode optional | The carrier code. For example, USPS or DHLEX. minLength : 1 maxLength : 1024 | string |
name optional | The name of the carrier. minLength : 1 maxLength : 1024 | string |
CarrierAppointment
Contains details for a transportation carrier appointment. This appointment is vended out by Amazon and is an indicator for when a transportation carrier is accepting shipments to be picked up.
Name | Description | Schema |
---|---|---|
endTime required | The end timestamp of the appointment in UTC. | string (date-time) |
startTime required | The start timestamp of the appointment in UTC. | string (date-time) |
ComplianceDetail
Contains item identifiers and related tax information.
Name | Description | Schema |
---|---|---|
asin optional | The Amazon Standard Identification Number, which identifies the detail page identifier. minLength : 1 maxLength : 10 | string |
fnsku optional | The Fulfillment Network SKU, which identifies a real fulfillable item with catalog data and condition. minLength : 1 maxLength : 10 | string |
msku optional | The merchant SKU, a merchant-supplied identifier for a specific SKU. minLength : 1 maxLength : 40 | string |
taxDetails optional | Information used to determine the tax compliance. | TaxDetails |
ConfirmDeliveryWindowOptionsResponse
The confirmDeliveryWindowOptions
response.
Name | Description | Schema |
---|---|---|
operationId required | UUID for the given operation. minLength : 36 maxLength : 38 Pattern : "^[a-zA-Z0-9-]*$" | string |
ConfirmPackingOptionResponse
The confirmPackingOption
response.
Name | Description | Schema |
---|---|---|
operationId required | UUID for the given operation. minLength : 36 maxLength : 38 Pattern : "^[a-zA-Z0-9-]*$" | string |
ConfirmPlacementOptionResponse
The confirmPlacementOption
response.
Name | Description | Schema |
---|---|---|
operationId required | UUID for the given operation. minLength : 36 maxLength : 38 Pattern : "^[a-zA-Z0-9-]*$" | string |
ConfirmShipmentContentUpdatePreviewResponse
The confirmShipmentContentUpdatePreview
response.
Name | Description | Schema |
---|---|---|
operationId required | UUID for the given operation. minLength : 36 maxLength : 38 Pattern : "^[a-zA-Z0-9-]*$" | string |
ConfirmTransportationOptionsRequest
The confirmTransportationOptions
request.
Name | Description | Schema |
---|---|---|
transportationSelections required | Information needed to confirm one of the available transportation options. | < TransportationSelection > array |
ConfirmTransportationOptionsResponse
The confirmTransportationOptions
response.
Name | Description | Schema |
---|---|---|
operationId required | UUID for the given operation. minLength : 36 maxLength : 38 Pattern : "^[a-zA-Z0-9-]*$" | string |
ContactInformation
The seller's contact information.
Name | Description | Schema |
---|---|---|
email optional | The email address. minLength : 1 maxLength : 1024 | string |
name required | The contact's name. minLength : 1 maxLength : 50 | string |
phoneNumber required | The phone number. minLength : 1 maxLength : 20 | string |
ContentUpdatePreview
Preview of the changes that will be applied to the shipment.
Name | Description | Schema |
---|---|---|
contentUpdatePreviewId required | Identifier of a content update preview. minLength : 38 maxLength : 38 Pattern : "^[a-zA-Z0-9-]*$" | string |
expiration required | The time at which the content update expires. In ISO 8601 datetime format with pattern yyyy-MM-ddTHH:mm:ss.sssZ . | string (date-time) |
requestedUpdates required | Objects that were included in the update request. | RequestedUpdates |
transportationOption required | Contains information pertaining to a transportation option and the related carrier. | TransportationOption |
CreateInboundPlanRequest
The createInboundPlan
request.
Name | Description | Schema |
---|---|---|
destinationMarketplaces required | Marketplaces where the items need to be shipped to. Currently only one marketplace can be selected in this request. | < string > array |
items required | Items included in this plan. | < ItemInput > array |
name optional | Name for the Inbound Plan. If one isn't provided, a default name will be provided. minLength : 1 maxLength : 40 | string |
sourceAddress required | Specific details to identify a place. | AddressInput |
CreateInboundPlanResponse
The createInboundPlan
response.
Name | Description | Schema |
---|---|---|
inboundPlanId required | Identifier of an inbound plan. minLength : 38 maxLength : 38 Pattern : "^[a-zA-Z0-9-]*$" | string |
operationId required | UUID for the given operation. minLength : 36 maxLength : 38 Pattern : "^[a-zA-Z0-9-]*$" | string |
CreateMarketplaceItemLabelsRequest
The createMarketplaceItemLabels
request.
Name | Description | Schema |
---|---|---|
height optional | The height of the item label. Minimum value : 25 Maximum value : 100 | number |
labelType required | Indicates the type of print type for a given label. | LabelPrintType |
localeCode optional | The locale code constructed from ISO 639 language code and ISO 3166-1 alpha-2 standard of country codes separated by an underscore character. Default : "en_US" Pattern : "^[a-z]{2}_[A-Z]{2}$" | string |
marketplaceId required | The Marketplace ID. For a list of possible values, refer to Marketplace IDs. minLength : 1 maxLength : 20 | string |
mskuQuantities required | Represents the quantity of an MSKU to print item labels for. | < MskuQuantity > array |
pageType optional | The page type to use to print the labels. Possible values: 'A4_21', 'A4_24', 'A4_24_64x33', 'A4_24_66x35', 'A4_24_70x36', 'A4_24_70x37', 'A4_24i', 'A4_27', 'A4_40_52x29', 'A4_44_48x25', 'Letter_30'. | ItemLabelPageType |
width optional | The width of the item label. Minimum value : 25 Maximum value : 100 | number |
CreateMarketplaceItemLabelsResponse
The createMarketplaceItemLabels
response.
Name | Description | Schema |
---|---|---|
documentDownloads required | Resources to download the requested document. | < DocumentDownload > array |
Currency
The type and amount of currency.
Name | Description | Schema |
---|---|---|
amount required | Decimal value of the currency. | number |
code required | ISO 4217 standard of a currency code. minLength : 3 maxLength : 3 | string |
CustomPlacementInput
Provide units going to the warehouse.
Name | Description | Schema |
---|---|---|
items required | Items included while creating Inbound Plan. | < ItemInput > array |
warehouseId required | Warehouse Id. minLength : 1 maxLength : 1024 | string |
Dates
Specifies the date that the seller expects their shipment will be shipped.
Name | Description | Schema |
---|---|---|
readyToShipWindow optional | Contains a start and end DateTime representing a time range. | Window |
DeliveryWindowOption
Contains information pertaining to a delivery window option.
Name | Description | Schema |
---|---|---|
availabilityType required | Identifies type of Delivery Window Availability. Values: AVAILABLE , CONGESTED | string |
deliveryWindowOptionId required | Identifier of a delivery window option. A delivery window option represent one option for when a shipment is expected to be delivered. minLength : 36 maxLength : 38 Pattern : "^[a-zA-Z0-9-]*$" | string |
endDate required | The time at which this delivery window option ends. In ISO 8601 datetime format with pattern yyyy-MM-ddTHH:mmZ . | string (date-time) |
startDate required | The time at which this delivery window option starts. In ISO 8601 datetime format with pattern yyyy-MM-ddTHH:mmZ . | string (date-time) |
validUntil required | The time at which this window delivery option is no longer valid. In ISO 8601 datetime format with pattern yyyy-MM-ddTHH:mmZ . | string (date-time) |
Dimensions
Measurement of a package's dimensions.
Name | Description | Schema |
---|---|---|
height required | The height of a package. Minimum value : 0 Maximum value : 100000 | number |
length required | The length of a package. Minimum value : 0 Maximum value : 100000 | number |
unitOfMeasurement required | Unit of linear measure. | UnitOfMeasurement |
width required | The width of a package. Minimum value : 0 Maximum value : 100000 | number |
DocumentDownload
Resource to download the requested document.
Name | Description | Schema |
---|---|---|
downloadType required | The type of download. Possible values: URL . | string |
expiration optional | The URI's expiration time. In ISO 8601 datetime format with pattern yyyy-MM-ddTHH:mm:ss.sssZ . | string (date-time) |
uri required | Uniform resource identifier to identify where the document is located. | string |
Error
Error object containing information about what went wrong.
Name | Description | Schema |
---|---|---|
code required | An error code that identifies the type of error that occurred. minLength : 1 maxLength : 256 | string |
details optional | Additional details that can help the caller understand or fix the issue. minLength : 0 maxLength : 8192 | string |
message required | A message that describes the error condition. minLength : 1 maxLength : 2048 | string |
ErrorList
A list of error responses returned when a request is unsuccessful.
Name | Description | Schema |
---|---|---|
errors required | List of errors. | < Error > array |
FreightInformation
Freight information describes the skus being transported. Freight carrier options and quotes will only be returned if the freight information is provided.
Name | Description | Schema |
---|---|---|
declaredValue optional | The type and amount of currency. | Currency |
freightClass optional | Freight class. Possible values: NONE , FC_50 , FC_55 , FC_60 , FC_65 , FC_70 , FC_77_5 , FC_85 , FC_92_5 , FC_100 , FC_110 , FC_125 , FC_150 , FC_175 , FC_200 , FC_250 , FC_300 , FC_400 , FC_500 .minLength : 1 maxLength : 1024 | string |
GenerateDeliveryWindowOptionsResponse
The generateDeliveryWindowOptions
response.
Name | Description | Schema |
---|---|---|
operationId required | UUID for the given operation. minLength : 36 maxLength : 38 Pattern : "^[a-zA-Z0-9-]*$" | string |
GeneratePackingOptionsResponse
The generatePackingOptions
response.
Name | Description | Schema |
---|---|---|
operationId required | UUID for the given operation. minLength : 36 maxLength : 38 Pattern : "^[a-zA-Z0-9-]*$" | string |
GeneratePlacementOptionsRequest
The generatePlacementOptions
request.
Name | Description | Schema |
---|---|---|
customPlacement optional | Custom placement options you want to add to the plan. This is only used for the India (IN - A21TJRUUN4KGV) marketplace. | < CustomPlacementInput > array |
GeneratePlacementOptionsResponse
The generatePlacementOptions
response.
Name | Description | Schema |
---|---|---|
operationId required | UUID for the given operation. minLength : 36 maxLength : 38 Pattern : "^[a-zA-Z0-9-]*$" | string |
GenerateSelfShipAppointmentSlotsRequest
The generateSelfShipAppointmentSlots
request.
GenerateSelfShipAppointmentSlotsResponse
The generateSelfShipAppointmentSlots
response.
Name | Description | Schema |
---|---|---|
operationId required | UUID for the given operation. minLength : 36 maxLength : 38 Pattern : "^[a-zA-Z0-9-]*$" | string |
GenerateShipmentContentUpdatePreviewsRequest
The GenerateShipmentContentUpdatePreviews
request.
Name | Description | Schema |
---|---|---|
boxes required | A list of boxes that will be present in the shipment after the update. | < BoxUpdateInput > array |
items required | A list of all items that will be present in the shipment after the update. | < ItemInput > array |
GenerateShipmentContentUpdatePreviewsResponse
The GenerateShipmentContentUpdatePreviews
response.
Name | Description | Schema |
---|---|---|
operationId required | UUID for the given operation. minLength : 36 maxLength : 38 Pattern : "^[a-zA-Z0-9-]*$" | string |
GenerateTransportationOptionsRequest
The generateTransportationOptions
request.
Name | Description | Schema |
---|---|---|
placementOptionId required | The placement option to generate transportation options for. minLength : 38 maxLength : 38 Pattern : "^[a-zA-Z0-9-]*$" | string |
shipmentTransportationConfigurations required | List of shipment transportation configurations. | < ShipmentTransportationConfiguration > array |
GenerateTransportationOptionsResponse
The generateTransportationOptions
response.
Name | Description | Schema |
---|---|---|
operationId required | UUID for the given operation. minLength : 36 maxLength : 38 Pattern : "^[a-zA-Z0-9-]*$" | string |
GetDeliveryChallanDocumentResponse
The getDeliveryChallanDocumentResponse
response.
Name | Description | Schema |
---|---|---|
documentDownload required | Resource to download the requested document. | DocumentDownload |
GetSelfShipAppointmentSlotsResponse
The getSelfShipAppointmentSlots
response.
Name | Description | Schema |
---|---|---|
pagination optional | Contains tokens to fetch from a certain page. | Pagination |
selfShipAppointmentSlotsAvailability required | The self ship appointment time slots availability and an expiration date for which the slots can be scheduled. | SelfShipAppointmentSlotsAvailability |
InboundOperationStatus
GetInboundOperationStatus response.
Name | Description | Schema |
---|---|---|
operation required | The name of the operation in the asynchronous API call. minLength : 1 maxLength : 1024 | string |
operationId required | The operation ID returned by the asynchronous API call. minLength : 36 maxLength : 38 Pattern : "^[a-zA-Z0-9-]*$" | string |
operationProblems required | The problems in the processing of the asynchronous operation. | < OperationProblem > array |
operationStatus required | The status of an operation. | OperationStatus |
InboundPlan
Inbound plan containing details of the inbound workflow.
Name | Description | Schema |
---|---|---|
createdAt required | The time at which the inbound plan was created. In ISO 8601 datetime with pattern yyyy-MM-ddTHH:mm:ssZ . | string (date-time) |
inboundPlanId required | Identifier of an inbound plan. minLength : 38 maxLength : 38 Pattern : "^[a-zA-Z0-9-]*$" | string |
lastUpdatedAt required | The time at which the inbound plan was last updated. In ISO 8601 datetime format with pattern yyyy-MM-ddTHH:mm:ssZ . | string (date-time) |
marketplaceIds required | A list of marketplace IDs. | < string > array |
name required | Human-readable name of the inbound plan. | string |
packingOptions 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. | < PackingOptionSummary > array |
placementOptions 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. | < PlacementOptionSummary > array |
shipments 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. | < ShipmentSummary > array |
sourceAddress required | Specific details to identify a place. | Address |
status required | Current status of the inbound plan. Possible values: ACTIVE , VOIDED , SHIPPED , ERRORED .minLength : 1 maxLength : 1024 | string |
InboundPlanSummary
A light-weight inbound plan.
Name | Description | Schema |
---|---|---|
createdAt required | The time at which the inbound plan was created. In ISO 8601 datetime format with pattern yyyy-MM-ddTHH:mm:ssZ . | string (date-time) |
inboundPlanId required | Identifier of an inbound plan. minLength : 38 maxLength : 38 Pattern : "^[a-zA-Z0-9-]*$" | string |
lastUpdatedAt required | The time at which the inbound plan was last updated. In ISO 8601 datetime format with pattern yyyy-MM-ddTHH:mm:ssZ . | string (date-time) |
marketplaceIds required | A list of marketplace IDs. | < string > array |
name required | Human-readable name of the inbound plan. | string |
sourceAddress required | Specific details to identify a place. | Address |
status required | The current status of the inbound plan. Possible values: ACTIVE , VOIDED , SHIPPED , ERRORED .minLength : 1 maxLength : 1024 | string |
Incentive
Contains details about cost related modifications to the placement cost.
Name | Description | Schema |
---|---|---|
description required | Description of the incentive. minLength : 1 maxLength : 1024 | string |
target required | Target of the incentive. Possible values: 'Placement Services', 'Fulfillment Fee Discount'. minLength : 1 maxLength : 1024 | string |
type required | Type of incentive. Possible values: FEE , DISCOUNT .minLength : 1 maxLength : 1024 | string |
value required | The type and amount of currency. | Currency |
Item
Information associated with a single SKU in the seller's catalog.
Name | Description | Schema |
---|---|---|
asin required | The Amazon Standard Identification Number (ASIN) of the item. minLength : 1 maxLength : 10 | string |
expiration optional | The expiration date of the MSKU. In ISO 8601 datetime format with patternYYYY-MM-DD . The same MSKU with different expiration dates cannot go into the same box. Pattern : "^([0-9]{4})-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$" | string |
fnsku required | A unique identifier assigned by Amazon to products stored in and fulfilled from an Amazon fulfillment center. minLength : 1 maxLength : 10 | string |
labelOwner required | Specifies who will label the items. Options include AMAZON , SELLER , and NONE .minLength : 1 maxLength : 1024 | string |
manufacturingLotCode optional | The manufacturing lot code. minLength : 1 maxLength : 256 | string |
msku required | The merchant SKU, a merchant-supplied identifier of a specific SKU. minLength : 1 maxLength : 40 | string |
prepInstructions required | Special preparations that are required for an item. | < PrepInstruction > array |
quantity required | The number of the specified MSKU. Minimum value : 1 Maximum value : 10000 | integer |
ItemInput
Defines an item's input parameters.
Name | Description | Schema |
---|---|---|
expiration 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. Pattern : "^([0-9]{4})-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$" | string |
labelOwner required | Specifies who will label the items. Options include AMAZON , SELLER or NONE . | LabelOwner |
manufacturingLotCode optional | The manufacturing lot code. minLength : 1 maxLength : 256 | string |
msku required | The merchant SKU, a merchant-supplied identifier of a specific SKU. minLength : 1 maxLength : 40 | string |
prepOwner required | The owner of the preparations, if special preparations are required. | PrepOwner |
quantity required | The number of units of the specified MSKU that will be shipped. Minimum value : 1 Maximum value : 10000 | integer |
ItemLabelPageType
The page type to use to print the labels. Possible values: 'A4_21', 'A4_24', 'A4_24_64x33', 'A4_24_66x35', 'A4_24_70x36', 'A4_24_70x37', 'A4_24i', 'A4_27', 'A4_40_52x29', 'A4_44_48x25', 'Letter_30'.
Type : enum
Value | Description |
---|---|
A4_21 | - |
A4_24 | - |
A4_24_64x33 | - |
A4_24_66x35 | - |
A4_24_70x36 | - |
A4_24_70x37 | - |
A4_24i | - |
A4_27 | - |
A4_40_52x29 | - |
A4_44_48x25 | - |
Letter_30 | - |
LabelOwner
Specifies who will label the items. Options include AMAZON
, SELLER
or NONE
.
Type : enum
Value | Description |
---|---|
AMAZON | Amazon provides the information. |
SELLER | Seller provides the information. |
NONE | No owner is required for the labelling. |
LabelPrintType
Indicates the type of print type for a given label.
Type : enum
Value | Description |
---|---|
STANDARD_FORMAT | - |
THERMAL_PRINTING | - |
ListDeliveryWindowOptionsResponse
The listDeliveryWindowOptions
response.
Name | Description | Schema |
---|---|---|
deliveryWindowOptions required | Delivery window options generated for the placement option. | < DeliveryWindowOption > array |
pagination optional | Contains tokens to fetch from a certain page. | Pagination |
ListInboundPlanBoxesResponse
The listInboundPlanBoxes
response.
Name | Description | Schema |
---|---|---|
boxes required | A list of boxes in an inbound plan. | < Box > array |
pagination optional | Contains tokens to fetch from a certain page. | Pagination |
ListInboundPlanItemsResponse
The listInboundPlanItems
response.
Name | Description | Schema |
---|---|---|
items required | The items in an inbound plan. | < Item > array |
pagination optional | Contains tokens to fetch from a certain page. | Pagination |
ListInboundPlanPalletsResponse
The listInboundPlanPallets
response.
Name | Description | Schema |
---|---|---|
pagination optional | Contains tokens to fetch from a certain page. | Pagination |
pallets required | The pallets in an inbound plan. | < Pallet > array |
ListInboundPlansResponse
The listInboundPlans
response.
Name | Description | Schema |
---|---|---|
inboundPlans optional | A list of inbound plans with minimal information. | < InboundPlanSummary > array |
pagination optional | Contains tokens to fetch from a certain page. | Pagination |
ListItemComplianceDetailsResponse
The listItemComplianceDetails
response.
Name | Description | Schema |
---|---|---|
complianceDetails optional | List of compliance details. | < ComplianceDetail > array |
ListPackingGroupBoxesResponse
The listPackingGroupBoxes
response.
Name | Description | Schema |
---|---|---|
boxes required | Provides the information about the list of boxes in the packing group. | < Box > array |
pagination optional | Contains tokens to fetch from a certain page. | Pagination |
ListPackingGroupItemsResponse
The listPackingGroupItems
response.
Name | Description | Schema |
---|---|---|
items required | Provides the information about the list of items in the packing group. | < Item > array |
pagination optional | Contains tokens to fetch from a certain page. | Pagination |
ListPackingOptionsResponse
The listPlacementOptions
response.
Name | Description | Schema |
---|---|---|
packingOptions required | List of packing options. | < PackingOption > array |
pagination optional | Contains tokens to fetch from a certain page. | Pagination |
ListPlacementOptionsResponse
The listPlacementOptions
response.
Name | Description | Schema |
---|---|---|
pagination optional | Contains tokens to fetch from a certain page. | Pagination |
placementOptions required | Placement options generated for the inbound plan. | < PlacementOption > array |
ListPrepDetailsResponse
The response to the listPrepDetails
operation.
Name | Description | Schema |
---|---|---|
mskuPrepDetails required | A list of MSKUs and related prep details. | < MskuPrepDetail > array |
ListShipmentBoxesResponse
The listShipmentBoxes
response.
Name | Description | Schema |
---|---|---|
boxes required | A list of boxes in a shipment. | < Box > array |
pagination optional | Contains tokens to fetch from a certain page. | Pagination |
ListShipmentContentUpdatePreviewsResponse
The ListShipmentContentUpdatePreviews
response.
Name | Description | Schema |
---|---|---|
contentUpdatePreviews required | A list of content update previews in a shipment. | < ContentUpdatePreview > array |
pagination optional | Contains tokens to fetch from a certain page. | Pagination |
ListShipmentItemsResponse
The listShipmentItems
response.
Name | Description | Schema |
---|---|---|
items required | The items in a shipment. | < Item > array |
pagination optional | Contains tokens to fetch from a certain page. | Pagination |
ListShipmentPalletsResponse
The listShipmentPallets
response.
Name | Description | Schema |
---|---|---|
pagination optional | Contains tokens to fetch from a certain page. | Pagination |
pallets required | The pallets in a shipment. | < Pallet > array |
ListTransportationOptionsResponse
The listTransportationOptions
response.
Name | Description | Schema |
---|---|---|
pagination optional | Contains tokens to fetch from a certain page. | Pagination |
transportationOptions required | Transportation options generated for the placement option. | < TransportationOption > array |
LtlTrackingDetail
Contains information related to Less-Than-Truckload (LTL) shipment tracking.
Name | Description | Schema |
---|---|---|
billOfLadingNumber optional | The number of the carrier shipment acknowledgement document. minLength : 1 maxLength : 1024 | string |
freightBillNumber optional | The number associated with the freight bill. | < string > array |
LtlTrackingDetailInput
Contains input information to update Less-Than-Truckload (LTL) tracking information.
Name | Description | Schema |
---|---|---|
billOfLadingNumber optional | The number of the carrier shipment acknowledgement document. minLength : 1 maxLength : 1024 | string |
freightBillNumber required | Number associated with the freight bill. | < string > array |
MskuPrepDetail
An MSKU and its related prep details.
Name | Description | Schema |
---|---|---|
allOwnersConstraint optional | A constraint that applies to all owners. If no constraint is specified, defer to any individual owner constraints. | AllOwnersConstraint |
labelOwnerConstraint optional | A constraint that can apply to an individual owner. If no constraint is specified, both AMAZON and SELLER are acceptable. | OwnerConstraint |
msku required | The merchant SKU, a merchant-supplied identifier for a specific SKU. minLength : 1 maxLength : 40 | string |
prepCategory required | The preparation category for shipping an item to Amazon's fulfillment network. | PrepCategory |
prepOwnerConstraint optional | A constraint that can apply to an individual owner. If no constraint is specified, both AMAZON and SELLER are acceptable. | OwnerConstraint |
prepTypes required | A list of preparation types associated with a preparation category. | < PrepType > array |
MskuPrepDetailInput
An MSKU and its related prep details.
Name | Description | Schema |
---|---|---|
msku required | The merchant SKU, a merchant-supplied identifier for a specific SKU. minLength : 1 maxLength : 40 | string |
prepCategory required | The preparation category for shipping an item to Amazon's fulfillment network. | PrepCategory |
prepTypes required | A list of preparation types associated with a preparation category. | < PrepType > array |
MskuQuantity
Represents an MSKU and the related quantity.
Name | Description | Schema |
---|---|---|
msku required | The merchant SKU, a merchant-supplied identifier for a specific SKU. minLength : 1 maxLength : 40 | string |
quantity required | A positive integer. Minimum value : 1 Maximum value : 10000 | integer |
OperationProblem
A problem with additional properties persisted to an operation.
Name | Description | Schema |
---|---|---|
code required | An error code that identifies the type of error that occurred. minLength : 1 maxLength : 256 | string |
details optional | Additional details that can help the caller understand or fix the issue. minLength : 0 maxLength : 8192 | string |
message required | A message that describes the error condition. minLength : 1 maxLength : 2048 | string |
severity required | The severity of the problem. Possible values: WARNING , ERROR .minLength : 1 maxLength : 1024 | string |
OperationStatus
The status of an operation.
Type : enum
Value | Description |
---|---|
SUCCESS | Indicates a request has successfully finished processing. |
FAILED | Indicates a request has finished processing but is in a failed state. |
IN_PROGRESS | Indicates a request is still processing. |
OwnerConstraint
A constraint that can apply to an individual owner. If no constraint is specified, both AMAZON
and SELLER
are acceptable.
Type : enum
Value | Description |
---|---|
AMAZON_ONLY | Only AMAZON is accepted as an owner. |
NONE_ONLY | Only NONE is accepted as an owner. |
SELLER_ONLY | Only SELLER is accepted as an owner. |
PackageGroupingInput
Packing information for the inbound plan.
Name | Description | Schema |
---|---|---|
boxes required | Box level information being provided. | < BoxInput > array |
packingGroupId optional | The ID of the packingGroup that packages are grouped according to. The PackingGroupId can only be provided before placement confirmation, and it must belong to the confirmed PackingOption . One of ShipmentId or PackingGroupId must be provided with every request.minLength : 38 maxLength : 38 Pattern : "^[a-zA-Z0-9-]*$" | string |
shipmentId optional | The ID of the shipment that packages are grouped according to. The ShipmentId can only be provided after placement confirmation, and the shipment must belong to the confirmed placement option. One of ShipmentId or PackingGroupId must be provided with every request.minLength : 38 maxLength : 38 Pattern : "^[a-zA-Z0-9-]*$" | string |
PackingOption
A packing option contains a set of pack groups plus additional information about the packing option, such as any discounts or fees if it's selected.
Name | Description | Schema |
---|---|---|
discounts required | Discount for the offered option. | < Incentive > array |
expiration optional | The time at which this packing option is no longer valid. In ISO 8601 datetime format with pattern yyyy-MM-ddTHH:mm:ss.sssZ . | string (date-time) |
fees required | Fee for the offered option. | < Incentive > array |
packingGroups required | Packing group IDs. | < string > array |
packingOptionId required | Identifier of a packing option. minLength : 38 maxLength : 38 Pattern : "^[a-zA-Z0-9-]*$" | string |
status required | The status of the packing option. Possible values: OFFERED , ACCEPTED , EXPIRED .minLength : 1 maxLength : 1024 | string |
supportedShippingConfigurations required | List of supported shipping modes. | < ShippingConfiguration > array |
PackingOptionSummary
Summary information about a packing option.
Name | Description | Schema |
---|---|---|
packingOptionId required | Identifier of a packing option. minLength : 38 maxLength : 38 Pattern : "^[a-zA-Z0-9-]*$" | string |
status required | The status of a packing option. Possible values: 'OFFERED', 'ACCEPTED', 'EXPIRED'. minLength : 1 maxLength : 1024 | string |
Pagination
Contains tokens to fetch from a certain page.
Name | Description | Schema |
---|---|---|
nextToken optional | When present, pass this string token in the next request to return the next response page. minLength : 1 maxLength : 1024 | string |
Pallet
Contains information about a pallet that is used in the inbound plan. The pallet is a container that holds multiple items or boxes.
Name | Description | Schema |
---|---|---|
dimensions optional | Measurement of a package's dimensions. | Dimensions |
packageId required | Primary key to uniquely identify a Package (Box or Pallet). minLength : 38 maxLength : 38 Pattern : "^[a-zA-Z0-9-]*$" | string |
quantity optional | The number of containers where all other properties like weight or dimensions are identical. Minimum value : 1 Maximum value : 10000 | integer |
stackability optional | Indicates whether pallets will be stacked when carrier arrives for pick-up. | Stackability |
weight optional | The weight of a package. | Weight |
PalletInput
Contains input information about a pallet to be used in the inbound plan.
Name | Description | Schema |
---|---|---|
dimensions optional | Measurement of a package's dimensions. | Dimensions |
quantity required | The number of containers where all other properties like weight or dimensions are identical. Minimum value : 1 Maximum value : 10000 | integer |
stackability optional | Indicates whether pallets will be stacked when carrier arrives for pick-up. | Stackability |
weight optional | The weight of a package. | Weight |
PlacementOption
Contains information pertaining to the placement of the contents of an inbound plan and the related costs.
Name | Description | Schema |
---|---|---|
discounts required | Discount for the offered option. | < Incentive > array |
expiration optional | The expiration date of the placement option. In ISO 8601 datetime format with pattern yyyy-MM-ddTHH:mm:ss.sssZ . | string (date-time) |
fees required | The fee for the offered option. | < Incentive > array |
placementOptionId required | The identifier of a placement option. A placement option represents the shipment splits and destinations of SKUs. minLength : 38 maxLength : 38 Pattern : "^[a-zA-Z0-9-]*$" | string |
shipmentIds required | Shipment ids. | < string > array |
status required | The status of a placement option. Possible values: OFFERED , ACCEPTED , EXPIRED .minLength : 1 maxLength : 1024 | string |
PlacementOptionSummary
Summary information about a placement option.
Name | Description | Schema |
---|---|---|
placementOptionId required | The identifier of a placement option. A placement option represents the shipment splits and destinations of SKUs. minLength : 38 maxLength : 38 Pattern : "^[a-zA-Z0-9-]*$" | string |
status required | The status of a placement option. Possible values: OFFERED , ACCEPTED .minLength : 1 maxLength : 1024 | string |
PrepCategory
The preparation category for shipping an item to Amazon's fulfillment network.
Type : enum
Value | Description |
---|---|
ADULT | Displays potentially offensive material such as profanity or nudity. |
BABY | Made for a child aged three years or younger, packaging with cutouts greater than one square inch. |
FC_PROVIDED | A prep type has been defined by the Fulfillment Center. This value is provided by Amazon and cannot be used as an input. |
FRAGILE | Glass or otherwise fragile, or a liquid in a glass container. |
GRANULAR | Made of powder, pellets, or granular material. |
HANGER | Made of cloth or fabric and intended to be put on a hanger. |
LIQUID | Liquid or viscous without a double seal. |
PERFORATED | In packaging that has a perforated opening. |
SET | Multiple items that are sold as one unit. |
SHARP | Sharp and easily exposed, not already contained in protective packaging. |
SMALL | Longest side less than 2 1/8 inches (width of a credit card). |
TEXTILE | Made of cloth or fabric that could be damaged by dirt, dust, moisture, or liquid. |
UNKNOWN | An unknown prep category was found and needs to be updated. This value is provided by Amazon and cannot be used as an input. |
NONE | Does not require prep. |
PrepInstruction
Information pertaining to the preparation of inbound goods.
Name | Description | Schema |
---|---|---|
fee optional | The type and amount of currency. | Currency |
prepOwner optional | In some situations, special preparations are required for items and this field reflects the owner of the preparations. Options include AMAZON , SELLER or NONE .minLength : 1 maxLength : 1024 | string |
prepType optional | Type of preparation that should be done. Possible values: ITEM_LABELING , ITEM_BUBBLEWRAP , ITEM_POLYBAGGING , ITEM_TAPING , ITEM_BLACK_SHRINKWRAP , ITEM_HANG_GARMENT , ITEM_BOXING , ITEM_SETCREAT , ITEM_RMOVHANG , ITEM_SUFFOSTK , ITEM_CAP_SEALING , ITEM_DEBUNDLE , ITEM_SETSTK , ITEM_SIOC , ITEM_NO_PREP , ADULT , BABY , TEXTILE , HANGER , FRAGILE , LIQUID , SHARP , SMALL , PERFORATED , GRANULAR , SET , FC_PROVIDED , UNKNOWN , NONE .minLength : 1 maxLength : 1024 | string |
PrepOwner
The owner of the preparations, if special preparations are required.
Type : enum
Value | Description |
---|---|
AMAZON | Amazon provides the information. |
SELLER | The seller provides the information. |
NONE | No owner is required for the preparations. |
PrepType
Preparation instructions for shipping an item to Amazon's fulfillment network. For more information about preparing items for shipment to Amazon's fulfillment network, refer to Seller Central Help for your marketplace.
Type : enum
Value | Description |
---|---|
ITEM_BLACK_SHRINKWRAP | The item requires black shrink wrapping. |
ITEM_BLANKSTK | The item requires a blank sticker to obscure a bad barcode that cannot be covered by another sticker. |
ITEM_BOXING | Products may require overboxing when there are safety concerns over sharp items, fragile items, hazardous liquids, and vinyl records. For items over 4.5 kg, use double-wall corrugated boxes. |
ITEM_BUBBLEWRAP | The item requires bubble wrapping. |
ITEM_CAP_SEALING | To prevent leakage, the product needs to have a secondary seal in one of the following types: Induction seal, safety ring, clips, heat shrink plastic band, or boxing. |
ITEM_DEBUNDLE | The item requires taking apart a set of items labeled for individual sale. Remove tape or shrink wrap that groups multiple inventory units together. |
ITEM_HANG_GARMENT | The item must be placed on a hanger. |
ITEM_LABELING | The FNSKU label must be applied to the item. |
ITEM_NO_PREP | The item does not require any prep. |
ITEM_POLYBAGGING | The item requires polybagging. |
ITEM_RMOVHANG | The item cannot be shipped on a hanger. |
ITEM_SETCREAT | Units that are sets must be labeled as sets on their packaging. The barcodes on the individual items must not face outward and must not require covering. |
ITEM_SETSTK | Products that are sets must be marked as sets on their packaging. Add a label to the unit that clearly states that the products must be received and sold as a single unit. For example, if a set of six unique toy cars is sold as one unit, the packaging for each car must indicate that it is part of the set. |
ITEM_SIOC | The item ships in its original product packaging. |
ITEM_SUFFOSTK | Poly bags with an opening of 12 cm or larger (measured when flat) must have a suffocation warning. This warning must be printed on the bag or attached as a label. |
ITEM_TAPING | Indicates that taping is required. |
Quote
The estimated shipping cost associated with the transportation option.
ReasonComment
Reason for cancelling or rescheduling a self-ship appointment.
Type : enum
Value | Description |
---|---|
APPOINTMENT_REQUESTED_BY_MISTAKE | - |
VEHICLE_DELAY | - |
SLOT_NOT_SUITABLE | - |
OUTSIDE_CARRIER_BUSINESS_HOURS | - |
UNFAVOURABLE_EXTERNAL_CONDITIONS | - |
PROCUREMENT_DELAY | - |
SHIPPING_PLAN_CHANGED | - |
INCREASED_QUANTITY | - |
OTHER | - |
Region
Representation of a location used within the inbounding experience.
Name | Description | Schema |
---|---|---|
countryCode optional | ISO 3166 standard alpha-2 country code. minLength : 1 maxLength : 1024 | string |
state optional | State. minLength : 1 maxLength : 1024 | string |
warehouseId optional | An identifier for a warehouse, such as a FC, IXD, upstream storage. minLength : 1 maxLength : 1024 | string |
RequestedUpdates
Objects that were included in the update request.
Name | Description | Schema |
---|---|---|
boxes optional | A list of boxes that will be present in the shipment after the update. | < BoxUpdateInput > array |
items optional | A list of all items that will be present in the shipment after the update. | < ItemInput > array |
ScheduleSelfShipAppointmentRequest
The scheduleSelfShipAppointment
request.
Name | Description | Schema |
---|---|---|
reasonComment optional | Reason for cancelling or rescheduling a self-ship appointment. | ReasonComment |
ScheduleSelfShipAppointmentResponse
The scheduleSelfShipAppointment
response.
Name | Description | Schema |
---|---|---|
selfShipAppointmentDetails required | Appointment details for carrier pickup or fulfillment center appointments. | SelfShipAppointmentDetails |
SelectedDeliveryWindow
Selected delivery window attributes.
Name | Description | Schema |
---|---|---|
availabilityType required | Identifies type of Delivery Window Availability. Values: AVAILABLE , CONGESTED | string |
deliveryWindowOptionId required | Identifier of a delivery window option. A delivery window option represent one option for when a shipment is expected to be delivered. minLength : 36 maxLength : 38 Pattern : "^[a-zA-Z0-9-]*$" | string |
editableUntil optional | The timestamp at which this Window can no longer be edited. | string (date-time) |
endDate required | The end timestamp of the window. | string (date-time) |
startDate required | The start timestamp of the window. | string (date-time) |
SelfShipAppointmentDetails
Appointment details for carrier pickup or fulfillment center appointments.
Name | Description | Schema |
---|---|---|
appointmentId optional | Identifier for appointment. | number |
appointmentSlotTime optional | An appointment slot time with start and end. | AppointmentSlotTime |
appointmentStatus optional | Status of the appointment. minLength : 1 maxLength : 1024 | string |
SelfShipAppointmentSlotsAvailability
The self ship appointment time slots availability and an expiration date for which the slots can be scheduled.
Name | Description | Schema |
---|---|---|
expiresAt optional | The time at which the self ship appointment slot expires. In ISO 8601 datetime format. | string (date-time) |
slots optional | A list of appointment slots. | < AppointmentSlot > array |
SetPackingInformationRequest
The setPackingInformation
request.
Name | Description | Schema |
---|---|---|
packageGroupings required | List of packing information for the inbound plan. | < PackageGroupingInput > array |
SetPackingInformationResponse
The setPackingInformation
response.
Name | Description | Schema |
---|---|---|
operationId required | UUID for the given operation. minLength : 36 maxLength : 38 Pattern : "^[a-zA-Z0-9-]*$" | string |
SetPrepDetailsRequest
The setPrepDetails
request.
Name | Description | Schema |
---|---|---|
marketplaceId required | The marketplace ID. For a list of possible values, refer to Marketplace IDs. minLength : 1 maxLength : 20 | string |
mskuPrepDetails required | A list of MSKUs and related prep details. | < MskuPrepDetailInput > array |
SetPrepDetailsResponse
The setPrepDetails
response.
Name | Description | Schema |
---|---|---|
operationId required | UUID for the given operation. minLength : 36 maxLength : 38 Pattern : "^[a-zA-Z0-9-]*$" | string |
Shipment
Contains information pertaining to a shipment in an inbound plan.
Name | Description | Schema |
---|---|---|
amazonReferenceId optional | A unique identifier created by Amazon that identifies this Amazon-partnered, Less Than Truckload/Full Truckload (LTL/FTL) shipment. minLength : 1 maxLength : 1024 | string |
contactInformation optional | The seller's contact information. | ContactInformation |
dates optional | Specifies the date that the seller expects their shipment will be shipped. | Dates |
destination required | The Amazon fulfillment center address and warehouse ID. | ShipmentDestination |
freightInformation optional | Freight information describes the skus being transported. Freight carrier options and quotes will only be returned if the freight information is provided. | FreightInformation |
name optional | The name of the shipment. | string |
placementOptionId required | The identifier of a placement option. A placement option represents the shipment splits and destinations of SKUs. minLength : 38 maxLength : 38 Pattern : "^[a-zA-Z0-9-]*$" | string |
selectedDeliveryWindow optional | Selected delivery window attributes. | SelectedDeliveryWindow |
selectedTransportationOptionId optional | Identifier of a transportation option. A transportation option represent one option for how to send a shipment. minLength : 38 maxLength : 38 Pattern : "^[a-zA-Z0-9-]*$" | string |
selfShipAppointmentDetails optional | List of self ship appointment details. | < SelfShipAppointmentDetails > array |
shipmentConfirmationId optional | The confirmed shipment ID which shows up on labels (for example, FBA1234ABCD ).minLength : 1 maxLength : 1024 | string |
shipmentId required | Identifier of a shipment. A shipment contains the boxes and units being inbounded. minLength : 38 maxLength : 38 Pattern : "^[a-zA-Z0-9-]*$" | string |
source required | Specifies the 'ship from' address for the shipment. | ShipmentSource |
status optional | 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 minLength : 1 maxLength : 1024 | string |
trackingDetails optional | Tracking information for Less-Than-Truckload (LTL) and Small Parcel Delivery (SPD) shipments. | TrackingDetails |
ShipmentDestination
The Amazon fulfillment center address and warehouse ID.
Name | Description | Schema |
---|---|---|
address optional | The address the shipment should be sent to. Empty if the destination type is AMAZON_OPTIMIZED . | Address |
destinationType required | The type of destination for this shipment. Possible values: AMAZON_OPTIMIZED , AMAZON_WAREHOUSE .minLength : 1 maxLength : 1024 | string |
warehouseId optional | The warehouse that the shipment should be sent to. Empty if the destination type is AMAZON_OPTIMIZED .minLength : 1 maxLength : 1024 | string |
ShipmentSource
Specifies the 'ship from' address for the shipment.
Name | Description | Schema |
---|---|---|
address optional | Specific details to identify a place. | Address |
sourceType required | The type of source for this shipment. Possible values: SELLER_FACILITY .minLength : 1 maxLength : 1024 | string |
ShipmentSummary
Summary information about a shipment.
Name | Description | Schema |
---|---|---|
shipmentId required | Identifier of a shipment. A shipment contains the boxes and units being inbounded. minLength : 38 maxLength : 38 Pattern : "^[a-zA-Z0-9-]*$" | string |
status 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 minLength : 1 maxLength : 1024 | string |
ShipmentTransportationConfiguration
Details needed to generate the transportation options.
Name | Description | Schema |
---|---|---|
contactInformation optional | The seller's contact information. | ContactInformation |
freightInformation optional | Freight information describes the skus being transported. Freight carrier options and quotes will only be returned if the freight information is provided. | FreightInformation |
pallets optional | List of pallet configuration inputs. | < PalletInput > array |
readyToShipWindow required | The range of dates within which the seller intends to ship their items. This is the pick-up date or 'ready to ship' date, not an estimated delivery date. | WindowInput |
shipmentId required | Identifier of a shipment. A shipment contains the boxes and units being inbounded. minLength : 38 maxLength : 38 Pattern : "^[a-zA-Z0-9-]*$" | string |
ShippingConfiguration
The shipping configurations supported for the packing option. Available modes are ground small parcel, freight less-than-truckload (LTL), freight full-truckload (FTL) palletized, freight FTL non-palletized, ocean less-than-container-load (LCL), ocean full-container load (FCL), air small parcel, and air small parcel express.
Name | Description | Schema |
---|---|---|
shippingMode optional | Mode of shipment transportation that this option will provide. Possible values: GROUND_SMALL_PARCEL , FREIGHT_LTL , FREIGHT_FTL_PALLET , FREIGHT_FTL_NONPALLET , OCEAN_LCL , OCEAN_FCL , AIR_SMALL_PARCEL , AIR_SMALL_PARCEL_EXPRESS .minLength : 1 maxLength : 1024 | string |
shippingSolution optional | Shipping program for the option. Possible values: AMAZON_PARTNERED_CARRIER , USE_YOUR_OWN_CARRIER .minLength : 1 maxLength : 1024 | string |
SpdTrackingDetail
Contains information related to Small Parcel Delivery (SPD) shipment tracking.
Name | Description | Schema |
---|---|---|
spdTrackingItems optional | List of Small Parcel Delivery (SPD) tracking items. | < SpdTrackingItem > array |
SpdTrackingDetailInput
Contains input information to update Small Parcel Delivery (SPD) tracking information.
Name | Description | Schema |
---|---|---|
spdTrackingItems required | List of Small Parcel Delivery (SPD) tracking items input. | < SpdTrackingItemInput > array |
SpdTrackingItem
Contains information used to track and identify a Small Parcel Delivery (SPD) item.
Name | Description | Schema |
---|---|---|
boxId optional | The ID provided by Amazon that identifies a given box. This ID is comprised of the external shipment ID (which is generated after transportation has been confirmed) and the index of the box. minLength : 1 maxLength : 1024 | string |
trackingId optional | The tracking ID associated with each box in a non-Amazon partnered Small Parcel Delivery (SPD) shipment. minLength : 1 maxLength : 1024 | string |
trackingNumberValidationStatus optional | Whether or not Amazon has validated the tracking number. If more than 24 hours have passed and the status is not yet 'VALIDATED', please verify the number and update if necessary. Possible values: VALIDATED , NOT_VALIDATED .minLength : 1 maxLength : 1024 | string |
SpdTrackingItemInput
Small Parcel Delivery (SPD) tracking items input information.
Name | Description | Schema |
---|---|---|
boxId required | The ID provided by Amazon that identifies a given box. This ID is comprised of the external shipment ID (which is generated after transportation has been confirmed) and the index of the box. minLength : 1 maxLength : 1024 | string |
trackingId required | The tracking Id associated with each box in a non-Amazon partnered Small Parcel Delivery (SPD) shipment. The seller must provide this information. minLength : 1 maxLength : 1024 | string |
Stackability
Indicates whether pallets will be stacked when carrier arrives for pick-up.
Type : enum
Value | Description |
---|---|
STACKABLE | A pallet that can be stacked on top of another pallet. |
NON_STACKABLE | A pallet that cannot be stacked on top of another pallet. |
TaxDetails
Information used to determine the tax compliance.
TaxRate
Contains the type and rate of tax.
Name | Description | Schema |
---|---|---|
cessRate optional | Rate of cess tax. | number |
gstRate optional | Rate of gst tax. | number |
taxType optional | Type of tax. Possible values: CGST , SGST , IGST , TOTAL_TAX .minLength : 1 maxLength : 1024 | string |
TrackingDetails
Tracking information for Less-Than-Truckload (LTL) and Small Parcel Delivery (SPD) shipments.
Name | Description | Schema |
---|---|---|
ltlTrackingDetail optional | Contains information related to Less-Than-Truckload (LTL) shipment tracking. | LtlTrackingDetail |
spdTrackingDetail optional | Contains information related to Small Parcel Delivery (SPD) shipment tracking. | SpdTrackingDetail |
TrackingDetailsInput
Tracking information input for Less-Than-Truckload (LTL) and Small Parcel Delivery (SPD) shipments.
Name | Description | Schema |
---|---|---|
ltlTrackingDetail optional | Contains input information to update Less-Than-Truckload (LTL) tracking information. | LtlTrackingDetailInput |
spdTrackingDetail optional | Contains input information to update Small Parcel Delivery (SPD) tracking information. | SpdTrackingDetailInput |
TransportationOption
Contains information pertaining to a transportation option and the related carrier.
Name | Description | Schema |
---|---|---|
carrier required | The carrier for the inbound shipment. | Carrier |
carrierAppointment optional | Contains details for a transportation carrier appointment. This appointment is vended out by Amazon and is an indicator for when a transportation carrier is accepting shipments to be picked up. | CarrierAppointment |
preconditions required | Identifies a list of preconditions for confirming the transportation option. | < string > array |
quote optional | The estimated shipping cost associated with the transportation option. | Quote |
shipmentId required | Identifier of a shipment. A shipment contains the boxes and units being inbounded. minLength : 38 maxLength : 38 Pattern : "^[a-zA-Z0-9-]*$" | string |
shippingMode required | Mode of shipment transportation that this option will provide. Possible values: GROUND_SMALL_PARCEL , FREIGHT_LTL , FREIGHT_FTL_PALLET , FREIGHT_FTL_NONPALLET , OCEAN_LCL , OCEAN_FCL , AIR_SMALL_PARCEL , AIR_SMALL_PARCEL_EXPRESS .minLength : 1 maxLength : 1024 | string |
shippingSolution required | Shipping program for the option. Possible values: AMAZON_PARTNERED_CARRIER , USE_YOUR_OWN_CARRIER .minLength : 1 maxLength : 1024 | string |
transportationOptionId required | Identifier of a transportation option. A transportation option represent one option for how to send a shipment. minLength : 38 maxLength : 38 Pattern : "^[a-zA-Z0-9-]*$" | string |
TransportationSelection
The transportation option selected to confirm.
Name | Description | Schema |
---|---|---|
contactInformation optional | The seller's contact information. | ContactInformation |
shipmentId required | Shipment ID that the transportation Option is for. minLength : 38 maxLength : 38 Pattern : "^[a-zA-Z0-9-]*$" | string |
transportationOptionId required | Transportation option being selected for the provided shipment. minLength : 38 maxLength : 38 Pattern : "^[a-zA-Z0-9-]*$" | string |
UnitOfMeasurement
Unit of linear measure.
Type : enum
Value | Description |
---|---|
IN | Inches. |
CM | Centimeters. |
UnitOfWeight
Unit of the weight being measured.
Type : enum
Value | Description |
---|---|
LB | Pounds. |
KG | Kilograms. |
UpdateInboundPlanNameRequest
The updateInboundPlanName
request.
Name | Description | Schema |
---|---|---|
name required | A human-readable name to update the inbound plan name to. minLength : 1 maxLength : 40 | string |
UpdateItemComplianceDetailsRequest
The updateItemComplianceDetails
request.
Name | Description | Schema |
---|---|---|
msku required | The merchant SKU, a merchant-supplied identifier for a specific SKU. minLength : 1 maxLength : 40 | string |
taxDetails required | Information used to determine the tax compliance. | TaxDetails |
UpdateItemComplianceDetailsResponse
The updateItemComplianceDetails
response.
Name | Description | Schema |
---|---|---|
operationId required | UUID for the given operation. minLength : 36 maxLength : 38 Pattern : "^[a-zA-Z0-9-]*$" | string |
UpdateShipmentNameRequest
The updateShipmentName
request.
Name | Description | Schema |
---|---|---|
name required | A human-readable name to update the shipment name to. minLength : 1 maxLength : 100 | string |
UpdateShipmentSourceAddressRequest
The UpdateShipmentSourceAddress
request.
Name | Description | Schema |
---|---|---|
address required | Specific details to identify a place. | AddressInput |
UpdateShipmentSourceAddressResponse
The UpdateShipmentSourceAddress
response.
Name | Description | Schema |
---|---|---|
operationId required | UUID for the given operation. minLength : 36 maxLength : 38 Pattern : "^[a-zA-Z0-9-]*$" | string |
UpdateShipmentTrackingDetailsRequest
The updateShipmentTrackingDetails
request.
Name | Description | Schema |
---|---|---|
trackingDetails required | Tracking information input for Less-Than-Truckload (LTL) and Small Parcel Delivery (SPD) shipments. | TrackingDetailsInput |
UpdateShipmentTrackingDetailsResponse
The updateShipmentTrackingDetails
response.
Name | Description | Schema |
---|---|---|
operationId required | UUID for the given operation. minLength : 36 maxLength : 38 Pattern : "^[a-zA-Z0-9-]*$" | string |
Weight
The weight of a package.
Name | Description | Schema |
---|---|---|
unit required | Unit of the weight being measured. | UnitOfWeight |
value required | Value of a weight. Minimum value : 0 Maximum value : 100000 | number |
Window
Contains a start and end DateTime representing a time range.
Name | Description | Schema |
---|---|---|
editableUntil optional | The timestamp at which this Window can no longer be edited. | string (date-time) |
end required | The end timestamp of the window. | string (date-time) |
start required | The start timestamp of the window. | string (date-time) |
WindowInput
Contains only a starting DateTime.
Name | Description | Schema |
---|---|---|
start required | The start date of the window. In ISO 8601 datetime format with minute precision. Supports patterns yyyy-MM-ddTHH:mmZ , yyyy-MM-ddTHH:mm:ssZ , or yyyy-MM-ddTHH:mm:ss.sssZ . Note that non-zero second and millisecond components are removed. | string (date-time) |
Status
The status of an inbound plan.
Type : enum
Value | Description |
---|---|
ACTIVE | An inbound plan that is being worked on. |
VOIDED | An inbound plan with all shipment cancelled and can no longer be modified. |
SHIPPED | A completed inbound plan. Only minor modifications can be made at this time. |
SortBy
Sort by field.
Type : enum
Value | Description |
---|---|
LAST_UPDATED_TIME | Last updated time of the inbound plan. |
CREATION_TIME | Inbound plan creation time. |
SortOrder
The sort order.
Type : enum
Value | Description |
---|---|
ASC | Ascending order. |
DESC | Descending order. |
Updated 20 days ago