wezone
/
selling-partner-api-models
mirror of https://github.com/amzn/selling-partner-api-models.git
10
0
Fork 0
Code Issues Projects Releases Wiki Activity

Update the Fulfillment Outbound model

This commit is contained in:
Jack Evoniuk 2024-03-20 10:30:37 -07:00
parent a0db67eb6c
commit 7bde415568
1 changed files with 138 additions and 101 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

239
models/fulfillment-outbound-api-model/fulfillmentOutbound_2020-07-01.json
View File

@ -32,7 +32,7 @@
"tags": [
"fbaOutbound"
],
"description": "Returns a list of fulfillment order previews based on shipping criteria that you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 30 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).",
"description": "Returns a list of fulfillment order previews based on shipping criteria that you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 30 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).",
"operationId": "getFulfillmentPreview",
"parameters": [
{
@ -235,7 +235,7 @@
"tags": [
"fbaOutbound"
],
"description": "Returns a list of fulfillment orders fulfilled after (or at) a specified date-time, or indicated by the next token parameter.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 30 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api)",
"description": "Returns a list of fulfillment orders fulfilled after (or at) a specified date-time, or indicated by the next token parameter.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 30 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api)",
"operationId": "listAllFulfillmentOrders",
"parameters": [
{
@ -444,7 +444,7 @@
"tags": [
"fbaOutbound"
],
"description": "Requests that Amazon ship items from the seller's inventory in Amazon's fulfillment network to a destination address.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 30 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api)",
"description": "Requests that Amazon ship items from the seller's inventory in Amazon's fulfillment network to a destination address.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 30 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api)",
"operationId": "createFulfillmentOrder",
"parameters": [
{
@ -592,13 +592,13 @@
"tags": [
"fbaOutbound"
],
"description": "Returns delivery tracking information for a package in an outbound shipment for a Multi-Channel Fulfillment order.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 30 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).",
"description": "Returns delivery tracking information for a package in an outbound shipment for a Multi-Channel Fulfillment order.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 30 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).",
"operationId": "getPackageTrackingDetails",
"parameters": [
{
"name": "packageNumber",
"in": "query",
"description": "The unencrypted package identifier returned by the getFulfillmentOrder operation.",
"description": "The unencrypted package identifier returned by the `getFulfillmentOrder` operation.",
"required": true,
"type": "integer",
"format": "int32"
@ -783,7 +783,7 @@
"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](https://developer-docs.amazon.com/sp-api/docs/url-encoding).\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 30 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).",
"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](https://developer-docs.amazon.com/sp-api/docs/url-encoding).\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 30 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).",
"operationId": "listReturnReasonCodes",
"parameters": [
{
@ -810,8 +810,8 @@
{
"name": "language",
"in": "query",
"description": "The language that the TranslatedDescription property of the ReasonCodeDetails response object should be translated into.",
"required": true,
"description": "The language that the `TranslatedDescription` property of the `ReasonCodeDetails` response object should be translated into.",
"required": false,
"type": "string"
}
],
@ -1005,7 +1005,7 @@
"tags": [
"fbaOutbound"
],
"description": "Creates a fulfillment return.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 30 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).",
"description": "Creates a fulfillment return.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 30 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).",
"operationId": "createFulfillmentReturn",
"parameters": [
{
@ -1019,7 +1019,7 @@
{
"name": "sellerFulfillmentOrderId",
"in": "path",
"description": "An identifier assigned by the seller 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.",
"description": "An identifier assigned by the seller 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,
"type": "string"
}
@ -1198,7 +1198,7 @@
"tags": [
"fbaOutbound"
],
"description": "Returns the fulfillment order indicated by the specified order identifier.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 30 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).",
"description": "Returns the fulfillment order indicated by the specified order identifier.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 30 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).",
"operationId": "getFulfillmentOrder",
"parameters": [
{
@ -1431,7 +1431,7 @@
"tags": [
"fbaOutbound"
],
"description": "Updates and/or requests shipment for a fulfillment order with an order hold on it.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 30 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).",
"description": "Updates and/or requests shipment for a fulfillment order with an order hold on it.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 30 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).",
"operationId": "updateFulfillmentOrder",
"parameters": [
{
@ -1587,7 +1587,7 @@
"tags": [
"fbaOutbound"
],
"description": "Requests that Amazon stop attempting to fulfill the fulfillment order indicated by the specified order identifier.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 30 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).",
"description": "Requests that Amazon stop attempting to fulfill the fulfillment order indicated by the specified order identifier.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 30 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).",
"operationId": "cancelFulfillmentOrder",
"parameters": [
{
@ -1892,7 +1892,7 @@
"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.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 30 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).",
"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.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 30 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).",
"operationId": "getFeatures",
"parameters": [
{
@ -2056,7 +2056,7 @@
"tags": [
"fbaOutbound"
],
"description": "Returns a list of inventory items that are eligible for the fulfillment feature you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 30 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api)..",
"description": "Returns a list of inventory items that are eligible for the fulfillment feature you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 30 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api)..",
"operationId": "getFeatureInventory",
"parameters": [
{
@ -2248,7 +2248,7 @@
"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](https://developer-docs.amazon.com/sp-api/docs/url-encoding).\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 30 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).",
"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](https://developer-docs.amazon.com/sp-api/docs/url-encoding).\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 30 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).",
"operationId": "getFeatureSKU",
"parameters": [
{
@ -2268,7 +2268,7 @@
{
"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.",
"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,
"type": "string"
}
@ -2543,7 +2543,7 @@
},
"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. For example, the seller might assign different SellerFulfillmentOrderItemId values to two items in a fulfillment order that share the same SellerSKU but have different GiftMessage values.",
"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`. For example, the seller might assign different `SellerFulfillmentOrderItemId` values to two items in a fulfillment order that share the same `SellerSKU` but have different `GiftMessage` values.",
"maxLength": 50
},
"quantity": {
@ -2564,7 +2564,7 @@
"description": "Amazon's fulfillment network SKU of the item."
},
"perUnitDeclaredValue": {
"description": "The monetary value assigned by the seller to this item.",
"description": "The monetary value assigned by the seller to this item. This is a required field for India MCF orders.",
"$ref": "#/definitions/Money"
},
"perUnitPrice": {
@ -2587,7 +2587,7 @@
},
"FulfillmentPolicy": {
"type": "string",
"description": "The FulfillmentPolicy value specified when you submitted the createFulfillmentOrder operation.",
"description": "The `FulfillmentPolicy` value specified when you submitted the `createFulfillmentOrder` operation.",
"enum": [
"FillOrKill",
"FillAll",
@ -2596,7 +2596,7 @@
"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. See the FulfillmentShipment object for shipment status definitions."
"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",
@ -2679,12 +2679,12 @@
},
"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.",
"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.\n\nThe 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.",
"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.\n\nThe 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": {
@ -2694,10 +2694,10 @@
"displayableOrderComment": {
"type": "string",
"description": "Order-specific text that appears in recipient-facing materials such as the outbound shipment packing slip.",
"maxLength": 1000
"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.",
"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`.",
"$ref": "#/definitions/ShippingSpeedCategory"
},
"deliveryWindow": {
@ -2733,9 +2733,13 @@
"items": {
"description": "A list of items to include in the fulfillment order preview, including quantity.",
"$ref": "#/definitions/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": "#/definitions/PaymentInformationList"
}
},
"description": "The request body schema for the createFulfillmentOrder operation."
"description": "The request body schema for the `createFulfillmentOrder` operation."
},
"CreateFulfillmentReturnRequest": {
"type": "object",
@ -2747,7 +2751,7 @@
"$ref": "#/definitions/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."
"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."
},
"CreateFulfillmentReturnResult": {
"type": "object",
@ -2767,15 +2771,15 @@
"type": "object",
"properties": {
"payload": {
"description": "The payload for the createFulfillmentReturn operation.",
"description": "The payload for the `createFulfillmentReturn` operation.",
"$ref": "#/definitions/CreateFulfillmentReturnResult"
},
"errors": {
"description": "One or more unexpected errors occurred during the createFulfillmentReturn operation.",
"description": "One or more unexpected errors occurred during the `createFulfillmentReturn` operation.",
"$ref": "#/definitions/ErrorList"
}
},
"description": "The response schema for the createFulfillmentReturn operation."
"description": "The response schema for the `createFulfillmentReturn` operation."
},
"CreateReturnItem": {
"type": "object",
@ -2847,11 +2851,11 @@
],
"properties": {
"startDate": {
"description": "The date and time of the start of the Scheduled Delivery window, in ISO 8601 date time format.",
"description": "The date and time of the start of the Scheduled Delivery window. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format.",
"$ref": "#/definitions/Timestamp"
},
"endDate": {
"description": "The date and time of the end of the Scheduled Delivery window, in ISO 8601 date time format.",
"description": "The date and time of the end of the Scheduled Delivery window. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format.",
"$ref": "#/definitions/Timestamp"
}
},
@ -2948,7 +2952,7 @@
"properties": {
"sellerFulfillmentOrderId": {
"type": "string",
"description": "The fulfillment order identifier submitted with the createFulfillmentOrder operation."
"description": "The fulfillment order identifier submitted with the `createFulfillmentOrder` operation."
},
"marketplaceId": {
"type": "string",
@ -2956,15 +2960,15 @@
},
"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."
"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.",
"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": "#/definitions/Timestamp"
},
"displayableOrderComment": {
"type": "string",
"description": "A text block submitted with the createFulfillmentOrder operation. Displays in recipient-facing materials such as the packing slip."
"description": "A text block submitted with the `createFulfillmentOrder` operation. Displays in recipient-facing materials such as the packing slip."
},
"shippingSpeedCategory": {
"$ref": "#/definitions/ShippingSpeedCategory"
@ -2973,7 +2977,7 @@
"$ref": "#/definitions/DeliveryWindow"
},
"destinationAddress": {
"description": "The destination address submitted with the createFulfillmentOrder operation.",
"description": "The destination address submitted with the `createFulfillmentOrder` operation.",
"$ref": "#/definitions/Address"
},
"fulfillmentAction": {
@ -2993,7 +2997,7 @@
"$ref": "#/definitions/FulfillmentOrderStatus"
},
"statusUpdatedDate": {
"description": "The date and time that the status of the fulfillment order last changed, in ISO 8601 date time format.",
"description": "The date and time that the status of the fulfillment order last changed. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format.",
"$ref": "#/definitions/Timestamp"
},
"notificationEmails": {
@ -3025,7 +3029,7 @@
},
"sellerFulfillmentOrderItemId": {
"type": "string",
"description": "A fulfillment order item identifier submitted with a call to the createFulfillmentOrder operation."
"description": "A fulfillment order item identifier submitted with a call to the `createFulfillmentOrder` operation."
},
"quantity": {
"$ref": "#/definitions/Quantity"
@ -3055,11 +3059,11 @@
"$ref": "#/definitions/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 has been cancelled, estimatedShipDate is not returned.",
"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 has been cancelled, `estimatedShipDate` is not returned.",
"$ref": "#/definitions/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 has been cancelled, estimatedArrivalDate is not returned.",
"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 has been cancelled, `estimatedArrivalDate` is not returned.",
"$ref": "#/definitions/Timestamp"
},
"perUnitPrice": {
@ -3071,7 +3075,7 @@
"$ref": "#/definitions/Money"
},
"perUnitDeclaredValue": {
"description": "The monetary value assigned by the seller to this item.",
"description": "The monetary value assigned by the seller to this item. This is a required field for India MCF orders.",
"$ref": "#/definitions/Money"
}
},
@ -3112,7 +3116,7 @@
"$ref": "#/definitions/Weight"
},
"estimatedFees": {
"description": "The estimated fulfillment fees for this fulfillment order preview, if applicable.",
"description": "The estimated fulfillment fees for this fulfillment order preview, if applicable. The fees data will not be available for IN marketplace orders.",
"$ref": "#/definitions/FeeList"
},
"fulfillmentPreviewShipments": {
@ -3122,7 +3126,7 @@
"$ref": "#/definitions/UnfulfillablePreviewItemList"
},
"orderUnfulfillableReasons": {
"description": "Error codes associated with the fulfillment order preview that indicate why the order is not fulfillable.\n\nError code examples:\n\nDeliverySLAUnavailable\nInvalidDestinationAddress",
"description": "Error codes associated with the fulfillment order preview that indicate why the order is not fulfillable.\n\nError code examples:\n\n`DeliverySLAUnavailable`\n`InvalidDestinationAddress`",
"$ref": "#/definitions/StringList"
},
"marketplaceId": {
@ -3157,10 +3161,10 @@
},
"sellerFulfillmentOrderItemId": {
"type": "string",
"description": "A fulfillment order item identifier that the seller created with a call to the createFulfillmentOrder operation."
"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.",
"description": "The estimated shipping weight of the item quantity for a single item, as identified by `sellerSku`, in a shipment.",
"$ref": "#/definitions/Weight"
},
"shippingWeightCalculationMethod": {
@ -3205,11 +3209,11 @@
],
"properties": {
"earliestShipDate": {
"description": "The earliest date that the shipment is expected to be sent from the fulfillment center, in ISO 8601 date time format.",
"description": "The earliest date that the shipment is expected to be sent from the fulfillment center. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format.",
"$ref": "#/definitions/Timestamp"
},
"latestShipDate": {
"description": "The latest date that the shipment is expected to be sent from the fulfillment center, in ISO 8601 date time format.",
"description": "The latest date that the shipment is expected to be sent from the fulfillment center. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format.",
"$ref": "#/definitions/Timestamp"
},
"earliestArrivalDate": {
@ -3217,7 +3221,7 @@
"$ref": "#/definitions/Timestamp"
},
"latestArrivalDate": {
"description": "The latest date that the shipment is expected to arrive at its destination, in ISO 8601 date time format.",
"description": "The latest date that the shipment is expected to arrive at its destination. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format.",
"$ref": "#/definitions/Timestamp"
},
"shippingNotes": {
@ -3300,16 +3304,16 @@
},
{
"value": "CANCELLED_BY_SELLER",
"description": "The shipment was cancelled using the CancelFulfillmentOrder request."
"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:\n\n* Pending - shippingDate represents the estimated time that the shipment will leave the Amazon fulfillment center.\n\n* Shipped - shippingDate represents the date that the shipment left the Amazon fulfillment center.\nIf 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.",
"description": "The meaning of the `shippingDate` value depends on the current status of the shipment. If the current value of `FulfillmentShipmentStatus` is:\n\n* Pending - `shippingDate` represents the estimated time that the shipment will leave the Amazon fulfillment center.\n\n* Shipped - `shippingDate` represents the date that the shipment left the Amazon fulfillment center.\nIf 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 <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format.",
"$ref": "#/definitions/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 has been cancelled, estimatedArrivalDate is not returned.",
"description": "The estimated arrival date and time of the shipment. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> 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 has been cancelled, `estimatedArrivalDate` is not returned.",
"$ref": "#/definitions/Timestamp"
},
"shippingNotes": {
@ -3342,7 +3346,7 @@
},
"sellerFulfillmentOrderItemId": {
"type": "string",
"description": "The fulfillment order item identifier that the seller created and submitted with a call to the createFulfillmentOrder operation."
"description": "The fulfillment order item identifier that the seller created and submitted with a call to the `createFulfillmentOrder` operation."
},
"quantity": {
"$ref": "#/definitions/Quantity"
@ -3394,7 +3398,7 @@
"description": "The 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.",
"description": "The estimated arrival date and time of the package. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format.",
"$ref": "#/definitions/Timestamp"
}
},
@ -3430,6 +3434,9 @@
},
"returnAuthorizations": {
"$ref": "#/definitions/ReturnAuthorizationList"
},
"paymentInformation": {
"$ref": "#/definitions/PaymentInformationList"
}
}
},
@ -3437,15 +3444,15 @@
"type": "object",
"properties": {
"payload": {
"description": "The payload for the getFulfillmentOrder operation.",
"description": "The payload for the `getFulfillmentOrder` operation.",
"$ref": "#/definitions/GetFulfillmentOrderResult"
},
"errors": {
"description": "One or more unexpected errors occurred during the getFulfillmentOrder operation.",
"description": "One or more unexpected errors occurred during the `getFulfillmentOrder` operation.",
"$ref": "#/definitions/ErrorList"
}
},
"description": "The response schema for the getFulfillmentOrder operation."
"description": "The response schema for the `getFulfillmentOrder` operation."
},
"GetFulfillmentPreviewItem": {
"type": "object",
@ -3464,7 +3471,7 @@
"$ref": "#/definitions/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.",
"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": "#/definitions/Money"
},
"sellerFulfillmentOrderItemId": {
@ -3502,7 +3509,7 @@
"$ref": "#/definitions/GetFulfillmentPreviewItemList"
},
"shippingSpeedCategories": {
"description": "A list of shipping methods used for creating fulfillment order previews.\n\nPossible values:\n\n* Standard - Standard shipping method.\n* Expedited - Expedited shipping method.\n* Priority - Priority shipping method.\n* ScheduledDelivery - Scheduled Delivery shipping method.\nNote: 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.",
"description": "A list of shipping methods used for creating fulfillment order previews.\n\nPossible values:\n\n* `Standard` - Standard shipping method.\n* `Expedited` - Expedited shipping method.\n* `Priority` - Priority shipping method.\n* `ScheduledDelivery` - Scheduled Delivery shipping method.\nNote: Shipping method service level agreements vary by marketplace. Sellers should refer to the Seller Central website in their marketplace for shipping method service level agreements and fulfillment fees.",
"$ref": "#/definitions/ShippingSpeedCategoryList"
},
"includeCODFulfillmentPreview": {
@ -3511,7 +3518,7 @@
},
"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 = ScheduledDelivery."
"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` = `ScheduledDelivery`."
},
"featureConstraints": {
"type": "array",
@ -3521,7 +3528,7 @@
}
}
},
"description": "The request body schema for the getFulfillmentPreview operation."
"description": "The request body schema for the `getFulfillmentPreview` operation."
},
"GetFulfillmentPreviewResult": {
"type": "object",
@ -3536,15 +3543,15 @@
"type": "object",
"properties": {
"payload": {
"description": "The response payload for the getFulfillmentPreview operation.",
"description": "The response payload for the `getFulfillmentPreview` operation.",
"$ref": "#/definitions/GetFulfillmentPreviewResult"
},
"errors": {
"description": "One or more unexpected errors occurred during the getFulfillmentPreview operation.",
"description": "One or more unexpected errors occurred during the `getFulfillmentPreview` operation.",
"$ref": "#/definitions/ErrorList"
}
},
"description": "The response schema for the getFulfillmentPreview operation."
"description": "The response schema for the `getFulfillmentPreview` operation."
},
"InvalidItemReasonCode": {
"type": "string",
@ -3640,15 +3647,15 @@
"type": "object",
"properties": {
"payload": {
"description": "The payload for the listAllFulfillmentOrders operation.",
"description": "The payload for the `listAllFulfillmentOrders` operation.",
"$ref": "#/definitions/ListAllFulfillmentOrdersResult"
},
"errors": {
"description": "One or more unexpected errors occurred during the listAllFulfillmentOrders operation.",
"description": "One or more unexpected errors occurred during the `listAllFulfillmentOrders` operation.",
"$ref": "#/definitions/ErrorList"
}
},
"description": "The response schema for the listAllFulfillmentOrders operation."
"description": "The response schema for the `listAllFulfillmentOrders` operation."
},
"ListReturnReasonCodesResult": {
"type": "object",
@ -3662,15 +3669,15 @@
"type": "object",
"properties": {
"payload": {
"description": "The payload for the listReturnReasonCodes operation.",
"description": "The payload for the `listReturnReasonCodes` operation.",
"$ref": "#/definitions/ListReturnReasonCodesResult"
},
"errors": {
"description": "One or more unexpected errors occurred during the listReturnReasonCodes operation.",
"description": "One or more unexpected errors occurred during the `listReturnReasonCodes` operation.",
"$ref": "#/definitions/ErrorList"
}
},
"description": "The response schema for the listReturnReasonCodes operation."
"description": "The response schema for the `listReturnReasonCodes` operation."
},
"NotificationEmailList": {
"type": "array",
@ -3964,7 +3971,7 @@
},
"currentStatusDescription": {
"type": "string",
"description": "Description corresponding to the CurrentStatus value."
"description": "Description corresponding to the `CurrentStatus` value."
},
"signedForBy": {
"type": "string",
@ -3982,15 +3989,15 @@
"type": "object",
"properties": {
"payload": {
"description": "The payload for the getPackageTrackingDetails operation.",
"description": "The payload for the `getPackageTrackingDetails` operation.",
"$ref": "#/definitions/PackageTrackingDetails"
},
"errors": {
"description": "One or more unexpected errors occurred during the getPackageTrackingDetails operation.",
"description": "One or more unexpected errors occurred during the `getPackageTrackingDetails` operation.",
"$ref": "#/definitions/ErrorList"
}
},
"description": "The response schema for the getPackageTrackingDetails operation."
"description": "The response schema for the `getPackageTrackingDetails` operation."
},
"ReasonCodeDetails": {
"type": "object",
@ -4021,6 +4028,29 @@
"$ref": "#/definitions/ReasonCodeDetails"
}
},
"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": "#/definitions/Timestamp"
}
},
"description": "The attributes related to the payment made from customer to seller for this order."
},
"ReturnAuthorization": {
"type": "object",
"required": [
@ -4054,6 +4084,13 @@
},
"description": "Return authorization information for items accepted for return."
},
"PaymentInformationList": {
"type": "array",
"description": "An array of various payment attributes related to this fulfillment order.",
"items": {
"$ref": "#/definitions/PaymentInformation"
}
},
"ReturnAuthorizationList": {
"type": "array",
"description": "An array of return authorization information.",
@ -4106,7 +4143,7 @@
},
"returnAuthorizationId": {
"type": "string",
"description": "Identifies the return authorization used to return this item. See ReturnAuthorization."
"description": "Identifies the return authorization used to return this item. Refer to `ReturnAuthorization`."
},
"returnReceivedCondition": {
"$ref": "#/definitions/ReturnItemDisposition"
@ -4401,7 +4438,7 @@
],
"properties": {
"eventDate": {
"description": "The date and time that the delivery event took place, in ISO 8601 date time format.",
"description": "The date and time that the delivery event took place. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format.",
"$ref": "#/definitions/Timestamp"
},
"eventAddress": {
@ -4444,7 +4481,7 @@
},
"sellerFulfillmentOrderItemId": {
"type": "string",
"description": "A fulfillment order item identifier created with a call to the getFulfillmentPreview operation.",
"description": "A fulfillment order item identifier created with a call to the `getFulfillmentPreview` operation.",
"maxLength": 50
},
"itemUnfulfillableReasons": {
@ -4474,7 +4511,7 @@
},
"sellerFulfillmentOrderItemId": {
"type": "string",
"description": "Identifies the fulfillment order item to update. Created with a previous call to the createFulfillmentOrder operation.",
"description": "Identifies the fulfillment order item to update. Created with a previous call to the `createFulfillmentOrder` operation.",
"maxLength": 50
},
"quantity": {
@ -4499,7 +4536,7 @@
"description": "Indicates whether the item is sellable or unsellable."
},
"perUnitDeclaredValue": {
"description": "The monetary value assigned by the seller to this item.",
"description": "The monetary value assigned by the seller to this item. This is a required field for India MCF orders.",
"$ref": "#/definitions/Money"
},
"perUnitPrice": {
@ -4522,7 +4559,7 @@
},
"UpdateFulfillmentOrderRequest": {
"type": "object",
"description": "The request body schema for the updateFulfillmentOrder operation.",
"description": "The request body schema for the `updateFulfillmentOrder` operation.",
"properties": {
"marketplaceId": {
"type": "string",
@ -4530,7 +4567,7 @@
},
"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.",
"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": {
@ -4540,7 +4577,7 @@
"displayableOrderComment": {
"type": "string",
"description": "Order-specific text that appears in recipient-facing materials such as the outbound shipment packing slip.",
"maxLength": 1000
"maxLength": 750
},
"shippingSpeedCategory": {
"$ref": "#/definitions/ShippingSpeedCategory"
@ -4579,31 +4616,31 @@
"type": "object",
"properties": {
"errors": {
"description": "One or more unexpected errors occurred during the updateFulfillmentOrder operation.",
"description": "One or more unexpected errors occurred during the `updateFulfillmentOrder` operation.",
"$ref": "#/definitions/ErrorList"
}
},
"description": "The response schema for the updateFulfillmentOrder operation."
"description": "The response schema for the `updateFulfillmentOrder` operation."
},
"CreateFulfillmentOrderResponse": {
"type": "object",
"properties": {
"errors": {
"description": "One or more unexpected errors occurred during the createFulfillmentOrder operation.",
"description": "One or more unexpected errors occurred during the `createFulfillmentOrder` operation.",
"$ref": "#/definitions/ErrorList"
}
},
"description": "The response schema for the createFulfillmentOrder operation."
"description": "The response schema for the `createFulfillmentOrder` operation."
},
"CancelFulfillmentOrderResponse": {
"type": "object",
"properties": {
"errors": {
"description": "One or more unexpected errors occurred during the cancelFulfillmentOrder operation.",
"description": "One or more unexpected errors occurred during the `cancelFulfillmentOrder` operation.",
"$ref": "#/definitions/ErrorList"
}
},
"description": "The response schema for the cancelFulfillmentOrder operation."
"description": "The response schema for the `cancelFulfillmentOrder` operation."
},
"Weight": {
"type": "object",
@ -4654,7 +4691,7 @@
},
"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.",
"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`.",
"enum": [
"Standard",
"Expedited",
@ -4687,7 +4724,7 @@
"$ref": "#/definitions/GetFeatureInventoryResult"
},
"errors": {
"description": "One or more unexpected errors occurred during the getFeatureInventory operation.",
"description": "One or more unexpected errors occurred during the `getFeatureInventory` operation.",
"$ref": "#/definitions/ErrorList"
}
},
@ -4720,14 +4757,14 @@
}
}
},
"description": "The payload for the getEligibileInventory operation."
"description": "The payload for the `getEligibileInventory` operation."
},
"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."
"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",
@ -4761,7 +4798,7 @@
"$ref": "#/definitions/ErrorList"
}
},
"description": "The response schema for the getFeatures operation."
"description": "The response schema for the `getFeatures` operation."
},
"GetFeaturesResult": {
"type": "object",
@ -4773,7 +4810,7 @@
"$ref": "#/definitions/Features"
}
},
"description": "The payload for the getFeatures operation."
"description": "The payload for the `getFeatures` operation."
},
"Features": {
"type": "array",
@ -4814,7 +4851,7 @@
"$ref": "#/definitions/ErrorList"
}
},
"description": "The response schema for the getFeatureSKU operation."
"description": "The response schema for the `getFeatureSKU` operation."
},
"GetFeatureSkuResult": {
"type": "object",
@ -4838,7 +4875,7 @@
},
"ineligibleReasons": {
"type": "array",
"description": "A list of one or more reasons that the seller SKU is ineligibile for the feature.\n\nPossible values:\n* MERCHANT_NOT_ENROLLED - The merchant isn't enrolled for the feature.\n* SKU_NOT_ELIGIBLE - The SKU doesn't reside in a warehouse that supports the feature.\n* INVALID_SKU - There is an issue with the SKU provided.",
"description": "A list of one or more reasons that the seller SKU is ineligibile for the feature.\n\nPossible values:\n* `MERCHANT_NOT_ENROLLED` - The merchant isn't enrolled for the feature.\n* `SKU_NOT_ELIGIBLE` - The SKU doesn't reside in a warehouse that supports the feature.\n* `INVALID_SKU` - There is an issue with the SKU provided.",
"items": {
"type": "string"
}
@ -4848,7 +4885,7 @@
"$ref": "#/definitions/FeatureSku"
}
},
"description": "The payload for the getFeatureSKU operation."
"description": "The payload for the `getFeatureSKU` operation."
},
"FeatureSettings": {
"type": "object",
@ -4876,11 +4913,11 @@
]
}
},
"description": "FeatureSettings allows users to apply fulfillment features to an order. To block an order from being shipped using Amazon Logistics (AMZL) and an AMZL tracking number, use featureName as BLOCK_AMZL and featureFulfillmentPolicy as 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), use featureName BLANK_BOX."
"description": "`FeatureSettings` allows users to apply fulfillment features to an order. To block an order from being shipped using Amazon Logistics (AMZL) and an AMZL tracking number, use `featureName` as `BLOCK_AMZL` and `featureFulfillmentPolicy` as `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), use featureName `BLANK_BOX`."
},
"SubmitFulfillmentOrderStatusUpdateRequest": {
"type": "object",
"description":"The request body schema for the submitFulfillmentOrderStatusUpdate operation.",
"description":"The request body schema for the `submitFulfillmentOrderStatusUpdate` operation.",
"properties": {
"fulfillmentOrderStatus": {
"$ref": "#/definitions/FulfillmentOrderStatus"
@ -4891,11 +4928,11 @@
"type": "object",
"properties": {
"errors": {
"description": "One or more unexpected errors occurred during the SubmitFulfillmentOrderStatusUpdate operation.",
"description": "One or more unexpected errors occurred during the `SubmitFulfillmentOrderStatusUpdate` operation.",
"$ref": "#/definitions/ErrorList"
}
},
"description": "The response schema for the SubmitFulfillmentOrderStatusUpdate operation."
"description": "The response schema for the `SubmitFulfillmentOrderStatusUpdate` operation."
}
}
}