openapi: 3.2.0 info: description: The Selling Partner API for Fulfillment Outbound lets you create applications that help a seller fulfill Multi-Channel Fulfillment orders using their inventory in Amazon's fulfillment network. You can get information on both potential and existing fulfillment orders. version: '2020-07-01' title: Selling Partner APIs for Fulfillment Outbound Fba Outbound… contact: name: Selling Partner API Developer Support url: https://sellercentral.amazon.com/gp/mws/contactus.html license: name: Apache License 2.0 url: http://www.apache.org/licenses/LICENSE-2.0 servers: - url: https://sellingpartnerapi-na.amazon.com tags: - name: fbaOutbound paths: /fba/outbound/2020-07-01/fulfillmentOrders/preview: x-amzn-api-sandbox: dynamic: {} post: tags: - fbaOutbound description: 'Returns a list of fulfillment order previews based on shipping criteria that you specify. **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 table above indicates 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.' operationId: getFulfillmentPreview responses: '200': description: Success. headers: x-amzn-RateLimit-Limit: description: Your rate limit (requests per second) for this operation. schema: type: string x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/GetFulfillmentPreviewResponse' '400': description: Request has missing or invalid parameters and cannot be parsed. headers: x-amzn-RateLimit-Limit: description: Your rate limit (requests per second) for this operation. schema: type: string x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/GetFulfillmentPreviewResponse' '401': description: The request's Authorization header is not formatted correctly or does not contain a valid token. headers: x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/GetFulfillmentPreviewResponse' '403': description: Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature. headers: x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/GetFulfillmentPreviewResponse' '404': description: The specified resource does not exist. headers: x-amzn-RateLimit-Limit: description: Your rate limit (requests per second) for this operation. schema: type: string x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/GetFulfillmentPreviewResponse' '429': description: The frequency of requests was greater than allowed. headers: x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/GetFulfillmentPreviewResponse' '500': description: An unexpected condition occurred that prevented the server from fulfilling the request. headers: x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/GetFulfillmentPreviewResponse' '503': description: Temporary overloading or maintenance of the server. headers: x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/GetFulfillmentPreviewResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/GetFulfillmentPreviewRequest' description: GetFulfillmentPreviewRequest parameter required: true summary: Get fulfillment preview x-summary-source: derived /fba/outbound/2020-07-01/deliveryOffers: x-amzn-api-sandbox: dynamic: {} post: tags: - fbaOutbound description: 'Returns delivery options that include an estimated delivery date and offer expiration, based on criteria that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may 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.' operationId: deliveryOffers responses: '200': description: Success. headers: x-amzn-RateLimit-Limit: description: Your rate limit (requests per second) for this operation. schema: type: string x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/GetDeliveryOffersResponse' '400': description: Request has missing or invalid parameters and cannot be parsed. headers: x-amzn-RateLimit-Limit: description: Your rate limit (requests per second) for this operation. schema: type: string x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/GetDeliveryOffersResponse' '401': description: The request's Authorization header is not formatted correctly or does not contain a valid token. headers: x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/GetDeliveryOffersResponse' '403': description: Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature. headers: x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/GetDeliveryOffersResponse' '404': description: The specified resource does not exist. headers: x-amzn-RateLimit-Limit: description: Your rate limit (requests per second) for this operation. schema: type: string x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/GetDeliveryOffersResponse' '429': description: The frequency of requests was greater than allowed. headers: x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/GetDeliveryOffersResponse' '500': description: An unexpected condition occurred that prevented the server from fulfilling the request. headers: x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/GetDeliveryOffersResponse' '503': description: Temporary overloading or maintenance of the server. headers: x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/GetDeliveryOffersResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/GetDeliveryOffersRequest' description: GetDeliveryOffersRequest parameter required: true summary: Delivery offers x-summary-source: derived /fba/outbound/2020-07-01/fulfillmentOrders: x-amzn-api-sandbox: dynamic: {} get: tags: - fbaOutbound description: 'Returns a list of fulfillment orders fulfilled after (or at) a specified date-time, or indicated by the `nextToken` parameter. **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 indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API' operationId: listAllFulfillmentOrders parameters: - name: queryStartDate in: query description: A date used to select fulfillment orders that were last updated after (or at) a specified time. An update is defined as any change in fulfillment order status, including the creation of a new fulfillment order. required: false schema: type: string format: date-time - name: nextToken in: query description: A string token returned in the response to your previous request. required: false schema: type: string responses: '200': description: Success. headers: x-amzn-RateLimit-Limit: description: Your rate limit (requests per second) for this operation. schema: type: string x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ListAllFulfillmentOrdersResponse' '400': description: Request has missing or invalid parameters and cannot be parsed. headers: x-amzn-RateLimit-Limit: description: Your rate limit (requests per second) for this operation. schema: type: string x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ListAllFulfillmentOrdersResponse' '401': description: The request's Authorization header is not formatted correctly or does not contain a valid token. headers: x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ListAllFulfillmentOrdersResponse' '403': description: Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature. headers: x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ListAllFulfillmentOrdersResponse' '404': description: The specified resource does not exist. headers: x-amzn-RateLimit-Limit: description: Your rate limit (requests per second) for this operation. schema: type: string x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ListAllFulfillmentOrdersResponse' '429': description: The frequency of requests was greater than allowed. headers: x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ListAllFulfillmentOrdersResponse' '500': description: An unexpected condition occurred that prevented the server from fulfilling the request. headers: x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ListAllFulfillmentOrdersResponse' '503': description: Temporary overloading or maintenance of the server. headers: x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ListAllFulfillmentOrdersResponse' summary: List all fulfillment orders x-summary-source: derived post: tags: - fbaOutbound description: 'Requests that Amazon ship items from the seller''s inventory in Amazon''s fulfillment network to a destination 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 table above indicates 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' operationId: createFulfillmentOrder responses: '200': description: Success. headers: x-amzn-RateLimit-Limit: description: Your rate limit (requests per second) for this operation. schema: type: string x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/CreateFulfillmentOrderResponse' '400': description: Request has missing or invalid parameters and cannot be parsed. headers: x-amzn-RateLimit-Limit: description: Your rate limit (requests per second) for this operation. schema: type: string x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/CreateFulfillmentOrderResponse' '401': description: The request's Authorization header is not formatted correctly or does not contain a valid token. headers: x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/CreateFulfillmentOrderResponse' '403': description: Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature. headers: x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/CreateFulfillmentOrderResponse' '404': description: The specified resource does not exist. headers: x-amzn-RateLimit-Limit: description: Your rate limit (requests per second) for this operation. schema: type: string x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/CreateFulfillmentOrderResponse' '429': description: The frequency of requests was greater than allowed. headers: x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/CreateFulfillmentOrderResponse' '500': description: An unexpected condition occurred that prevented the server from fulfilling the request. headers: x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/CreateFulfillmentOrderResponse' '503': description: Temporary overloading or maintenance of the server. headers: x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/CreateFulfillmentOrderResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateFulfillmentOrderRequest' description: CreateFulfillmentOrderRequest parameter required: true summary: Create fulfillment order x-summary-source: derived /fba/outbound/2020-07-01/tracking: x-amzn-api-sandbox: dynamic: {} get: tags: - fbaOutbound description: 'Returns delivery tracking information for a package in an outbound shipment for a Multi-Channel Fulfillment order. **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 table above indicates 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.' operationId: getPackageTrackingDetails parameters: - name: packageNumber in: query description: The unencrypted package identifier. You can obtain this value from the `getFulfillmentOrder` operation. required: true schema: type: integer format: int32 responses: '200': description: Success. headers: x-amzn-RateLimit-Limit: description: Your rate limit (requests per second) for this operation. schema: type: string x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/GetPackageTrackingDetailsResponse' '400': description: Request has missing or invalid parameters and cannot be parsed. headers: x-amzn-RateLimit-Limit: description: Your rate limit (requests per second) for this operation. schema: type: string x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/GetPackageTrackingDetailsResponse' '401': description: The request's Authorization header is not formatted correctly or does not contain a valid token. headers: x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/GetPackageTrackingDetailsResponse' '403': description: Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature. headers: x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/GetPackageTrackingDetailsResponse' '404': description: The specified resource does not exist. headers: x-amzn-RateLimit-Limit: description: Your rate limit (requests per second) for this operation. schema: type: string x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/GetPackageTrackingDetailsResponse' '429': description: The frequency of requests was greater than allowed. headers: x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/GetPackageTrackingDetailsResponse' '500': description: An unexpected condition occurred that prevented the server from fulfilling the request. headers: x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/GetPackageTrackingDetailsResponse' '503': description: Temporary overloading or maintenance of the server. headers: x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/GetPackageTrackingDetailsResponse' summary: Get package tracking details x-summary-source: derived /fba/outbound/2020-07-01/returnReasonCodes: x-amzn-api-sandbox: dynamic: {} get: tags: - fbaOutbound description: 'Returns a list of return reason codes for a seller SKU in a given marketplace. The parameters for this operation may contain special characters that require URL encoding. To avoid errors with SKUs when encoding URLs, refer to URL Encoding. **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 table above indicates 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.' operationId: listReturnReasonCodes parameters: - name: sellerSku in: query description: The seller SKU for which return reason codes are required. required: true schema: type: string - name: marketplaceId in: query description: The marketplace for which the seller wants return reason codes. required: false schema: type: string - name: sellerFulfillmentOrderId in: query description: The identifier assigned to the item by the seller when the fulfillment order was created. The service uses this value to determine the marketplace for which the seller wants return reason codes. required: false schema: type: string - name: language in: query description: The language that the `TranslatedDescription` property of the `ReasonCodeDetails` response object should be translated into. required: false schema: type: string responses: '200': description: Success. headers: x-amzn-RateLimit-Limit: description: Your rate limit (requests per second) for this operation. schema: type: string x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ListReturnReasonCodesResponse' '400': description: Request has missing or invalid parameters and cannot be parsed. headers: x-amzn-RateLimit-Limit: description: Your rate limit (requests per second) for this operation. schema: type: string x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ListReturnReasonCodesResponse' '401': description: The request's Authorization header is not formatted correctly or does not contain a valid token. headers: x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ListReturnReasonCodesResponse' '403': description: Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature. headers: x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ListReturnReasonCodesResponse' '404': description: The specified resource does not exist. headers: x-amzn-RateLimit-Limit: description: Your rate limit (requests per second) for this operation. schema: type: string x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ListReturnReasonCodesResponse' '429': description: The frequency of requests was greater than allowed. headers: x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ListReturnReasonCodesResponse' '500': description: An unexpected condition occurred that prevented the server from fulfilling the request. headers: x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ListReturnReasonCodesResponse' '503': description: Temporary overloading or maintenance of the server. headers: x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ListReturnReasonCodesResponse' summary: List return reason codes x-summary-source: derived /fba/outbound/2020-07-01/fulfillmentOrders/{sellerFulfillmentOrderId}/return: x-amzn-api-sandbox: dynamic: {} put: tags: - fbaOutbound description: 'Creates a fulfillment return. **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 table above indicates 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.' operationId: createFulfillmentReturn parameters: - name: sellerFulfillmentOrderId in: path description: An identifier the seller assigns to the fulfillment order at the time it was created. The seller uses their own records to find the correct `sellerFulfillmentOrderId` value based on the buyer's request to return items. required: true schema: type: string responses: '200': description: Success. headers: x-amzn-RateLimit-Limit: description: Your rate limit (requests per second) for this operation. schema: type: string x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/CreateFulfillmentReturnResponse' '400': description: Request has missing or invalid parameters and cannot be parsed. headers: x-amzn-RateLimit-Limit: description: Your rate limit (requests per second) for this operation. schema: type: string x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/CreateFulfillmentReturnResponse' '401': description: The request's Authorization header is not formatted correctly or does not contain a valid token. headers: x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/CreateFulfillmentReturnResponse' '403': description: Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature. headers: x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/CreateFulfillmentReturnResponse' '404': description: The specified resource does not exist. headers: x-amzn-RateLimit-Limit: description: Your rate limit (requests per second) for this operation. schema: type: string x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/CreateFulfillmentReturnResponse' '429': description: The frequency of requests was greater than allowed. headers: x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/CreateFulfillmentReturnResponse' '500': description: An unexpected condition occurred that prevented the server from fulfilling the request. headers: x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/CreateFulfillmentReturnResponse' '503': description: Temporary overloading or maintenance of the server. headers: x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/CreateFulfillmentReturnResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateFulfillmentReturnRequest' description: The request body of the `createFulfillmentReturn` operation. required: true summary: Create fulfillment return x-summary-source: derived /fba/outbound/2020-07-01/fulfillmentOrders/{sellerFulfillmentOrderId}: x-amzn-api-sandbox: dynamic: {} get: tags: - fbaOutbound description: 'Returns the fulfillment order indicated by the specified order identifier. **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 table above indicates 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.' operationId: getFulfillmentOrder parameters: - name: sellerFulfillmentOrderId in: path description: The identifier assigned to the item by the seller when the fulfillment order was created. required: true schema: type: string maxLength: 40 responses: '200': description: Success. headers: x-amzn-RateLimit-Limit: description: Your rate limit (requests per second) for this operation. schema: type: string x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/GetFulfillmentOrderResponse' '400': description: Request has missing or invalid parameters and cannot be parsed. headers: x-amzn-RateLimit-Limit: description: Your rate limit (requests per second) for this operation. schema: type: string x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/GetFulfillmentOrderResponse' '401': description: The request's Authorization header is not formatted correctly or does not contain a valid token. headers: x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/GetFulfillmentOrderResponse' '403': description: Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature. headers: x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/GetFulfillmentOrderResponse' '404': description: The specified resource does not exist. headers: x-amzn-RateLimit-Limit: description: Your rate limit (requests per second) for this operation. schema: type: string x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/GetFulfillmentOrderResponse' '429': description: The frequency of requests was greater than allowed. headers: x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/GetFulfillmentOrderResponse' '500': description: An unexpected condition occurred that prevented the server from fulfilling the request. headers: x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/GetFulfillmentOrderResponse' '503': description: Temporary overloading or maintenance of the server. headers: x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/GetFulfillmentOrderResponse' summary: Get fulfillment order x-summary-source: derived put: tags: - fbaOutbound description: 'Updates and/or requests shipment for a fulfillment order with an order hold on it. **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 table above indicates 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.' operationId: updateFulfillmentOrder parameters: - name: sellerFulfillmentOrderId in: path description: The identifier assigned to the item by the seller when the fulfillment order was created. required: true schema: type: string maxLength: 40 responses: '200': description: Success. headers: x-amzn-RateLimit-Limit: description: Your rate limit (requests per second) for this operation. schema: type: string x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/UpdateFulfillmentOrderResponse' '400': description: Request has missing or invalid parameters and cannot be parsed. headers: x-amzn-RateLimit-Limit: description: Your rate limit (requests per second) for this operation. schema: type: string x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/UpdateFulfillmentOrderResponse' '401': description: The request's Authorization header is not formatted correctly or does not contain a valid token. headers: x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/UpdateFulfillmentOrderResponse' '403': description: Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature. headers: x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/UpdateFulfillmentOrderResponse' '404': description: The specified resource does not exist. headers: x-amzn-RateLimit-Limit: description: Your rate limit (requests per second) for this operation. schema: type: string x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/UpdateFulfillmentOrderResponse' '429': description: The frequency of requests was greater than allowed. headers: x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/UpdateFulfillmentOrderResponse' '500': description: An unexpected condition occurred that prevented the server from fulfilling the request. headers: x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/UpdateFulfillmentOrderResponse' '503': description: Temporary overloading or maintenance of the server. headers: x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/UpdateFulfillmentOrderResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateFulfillmentOrderRequest' description: The request body of the `updateFulfillmentOrder` operation. required: true summary: Update fulfillment order x-summary-source: derived /fba/outbound/2020-07-01/fulfillmentOrders/{sellerFulfillmentOrderId}/cancel: x-amzn-api-sandbox: dynamic: {} put: tags: - fbaOutbound description: 'Requests that Amazon stop attempting to fulfill the fulfillment order indicated by the specified order identifier. **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 table above indicates 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.' operationId: cancelFulfillmentOrder parameters: - name: sellerFulfillmentOrderId in: path description: The identifier assigned to the item by the seller when the fulfillment order was created. required: true schema: type: string maxLength: 40 responses: '200': description: Success. headers: x-amzn-RateLimit-Limit: description: Your rate limit (requests per second) for this operation. schema: type: string x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/CancelFulfillmentOrderResponse' '400': description: Request has missing or invalid parameters and cannot be parsed. headers: x-amzn-RateLimit-Limit: description: Your rate limit (requests per second) for this operation. schema: type: string x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/CancelFulfillmentOrderResponse' '401': description: The request's Authorization header is not formatted correctly or does not contain a valid token. headers: x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/CancelFulfillmentOrderResponse' '403': description: Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature. headers: x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/CancelFulfillmentOrderResponse' '404': description: The specified resource does not exist. headers: x-amzn-RateLimit-Limit: description: Your rate limit (requests per second) for this operation. schema: type: string x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/CancelFulfillmentOrderResponse' '429': description: The frequency of requests was greater than allowed. headers: x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/CancelFulfillmentOrderResponse' '500': description: An unexpected condition occurred that prevented the server from fulfilling the request. headers: x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/CancelFulfillmentOrderResponse' '503': description: Temporary overloading or maintenance of the server. headers: x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/CancelFulfillmentOrderResponse' summary: Cancel fulfillment order x-summary-source: derived /fba/outbound/2020-07-01/fulfillmentOrders/{sellerFulfillmentOrderId}/status: x-amzn-api-sandbox-only: true x-amzn-api-sandbox: dynamic: {} put: tags: - fbaOutbound description: Requests that Amazon update the status of an order in the sandbox testing environment. This is a sandbox-only operation and must be directed to a sandbox endpoint. Refer to Fulfillment Outbound Dynamic Sandbox Guide and Selling Partner API sandbox for more information. operationId: submitFulfillmentOrderStatusUpdate parameters: - name: sellerFulfillmentOrderId in: path description: The identifier assigned to the item by the seller when the fulfillment order was created. required: true schema: type: string maxLength: 40 responses: '200': description: Success. headers: x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/SubmitFulfillmentOrderStatusUpdateResponse' '400': description: Request has missing or invalid parameters and cannot be parsed. headers: x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/SubmitFulfillmentOrderStatusUpdateResponse' '401': description: The request's Authorization header is not formatted correctly or does not contain a valid token. headers: x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/SubmitFulfillmentOrderStatusUpdateResponse' '403': description: Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature. headers: x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/SubmitFulfillmentOrderStatusUpdateResponse' '404': description: The specified resource does not exist. headers: x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/SubmitFulfillmentOrderStatusUpdateResponse' '429': description: The frequency of requests was greater than allowed. headers: x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/SubmitFulfillmentOrderStatusUpdateResponse' '500': description: An unexpected condition occurred that prevented the server from fulfilling the request. headers: x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/SubmitFulfillmentOrderStatusUpdateResponse' '503': description: Temporary overloading or maintenance of the server. headers: x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/SubmitFulfillmentOrderStatusUpdateResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/SubmitFulfillmentOrderStatusUpdateRequest' description: The identifier assigned to the item by the seller when the fulfillment order was created. required: true summary: Submit fulfillment order status update x-summary-source: derived /fba/outbound/2020-07-01/features: x-amzn-api-sandbox: dynamic: {} get: tags: - fbaOutbound description: 'Returns a list of features available for Multi-Channel Fulfillment orders in the marketplace you specify, and whether the seller for which you made the call is enrolled for each feature. **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 table above indicates 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.' operationId: getFeatures parameters: - name: marketplaceId in: query description: The marketplace for which to return the list of features. required: true schema: type: string responses: '200': description: Success. headers: x-amzn-RateLimit-Limit: description: Your rate limit (requests per second) for this operation. schema: type: string x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/GetFeaturesResponse' '400': description: Request has missing or invalid parameters and cannot be parsed. headers: x-amzn-RateLimit-Limit: description: Your rate limit (requests per second) for this operation. schema: type: string x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/GetFeaturesResponse' '401': description: The request's Authorization header is not formatted correctly or does not contain a valid token. headers: x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/GetFeaturesResponse' '403': description: Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature. headers: x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/GetFeaturesResponse' '404': description: The specified resource does not exist. headers: x-amzn-RateLimit-Limit: description: Your rate limit (requests per second) for this operation. schema: type: string x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/GetFeaturesResponse' '429': description: The frequency of requests was greater than allowed. headers: x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/GetFeaturesResponse' '500': description: An unexpected condition occurred that prevented the server from fulfilling the request. headers: x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/GetFeaturesResponse' '503': description: Temporary overloading or maintenance of the server. headers: x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/GetFeaturesResponse' summary: Get features x-summary-source: derived /fba/outbound/2020-07-01/features/inventory/{featureName}: x-amzn-api-sandbox: dynamic: {} get: tags: - fbaOutbound description: 'Returns a list of inventory items that are eligible for the fulfillment feature you specify. **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 table above indicates 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.' operationId: getFeatureInventory parameters: - name: marketplaceId in: query description: The marketplace for which to return a list of the inventory that is eligible for the specified feature. required: true schema: type: string - name: featureName in: path description: The name of the feature for which to return a list of eligible inventory. required: true schema: type: string - name: nextToken in: query description: A string token returned in the response to your previous request that is used to return the next response page. A value of `null` will return the first page. required: false schema: type: string - name: queryStartDate in: query description: A date that you can use to select inventory that has been updated since a specified date. An update is defined as any change in feature-enabled inventory availability. The date must be in the format `yyyy-MM-ddTHH:mm:ss.sssZ` required: false schema: type: string format: date-time responses: '200': description: Success. headers: x-amzn-RateLimit-Limit: description: Your rate limit (requests per second) for this operation. schema: type: string x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/GetFeatureInventoryResponse' '400': description: Request has missing or invalid parameters and cannot be parsed. headers: x-amzn-RateLimit-Limit: description: Your rate limit (requests per second) for this operation. schema: type: string x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/GetFeatureInventoryResponse' '401': description: The request's Authorization header is not formatted correctly or does not contain a valid token. headers: x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/GetFeatureInventoryResponse' '403': description: Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature. headers: x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/GetFeatureInventoryResponse' '404': description: The specified resource does not exist. headers: x-amzn-RateLimit-Limit: description: Your rate limit (requests per second) for this operation. schema: type: string x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/GetFeatureInventoryResponse' '429': description: The frequency of requests was greater than allowed. headers: x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/GetFeatureInventoryResponse' '500': description: An unexpected condition occurred that prevented the server from fulfilling the request. headers: x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/GetFeatureInventoryResponse' '503': description: Temporary overloading or maintenance of the server. headers: x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/GetFeatureInventoryResponse' summary: Get feature inventory x-summary-source: derived /fba/outbound/2020-07-01/features/inventory/{featureName}/{sellerSku}: x-amzn-api-sandbox: dynamic: {} get: tags: - fbaOutbound description: 'Returns the number of items with the `sellerSku` you specify that can have orders fulfilled using the specified feature. Note that if the `sellerSku` isn''t eligible, the response will contain an empty `skuInfo` object. The parameters for this operation may contain special characters that require URL encoding. To avoid errors with SKUs when encoding URLs, refer to URL Encoding. **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 indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.' operationId: getFeatureSKU parameters: - name: marketplaceId in: query description: The marketplace for which to return the count. required: true schema: type: string - name: featureName in: path description: The name of the feature. required: true schema: type: string - name: sellerSku in: path description: Used to identify an item in the given marketplace. `sellerSku` is qualified by the seller's `sellerId`, which is included with every operation that you submit. required: true schema: type: string responses: '200': description: Success. headers: x-amzn-RateLimit-Limit: description: Your rate limit (requests per second) for this operation. schema: type: string x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/GetFeatureSkuResponse' '400': description: Request has missing or invalid parameters and cannot be parsed. headers: x-amzn-RateLimit-Limit: description: Your rate limit (requests per second) for this operation. schema: type: string x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/GetFeatureSkuResponse' '401': description: The request's Authorization header is not formatted correctly or does not contain a valid token. headers: x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/GetFeatureSkuResponse' '403': description: Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature. headers: x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/GetFeatureSkuResponse' '404': description: The specified resource does not exist. headers: x-amzn-RateLimit-Limit: description: Your rate limit (requests per second) for this operation. schema: type: string x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/GetFeatureSkuResponse' '429': description: The frequency of requests was greater than allowed. headers: x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/GetFeatureSkuResponse' '500': description: An unexpected condition occurred that prevented the server from fulfilling the request. headers: x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/GetFeatureSkuResponse' '503': description: Temporary overloading or maintenance of the server. headers: x-amzn-RequestId: description: Unique request reference identifier. schema: type: string content: application/json: schema: $ref: '#/components/schemas/GetFeatureSkuResponse' summary: Get feature SKU x-summary-source: derived components: schemas: DeliveryDocumentList: type: array description: A list of delivery documents for a package. items: $ref: '#/components/schemas/DeliveryDocument' UpdateFulfillmentOrderResponse: type: object properties: errors: description: One or more unexpected errors occurred during the `updateFulfillmentOrder` operation. $ref: '#/components/schemas/ErrorList' description: The response schema for the `updateFulfillmentOrder` operation. CreateFulfillmentOrderResponse: type: object properties: errors: description: One or more unexpected errors occurred during the `createFulfillmentOrder` operation. $ref: '#/components/schemas/ErrorList' description: The response schema for the `createFulfillmentOrder` operation. Origin: type: object required: - countryCode description: The origin for the delivery offer. properties: countryCode: type: string description: The two-digit country code (in ISO 3166-1 alpha-2 format) for the country where the items will ship from. minLength: 2 maxLength: 2 FulfillmentPreviewShipment: type: object required: - fulfillmentPreviewItems properties: earliestShipDate: description: The earliest date that the shipment is expected to be sent from the fulfillment center, in ISO 8601 date time format. $ref: '#/components/schemas/Timestamp' latestShipDate: description: The latest date that the shipment is expected to be sent from the fulfillment center, in ISO 8601 date time format. $ref: '#/components/schemas/Timestamp' earliestArrivalDate: description: The earliest date that the shipment is expected to arrive at its destination. $ref: '#/components/schemas/Timestamp' latestArrivalDate: description: The latest date that the shipment is expected to arrive at its destination, in ISO 8601 date time format. $ref: '#/components/schemas/Timestamp' shippingNotes: type: array description: Provides additional insight into the shipment timeline when exact delivery dates are not able to be precomputed. items: type: string fulfillmentPreviewItems: description: Information about the items in the shipment. $ref: '#/components/schemas/FulfillmentPreviewItemList' description: Delivery and item information for a shipment in a fulfillment order preview. FulfillmentShipmentItemList: type: array description: An array of fulfillment shipment item information. items: $ref: '#/components/schemas/FulfillmentShipmentItem' FulfillmentPreviewShipmentList: type: array description: An array of fulfillment preview shipment information. items: $ref: '#/components/schemas/FulfillmentPreviewShipment' ReturnItem: type: object required: - amazonShipmentId - sellerFulfillmentOrderItemId - sellerReturnItemId - sellerReturnReasonCode - status - statusChangedDate properties: sellerReturnItemId: type: string description: An identifier the seller assigns to the return item. sellerFulfillmentOrderItemId: type: string description: The identifier assigned to the item by the seller when the fulfillment order was created. amazonShipmentId: type: string description: The identifier for the shipment that is associated with the return item. sellerReturnReasonCode: type: string description: The return reason code assigned to the return item by the seller. returnComment: type: string description: An optional comment about the return item. amazonReturnReasonCode: type: string description: The return reason code that the Amazon fulfillment center assigned to the return item. status: description: Indicates if the return item has been processed by an Amazon fulfillment center. $ref: '#/components/schemas/FulfillmentReturnItemStatus' statusChangedDate: description: Indicates when the status last changed. $ref: '#/components/schemas/Timestamp' returnAuthorizationId: type: string description: Identifies the return authorization used to return this item. Refer to `ReturnAuthorization`. returnReceivedCondition: $ref: '#/components/schemas/ReturnItemDisposition' fulfillmentCenterId: type: string description: The identifier for the Amazon fulfillment center that processed the return item. description: An item that Amazon accepted for return. UnfulfillablePreviewItem: type: object required: - quantity - sellerFulfillmentOrderItemId - sellerSku properties: sellerSku: type: string description: The seller SKU of the item. maxLength: 50 quantity: $ref: '#/components/schemas/Quantity' sellerFulfillmentOrderItemId: type: string description: A fulfillment order item identifier created with a call to the `getFulfillmentPreview` operation. maxLength: 50 itemUnfulfillableReasons: description: Error codes associated with the fulfillment order preview that indicate why the item is unfulfillable. $ref: '#/components/schemas/StringList' description: Information about unfulfillable items in a fulfillment order preview. GetFulfillmentPreviewItem: type: object required: - quantity - sellerFulfillmentOrderItemId - sellerSku properties: sellerSku: type: string description: The seller SKU of the item. maxLength: 50 quantity: $ref: '#/components/schemas/Quantity' perUnitDeclaredValue: description: The monetary value assigned by the seller to this item. This is a required field if this order is an export order or an India MCF order. $ref: '#/components/schemas/Money' sellerFulfillmentOrderItemId: type: string description: A fulfillment order item identifier that the seller creates to track items in the fulfillment preview. maxLength: 50 description: Item information for a fulfillment order preview. GetFeatureInventoryResult: type: object required: - featureName - marketplaceId properties: marketplaceId: type: string description: The requested marketplace. featureName: type: string description: The name of the feature. nextToken: type: string description: When present and not empty, pass this string token in the next request to return the next response page. featureSkus: type: array description: An array of SKUs eligible for this feature and the quantity available. items: $ref: '#/components/schemas/FeatureSku' description: The payload for the `getEligibleInventory` operation. InvalidItemReasonCode: type: string description: A code for why the item is invalid for return. enum: - InvalidValues - DuplicateRequest - NoCompletedShipItems - NoReturnableQuantity x-docgen-enum-table-extension: - value: InvalidValues description: The item was not found in a fulfillment order. - value: DuplicateRequest description: A fulfillment return has already been requested for this item. - value: NoCompletedShipItems description: The fulfillment order containing this item has not yet shipped. - value: NoReturnableQuantity description: All item quantity available for return has been allocated to other return items. Fee: type: object required: - amount - name properties: name: type: string description: The type of fee. enum: - FBAPerUnitFulfillmentFee - FBAPerOrderFulfillmentFee - FBATransportationFee - FBAFulfillmentCODFee x-docgen-enum-table-extension: - value: FBAPerUnitFulfillmentFee description: Estimated fee for each unit in the fulfillment order. - value: FBAPerOrderFulfillmentFee description: Estimated order-level fee. - value: FBATransportationFee description: Estimated shipping fee. - value: FBAFulfillmentCODFee description: Estimated COD (Cash On Delivery) fee. This fee applies only to fulfillment order previews for COD. amount: description: The amount of the fee. $ref: '#/components/schemas/Money' description: Fee type and cost. ReturnAuthorizationList: type: array description: An array of return authorization information. items: $ref: '#/components/schemas/ReturnAuthorization' Destination: type: object properties: deliveryAddress: $ref: '#/components/schemas/VariablePrecisionAddress' ipAddress: $ref: '#/components/schemas/IpAddress' description: The IP address of the customer. description: The destination for the delivery offer. FulfillmentOrderItem: type: object required: - cancelledQuantity - quantity - sellerFulfillmentOrderItemId - sellerSku - unfulfillableQuantity properties: sellerSku: type: string description: The seller SKU of the item. sellerFulfillmentOrderItemId: type: string description: A fulfillment order item identifier submitted with a call to the `createFulfillmentOrder` operation. quantity: $ref: '#/components/schemas/Quantity' giftMessage: type: string description: A message to the gift recipient, if applicable. displayableComment: type: string description: Item-specific text that displays in recipient-facing materials such as the outbound shipment packing slip. fulfillmentNetworkSku: type: string description: Amazon's fulfillment network SKU of the item. orderItemDisposition: type: string description: Indicates whether the item is sellable or unsellable. cancelledQuantity: description: The item quantity that was cancelled by the seller. $ref: '#/components/schemas/Quantity' unfulfillableQuantity: description: The item quantity that is unfulfillable. $ref: '#/components/schemas/Quantity' estimatedShipDate: description: The estimated date and time that the item quantity is scheduled to ship from the fulfillment center. Note that this value can change over time. If the shipment that contains the item quantity is cancelled, `estimatedShipDate` is not returned. $ref: '#/components/schemas/Timestamp' estimatedArrivalDate: description: The estimated arrival date and time of the item quantity. Note that this value can change over time. If the shipment that contains the item quantity is cancelled, `estimatedArrivalDate` is not returned. $ref: '#/components/schemas/Timestamp' perUnitPrice: description: The amount to be collected from the recipient for this item in a COD (Cash On Delivery) order. $ref: '#/components/schemas/Money' perUnitTax: description: The tax on the amount to be collected from the recipient for this item in a COD (Cash On Delivery) order. $ref: '#/components/schemas/Money' perUnitDeclaredValue: description: The monetary value assigned by the seller to this item. This is a required field for India MCF orders. $ref: '#/components/schemas/Money' description: Item information for a fulfillment order. FulfillmentOrder: type: object required: - destinationAddress - displayableOrderComment - displayableOrderDate - displayableOrderId - fulfillmentOrderStatus - marketplaceId - receivedDate - sellerFulfillmentOrderId - shippingSpeedCategory - statusUpdatedDate properties: sellerFulfillmentOrderId: type: string description: The fulfillment order identifier submitted with the `createFulfillmentOrder` operation. marketplaceId: type: string description: The identifier for the marketplace the fulfillment order is placed against. displayableOrderId: type: string description: A fulfillment order identifier submitted with the `createFulfillmentOrder` operation. Displays as the order identifier in recipient-facing materials such as the packing slip. displayableOrderDate: description: A date and time submitted with the `createFulfillmentOrder` operation. Displays as the order date in recipient-facing materials such as the packing slip. $ref: '#/components/schemas/Timestamp' displayableOrderComment: type: string description: A text block submitted with the `createFulfillmentOrder` operation. Displays in recipient-facing materials such as the packing slip. shippingSpeedCategory: $ref: '#/components/schemas/ShippingSpeedCategory' deliveryWindow: $ref: '#/components/schemas/DeliveryWindow' destinationAddress: description: The destination address submitted with the `createFulfillmentOrder` operation. $ref: '#/components/schemas/Address' fulfillmentAction: $ref: '#/components/schemas/FulfillmentAction' fulfillmentPolicy: $ref: '#/components/schemas/FulfillmentPolicy' codSettings: $ref: '#/components/schemas/CODSettings' receivedDate: description: The date and time that the fulfillment order was received by an Amazon fulfillment center. $ref: '#/components/schemas/Timestamp' fulfillmentOrderStatus: $ref: '#/components/schemas/FulfillmentOrderStatus' statusUpdatedDate: description: The date and time that the status of the fulfillment order last changed, in ISO 8601 date time format. $ref: '#/components/schemas/Timestamp' notificationEmails: $ref: '#/components/schemas/NotificationEmailList' featureConstraints: type: array description: A list of features and their fulfillment policies to apply to the order. items: $ref: '#/components/schemas/FeatureSettings' description: General information about a fulfillment order, including its status. GetFulfillmentPreviewResult: type: object properties: fulfillmentPreviews: $ref: '#/components/schemas/FulfillmentPreviewList' description: A list of fulfillment order previews, including estimated shipping weights, estimated shipping fees, and estimated ship dates and arrival dates. GetFulfillmentOrderResponse: type: object properties: payload: description: The payload for the `getFulfillmentOrder` operation. $ref: '#/components/schemas/GetFulfillmentOrderResult' errors: description: One or more unexpected errors occurred during the `getFulfillmentOrder` operation. $ref: '#/components/schemas/ErrorList' description: The response schema for the `getFulfillmentOrder` operation. CreateReturnItemList: type: array description: An array of items to be returned. items: $ref: '#/components/schemas/CreateReturnItem' ScheduledDeliveryInfo: type: object required: - deliveryTimeZone - deliveryWindows properties: deliveryTimeZone: type: string description: 'The time zone of the destination address for the fulfillment order preview. Must be an IANA time zone name. Example: Asia/Tokyo.' deliveryWindows: description: An array of time ranges that are available for scheduled delivery. $ref: '#/components/schemas/DeliveryWindowList' description: Delivery information for a scheduled delivery. This is only available in the JP marketplace. UpdateFulfillmentOrderItem: type: object required: - quantity - sellerFulfillmentOrderItemId properties: sellerSku: type: string description: The seller SKU of the item. sellerFulfillmentOrderItemId: type: string description: Identifies the fulfillment order item to update. Created with a previous call to the `createFulfillmentOrder` operation. maxLength: 50 quantity: $ref: '#/components/schemas/Quantity' giftMessage: type: string description: A message to the gift recipient, if applicable. maxLength: 512 displayableComment: type: string description: Item-specific text that displays in recipient-facing materials such as the outbound shipment packing slip. maxLength: 250 fulfillmentNetworkSku: type: string description: Amazon's fulfillment network SKU of the item. orderItemDisposition: type: string description: Indicates whether the item is sellable or unsellable. perUnitDeclaredValue: description: The monetary value assigned by the seller to this item. This is a required field for India MCF orders. $ref: '#/components/schemas/Money' perUnitPrice: description: The amount to be collected from the recipient for this item in a COD (Cash On Delivery) order. $ref: '#/components/schemas/Money' perUnitTax: description: The tax on the amount to be collected from the recipient for this item in a COD (Cash On Delivery) order. $ref: '#/components/schemas/Money' description: Item information for updating a fulfillment order. DropOffLocation: type: object required: - type properties: type: type: string description: The drop-off location type at the destination address. enum: - FRONT_DOOR - DELIVERY_BOX - GAS_METER_BOX - BICYCLE_BASKET - GARAGE - RECEPTIONIST - FALLBACK_NEIGHBOR_DELIVERY - DO_NOT_LEAVE_UNATTENDED x-docgen-enum-table-extension: - value: FRONT_DOOR description: Front door location. - value: DELIVERY_BOX description: Delivery box location. - value: GAS_METER_BOX description: Gas meter box location. - value: BICYCLE_BASKET description: Bicycle basket location. - value: GARAGE description: Garage location. - value: RECEPTIONIST description: Delivery to or via receptionist. - value: FALLBACK_NEIGHBOR_DELIVERY description: Delivery to a designated neighbor when the recipient is not available at the destination address. - value: DO_NOT_LEAVE_UNATTENDED description: Attended delivery (package not left unattended). attributes: type: object additionalProperties: type: string description: 'Additional information about the drop-off location. This information can vary depending on the type of drop-off location specified in the `type` field. If the `type` is set to `FALLBACK_NEIGHBOR_DELIVERY`, the `attributes` object must include the keys `neighborName` and `houseNumber` to provide the name and house number of the designated neighbor. For `RECEPTIONIST` type, the `attributes` object may include a `recipientName` field that contains the name of the person who received or will receive the package.' description: The drop-off location at the destination address. FulfillmentShipmentPackageList: type: array description: An array of fulfillment shipment package information. items: $ref: '#/components/schemas/FulfillmentShipmentPackage' CreateFulfillmentReturnResponse: type: object properties: payload: description: The payload for the `createFulfillmentReturn` operation. $ref: '#/components/schemas/CreateFulfillmentReturnResult' errors: description: One or more unexpected errors occurred during the `createFulfillmentReturn` operation. $ref: '#/components/schemas/ErrorList' description: The response schema for the `createFulfillmentReturn` operation. FulfillmentReturnItemStatus: type: string description: Indicates if the return item has been processed by a fulfillment center. enum: - New - Processed x-docgen-enum-table-extension: - value: New description: The return item has not yet been processed by a fulfillment center. - value: Processed description: The return item has been processed by a fulfillment center. InvalidItemReason: type: object required: - description - invalidItemReasonCode properties: invalidItemReasonCode: $ref: '#/components/schemas/InvalidItemReasonCode' description: type: string description: A human readable description of the invalid item reason code. description: The reason that the item is invalid for return. UpdateFulfillmentOrderRequest: type: object description: The request body schema for the `updateFulfillmentOrder` operation. properties: marketplaceId: type: string description: The marketplace the fulfillment order is placed against. displayableOrderId: type: string description: A fulfillment order identifier that the seller creates. This value displays as the order identifier in recipient-facing materials such as the outbound shipment packing slip. The value of `DisplayableOrderId` should match the order identifier that the seller provides to the recipient. The seller can use the `SellerFulfillmentOrderId` for this value or they can specify an alternate value if they want the recipient to reference an alternate order identifier. maxLength: 40 displayableOrderDate: description: The date and time of the fulfillment order. Displays as the order date in recipient-facing materials such as the outbound shipment packing slip. $ref: '#/components/schemas/Timestamp' displayableOrderComment: type: string description: Order-specific text that appears in recipient-facing materials such as the outbound shipment packing slip. maxLength: 750 shippingSpeedCategory: $ref: '#/components/schemas/ShippingSpeedCategory' destinationAddress: description: The destination address for the fulfillment order. $ref: '#/components/schemas/Address' fulfillmentAction: $ref: '#/components/schemas/FulfillmentAction' fulfillmentPolicy: $ref: '#/components/schemas/FulfillmentPolicy' shipFromCountryCode: type: string description: The two-character country code for the country from which the fulfillment order ships. Must be in ISO 3166-1 alpha-2 format. notificationEmails: $ref: '#/components/schemas/NotificationEmailList' featureConstraints: type: array description: A list of features and their fulfillment policies to apply to the order. items: $ref: '#/components/schemas/FeatureSettings' items: description: A list of items to include in the fulfillment order preview, including quantity. $ref: '#/components/schemas/UpdateFulfillmentOrderItemList' LockerDetails: type: object properties: lockerNumber: type: string description: Indicates the locker number lockerAccessCode: type: string description: Indicates the locker access code description: The locker details, which you can use to access the locker delivery box. GetDeliveryOffersRequest: type: object required: - product - terms properties: product: $ref: '#/components/schemas/GetDeliveryOffersProduct' description: The product details for the delivery offer. terms: $ref: '#/components/schemas/GetDeliveryOffersTerms' description: The terms for the delivery offer. description: The request body schema for the `getDeliveryOffers` operation. Timestamp: description: Date timestamp type: string format: date-time DeliveryWindow: type: object required: - endDate - startDate properties: startDate: description: The date and time of the start of the Scheduled Delivery window, in ISO 8601 date time format. $ref: '#/components/schemas/Timestamp' endDate: description: The date and time of the end of the Scheduled Delivery window, in ISO 8601 date time format. $ref: '#/components/schemas/Timestamp' description: The time range within which a Scheduled Delivery fulfillment order should be delivered. This is only available in the JP marketplace. VariablePrecisionAddress: type: object required: - countryCode - postalCode properties: addressLine1: type: string description: The first line of the address. addressLine2: type: string description: Additional address information, if required. addressLine3: type: string description: Additional address information, if required. city: type: string description: The city where the person, business, or institution is located. This property should not be used in Japan. districtOrCounty: type: string description: The district or county where the person, business, or institution is located. stateOrRegion: type: string description: The state or region where the person, business or institution is located. postalCode: type: string description: The postal code of the address. countryCode: type: string description: The two digit country code. In ISO 3166-1 alpha-2 format. minLength: 2 maxLength: 2 description: A physical address with varying degrees of precision. A more precise address can provide more accurate results than country code and postal code alone. GetFeaturesResponse: type: object properties: payload: $ref: '#/components/schemas/GetFeaturesResult' errors: $ref: '#/components/schemas/ErrorList' description: The response schema for the `getFeatures` operation. DeliveryPreferences: type: object properties: deliveryInstructions: type: string description: Additional delivery instructions. For example, this could be instructions on how to enter a building, nearby landmark or navigation instructions, or `Beware of dogs`. maxLength: 250 dropOffLocation: description: The preferred location to leave packages at the destination address. $ref: '#/components/schemas/DropOffLocation' description: 'The delivery preferences applied to the destination address. These preferences are applied when possible and are best effort. This feature is currently supported only in the JP marketplace and not applicable for other marketplaces. For eligible orders, the default delivery preference will be to deliver the package unattended at the front door, unless you specify otherwise.' DeliveryOffer: type: object properties: expiresAt: $ref: '#/components/schemas/Timestamp' description: The timestamp at which a delivery offer expires. dateRange: $ref: '#/components/schemas/DateRange' description: The range between which delivery is expected. policy: $ref: '#/components/schemas/DeliveryPolicy' description: The policy for a delivery offer, including localized messaging. description: An available offer for delivery of a product. GetFulfillmentPreviewItemList: type: array description: An array of fulfillment preview item information. items: $ref: '#/components/schemas/GetFulfillmentPreviewItem' FulfillmentShipmentList: type: array description: An array of fulfillment shipment information. items: $ref: '#/components/schemas/FulfillmentShipment' ListAllFulfillmentOrdersResult: description: The request for the `listAllFulfillmentOrders` operation. type: object properties: nextToken: type: string description: When present and not empty, pass this string token in the next request to return the next response page. fulfillmentOrders: type: array description: An array of fulfillment order information. items: $ref: '#/components/schemas/FulfillmentOrder' TrackingEvent: type: object required: - eventAddress - eventCode - eventDate - eventDescription properties: eventDate: description: The date and time that the delivery event took place, in ISO 8601 date time format. $ref: '#/components/schemas/Timestamp' eventAddress: description: The city where the delivery event took place. $ref: '#/components/schemas/TrackingAddress' eventCode: description: The event code for the delivery event. $ref: '#/components/schemas/EventCode' eventDescription: type: string description: A description for the corresponding event code. description: Information for tracking package deliveries. FulfillmentPreviewItem: type: object required: - quantity - sellerFulfillmentOrderItemId - sellerSku properties: sellerSku: type: string description: The seller SKU of the item. quantity: description: The item quantity. $ref: '#/components/schemas/Quantity' sellerFulfillmentOrderItemId: type: string description: A fulfillment order item identifier that the seller created with a call to the `createFulfillmentOrder` operation. estimatedShippingWeight: description: The estimated shipping weight of the item quantity for a single item, as identified by `sellerSku`, in a shipment. $ref: '#/components/schemas/Weight' shippingWeightCalculationMethod: type: string description: The method used to calculate the estimated shipping weight. enum: - Package - Dimensional x-docgen-enum-table-extension: - value: Package description: Based on the actual weight of the items. - value: Dimensional description: Based on the cubic space that the items occupy. description: Item information for a shipment in a fulfillment order preview. GetDeliveryOffersProduct: type: object required: - productIdentifier properties: productIdentifier: $ref: '#/components/schemas/ProductIdentifier' description: Product identifier input that locates a product for MCF. amount: $ref: '#/components/schemas/Amount' description: The amount of the requested product. description: The product details for the delivery offer. CODSettings: type: object required: - isCodRequired properties: isCodRequired: type: boolean description: When true, this fulfillment order requires a COD (Cash On Delivery) payment. codCharge: description: The amount of the COD charge to be collected from the recipient for a COD order. $ref: '#/components/schemas/Money' codChargeTax: description: The amount of the tax on the COD charge to be collected from the recipient for a COD order. $ref: '#/components/schemas/Money' shippingCharge: description: The amount of the tax on the COD charge to be collected from the recipient for a COD order. $ref: '#/components/schemas/Money' shippingChargeTax: description: The amount of the tax on the shipping charge to be collected from the recipient for a COD order. $ref: '#/components/schemas/Money' description: The COD (Cash On Delivery) charges that you associate with a COD fulfillment order. DeliveryPolicy: type: object properties: message: $ref: '#/components/schemas/DeliveryMessage' description: Localized messaging for a delivery offering. description: The policy for a delivery offering. FulfillmentShipment: type: object required: - amazonShipmentId - fulfillmentCenterId - fulfillmentShipmentItem - fulfillmentShipmentStatus properties: amazonShipmentId: type: string description: A shipment identifier assigned by Amazon. fulfillmentCenterId: type: string description: An identifier for the fulfillment center from which the shipment is sent. fulfillmentShipmentStatus: type: string description: The current status of the shipment. enum: - PENDING - SHIPPED - CANCELLED_BY_FULFILLER - CANCELLED_BY_SELLER x-docgen-enum-table-extension: - value: PENDING description: The process of picking units from inventory has begun. - value: SHIPPED description: All packages in the shipment have left the fulfillment center. - value: CANCELLED_BY_FULFILLER description: The Amazon fulfillment center could not fulfill the shipment as planned. This might be because the inventory was not at the expected location in the fulfillment center. After cancelling the fulfillment order, Amazon immediately creates a new fulfillment shipment and again attempts to fulfill the order. - value: CANCELLED_BY_SELLER description: The shipment was cancelled using the CancelFulfillmentOrder request. shippingDate: description: 'The meaning of the `shippingDate` value depends on the current status of the shipment. If the current value of FulfillmentShipmentStatus is: * Pending - shippingDate represents the estimated time that the shipment will leave the Amazon fulfillment center. * Shipped - shippingDate represents the date that the shipment left the Amazon fulfillment center. If a shipment includes more than one package, `shippingDate` applies to all of the packages in the shipment. If the value of `FulfillmentShipmentStatus` is `CancelledByFulfiller` or `CancelledBySeller`, `shippingDate` is not returned. The value must be in ISO 8601 date time format.' $ref: '#/components/schemas/Timestamp' estimatedArrivalDate: description: The estimated arrival date and time of the shipment, in ISO 8601 date time format. Note that this value can change over time. If a shipment includes more than one package, `estimatedArrivalDate` applies to all of the packages in the shipment. If the shipment is cancelled, `estimatedArrivalDate` is not returned. $ref: '#/components/schemas/Timestamp' shippingNotes: type: array description: Provides additional insight into shipment timeline. Primarily used to communicate that actual delivery dates aren't available. items: type: string fulfillmentShipmentItem: $ref: '#/components/schemas/FulfillmentShipmentItemList' fulfillmentShipmentPackage: $ref: '#/components/schemas/FulfillmentShipmentPackageList' description: Delivery and item information for a shipment in a fulfillment order. GetDeliveryOffersResult: type: object properties: deliveryOffers: $ref: '#/components/schemas/DeliveryOffersList' description: An array of delivery offers. description: A list of delivery offers, including offer expiration, earliest and latest date and time range, and the delivery offer policy. PackageTrackingDetails: description: Tracking details of package type: object required: - packageNumber properties: packageNumber: type: integer format: int32 description: The package identifier. trackingNumber: type: string description: The tracking number for the package. customerTrackingLink: type: string description: Link on swiship.com that allows customers to track the package. carrierCode: type: string description: The name of the carrier. carrierPhoneNumber: type: string description: The phone number of the carrier. carrierURL: type: string description: The URL of the carrier's website. shipDate: description: The shipping date for the package. $ref: '#/components/schemas/Timestamp' estimatedArrivalDate: description: The estimated arrival date. $ref: '#/components/schemas/Timestamp' shipToAddress: description: The destination city for the package. $ref: '#/components/schemas/TrackingAddress' currentStatus: $ref: '#/components/schemas/CurrentStatus' currentStatusDescription: type: string description: Description corresponding to the `CurrentStatus` value. deliveryWindow: description: The delivery window for the package. This is available after the package reaches its destination delivery station. $ref: '#/components/schemas/DateRange' signedForBy: type: string description: The name of the person who signed for the package. additionalLocationInfo: $ref: '#/components/schemas/AdditionalLocationInfo' trackingEvents: $ref: '#/components/schemas/TrackingEventList' DateRange: type: object required: - earliest - latest properties: earliest: $ref: '#/components/schemas/Timestamp' description: The earliest point in a date range. latest: $ref: '#/components/schemas/Timestamp' description: The latest point in a date range. description: The time range within which something (for example, a delivery) will occur. GetFulfillmentPreviewResponse: type: object properties: payload: description: The response payload for the `getFulfillmentPreview` operation. $ref: '#/components/schemas/GetFulfillmentPreviewResult' errors: description: One or more unexpected errors occurred during the `getFulfillmentPreview` operation. $ref: '#/components/schemas/ErrorList' description: The response schema for the `getFulfillmentPreview` operation. CurrentStatus: type: string description: The current delivery status of the package. enum: - IN_TRANSIT - DELIVERED - RETURNING - RETURNED - UNDELIVERABLE - DELAYED - AVAILABLE_FOR_PICKUP - CUSTOMER_ACTION - UNKNOWN - OUT_FOR_DELIVERY - DELIVERY_ATTEMPTED - PICKUP_SUCCESSFUL - PICKUP_CANCELLED - PICKUP_ATTEMPTED - PICKUP_SCHEDULED - RETURN_REQUEST_ACCEPTED - REFUND_ISSUED - RETURN_RECEIVED_IN_FC x-docgen-enum-table-extension: - value: IN_TRANSIT description: In transit to the destination address. - value: DELIVERED description: Delivered to the destination address. - value: RETURNING description: In the process of being returned to Amazon's fulfillment network. - value: RETURNED description: Returned to Amazon's fulfillment network. - value: UNDELIVERABLE description: Undeliverable because package was lost or destroyed. - value: DELAYED description: Delayed. - value: AVAILABLE_FOR_PICKUP description: Available for pickup. - value: CUSTOMER_ACTION description: Requires customer action. - value: UNKNOWN description: Unknown Status Code was returned. - value: OUT_FOR_DELIVERY description: Out for Delivery. - value: DELIVERY_ATTEMPTED description: Delivery Attempted. - value: PICKUP_SUCCESSFUL description: Pickup Successful. - value: PICKUP_CANCELLED description: Pickup Cancelled. - value: PICKUP_ATTEMPTED description: Pickup Attempted. - value: PICKUP_SCHEDULED description: Pickup Scheduled. - value: RETURN_REQUEST_ACCEPTED description: Return Request Accepted. - value: REFUND_ISSUED description: Refund Issued. - value: RETURN_RECEIVED_IN_FC description: Return Received In FC. ReturnItemList: type: array description: An array of items that Amazon accepted for return. Returns empty if no items were accepted for return. items: $ref: '#/components/schemas/ReturnItem' CreateFulfillmentOrderItemList: type: array description: An array of item information for creating a fulfillment order. items: $ref: '#/components/schemas/CreateFulfillmentOrderItem' GetDeliveryOffersTerms: type: object required: - origin - destination properties: origin: $ref: '#/components/schemas/Origin' description: The origin for the delivery offer. destination: $ref: '#/components/schemas/Destination' description: The destination for the delivery offer. description: The delivery terms for the delivery offer. ListReturnReasonCodesResult: description: The request for the `listReturnReasonCodes` operation. type: object properties: reasonCodeDetails: $ref: '#/components/schemas/ReasonCodeDetailsList' DeliveryOffersList: type: array description: An array of delivery offer information. items: $ref: '#/components/schemas/DeliveryOffer' PaymentInformationList: type: array description: An array of various payment attributes related to this fulfillment order. items: $ref: '#/components/schemas/PaymentInformation' ReasonCodeDetailsList: type: array description: An array of return reason code details. items: $ref: '#/components/schemas/ReasonCodeDetails' StringList: description: String list type: array items: type: string AdditionalLocationInfo: type: string description: Additional location information. enum: - AS_INSTRUCTED - CARPORT - CUSTOMER_PICKUP - DECK - DOOR_PERSON - FRONT_DESK - FRONT_DOOR - GARAGE - GUARD - MAIL_ROOM - MAIL_SLOT - MAILBOX - MC_BOY - MC_GIRL - MC_MAN - MC_WOMAN - NEIGHBOR - OFFICE - OUTBUILDING - PATIO - PORCH - REAR_DOOR - RECEPTIONIST - RECEIVER - SECURE_LOCATION - SIDE_DOOR x-docgen-enum-table-extension: - value: AS_INSTRUCTED description: As instructed. - value: CARPORT description: Carport. - value: CUSTOMER_PICKUP description: Picked up by customer. - value: DECK description: Deck. - value: DOOR_PERSON description: Resident. - value: FRONT_DESK description: Front desk. - value: FRONT_DOOR description: Front door. - value: GARAGE description: Garage. - value: GUARD description: Residential guard. - value: MAIL_ROOM description: Mail room. - value: MAIL_SLOT description: Mail slot. - value: MAILBOX description: Mailbox. - value: MC_BOY description: Delivered to male child. - value: MC_GIRL description: Delivered to female child. - value: MC_MAN description: Delivered to male adult. - value: MC_WOMAN description: Delivered to female adult. - value: NEIGHBOR description: Delivered to neighbor. - value: OFFICE description: Office. - value: OUTBUILDING description: Outbuilding. - value: PATIO description: Patio. - value: PORCH description: Porch. - value: REAR_DOOR description: Rear door. - value: RECEPTIONIST description: Receptionist. - value: RECEIVER description: Resident. - value: SECURE_LOCATION description: Secure location. - value: SIDE_DOOR description: Side door. CreateFulfillmentOrderRequest: type: object required: - destinationAddress - displayableOrderComment - displayableOrderDate - displayableOrderId - items - sellerFulfillmentOrderId - shippingSpeedCategory properties: marketplaceId: type: string description: The marketplace the fulfillment order is placed against. sellerFulfillmentOrderId: type: string description: A fulfillment order identifier that the seller creates to track their fulfillment order. The `sellerFulfillmentOrderId` must be unique for each fulfillment order that a seller creates. If the seller's system already creates unique order identifiers, then these might be good values for them to use. maxLength: 40 displayableOrderId: type: string description: 'A fulfillment order identifier that the seller creates. This value displays as the order identifier in recipient-facing materials such as the outbound shipment packing slip. The value of `displayableOrderId` should match the order identifier that the seller provides to the recipient. The seller can use the SellerFulfillmentOrderId for this value or they can specify an alternate value if they want the recipient to reference an alternate order identifier. The value must be an alpha-numeric or ISO 8859-1 compliant string from one to 40 characters in length. Cannot contain two spaces in a row. Leading and trailing white space is removed.' maxLength: 40 displayableOrderDate: description: The date and time of the fulfillment order. Displays as the order date in recipient-facing materials such as the outbound shipment packing slip. $ref: '#/components/schemas/Timestamp' displayableOrderComment: type: string description: Order-specific text that appears in recipient-facing materials such as the outbound shipment packing slip. maxLength: 750 shippingSpeedCategory: description: 'The shipping method for the fulfillment order. When this value is `ScheduledDelivery`, choose Ship for the `fulfillmentAction`. Hold is not a valid `fulfillmentAction` value when the `shippingSpeedCategory` value is `ScheduledDelivery`. Note: Shipping method service level agreements vary by marketplace. Sellers can refer to [Seller Central]( https://developer-docs.amazon.com/sp-api/docs/seller-central-urls) for shipping method service-level agreements and multi-channel fulfillment fees.' $ref: '#/components/schemas/ShippingSpeedCategory' deliveryWindow: $ref: '#/components/schemas/DeliveryWindow' destinationAddress: description: The destination address for the fulfillment order. $ref: '#/components/schemas/Address' deliveryPreferences: description: 'The delivery preferences applied to the destination address. These preferences are applied when possible and are best effort. For eligible orders, the default delivery preference is to leave the package unattended at the front door. This feature is currently supported only in the JP marketplace and not applicable for other marketplaces. For eligible orders, the default delivery preference will be to deliver the package unattended at the front door, unless you specify otherwise.' $ref: '#/components/schemas/DeliveryPreferences' fulfillmentAction: $ref: '#/components/schemas/FulfillmentAction' fulfillmentPolicy: $ref: '#/components/schemas/FulfillmentPolicy' codSettings: $ref: '#/components/schemas/CODSettings' shipFromCountryCode: type: string description: The two-character country code for the country from which the fulfillment order ships. Must be in ISO 3166-1 alpha-2 format. notificationEmails: $ref: '#/components/schemas/NotificationEmailList' featureConstraints: type: array description: A list of features and their fulfillment policies to apply to the order. items: $ref: '#/components/schemas/FeatureSettings' items: description: A list of items to include in the fulfillment order preview, including quantity. Maximum of 100 line items with a maximum of 250 units per order. $ref: '#/components/schemas/CreateFulfillmentOrderItemList' paymentInformation: description: An array of various payment attributes related to this fulfillment order. This property is required if the order is placed against the India marketplace. $ref: '#/components/schemas/PaymentInformationList' description: The request body schema for the `createFulfillmentOrder` operation. Error: type: object required: - code - message properties: code: type: string description: An error code that identifies the type of error that occurred. message: type: string description: A message that describes the error condition. details: type: string description: Additional details that can help the caller understand or fix the issue. description: Error response returned when the request is unsuccessful. FulfillmentPreview: type: object required: - isCODCapable - isFulfillable - marketplaceId - shippingSpeedCategory properties: shippingSpeedCategory: $ref: '#/components/schemas/ShippingSpeedCategory' scheduledDeliveryInfo: $ref: '#/components/schemas/ScheduledDeliveryInfo' isFulfillable: type: boolean description: When true, this fulfillment order preview is fulfillable. isCODCapable: type: boolean description: When true, this fulfillment order preview is for COD (Cash On Delivery). estimatedShippingWeight: description: Estimated shipping weight for this fulfillment order preview. $ref: '#/components/schemas/Weight' estimatedFees: description: The estimated fulfillment fees for this fulfillment order preview, if applicable. The fees data will not be available for IN marketplace orders. $ref: '#/components/schemas/FeeList' fulfillmentPreviewShipments: $ref: '#/components/schemas/FulfillmentPreviewShipmentList' unfulfillablePreviewItems: $ref: '#/components/schemas/UnfulfillablePreviewItemList' orderUnfulfillableReasons: description: 'Error codes associated with the fulfillment order preview that indicate why the order is not fulfillable. Error code examples: `DeliverySLAUnavailable` `InvalidDestinationAddress`' $ref: '#/components/schemas/StringList' marketplaceId: type: string description: The marketplace the fulfillment order is placed against. featureConstraints: type: array description: A list of features and their fulfillment policies to apply to the order. items: $ref: '#/components/schemas/FeatureSettings' description: Information about a fulfillment order preview, including delivery and fee information based on shipping method. SubmitFulfillmentOrderStatusUpdateRequest: type: object description: The request body schema for the `submitFulfillmentOrderStatusUpdate` operation. properties: fulfillmentOrderStatus: $ref: '#/components/schemas/FulfillmentOrderStatus' CreateReturnItem: type: object required: - amazonShipmentId - returnReasonCode - sellerFulfillmentOrderItemId - sellerReturnItemId properties: sellerReturnItemId: type: string description: An identifier the seller assigns to the return item. maxLength: 80 sellerFulfillmentOrderItemId: type: string description: The identifier assigned to the item by the seller when the fulfillment order was created. amazonShipmentId: type: string description: The identifier for the shipment that is associated with the return item. returnReasonCode: type: string description: The return reason code assigned to the return item by the seller. returnComment: type: string description: An optional comment about the return item. maxLength: 1000 description: An item that Amazon accepted for return. SubmitFulfillmentOrderStatusUpdateResponse: type: object properties: errors: description: One or more unexpected errors occurred during the `SubmitFulfillmentOrderStatusUpdate` operation. $ref: '#/components/schemas/ErrorList' description: The response schema for the `SubmitFulfillmentOrderStatusUpdate` operation. GetFeatureSkuResult: type: object required: - featureName - isEligible - marketplaceId properties: marketplaceId: type: string description: The requested marketplace. featureName: type: string description: The name of the feature. isEligible: type: boolean description: When true, the seller SKU is eligible for the requested feature. ineligibleReasons: type: array description: 'A list of one or more reasons that the seller SKU is ineligible for the feature. Possible values: * `MERCHANT_NOT_ENROLLED`: The merchant isn''t enrolled for the feature. * `SKU_NOT_ELIGIBLE`: The SKU doesn''t reside in a warehouse that supports the feature. * `INVALID_SKU`: There is an issue with the SKU provided.' items: type: string sellerSku: type: string description: Used to identify an item in the given marketplace. SellerSKU is qualified by the seller's SellerId, which is included with every operation that you submit. fnSku: type: string description: The unique SKU used by Amazon's fulfillment network. asin: type: string description: The Amazon Standard Identification Number (ASIN) of the item. skuCount: type: number description: The number of SKUs available for this service. description: The payload for the `getFeatureSKU` operation. FulfillmentPolicy: type: string description: The `FulfillmentPolicy` value specified when you called the `createFulfillmentOrder` operation. enum: - FillOrKill - FillAll - FillAllAvailable x-docgen-enum-table-extension: - value: FillOrKill description: If an item in a fulfillment order is determined to be unfulfillable before any shipment in the order has acquired the status of Pending (the process of picking units from inventory has begun), then the entire order is considered unfulfillable. However, if an item in a fulfillment order is determined to be unfulfillable after a shipment in the order has acquired the status of Pending, Amazon cancels as much of the fulfillment order as possible. Refer to the `FulfillmentShipment` object for shipment status definitions. - value: FillAll description: All fulfillable items in the fulfillment order are shipped. The fulfillment order remains in a processing state until all items are either shipped by Amazon or cancelled by the seller. **Note:** The `Hold` state overrides the `FillAll` fulfillment policy. `Hold` orders are automatically canceled after 14 days. If you use the `FillAll` policy with the `Ship` state, and there are unshipped items, then the order becomes `Unfulfillable` or `CompletePartialled` after 24 hours. - value: FillAllAvailable description: All fulfillable items in the fulfillment order are shipped. All unfulfillable items in the order are cancelled. FeatureSku: type: object properties: sellerSku: type: string description: Used to identify an item in the given marketplace. SellerSKU is qualified by the seller's SellerId, which is included with every operation that you submit. fnSku: type: string description: The unique SKU used by Amazon's fulfillment network. asin: type: string description: The Amazon Standard Identification Number (ASIN) of the item. skuCount: type: number description: The number of SKUs available for this service. overlappingSkus: type: array description: Other seller SKUs that are shared across the same inventory. items: type: string description: Information about an SKU, including the count available, identifiers, and a list of overlapping SKUs that share the same inventory pool. GetDeliveryOffersResponse: type: object properties: payload: $ref: '#/components/schemas/GetDeliveryOffersResult' description: The response payload for the `getDeliveryOffers` operation. errors: $ref: '#/components/schemas/ErrorList' description: One or more unexpected errors occurred during the `getDeliveryOffers` operation. description: The response schema for the `getDeliveryOffers` operation. CreateFulfillmentReturnResult: description: The result for the `createFulfillmentReturn` operation. type: object properties: returnItems: $ref: '#/components/schemas/ReturnItemList' invalidReturnItems: $ref: '#/components/schemas/InvalidReturnItemList' returnAuthorizations: $ref: '#/components/schemas/ReturnAuthorizationList' Decimal: type: string description: A decimal number with no loss of precision. Useful when precision loss is unacceptable, as with currencies. Follows RFC7159 for number representation. FulfillmentOrderItemList: type: array description: An array of fulfillment order item information. items: $ref: '#/components/schemas/FulfillmentOrderItem' ReasonCodeDetails: type: object required: - description - returnReasonCode properties: returnReasonCode: type: string description: A code that indicates a valid return reason. description: type: string description: A human readable description of the return reason code. translatedDescription: type: string description: A translation of the description. The translation is in the language specified in the `language` request parameter. description: A return reason code, a description, and an optional description translation. Weight: type: object required: - unit - value properties: unit: type: string description: The unit of weight. enum: - KG - KILOGRAMS - LB - POUNDS x-docgen-enum-table-extension: - value: KG description: Kilograms. - value: KILOGRAMS description: Kilograms. - value: LB description: Pounds. - value: POUNDS description: Pounds. value: type: string description: The weight value. description: The weight. EventCode: type: string description: The event code for the delivery event. enum: - EVENT_101 - EVENT_102 - EVENT_201 - EVENT_202 - EVENT_203 - EVENT_204 - EVENT_205 - EVENT_206 - EVENT_301 - EVENT_302 - EVENT_304 - EVENT_306 - EVENT_307 - EVENT_308 - EVENT_309 - EVENT_401 - EVENT_402 - EVENT_403 - EVENT_404 - EVENT_405 - EVENT_406 - EVENT_407 - EVENT_408 - EVENT_409 - EVENT_411 - EVENT_412 - EVENT_413 - EVENT_414 - EVENT_415 - EVENT_416 - EVENT_417 - EVENT_418 - EVENT_419 - EVENT_801 - EVENT_804 x-docgen-enum-table-extension: - value: EVENT_101 description: Carrier notified to pick up package. - value: EVENT_102 description: Shipment picked up from seller's facility. - value: EVENT_201 description: Arrival scan. - value: EVENT_202 description: Departure scan. - value: EVENT_203 description: Arrived at destination country. - value: EVENT_204 description: Initiated customs clearance process. - value: EVENT_205 description: Completed customs clearance process. - value: EVENT_206 description: In transit to pickup location. - value: EVENT_301 description: Delivered. - value: EVENT_302 description: Out for delivery. - value: EVENT_304 description: Delivery attempted. - value: EVENT_306 description: Customer contacted to arrange delivery. - value: EVENT_307 description: Delivery appointment scheduled. - value: EVENT_308 description: Available for pickup. - value: EVENT_309 description: Returned to seller. - value: EVENT_401 description: Held by carrier - incorrect address. - value: EVENT_402 description: Customs clearance delay. - value: EVENT_403 description: Customer moved. - value: EVENT_404 description: Delay in delivery due to external factors. - value: EVENT_405 description: Shipment damaged. - value: EVENT_406 description: Held by carrier. - value: EVENT_407 description: Customer refused delivery. - value: EVENT_408 description: Returning to seller. - value: EVENT_409 description: Lost by carrier. - value: EVENT_411 description: Paperwork received - did not receive shipment. - value: EVENT_412 description: Shipment received - did not receive paperwork. - value: EVENT_413 description: Held by carrier - customer refused shipment due to customs charges. - value: EVENT_414 description: Missorted by carrier. - value: EVENT_415 description: Received from prior carrier. - value: EVENT_416 description: Undeliverable. - value: EVENT_417 description: Shipment missorted. - value: EVENT_418 description: Shipment delayed. - value: EVENT_419 description: Address corrected - delivery rescheduled. - value: EVENT_801 description: Package delivered to locker. - value: EVENT_804 description: Package picked up from locker. FeeList: type: array description: An array of fee type and cost pairs. items: $ref: '#/components/schemas/Fee' Feature: type: object required: - featureDescription - featureName properties: featureName: type: string description: The feature name. featureDescription: type: string description: The feature description. sellerEligible: type: boolean description: When true, indicates that the seller is eligible to use the feature. description: A Multi-Channel Fulfillment feature. NotificationEmailList: type: array description: A list of email addresses that the seller provides that are used by Amazon to send ship-complete notifications to recipients on behalf of the seller. items: type: string maxLength: 64 Features: type: array description: An array of features. items: $ref: '#/components/schemas/Feature' FeatureSettings: type: object properties: featureName: type: string description: "The name of the feature. Valid feature names are:\n\n- `BLOCK_AMZL`: Blocks orders from being shipped using Amazon Logistics (AMZL).\n - Note: Using this feature will incur additional fee surcharges on MCF orders and may increase the risk of unfulfilled or delayed deliveries if alternative carriers are unavailable. Using `BLOCK_AMZL` in an order request will take precedence over your Seller Central account setting.\n- `BLANK_BOX`: Ships orders in non-Amazon branded packaging (blank boxes).\n- `OVERBOX`: Requires items to be shipped in an overbox rather than in their original product packaging.\n- `PACKING_SLIP`: Requires a packing slip to be included with the order.\n- `SIGNATURE_CONFIRMATION`: Requires a signature from the recipient upon delivery. \n - Note: Using signature confirmation features will incur additional fees on MCF orders and are currently supported only in the US marketplace." featureFulfillmentPolicy: type: string description: Specifies the policy to use when fulfilling an order. enum: - Required - NotRequired x-docgen-enum-table-extension: - value: Required description: If the offer can't be shipped with the selected feature, reject the order. - value: NotRequired description: The feature is not required for shipping. description: Feature settings allows you to apply fulfillment features to an order. To block an order from being shipped using Amazon Logistics (AMZL) and an AMZL tracking number, set `featureName` to `BLOCK_AMZL` and `featureFulfillmentPolicy` to `Required`. Blocking AMZL will incur an additional fee surcharge on your MCF orders and increase the risk of some of your orders being unfulfilled or delivered late if there are no alternative carriers available. Using `BLOCK_AMZL` in an order request will take precedence over your Seller Central account setting. To ship in non-Amazon branded packaging (blank boxes), set `featureName` to `BLANK_BOX`. To require items to be shipped in an overbox rather than in their original product packaging, set `featureName` to `OVERBOX`. To require a packing slip to be included with the order, set `featureName` to `PACKING_SLIP`. To require a signature from the recipient upon delivery, set `featureName` to `SIGNATURE_CONFIRMATION`. Note that using signature confirmation features will incur additional fees on MCF orders and are currently supported only in the US marketplace. To ensure all items in an order are delivered together, set `featureName` to `DELIVER_TOGETHER`. GetFeatureSkuResponse: type: object properties: payload: $ref: '#/components/schemas/GetFeatureSkuResult' errors: $ref: '#/components/schemas/ErrorList' description: The response schema for the `getFeatureSKU` operation. GetFulfillmentPreviewRequest: type: object required: - address - items properties: marketplaceId: type: string description: The marketplace the fulfillment order is placed against. address: description: The destination address for the fulfillment order preview. $ref: '#/components/schemas/Address' items: description: 'Identifying information and quantity information for the items in the fulfillment order preview. Maximum of 100 line items with a maximum of 250 units per order. ' $ref: '#/components/schemas/GetFulfillmentPreviewItemList' shippingSpeedCategories: description: 'A list of shipping methods used for creating fulfillment order previews. Possible values: * `Standard`: Standard shipping method. * `Expedited`: Expedited shipping method. * `Priority`: Priority shipping method. * `ScheduledDelivery`: Scheduled Delivery shipping method. **Note:** Shipping method service level agreements vary by marketplace. Sellers should see the Seller Central website in their marketplace for shipping method service level agreements and fulfillment fees.' $ref: '#/components/schemas/ShippingSpeedCategoryList' includeCODFulfillmentPreview: type: boolean description: When true, returns all fulfillment order previews both for COD and not for COD. Otherwise, returns only fulfillment order previews that are not for COD. includeDeliveryWindows: type: boolean description: When true, returns the `ScheduledDeliveryInfo` response object, which contains the available delivery windows for a Scheduled Delivery. The `ScheduledDeliveryInfo` response object can only be returned for fulfillment order previews with `ShippingSpeedCategories` equal to `ScheduledDelivery`. featureConstraints: type: array description: A list of features and their fulfillment policies to apply to the order. items: $ref: '#/components/schemas/FeatureSettings' description: The request body schema for the `getFulfillmentPreview` operation. UnfulfillablePreviewItemList: type: array description: An array of unfulfillable preview item information. items: $ref: '#/components/schemas/UnfulfillablePreviewItem' DeliveryMessage: type: object properties: text: type: string description: The message content for a delivery offering. locale: type: string description: The locale for the message (e.g., `en_US`). description: Localized messaging for a delivery offering. ReturnAuthorization: type: object required: - amazonRmaId - fulfillmentCenterId - returnAuthorizationId - returnToAddress - rmaPageURL properties: returnAuthorizationId: type: string description: An identifier for the return authorization. This identifier associates return items with the return authorization used to return them. fulfillmentCenterId: type: string description: An identifier for the Amazon fulfillment center to which the return items should be sent. returnToAddress: description: The address of the Amazon fulfillment center that the return items should be sent to. $ref: '#/components/schemas/Address' amazonRmaId: type: string description: The return merchandise authorization (RMA) that Amazon needs to process the return. rmaPageURL: type: string description: A URL for a web page that contains the return authorization barcode and the mailing label. This does not include pre-paid shipping. description: Return authorization information for items accepted for return. Money: type: object required: - currencyCode - value properties: currencyCode: type: string description: Three digit currency code in ISO 4217 format. value: $ref: '#/components/schemas/Decimal' description: An amount of money, including units in the form of currency. FulfillmentAction: type: string description: Specifies whether the fulfillment order should ship now or have an order hold put on it. enum: - Ship - Hold x-docgen-enum-table-extension: - value: Ship description: The fulfillment order ships now. - value: Hold description: An order hold is put on the fulfillment order. CreateFulfillmentReturnRequest: type: object required: - items properties: items: $ref: '#/components/schemas/CreateReturnItemList' description: The `createFulfillmentReturn` operation creates a fulfillment return for items that were fulfilled using the `createFulfillmentOrder` operation. For calls to `createFulfillmentReturn`, you must include `returnReasonCode` values returned by a previous call to the `listReturnReasonCodes` operation. InvalidReturnItem: type: object required: - invalidItemReason - sellerFulfillmentOrderItemId - sellerReturnItemId properties: sellerReturnItemId: type: string description: An identifier the seller assigns to the return item. sellerFulfillmentOrderItemId: type: string description: The identifier assigned to the item by the seller when the fulfillment order was created. invalidItemReason: $ref: '#/components/schemas/InvalidItemReason' description: An item that is invalid for return. TrackingAddress: type: object required: - city - country - state properties: city: type: string description: The city. maxLength: 150 state: type: string description: The state. maxLength: 150 country: type: string description: The country. maxLength: 6 description: Address information for tracking the package. DeliveryDocument: type: object required: - documentType properties: documentType: type: string description: The delivery document type. The only possible value is `DELIVERY_IMAGE`. url: type: string description: A URL that is valid for one hour to download the document. In case of URL expiry, call the API again to get a new url. The URL will have a Content-Type header. description: A delivery document for a package. ListAllFulfillmentOrdersResponse: type: object properties: payload: description: The payload for the `listAllFulfillmentOrders` operation. $ref: '#/components/schemas/ListAllFulfillmentOrdersResult' errors: description: One or more unexpected errors occurred during the `listAllFulfillmentOrders` operation. $ref: '#/components/schemas/ErrorList' description: The response schema for the `listAllFulfillmentOrders` operation. InvalidReturnItemList: type: array description: An array of invalid return item information. items: $ref: '#/components/schemas/InvalidReturnItem' DeliveryInformation: type: object properties: deliveryDocumentList: description: All of the delivery documents for a package. $ref: '#/components/schemas/DeliveryDocumentList' dropOffLocation: description: The drop off location for a package. $ref: '#/components/schemas/DropOffLocation' description: The delivery information of the package, this information is only available post package delivery to its intended destination. ErrorList: type: array description: A list of error responses returned when a request is unsuccessful. items: $ref: '#/components/schemas/Error' CreateFulfillmentOrderItem: type: object required: - quantity - sellerFulfillmentOrderItemId - sellerSku properties: sellerSku: type: string description: The seller SKU of the item. maxLength: 50 sellerFulfillmentOrderItemId: type: string description: A fulfillment order item identifier that the seller creates to track fulfillment order items. Used to disambiguate multiple fulfillment items that have the same `sellerSku` value. For example, the seller might assign different `sellerFulfillmentOrderItemId` values to two items in a fulfillment order that share the same `sellerSku` value but have different `giftMessage` values. maxLength: 50 quantity: $ref: '#/components/schemas/Quantity' giftMessage: type: string description: A message to the gift recipient, if applicable. maxLength: 512 displayableComment: type: string description: Item-specific text that displays in recipient-facing materials such as the outbound shipment packing slip. maxLength: 250 fulfillmentNetworkSku: type: string description: Amazon's fulfillment network SKU of the item. perUnitDeclaredValue: description: The monetary value assigned by the seller to this item. This is a required field for India MCF orders. $ref: '#/components/schemas/Money' perUnitPrice: description: The amount to be collected from the recipient for this item in a COD (Cash On Delivery) order. $ref: '#/components/schemas/Money' perUnitTax: description: The tax on the amount to be collected from the recipient for this item in a COD (Cash On Delivery) order. $ref: '#/components/schemas/Money' description: Item information for creating a fulfillment order. IpAddress: type: string format: ip description: An IP address. FulfillmentPreviewList: type: array description: An array of fulfillment preview information. items: $ref: '#/components/schemas/FulfillmentPreview' CancelFulfillmentOrderResponse: type: object properties: errors: description: One or more unexpected errors occurred during the `cancelFulfillmentOrder` operation. $ref: '#/components/schemas/ErrorList' description: The response schema for the `cancelFulfillmentOrder` operation. DeliveryWindowList: type: array description: An array of delivery windows. items: $ref: '#/components/schemas/DeliveryWindow' ShippingSpeedCategoryList: description: List of shipping speed categories. type: array items: $ref: '#/components/schemas/ShippingSpeedCategory' GetFulfillmentOrderResult: description: The request for the `getFulfillmentOrder` operation. type: object required: - fulfillmentOrder - fulfillmentOrderItems - returnAuthorizations - returnItems properties: fulfillmentOrder: $ref: '#/components/schemas/FulfillmentOrder' fulfillmentOrderItems: $ref: '#/components/schemas/FulfillmentOrderItemList' fulfillmentShipments: $ref: '#/components/schemas/FulfillmentShipmentList' returnItems: $ref: '#/components/schemas/ReturnItemList' returnAuthorizations: $ref: '#/components/schemas/ReturnAuthorizationList' paymentInformation: $ref: '#/components/schemas/PaymentInformationList' FulfillmentShipmentItem: type: object required: - quantity - sellerFulfillmentOrderItemId - sellerSku properties: sellerSku: type: string description: The seller SKU of the item. sellerFulfillmentOrderItemId: type: string description: The fulfillment order item identifier that the seller created and submitted with a call to the `createFulfillmentOrder` operation. quantity: $ref: '#/components/schemas/Quantity' packageNumber: type: integer format: int32 description: An identifier for the package that contains the item quantity. serialNumber: type: string description: The serial number of the shipped item. manufacturerLotCodes: description: The manufacturer lot codes of the shipped items. $ref: '#/components/schemas/StringList' description: Item information for a shipment in a fulfillment order. FulfillmentOrderStatus: type: string description: The current status of the fulfillment order. enum: - New - Received - Planning - Processing - Cancelled - Complete - CompletePartialled - Unfulfillable - Invalid x-docgen-enum-table-extension: - value: New description: The fulfillment order was received but not yet validated. - value: Received description: The fulfillment order was received and validated. Validation includes determining that the destination address is valid and that Amazon's records indicate that the seller has enough sellable (undamaged) inventory to fulfill the order. The seller can cancel a fulfillment order that has a status of Received. - value: Planning description: The fulfillment order has been sent to Amazon's fulfillment network to begin shipment planning, but no unit in any shipment has been picked from inventory yet. The seller can cancel a fulfillment order that has a status of Planning. - value: Processing description: The process of picking units from inventory has begun on at least one shipment in the fulfillment order. The seller cannot cancel a fulfillment order that has a status of Processing. - value: Cancelled description: The fulfillment order has been cancelled by the seller. - value: Complete description: All item quantities in the fulfillment order have been fulfilled. - value: CompletePartialled description: Some item quantities in the fulfillment order were fulfilled; the rest were either cancelled or unfulfillable. - value: Unfulfillable description: No item quantities in the fulfillment order could be fulfilled because the Amazon fulfillment center workers found no inventory for those items or found no inventory that was in sellable (undamaged) condition. - value: Invalid description: The fulfillment order was received but could not be validated. The reasons for this include an invalid destination address or Amazon's records indicating that the seller does not have enough sellable inventory to fulfill the order. When this happens, the fulfillment order is invalid and no items in the order will ship. Quantity: type: integer format: int32 description: The item quantity. FulfillmentShipmentPackage: type: object required: - carrierCode - packageNumber properties: packageNumber: type: integer format: int32 description: Identifies a package in a shipment. carrierCode: type: string description: Identifies the carrier who will deliver the shipment to the recipient. trackingNumber: type: string description: The tracking number, if provided, can be used to obtain tracking and delivery information. amazonFulfillmentTrackingNumber: type: string description: The Amazon fulfillment tracking number, if provided, can be used to obtain tracking and delivery information. estimatedArrivalDate: description: The estimated arrival date and time of the package, in ISO 8601 date time format. $ref: '#/components/schemas/Timestamp' lockerDetails: description: The locker details, if provided can be used to access locker delivery box. $ref: '#/components/schemas/LockerDetails' deliveryInformation: description: The delivery information of the package, this information is only available post package delivery to its intended destination. $ref: '#/components/schemas/DeliveryInformation' description: Package information for a shipment in a fulfillment order. ListReturnReasonCodesResponse: type: object properties: payload: description: The payload for the `listReturnReasonCodes` operation. $ref: '#/components/schemas/ListReturnReasonCodesResult' errors: description: One or more unexpected errors occurred during the `listReturnReasonCodes` operation. $ref: '#/components/schemas/ErrorList' description: The response schema for the `listReturnReasonCodes` operation. TrackingEventList: type: array description: An array of tracking event information. items: $ref: '#/components/schemas/TrackingEvent' Address: type: object required: - addressLine1 - countryCode - name - postalCode properties: name: type: string description: The name of the person, business or institution at the address. addressLine1: type: string description: The first line of the address. addressLine2: type: string description: Additional address information, if required. addressLine3: type: string description: Additional address information, if required. city: type: string description: The city where the person, business, or institution is located. This property is required in all countries except Japan. It should not be used in Japan. districtOrCounty: type: string description: The district or county where the person, business, or institution is located. stateOrRegion: type: string description: The state or region where the person, business or institution is located. postalCode: type: string description: The postal code of the address. countryCode: type: string description: The two digit country code. In ISO 3166-1 alpha-2 format. phone: type: string description: The phone number of the person, business, or institution located at the address. description: A physical address. FulfillmentPreviewItemList: type: array description: An array of fulfillment preview item information. items: $ref: '#/components/schemas/FulfillmentPreviewItem' Amount: type: object required: - unitOfMeasure - value properties: unitOfMeasure: type: string description: The unit of measure for the amount. enum: - Eaches x-docgen-enum-table-extension: - value: Eaches description: Specifies an integer count of units. value: $ref: '#/components/schemas/Decimal' description: The amount of a product in the associated unit of measurement. description: A quantity based on the specified unit of measurement. GetFeaturesResult: type: object required: - features properties: features: $ref: '#/components/schemas/Features' description: The payload for the `getFeatures` operation. UpdateFulfillmentOrderItemList: type: array description: An array of fulfillment order item information for updating a fulfillment order. items: $ref: '#/components/schemas/UpdateFulfillmentOrderItem' ProductIdentifier: type: object required: - merchantSku properties: merchantSku: type: string description: The merchant SKU for the product. maxLength: 50 description: Product identifier input that locates a product for MCF. GetPackageTrackingDetailsResponse: type: object properties: payload: description: The payload for the `getPackageTrackingDetails` operation. $ref: '#/components/schemas/PackageTrackingDetails' errors: description: One or more unexpected errors occurred during the `getPackageTrackingDetails` operation. $ref: '#/components/schemas/ErrorList' description: The response schema for the `getPackageTrackingDetails` operation. GetFeatureInventoryResponse: type: object properties: payload: $ref: '#/components/schemas/GetFeatureInventoryResult' errors: description: One or more unexpected errors occurred during the getFeatureInventory operation. $ref: '#/components/schemas/ErrorList' description: The breakdown of eligibility inventory by feature. PaymentInformation: type: object required: - paymentTransactionId - paymentMode - paymentDate properties: paymentTransactionId: type: string description: The transaction identifier of this payment. paymentMode: type: string description: The transaction mode of this payment. paymentDate: description: The transaction date of this payment. $ref: '#/components/schemas/Timestamp' description: The attributes related to the payment made from customer to seller for this order. ReturnItemDisposition: type: string description: The condition of the return item when received by an Amazon fulfillment center. enum: - Sellable - Defective - CustomerDamaged - CarrierDamaged - FulfillerDamaged x-docgen-enum-table-extension: - value: Sellable description: Item is in sellable condition. - value: Defective description: Item is defective. - value: CustomerDamaged description: Item was damaged by the buyer or the seller. - value: CarrierDamaged description: Item was damaged by the carrier. - value: FulfillerDamaged description: Item was damaged by Amazon. ShippingSpeedCategory: type: string description: 'The shipping method used for the fulfillment order. When this value is `ScheduledDelivery`, choose `Ship` for the `fulfillmentAction`. `Hold` is not a valid `fulfillmentAction` value when the `shippingSpeedCategory` value is `ScheduledDelivery`. Note: Shipping method service level agreements vary by marketplace. Sellers should refer to the [Seller Central](https://developer-docs.amazon.com/sp-api/docs/seller-central-urls) website in their marketplace for shipping method service level agreements and fulfillment fees.' enum: - Standard - Expedited - Priority - ScheduledDelivery x-docgen-enum-table-extension: - value: Standard description: Standard shipping method. - value: Expedited description: Expedited shipping method. - value: Priority description: Priority shipping method. - value: ScheduledDelivery description: Scheduled Delivery shipping method. This is only available in the JP marketplace.