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
selling-partner-api-models/models/product-pricing-api-model/productPricingV0.json

2613 lines
93 KiB
JSON
Raw Normal View History

Initial commit
2020-07-30 08:33:17 +08:00
{
"swagger": "2.0",
"info": {
"title": "Selling Partner API for Pricing",
"description": "The Selling Partner API for Pricing helps you programmatically retrieve product pricing and offer information for Amazon Marketplace products.",
"version": "v0",
"contact": {
Updated models
2020-08-14 08:37:01 +08:00
"name": "Selling Partner API Developer Support",
"url": "https://sellercentral.amazon.com/gp/mws/contactus.html"
Initial commit
2020-07-30 08:33:17 +08:00
},
"license": {
Updated models
2020-08-14 08:37:01 +08:00
"name": "Apache License 2.0",
"url": "http://www.apache.org/licenses/LICENSE-2.0"
Initial commit
2020-07-30 08:33:17 +08:00
}
},
"host": "sellingpartnerapi-na.amazon.com",
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"paths": {
"/products/pricing/v0/price": {
"get": {
"tags": [
"productPricing"
],
Updated models
2020-08-14 08:37:01 +08:00
"description": "Returns pricing information for a seller's offer listings based on seller SKU or ASIN.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 1 | 1 |\n\nFor more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.",
Initial commit
2020-07-30 08:33:17 +08:00
"operationId": "getPricing",
"parameters": [
{
"name": "MarketplaceId",
"in": "query",
"description": "A marketplace identifier. Specifies the marketplace for which prices are returned.",
"required": true,
"type": "string"
},
{
"name": "Asins",
"in": "query",
"description": "A list of up to twenty Amazon Standard Identification Number (ASIN) values used to identify items in the given marketplace.",
"type": "array",
"items": {
"type": "string"
},
"maxItems": 20
},
{
"name": "Skus",
"in": "query",
"description": "A list of up to twenty seller SKU values used to identify items in the given marketplace.",
"type": "array",
"items": {
"type": "string"
},
"maxItems": 20
},
{
"name": "ItemType",
"in": "query",
Updated models
2020-08-14 08:37:01 +08:00
"description": "Indicates whether ASIN values or seller SKU values are used to identify items. If you specify Asin, the information in the response will be dependent on the list of Asins you provide in the Asins parameter. If you specify Sku, the information in the response will be dependent on the list of Skus you provide in the Skus parameter.",
Initial commit
2020-07-30 08:33:17 +08:00
"required": true,
"type": "string",
"enum": [
"Asin",
"Sku"
Updated models
2020-08-14 08:37:01 +08:00
],
"x-docgen-enum-table-extension": [
{
"value": "Asin",
"description": "The Amazon Standard Identification Number (ASIN)."
},
{
"value": "Sku",
"description": "The seller SKU."
}
Initial commit
2020-07-30 08:33:17 +08:00
]
},
{
"name": "ItemCondition",
"in": "query",
"description": "Filters the offer listings based on item condition. Possible values: New, Used, Collectible, Refurbished, Club.",
"type": "string",
"enum": [
"New",
"Used",
"Collectible",
"Refurbished",
"Club"
Updated models
2020-08-14 08:37:01 +08:00
],
"x-docgen-enum-table-extension": [
{
"value": "New",
"description": "New"
},
{
"value": "Used",
"description": "Used"
},
{
"value": "Collectible",
"description": "Collectible"
},
{
"value": "Refurbished",
"description": "Refurbished"
},
{
"value": "Club",
"description": "Club"
}
Initial commit
2020-07-30 08:33:17 +08:00
]
}
],
"responses": {
"200": {
"description": "Success.",
"x-amazon-spds-sandbox-behaviors": [
{
"request": {
"parameters": {
"MarketplaceId": {
"value": "ATVPDKIKX0DER"
},
"ItemType": {
"value": "Asin"
}
}
},
"response": {
"payload": [
{
"status": "Success",
"ASIN": "B00V5DG6IQ",
"Product": {
"Identifiers": {
"MarketplaceASIN": {
"MarketplaceId": "ATVPDKIKX0DER",
"ASIN": "B00V5DG6IQ"
},
"SKUIdentifier": {
"MarketplaceId": "",
"SellerId": "",
"SellerSKU": ""
}
},
"Offers": [
{
"BuyingPrice": {
"ListingPrice": {
"CurrencyCode": "USD",
"Amount": 10.00
},
"LandedPrice": {
"CurrencyCode": "USD",
"Amount": 10.00
},
"Shipping": {
"CurrencyCode": "USD",
"Amount": 0.00
}
},
"RegularPrice": {
"CurrencyCode": "USD",
"Amount": 10.00
},
"FulfillmentChannel": "MERCHANT",
"ItemCondition": "New",
"ItemSubCondition": "New",
"SellerSKU": "NABetaASINB00V5DG6IQ"
}
]
}
},
{
"status": "Success",
"ASIN": "B00551Q3CS",
"Product": {
"Identifiers": {
"MarketplaceASIN": {
"MarketplaceId": "ATVPDKIKX0DER",
"ASIN": "B00551Q3CS"
},
"SKUIdentifier": {
"MarketplaceId": "",
"SellerId": "",
"SellerSKU": ""
}
},
"Offers": [
{
"BuyingPrice": {
"ListingPrice": {
"CurrencyCode": "USD",
"Amount": 10.00
},
"LandedPrice": {
"CurrencyCode": "USD",
"Amount": 10.00
},
"Shipping": {
"CurrencyCode": "USD",
"Amount": 0.00
}
},
"RegularPrice": {
"CurrencyCode": "USD",
"Amount": 10.00
},
"FulfillmentChannel": "MERCHANT",
"ItemCondition": "New",
"ItemSubCondition": "New",
"SellerSKU": "NABetaASINB00551Q3CS"
}
]
}
}
]
}
},
{
"request": {
"parameters": {
"MarketplaceId": {
"value": "ATVPDKIKX0DER"
},
"ItemType": {
"value": "Sku"
}
}
},
"response": {
"payload": [
{
"status": "Success",
"SellerSKU": "NABetaASINB00V5DG6IQ",
"Product": {
"Identifiers": {
"MarketplaceASIN": {
"MarketplaceId": "ATVPDKIKX0DER",
"ASIN": "B00V5DG6IQ"
},
"SKUIdentifier": {
"MarketplaceId": "ATVPDKIKX0DER",
"SellerId": "A3TH9S8BH6GOGM",
"SellerSKU": "NABetaASINB00V5DG6IQ"
}
},
"Offers": [
{
"BuyingPrice": {
"ListingPrice": {
"CurrencyCode": "USD",
"Amount": 10.00
},
"LandedPrice": {
"CurrencyCode": "USD",
"Amount": 10.00
},
"Shipping": {
"CurrencyCode": "USD",
"Amount": 0.00
}
},
"RegularPrice": {
"CurrencyCode": "USD",
"Amount": 10.00
},
"FulfillmentChannel": "MERCHANT",
"ItemCondition": "New",
"ItemSubCondition": "New",
"SellerSKU": "NABetaASINB00V5DG6IQ"
}
]
}
},
{
"status": "Success",
"SellerSKU": "NABetaASINB00551Q3CS",
"Product": {
"Identifiers": {
"MarketplaceASIN": {
"MarketplaceId": "ATVPDKIKX0DER",
"ASIN": "B00551Q3CS"
},
"SKUIdentifier": {
"MarketplaceId": "ATVPDKIKX0DER",
"SellerId": "A3TH9S8BH6GOGM",
"SellerSKU": "NABetaASINB00551Q3CS"
}
},
"Offers": [
{
"BuyingPrice": {
"ListingPrice": {
"CurrencyCode": "USD",
"Amount": 10.00
},
"LandedPrice": {
"CurrencyCode": "USD",
"Amount": 10.00
},
"Shipping": {
"CurrencyCode": "USD",
"Amount": 0.00
}
},
"RegularPrice": {
"CurrencyCode": "USD",
"Amount": 10.00
},
"FulfillmentChannel": "MERCHANT",
"ItemCondition": "New",
"ItemSubCondition": "New",
"SellerSKU": "NABetaASINB00551Q3CS"
}
]
}
}
]
}
},
{
"request": {
"parameters": {
"MarketplaceId": {
"value": "ATVPDKIKX0DER"
},
"ItemType": {
"value": "Asin"
}
}
},
"response": {
"payload": [
{
"status": "Success",
"ASIN": "B00V5DG6IQ",
"Product": {
"Identifiers": {
"MarketplaceASIN": {
"MarketplaceId": "ATVPDKIKX0DER",
"ASIN": "B00V5DG6IQ"
},
"SKUIdentifier": {
"MarketplaceId": "",
"SellerId": "",
"SellerSKU": ""
}
},
"CompetitivePricing": {
"CompetitivePrices": [],
"NumberOfOfferListings": [
{
"Count": 1,
"condition": "New"
},
{
"Count": 1,
"condition": "Any"
}
]
},
"SalesRankings": [
{
"ProductCategoryId": "office_product_display_on_website",
"Rank": 19
},
{
"ProductCategoryId": "1069616",
"Rank": 1
},
{
"ProductCategoryId": "705333011",
"Rank": 1
},
{
"ProductCategoryId": "1069242",
"Rank": 17
}
]
}
},
{
"status": "Success",
"ASIN": "B00551Q3CS",
"Product": {
"Identifiers": {
"MarketplaceASIN": {
"MarketplaceId": "ATVPDKIKX0DER",
"ASIN": "B00551Q3CS"
},
"SKUIdentifier": {
"MarketplaceId": "",
"SellerId": "",
"SellerSKU": ""
}
},
"CompetitivePricing": {
"CompetitivePrices": [],
"NumberOfOfferListings": [
{
"Count": 1,
"condition": "New"
},
{
"Count": 1,
"condition": "Any"
}
]
},
"SalesRankings": [
{
"ProductCategoryId": "464394",
"Rank": 224
},
{
"ProductCategoryId": "12954861",
"Rank": 1057
}
]
}
}
]
}
},
{
"request": {
"parameters": {
"MarketplaceId": {
"value": "ATVPDKIKX0DER"
},
"ItemType": {
"value": "Sku"
}
}
},
"response": {
"payload": [
{
"status": "Success",
"SellerSKU": "NABetaASINB00V5DG6IQ",
"Product": {
"Identifiers": {
"MarketplaceASIN": {
"MarketplaceId": "ATVPDKIKX0DER",
"ASIN": "B00V5DG6IQ"
},
"SKUIdentifier": {
"MarketplaceId": "ATVPDKIKX0DER",
"SellerId": "A3TH9S8BH6GOGM",
"SellerSKU": "NABetaASINB00V5DG6IQ"
}
},
"CompetitivePricing": {
"CompetitivePrices": [],
"NumberOfOfferListings": [
{
"Count": 1,
"condition": "New"
},
{
"Count": 1,
"condition": "Any"
}
]
},
"SalesRankings": [
{
"ProductCategoryId": "office_product_display_on_website",
"Rank": 19
},
{
"ProductCategoryId": "1069616",
"Rank": 1
},
{
"ProductCategoryId": "705333011",
"Rank": 1
},
{
"ProductCategoryId": "1069242",
"Rank": 17
}
]
}
},
{
"status": "Success",
"SellerSKU": "NABetaASINB00551Q3CS",
"Product": {
"Identifiers": {
"MarketplaceASIN": {
"MarketplaceId": "ATVPDKIKX0DER",
"ASIN": "B00551Q3CS"
},
"SKUIdentifier": {
"MarketplaceId": "ATVPDKIKX0DER",
"SellerId": "A3TH9S8BH6GOGM",
"SellerSKU": "NABetaASINB00551Q3CS"
}
},
"CompetitivePricing": {
"CompetitivePrices": [],
"NumberOfOfferListings": [
{
"Count": 1,
"condition": "New"
},
{
"Count": 1,
"condition": "Any"
}
]
},
"SalesRankings": [
{
"ProductCategoryId": "464394",
"Rank": 224
},
{
"ProductCategoryId": "12954861",
"Rank": 1057
}
]
}
}
]
}
}
],
"schema": {
"$ref": "#/definitions/GetPricingResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference ID."
}
}
},
"400": {
"description": "Request has missing or invalid parameters and cannot be parsed.",
"x-amazon-spds-sandbox-behaviors": [
{
"request": {
"parameters": {
"MarketplaceId": {
"value": "TEST_CASE_400"
}
}
},
"response": {
"errors": [
{
"code": "InvalidInput",
"message": "Invalid Input"
}
]
}
}
],
"schema": {
"$ref": "#/definitions/GetPricingResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference ID."
}
}
},
"401": {
"description": "The request's Authorization header is not formatted correctly or does not contain a valid token.",
"schema": {
"$ref": "#/definitions/GetPricingResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference ID."
}
}
},
"403": {
"description": "Indicates access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"schema": {
"$ref": "#/definitions/GetPricingResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference ID."
}
}
},
"404": {
"description": "The specified resource does not exist.",
"schema": {
"$ref": "#/definitions/GetPricingResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference ID."
}
}
},
"429": {
"description": "The frequency of requests was greater than allowed.",
"schema": {
"$ref": "#/definitions/GetPricingResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference ID."
}
}
},
"500": {
"description": "An unexpected condition occurred that prevented the server from fulfilling the request.",
"schema": {
"$ref": "#/definitions/GetPricingResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference ID."
}
}
},
"503": {
"description": "Temporary overloading or maintenance of the server.",
"schema": {
"$ref": "#/definitions/GetPricingResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference ID."
}
}
}
}
}
},
"/products/pricing/v0/competitivePrice": {
"get": {
"tags": [
"productPricing"
],
Updated models
2020-08-14 08:37:01 +08:00
"description": "Returns competitive pricing information for a seller's offer listings based on seller SKU or ASIN.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 1 | 1 |\n\nFor more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.",
Initial commit
2020-07-30 08:33:17 +08:00
"operationId": "getCompetitivePricing",
"parameters": [
{
"name": "MarketplaceId",
"in": "query",
"description": "A marketplace identifier. Specifies the marketplace for which prices are returned.",
"required": true,
"type": "string"
},
{
"name": "Asins",
"in": "query",
"description": "A list of up to twenty Amazon Standard Identification Number (ASIN) values used to identify items in the given marketplace.",
"type": "array",
"items": {
"type": "string"
},
"maxItems": 20
},
{
"name": "Skus",
"in": "query",
"description": "A list of up to twenty seller SKU values used to identify items in the given marketplace.",
"type": "array",
"items": {
"type": "string"
},
"maxItems": 20
},
{
"name": "ItemType",
"in": "query",
"description": "Indicates whether ASIN values or seller SKU values are used to identify items. If you specify Asin, the information in the response will be dependent on the list of Asins you provide in the Asins parameter. If you specify Sku, the information in the response will be dependent on the list of Skus you provide in the Skus parameter. Possible values: Asin, Sku.",
"required": true,
"type": "string",
"enum": [
"Asin",
"Sku"
Updated models
2020-08-14 08:37:01 +08:00
],
"x-docgen-enum-table-extension": [
{
"value": "Asin",
"description": "The Amazon Standard Identification Number (ASIN)."
},
{
"value": "Sku",
"description": "The seller SKU."
}
Initial commit
2020-07-30 08:33:17 +08:00
]
}
],
"responses": {
"200": {
"description": "Success.",
"x-amazon-spds-sandbox-behaviors": [
{
"request": {
"parameters": {
"MarketplaceId": {
"value": "ATVPDKIKX0DER"
},
"ItemType": {
"value": "Asin"
}
}
},
"response": {
"payload": [
{
"status": "Success",
"ASIN": "B00V5DG6IQ",
"Product": {
"Identifiers": {
"MarketplaceASIN": {
"MarketplaceId": "ATVPDKIKX0DER",
"ASIN": "B00V5DG6IQ"
},
"SKUIdentifier": {
"MarketplaceId": "",
"SellerId": "",
"SellerSKU": ""
}
},
"CompetitivePricing": {
"CompetitivePrices": [
{
"CompetitivePriceId": "4545645646",
"Price": {
"LandedPrice": {
"CurrencyCode": "USD",
"Amount": 10
},
"ListingPrice": {
"CurrencyCode": "USD",
"Amount": 130
},
"Shipping": {
"CurrencyCode": "USD",
"Amount": 120
},
"Points": {
"PointsNumber": 130,
"PointsMonetaryValue": {
"CurrencyCode": "USD",
"Amount": 10
}
}
},
"condition": "new",
"belongsToRequester": true
}
],
"NumberOfOfferListings": [
{
"Count": 20,
"condition": "new"
}
],
"TradeInValue": {
"CurrencyCode": "USD",
"Amount": 10
}
},
"SalesRankings": [
{
"ProductCategoryId": "325345",
"Rank": 1
}
]
}
},
{
"status": "Success",
"ASIN": "B00551Q3CS",
"Product": {
"Identifiers": {
"MarketplaceASIN": {
"MarketplaceId": "ATVPDKIKX0DER",
"ASIN": "B00551Q3CS"
},
"SKUIdentifier": {
"MarketplaceId": "",
"SellerId": "",
"SellerSKU": ""
}
},
"CompetitivePricing": {
"CompetitivePrices": [
{
"CompetitivePriceId": "45456452646",
"Price": {
"LandedPrice": {
"CurrencyCode": "USD",
"Amount": 10
},
"ListingPrice": {
"CurrencyCode": "USD",
"Amount": 130
},
"Shipping": {
"CurrencyCode": "USD",
"Amount": 120
},
"Points": {
"PointsNumber": 130,
"PointsMonetaryValue": {
"CurrencyCode": "USD",
"Amount": 10
}
}
},
"condition": "new",
"belongsToRequester": true
}
],
"NumberOfOfferListings": [
{
"Count": 1,
"condition": "new"
}
],
"TradeInValue": {
"CurrencyCode": "string",
"Amount": 0
}
},
"SalesRankings": [
{
"ProductCategoryId": "54564",
"Rank": 1
}
]
}
}
]
}
},
{
"request": {
"parameters": {
"MarketplaceId": {
"value": "ATVPDKIKX0DER"
},
"ItemType": {
"value": "Sku"
}
}
},
"response": {
"payload": [
{
"status": "Success",
"SellerSKU": "NABetaASINB00V5DG6IQ",
"Product": {
"Identifiers": {
"MarketplaceASIN": {
"MarketplaceId": "ATVPDKIKX0DER",
"ASIN": "B00V5DG6IQ"
},
"SKUIdentifier": {
"MarketplaceId": "ATVPDKIKX0DER",
"SellerId": "A3TH9S8BH6GOGM",
"SellerSKU": "NABetaASINB00V5DG6IQ"
}
},
"CompetitivePricing": {
"CompetitivePrices": [
{
"CompetitivePriceId": "3454535",
"Price": {
"LandedPrice": {
"CurrencyCode": "USD",
"Amount": 10
},
"ListingPrice": {
"CurrencyCode": "USD",
"Amount": 130
},
"Shipping": {
"CurrencyCode": "USD",
"Amount": 120
},
"Points": {
"PointsNumber": 130,
"PointsMonetaryValue": {
"CurrencyCode": "USD",
"Amount": 10
}
}
},
"condition": "new",
"belongsToRequester": true
}
],
"NumberOfOfferListings": [
{
"Count": 402,
"condition": "new"
}
],
"TradeInValue": {
"CurrencyCode": "USD",
"Amount": 20
}
},
"SalesRankings": [
{
"ProductCategoryId": "676554",
"Rank": 1
}
]
}
},
{
"status": "Success",
"SellerSKU": "NABetaASINB00551Q3CS",
"Product": {
"Identifiers": {
"MarketplaceASIN": {
"MarketplaceId": "ATVPDKIKX0DER",
"ASIN": "B00551Q3CS"
},
"SKUIdentifier": {
"MarketplaceId": "ATVPDKIKX0DER",
"SellerId": "A3TH9S8BH6GOGM",
"SellerSKU": "NABetaASINB00551Q3CS"
}
},
"CompetitivePricing": {
"CompetitivePrices": [
{
"CompetitivePriceId": "4545645646",
"Price": {
"LandedPrice": {
"CurrencyCode": "USD",
"Amount": 10
},
"ListingPrice": {
"CurrencyCode": "USD",
"Amount": 130
},
"Shipping": {
"CurrencyCode": "USD",
"Amount": 120
},
"Points": {
"PointsNumber": 130,
"PointsMonetaryValue": {
"CurrencyCode": "USD",
"Amount": 10
}
}
},
"condition": "new",
"belongsToRequester": true
}
],
"NumberOfOfferListings": [
{
"Count": 402,
"condition": "new"
}
],
"TradeInValue": {
"CurrencyCode": "USD",
"Amount": 20
}
},
"SalesRankings": [
{
"ProductCategoryId": "35345",
"Rank": 1
}
]
}
}
]
}
},
{
"request": {
"parameters": {
"MarketplaceId": {
"value": "ATVPDKIKX0DER"
},
"ItemType": {
"value": "Asin"
}
}
},
"response": {
"payload": [
{
"status": "Success",
"ASIN": "B00V5DG6IQ",
"Product": {
"Identifiers": {
"MarketplaceASIN": {
"MarketplaceId": "ATVPDKIKX0DER",
"ASIN": "B00V5DG6IQ"
},
"SKUIdentifier": {
"MarketplaceId": "",
"SellerId": "",
"SellerSKU": ""
}
},
"CompetitivePricing": {
"CompetitivePrices": [],
"NumberOfOfferListings": [
{
"Count": 1,
"condition": "New"
},
{
"Count": 1,
"condition": "Any"
}
]
},
"SalesRankings": [
{
"ProductCategoryId": "office_product_display_on_website",
"Rank": 19
},
{
"ProductCategoryId": "1069616",
"Rank": 1
},
{
"ProductCategoryId": "705333011",
"Rank": 1
},
{
"ProductCategoryId": "1069242",
"Rank": 17
}
]
}
},
{
"status": "Success",
"ASIN": "B00551Q3CS",
"Product": {
"Identifiers": {
"MarketplaceASIN": {
"MarketplaceId": "ATVPDKIKX0DER",
"ASIN": "B00551Q3CS"
},
"SKUIdentifier": {
"MarketplaceId": "",
"SellerId": "",
"SellerSKU": ""
}
},
"CompetitivePricing": {
"CompetitivePrices": [],
"NumberOfOfferListings": [
{
"Count": 1,
"condition": "New"
},
{
"Count": 1,
"condition": "Any"
}
]
},
"SalesRankings": [
{
"ProductCategoryId": "464394",
"Rank": 224
},
{
"ProductCategoryId": "12954861",
"Rank": 1057
}
]
}
}
]
}
},
{
"request": {
"parameters": {
"MarketplaceId": {
"value": "ATVPDKIKX0DER"
},
"ItemType": {
"value": "Sku"
}
}
},
"response": {
"payload": [
{
"status": "Success",
"SellerSKU": "NABetaASINB00V5DG6IQ",
"Product": {
"Identifiers": {
"MarketplaceASIN": {
"MarketplaceId": "ATVPDKIKX0DER",
"ASIN": "B00V5DG6IQ"
},
"SKUIdentifier": {
"MarketplaceId": "ATVPDKIKX0DER",
"SellerId": "A3TH9S8BH6GOGM",
"SellerSKU": "NABetaASINB00V5DG6IQ"
}
},
"CompetitivePricing": {
"CompetitivePrices": [],
"NumberOfOfferListings": [
{
"Count": 1,
"condition": "New"
},
{
"Count": 1,
"condition": "Any"
}
]
},
"SalesRankings": [
{
"ProductCategoryId": "office_product_display_on_website",
"Rank": 19
},
{
"ProductCategoryId": "1069616",
"Rank": 1
},
{
"ProductCategoryId": "705333011",
"Rank": 1
},
{
"ProductCategoryId": "1069242",
"Rank": 17
}
]
}
},
{
"status": "Success",
"SellerSKU": "NABetaASINB00551Q3CS",
"Product": {
"Identifiers": {
"MarketplaceASIN": {
"MarketplaceId": "ATVPDKIKX0DER",
"ASIN": "B00551Q3CS"
},
"SKUIdentifier": {
"MarketplaceId": "ATVPDKIKX0DER",
"SellerId": "A3TH9S8BH6GOGM",
"SellerSKU": "NABetaASINB00551Q3CS"
}
},
"CompetitivePricing": {
"CompetitivePrices": [],
"NumberOfOfferListings": [
{
"Count": 1,
"condition": "New"
},
{
"Count": 1,
"condition": "Any"
}
]
},
"SalesRankings": [
{
"ProductCategoryId": "464394",
"Rank": 224
},
{
"ProductCategoryId": "12954861",
"Rank": 1057
}
]
}
}
]
}
}
],
"schema": {
"$ref": "#/definitions/GetPricingResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference ID."
}
}
},
"400": {
"description": "Request has missing or invalid parameters and cannot be parsed.",
"x-amazon-spds-sandbox-behaviors": [
{
"request": {
"parameters": {
"MarketplaceId": {
"value": "TEST_CASE_400"
}
}
},
"response": {
"errors": [
{
"code": "InvalidInput",
"message": "Invalid Input"
}
]
}
}
],
"schema": {
"$ref": "#/definitions/GetPricingResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference ID."
}
}
},
"401": {
"description": "The request's Authorization header is not formatted correctly or does not contain a valid token.",
"schema": {
"$ref": "#/definitions/GetPricingResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference ID."
}
}
},
"403": {
"description": "Indicates access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"schema": {
"$ref": "#/definitions/GetPricingResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference ID."
}
}
},
"404": {
"description": "The specified resource does not exist.",
"schema": {
"$ref": "#/definitions/GetPricingResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference ID."
}
}
},
"429": {
"description": "The frequency of requests was greater than allowed.",
"schema": {
"$ref": "#/definitions/GetPricingResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference ID."
}
}
},
"500": {
"description": "An unexpected condition occurred that prevented the server from fulfilling the request.",
"schema": {
"$ref": "#/definitions/GetPricingResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference ID."
}
}
},
"503": {
"description": "Temporary overloading or maintenance of the server.",
"schema": {
"$ref": "#/definitions/GetPricingResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference ID."
}
}
}
}
}
},
"/products/pricing/v0/listings/{SellerSKU}/offers": {
"get": {
"tags": [
"productPricing"
],
Updated models
2020-08-14 08:37:01 +08:00
"description": "Returns the lowest priced offers for a single SKU listing.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 1 | 1 |\n\nFor more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.",
Initial commit
2020-07-30 08:33:17 +08:00
"operationId": "getListingOffers",
"parameters": [
{
"name": "MarketplaceId",
"in": "query",
"description": "A marketplace identifier. Specifies the marketplace for which prices are returned.",
"required": true,
"type": "string"
},
{
"name": "ItemCondition",
"in": "query",
"description": "Filters the offer listings based on item condition. Possible values: New, Used, Collectible, Refurbished, Club.",
"required": true,
"type": "string",
"enum": [
"New",
"Used",
"Collectible",
"Refurbished",
"Club"
Updated models
2020-08-14 08:37:01 +08:00
],
"x-docgen-enum-table-extension": [
{
"value": "New",
"description": "New"
},
{
"value": "Used",
"description": "Used"
},
{
"value": "Collectible",
"description": "Collectible"
},
{
"value": "Refurbished",
"description": "Refurbished"
},
{
"value": "Club",
"description": "Club"
}
Initial commit
2020-07-30 08:33:17 +08:00
]
},
{
"name": "SellerSKU",
"in": "path",
"description": "Identifies an item in the given marketplace. SellerSKU is qualified by the seller's SellerId, which is included with every operation that you submit.",
"type": "string",
"required": true
}
],
"responses": {
"200": {
"description": "Success.",
"x-amazon-spds-sandbox-behaviors": [
{
"request": {
"parameters": {
"SellerSKU": {
"value": "NABetaASINB00V5DG6IQ"
},
"MarketplaceId": {
"value": "ATVPDKIKX0DER"
}
}
},
"response": {
"payload": {
"SKU": "NABetaASINB00V5DG6IQ",
"status": "Success",
"ItemCondition": "New",
"Identifier": {
"MarketplaceId": "ATVPDKIKX0DER",
"ItemCondition": "New",
"SellerSKU": "NABetaASINB00V5DG6IQ"
},
"Summary": {
"LowestPrices": [
{
"condition": "new",
"fulfillmentChannel": "Merchant",
"LandedPrice": {
"CurrencyCode": "USD",
"Amount": 10.00
},
"ListingPrice": {
"CurrencyCode": "USD",
"Amount": 10.00
},
"Shipping": {
"CurrencyCode": "USD",
"Amount": 0.00
}
}
],
"NumberOfOffers": [
{
"condition": "new",
"fulfillmentChannel": "Merchant"
}
],
"BuyBoxEligibleOffers": [
{
"condition": "new",
"fulfillmentChannel": "Merchant"
}
],
"TotalOfferCount": 1
},
"Offers": [
{
"Shipping": {
"CurrencyCode": "USD",
"Amount": 0.00
},
"ListingPrice": {
"CurrencyCode": "USD",
"Amount": 10.00
},
"ShippingTime": {
"maximumHours": 48,
"minimumHours": 24,
"availabilityType": "NOW"
},
"SellerFeedbackRating": {
"FeedbackCount": 0,
"SellerPositiveFeedbackRating": 0.0
},
"ShipsFrom": {
"State": "WA",
"Country": "US"
},
"SubCondition": "new",
"IsFeaturedMerchant": false,
"MyOffer": true,
"IsFulfilledByAmazon": false
}
],
"MarketplaceID": "ATVPDKIKX0DER"
}
}
}
],
"schema": {
"$ref": "#/definitions/GetOffersResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference ID."
}
}
},
"400": {
"description": "Request has missing or invalid parameters and cannot be parsed.",
"x-amazon-spds-sandbox-behaviors": [
{
"request": {
"parameters": {
"SellerSKU": {
"value": "TEST_CASE_400"
}
}
},
"response": {
"errors": [
{
"code": "InvalidInput",
"message": "Invalid Input"
}
]
}
}
],
"schema": {
"$ref": "#/definitions/GetOffersResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference ID."
}
}
},
"401": {
"description": "The request's Authorization header is not formatted correctly or does not contain a valid token.",
"schema": {
"$ref": "#/definitions/GetOffersResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference ID."
}
}
},
"403": {
"description": "Indicates access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"schema": {
"$ref": "#/definitions/GetOffersResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference ID."
}
}
},
"404": {
"description": "The specified resource does not exist.",
"schema": {
"$ref": "#/definitions/GetOffersResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference ID."
}
}
},
"429": {
"description": "The frequency of requests was greater than allowed.",
"schema": {
"$ref": "#/definitions/GetOffersResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference ID."
}
}
},
"500": {
"description": "An unexpected condition occurred that prevented the server from fulfilling the request.",
"schema": {
"$ref": "#/definitions/GetOffersResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference ID."
}
}
},
"503": {
"description": "Temporary overloading or maintenance of the server.",
"schema": {
"$ref": "#/definitions/GetOffersResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference ID."
}
}
}
}
}
},
"/products/pricing/v0/items/{Asin}/offers": {
"get": {
"tags": [
"productPricing"
],
Updated models
2020-08-14 08:37:01 +08:00
"description": "Returns the lowest priced offers for a single item based on ASIN.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 1 | 1 |\n\nFor more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.",
Initial commit
2020-07-30 08:33:17 +08:00
"operationId": "getItemOffers",
"parameters": [
{
"name": "MarketplaceId",
"in": "query",
"description": "A marketplace identifier. Specifies the marketplace for which prices are returned.",
"required": true,
"type": "string"
},
{
"name": "ItemCondition",
"in": "query",
"description": "Filters the offer listings to be considered based on item condition. Possible values: New, Used, Collectible, Refurbished, Club.",
"required": true,
"type": "string",
"enum": [
"New",
"Used",
"Collectible",
"Refurbished",
"Club"
Updated models
2020-08-14 08:37:01 +08:00
],
"x-docgen-enum-table-extension": [
{
"value": "New",
"description": "New"
},
{
"value": "Used",
"description": "Used"
},
{
"value": "Collectible",
"description": "Collectible"
},
{
"value": "Refurbished",
"description": "Refurbished"
},
{
"value": "Club",
"description": "Club"
}
Initial commit
2020-07-30 08:33:17 +08:00
]
},
{
"name": "Asin",
"in": "path",
"description": "The Amazon Standard Identification Number (ASIN) of the item.",
"type": "string",
"required": true
}
],
"responses": {
"200": {
"description": "Success.",
"x-amazon-spds-sandbox-behaviors": [
{
"request": {
"parameters": {
"Asin": {
"value": "B00V5DG6IQ"
},
"MarketplaceId": {
"value": "ATVPDKIKX0DER"
}
}
},
"response": {
"payload": {
"ASIN": "B00V5DG6IQ",
"status": "Success",
"ItemCondition": "New",
"Identifier": {
"MarketplaceId": "ATVPDKIKX0DER",
"ItemCondition": "New",
"ASIN": "B00V5DG6IQ"
},
"Summary": {
"LowestPrices": [
{
"condition": "new",
"fulfillmentChannel": "Merchant",
"LandedPrice": {
"CurrencyCode": "USD",
"Amount": 10.00
},
"ListingPrice": {
"CurrencyCode": "USD",
"Amount": 10.00
},
"Shipping": {
"CurrencyCode": "USD",
"Amount": 0.00
}
}
],
"NumberOfOffers": [
{
"condition": "new",
"fulfillmentChannel": "Merchant"
}
],
"BuyBoxEligibleOffers": [
{
"condition": "new",
"fulfillmentChannel": "Merchant"
}
],
"TotalOfferCount": 1
},
"Offers": [
{
"Shipping": {
"CurrencyCode": "USD",
"Amount": 0.00
},
"ListingPrice": {
"CurrencyCode": "USD",
"Amount": 10.00
},
"ShippingTime": {
"maximumHours": 48,
"minimumHours": 24,
"availabilityType": "NOW"
},
"SellerFeedbackRating": {
"FeedbackCount": 0,
"SellerPositiveFeedbackRating": 0.0
},
"ShipsFrom": {
"State": "WA",
"Country": "US"
},
"SubCondition": "new",
"IsFeaturedMerchant": false,
"IsFulfilledByAmazon": false
}
],
"MarketplaceID": "ATVPDKIKX0DER"
}
}
}
],
"schema": {
"$ref": "#/definitions/GetOffersResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference ID."
}
}
},
"400": {
"description": "Request has missing or invalid parameters and cannot be parsed.",
"x-amazon-spds-sandbox-behaviors": [
{
"request": {
"parameters": {
"Asin": {
"value": "TEST_CASE_400"
}
}
},
"response": {
"errors": [
{
"code": "InvalidInput",
"message": "Invalid Input"
}
]
}
}
],
"schema": {
"$ref": "#/definitions/GetOffersResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference ID."
}
}
},
"401": {
"description": "The request's Authorization header is not formatted correctly or does not contain a valid token.",
"schema": {
"$ref": "#/definitions/GetOffersResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference ID."
}
}
},
"403": {
"description": "Indicates access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"schema": {
"$ref": "#/definitions/GetOffersResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference ID."
}
}
},
"404": {
"description": "The specified resource does not exist.",
"schema": {
"$ref": "#/definitions/GetOffersResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference ID."
}
}
},
"429": {
"description": "The frequency of requests was greater than allowed.",
"schema": {
"$ref": "#/definitions/GetOffersResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference ID."
}
}
},
"500": {
"description": "An unexpected condition occurred that prevented the server from fulfilling the request.",
"schema": {
"$ref": "#/definitions/GetOffersResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference ID."
}
}
},
"503": {
"description": "Temporary overloading or maintenance of the server.",
"schema": {
"$ref": "#/definitions/GetOffersResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference ID."
}
}
}
}
}
}
},
"definitions": {
"GetPricingResponse": {
"description": "The response schema for the getPricing and getCompetitivePricing operations.",
"type": "object",
"properties": {
"payload": {
"description": "The payload for the getPricing and getCompetitivePricing operations.",
"$ref": "#/definitions/PriceList"
},
"errors": {
"description": "One or more unexpected errors occurred during the operation.",
"$ref": "#/definitions/ErrorList"
}
}
},
"GetOffersResponse": {
"description": "The response schema for the getListingOffers and getItemOffers operations.",
"type": "object",
"properties": {
"payload": {
"description": "The payload for the getListingOffers and getItemOffers operations.",
"$ref": "#/definitions/GetOffersResult"
},
"errors": {
"description": "One or more unexpected errors occurred during the operation.",
"$ref": "#/definitions/ErrorList"
}
}
},
"PriceList": {
"type": "array",
"items": {
"$ref": "#/definitions/Price"
},
"maxItems": 20
},
"GetOffersResult": {
"type": "object",
"required": [
"MarketplaceID",
"ItemCondition",
"status",
"Identifier",
"Summary",
"Offers"
],
"properties": {
"MarketplaceID": {
"description": "A marketplace identifier.",
"type": "string"
},
"ASIN": {
"description": "The Amazon Standard Identification Number (ASIN) of the item.",
"type":"string"
},
"SKU": {
"description": "The stock keeping unit (SKU) of the item.",
"type": "string"
},
"ItemCondition": {
"description": "The condition of the item.",
"$ref": "#/definitions/ConditionType"
},
"status": {
"description": "The status of the operation.",
"type": "string"
},
"Identifier": {
"description": "Metadata that identifies the item.",
"$ref": "#/definitions/ItemIdentifier"
},
"Summary": {
"description": "Pricing information about the item.",
"$ref": "#/definitions/Summary"
},
"Offers" : {
"description": "A list of offer details. The list is the same length as the TotalOfferCount in the Summary or 20, whichever is less.",
"$ref" : "#/definitions/OfferDetailList"
}
}
},
"Price": {
"type": "object",
"required": [
"status"
],
"properties": {
"status": {
"description": "The status of the operation.",
"type": "string"
},
"SellerSKU": {
"description": "The seller stock keeping unit (SKU) of the item.",
"type": "string"
},
"ASIN": {
"description": "The Amazon Standard Identification Number (ASIN) of the item.",
"type": "string"
},
"Product": {
"$ref": "#/definitions/Product"
}
}
},
"Product": {
"description": "An item.",
"type": "object",
"required": [
"Identifiers"
],
"properties": {
"Identifiers" : {
"$ref" : "#/definitions/IdentifierType"
},
"AttributeSets" : {
"$ref" : "#/definitions/AttributeSetList"
},
"Relationships" : {
"$ref" : "#/definitions/RelationshipList"
},
"CompetitivePricing" : {
"$ref" : "#/definitions/CompetitivePricingType"
},
"SalesRankings" : {
"$ref" : "#/definitions/SalesRankList"
},
"Offers" : {
"$ref" : "#/definitions/OffersList"
}
}
},
"IdentifierType" : {
"description": "Specifies the identifiers used to uniquely identify an item.",
"type" : "object",
"required": [
"MarketplaceASIN"
],
"properties" : {
"MarketplaceASIN" : {
"description": "Indicates the item is identified by MarketPlaceId and ASIN.",
"$ref" : "#/definitions/ASINIdentifier"
},
"SKUIdentifier" : {
"description": "Indicates the item is identified by MarketPlaceId, SellerId, and SellerSKU.",
"$ref" : "#/definitions/SellerSKUIdentifier"
}
}
},
"ASINIdentifier": {
"type": "object",
"required" : [ "MarketplaceId", "ASIN" ],
"properties" : {
"MarketplaceId" : {
"description": "A marketplace identifier.",
"type" : "string"
},
"ASIN" : {
"description": "The Amazon Standard Identification Number (ASIN) of the item.",
"type" : "string"
}
}
},
"SellerSKUIdentifier": {
"type" : "object",
"required" : [ "MarketplaceId", "SellerId", "SellerSKU" ],
"properties" : {
"MarketplaceId" : {
"description": "A marketplace identifier.",
"type" : "string"
},
"SellerId" : {
"description": "The seller identifier submitted for the operation.",
"type" : "string"
},
"SellerSKU" : {
"description": "The seller stock keeping unit (SKU) of the item.",
"type" : "string"
}
}
},
"AttributeSetList" : {
"description": "A list of product attributes if they are applicable to the product that is returned.",
"type" : "array",
"items" : {
"type" : "object"
}
},
"RelationshipList" : {
"description": "A list that contains product variation information, if applicable.",
"type" : "array",
"items" : {
"type" : "object"
}
},
"CompetitivePricingType" : {
"description": "Competitive pricing information for the item.",
"type" : "object",
"required" : [ "CompetitivePrices", "NumberOfOfferListings" ],
"properties" : {
"CompetitivePrices" : {
"$ref" : "#/definitions/CompetitivePriceList"
},
"NumberOfOfferListings" : {
"$ref" : "#/definitions/NumberOfOfferListingsList"
},
"TradeInValue" : {
"description": "The trade-in value of the item in the trade-in program.",
"$ref" : "#/definitions/MoneyType"
}
}
},
"CompetitivePriceList" : {
"description": "A list of competitive pricing information.",
"type" : "array",
"items" : {
"$ref" : "#/definitions/CompetitivePriceType"
}
},
"CompetitivePriceType" : {
"type" : "object",
"required" : [ "CompetitivePriceId", "Price" ],
"properties" : {
"CompetitivePriceId" : {
"description": "The pricing model for each price that is returned.\n\nPossible values:\n\n* 1 - New Buy Box Price.\n* 2 - Used Buy Box Price.",
"type" : "string"
},
"Price" : {
"description": "Pricing information for a given CompetitivePriceId value.",
"$ref" : "#/definitions/PriceType"
},
"condition" : {
"description": "Indicates the condition of the item whose pricing information is returned. Possible values are: New, Used, Collectible, Refurbished, or Club.",
"type" : "string"
},
"subcondition" : {
"description": "Indicates the subcondition of the item whose pricing information is returned. Possible values are: New, Mint, Very Good, Good, Acceptable, Poor, Club, OEM, Warranty, Refurbished Warranty, Refurbished, Open Box, or Other.",
"type" : "string"
},
"belongsToRequester" : {
"description": " Indicates whether or not the pricing information is for an offer listing that belongs to the requester. The requester is the seller associated with the SellerId that was submitted with the request. Possible values are: true and false.",
"type" : "boolean"
}
}
},
"NumberOfOfferListingsList" : {
"description": "The number of active offer listings for the item that was submitted. The listing count is returned by condition, one for each listing condition value that is returned.",
"type" : "array",
"items" : {
"$ref" : "#/definitions/OfferListingCountType"
}
},
"OfferListingCountType" : {
"description": "The number of offer listings with the specified condition.",
"type" : "object",
"required" : [ "Count", "condition" ],
"properties" : {
"Count" : {
"description": "The number of offer listings.",
"type" : "integer",
"format": "int32"
},
"condition" : {
"description": "The condition of the item.",
"type" : "string"
}
}
},
"MoneyType" : {
"type" : "object",
"properties" : {
"CurrencyCode" : {
"description": "The currency code in ISO 4217 format.",
"type" : "string"
},
"Amount" : {
"description": "The monetary value.",
"type" : "number"
}
}
},
"SalesRankList" : {
"description": "A list of sales rank information for the item, by category.",
"type" : "array",
"items" : {
"$ref" : "#/definitions/SalesRankType"
}
},
"SalesRankType" : {
"type" : "object",
"required" : [ "ProductCategoryId", "Rank" ],
"properties" : {
"ProductCategoryId" : {
"description": " Identifies the item category from which the sales rank is taken.",
"type" : "string"
},
"Rank" : {
"description": "The sales rank of the item within the item category.",
"type" : "integer",
"format": "int32"
}
}
},
"PriceType" : {
"type" : "object",
"required" : [ "ListingPrice" ],
"properties" : {
"LandedPrice" : {
"description": "The value calculated by adding ListingPrice + Shipping - Points. Note that if the landed price is not returned, the listing price represents the product with the lowest landed price.",
"$ref" : "#/definitions/MoneyType"
},
"ListingPrice" : {
"description": "The listing price of the item including any promotions that apply.",
"$ref" : "#/definitions/MoneyType"
},
"Shipping" : {
"description": "The shipping cost of the product. Note that the shipping cost is not always available.",
"$ref" : "#/definitions/MoneyType"
},
"Points" : {
"description": "The number of Amazon Points offered with the purchase of an item, and their monetary value.",
"$ref" : "#/definitions/Points"
}
}
},
"OffersList" : {
"description": "A list of offers.",
"type" : "array",
"items" : {
"$ref" : "#/definitions/OfferType"
}
},
"OfferType" : {
"type" : "object",
Updated models
2020-08-14 08:37:01 +08:00
"required" : [ "BuyingPrice", "RegularPrice", "FulfillmentChannel", "ItemCondition", "ItemSubCondition", "SellerSKU" ],
Initial commit
2020-07-30 08:33:17 +08:00
"properties" : {
"BuyingPrice" : {
"description": "Contains pricing information that includes promotions and contains the shipping cost.",
"$ref" : "#/definitions/PriceType"
},
"RegularPrice" : {
"description": "The current price excluding any promotions that apply to the product. Excludes the shipping cost.",
"$ref" : "#/definitions/MoneyType"
},
"FulfillmentChannel" : {
"description": "The fulfillment channel for the offer listing. Possible values:\n\n* Amazon - Fulfilled by Amazon.\n* Merchant - Fulfilled by the seller.",
"type" : "string"
},
"ItemCondition" : {
"description": "The item condition for the offer listing. Possible values: New, Used, Collectible, Refurbished, or Club.",
"type" : "string"
},
"ItemSubCondition" : {
"description": "The item subcondition for the offer listing. Possible values: New, Mint, Very Good, Good, Acceptable, Poor, Club, OEM, Warranty, Refurbished Warranty, Refurbished, Open Box, or Other.",
"type" : "string"
},
"SellerSKU" : {
"description": "The seller stock keeping unit (SKU) of the item.",
"type" : "string"
}
}
},
"Points" : {
"type" : "object",
"properties" : {
"PointsNumber" : {
"description": "The number of points.",
"type" : "integer",
"format": "int32"
},
"PointsMonetaryValue" : {
"description": "The monetary value of the points.",
"$ref" : "#/definitions/MoneyType"
}
}
},
"ConditionType": {
"description": "Indicates the condition of the item. Possible values: New, Used, Collectible, Refurbished, Club.",
"type": "string",
"enum": [
"New",
"Used",
"Collectible",
"Refurbished",
"Club"
Updated models
2020-08-14 08:37:01 +08:00
],
"x-docgen-enum-table-extension": [
{
"value": "New",
"description": "New"
},
{
"value": "Used",
"description": "Used"
},
{
"value": "Collectible",
"description": "Collectible"
},
{
"value": "Refurbished",
"description": "Refurbished"
},
{
"value": "Club",
"description": "Club"
}
Initial commit
2020-07-30 08:33:17 +08:00
]
},
"ItemIdentifier": {
"description": "Information that identifies an item.",
"type": "object",
"required": [
"MarketplaceId",
"ItemCondition"
],
"properties": {
"MarketplaceId": {
"description": "A marketplace identifier. Specifies the marketplace from which prices are returned.",
"type": "string"
},
"ASIN": {
"description": "The Amazon Standard Identification Number (ASIN) of the item.",
"type": "string"
},
"SellerSKU": {
"description": "The seller stock keeping unit (SKU) of the item.",
"type": "string"
},
"ItemCondition": {
"description": "The condition of the item.",
"$ref": "#/definitions/ConditionType"
}
}
},
"Summary" : {
"description": "Contains price information about the product, including the LowestPrices and BuyBoxPrices, the ListPrice, the SuggestedLowerPricePlusShipping, and NumberOfOffers and NumberOfBuyBoxEligibleOffers.",
"type" : "object",
"required" : [ "TotalOfferCount" ],
"properties" : {
"TotalOfferCount" : {
"description": "The number of unique offers contained in NumberOfOffers.",
"type" : "integer",
"format": "int32"
},
"NumberOfOffers" : {
"description": "A list that contains the total number of offers for the item for the given conditions and fulfillment channels.",
"$ref" : "#/definitions/NumberOfOffers"
},
"LowestPrices" : {
"description": "A list of the lowest prices for the item.",
"$ref" : "#/definitions/LowestPrices"
},
"BuyBoxPrices" : {
"description": "A list of item prices.",
"$ref" : "#/definitions/BuyBoxPrices"
},
"ListPrice" : {
"description": "The list price of the item as suggested by the manufacturer.",
"$ref" : "#/definitions/MoneyType"
},
"SuggestedLowerPricePlusShipping" : {
"description": "The suggested lower price of the item, including shipping and Amazon Points. The suggested lower price is based on a range of factors, including historical selling prices, recent Buy Box-eligible prices, and input from customers for your products.",
"$ref" : "#/definitions/MoneyType"
},
"BuyBoxEligibleOffers" : {
"description": "A list that contains the total number of offers that are eligible for the Buy Box for the given conditions and fulfillment channels.",
"$ref" : "#/definitions/BuyBoxEligibleOffers"
},
"OffersAvailableTime" : {
"description": "When the status is ActiveButTooSoonForProcessing, this is the time when the offers will be available for processing.",
"type" : "string",
"format": "date-time"
}
}
},
"BuyBoxEligibleOffers" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/OfferCountType"
}
},
"BuyBoxPrices" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/BuyBoxPriceType"
}
},
"LowestPrices" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/LowestPriceType"
}
},
"NumberOfOffers" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/OfferCountType"
}
},
"OfferCountType" : {
"description": "The total number of offers for the specified condition and fulfillment channel.",
"type" : "object",
"properties" : {
"condition" : {
"description": "Indicates the condition of the item. For example: New, Used, Collectible, Refurbished, or Club.",
"type" : "string"
},
"fulfillmentChannel" : {
"description": "Indicates whether the item is fulfilled by Amazon or by the seller.",
"$ref" : "#/definitions/FulfillmentChannelType"
},
"OfferCount" : {
"description": "The number of offers in a fulfillment channel that meet a specific condition.",
"type" : "integer",
"format": "int32"
}
}
},
Updated models
2020-08-14 08:37:01 +08:00
"FulfillmentChannelType":
{
"description": "Indicates whether the item is fulfilled by Amazon or by the seller (merchant).",
"type": "string",
"enum": ["Amazon", "Merchant"],
"x-docgen-enum-table-extension": [
{
"value": "Amazon",
"description": "Fulfilled by Amazon."
},
{
"value": "Merchant",
"description": "Fulfilled by the seller."
}
]
Initial commit
2020-07-30 08:33:17 +08:00
},
"LowestPriceType" : {
"type" : "object",
"required" : [ "condition", "fulfillmentChannel", "LandedPrice", "ListingPrice", "Shipping" ],
"properties" : {
"condition" : {
"description": "Indicates the condition of the item. For example: New, Used, Collectible, Refurbished, or Club.",
"type" : "string"
},
"fulfillmentChannel" : {
"description": "Indicates whether the item is fulfilled by Amazon or by the seller.",
"type" : "string"
},
"LandedPrice" : {
"description": "The value calculated by adding ListingPrice + Shipping - Points.",
"$ref" : "#/definitions/MoneyType"
},
"ListingPrice" : {
"description": "The price of the item.",
"$ref" : "#/definitions/MoneyType"
},
"Shipping" : {
"description": "The shipping cost.",
"$ref" : "#/definitions/MoneyType"
},
"Points" : {
"description": "The number of Amazon Points offered with the purchase of an item.",
"$ref" : "#/definitions/Points"
}
}
},
"BuyBoxPriceType" : {
"type" : "object",
"required" : [ "condition", "LandedPrice", "ListingPrice", "Shipping" ],
"properties" : {
"condition" : {
"description": "Indicates the condition of the item. For example: New, Used, Collectible, Refurbished, or Club.",
"type" : "string"
},
"LandedPrice" : {
"description": "The value calculated by adding ListingPrice + Shipping - Points.",
"$ref" : "#/definitions/MoneyType"
},
"ListingPrice" : {
"description": "The price of the item.",
"$ref" : "#/definitions/MoneyType"
},
"Shipping" : {
"description": "The shipping cost.",
"$ref" : "#/definitions/MoneyType"
},
"Points" : {
"description": "The number of Amazon Points offered with the purchase of an item.",
"$ref" : "#/definitions/Points"
}
}
},
"OfferDetailList" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/OfferDetail"
},
"maxItems": 20
},
"OfferDetail": {
"type": "object",
"required": [
"SubCondition",
"ShippingTime",
"ListingPrice",
"Shipping",
"IsFulfilledByAmazon"
],
"properties": {
"MyOffer": {
"description": "When true, this is the seller's offer.",
"type": "boolean"
},
"SubCondition" : {
"description": "The subcondition of the item. Subcondition values: New, Mint, Very Good, Good, Acceptable, Poor, Club, OEM, Warranty, Refurbished Warranty, Refurbished, Open Box, or Other.",
"type" : "string"
},
"SellerFeedbackRating" : {
"description": "Information about the seller's feedback, including the percentage of positive feedback, and the total number of ratings received.",
"$ref" : "#/definitions/SellerFeedbackType"
},
"ShippingTime" : {
"description": "The maximum time within which the item will likely be shipped once an order has been placed.",
"$ref" : "#/definitions/DetailedShippingTimeType"
},
"ListingPrice" : {
"description": "The price of the item.",
"$ref" : "#/definitions/MoneyType"
},
"Points" : {
"description": "The number of Amazon Points offered with the purchase of an item.",
"$ref" : "#/definitions/Points"
},
"Shipping" : {
"description": "The shipping cost.",
"$ref" : "#/definitions/MoneyType"
},
"ShipsFrom" : {
"description": "The state and country from where the item is shipped.",
"$ref" : "#/definitions/ShipsFromType"
},
"IsFulfilledByAmazon" : {
"description": "When true, the offer is fulfilled by Amazon.",
"type" : "boolean"
},
"IsBuyBoxWinner" : {
"description": "When true, the offer is currently in the Buy Box. There can be up to two Buy Box winners at any time per ASIN, one that is eligible for Prime and one that is not eligible for Prime.",
"type" : "boolean"
},
"IsFeaturedMerchant" : {
"description": "When true, the seller of the item is eligible to win the Buy Box.",
"type" : "boolean"
}
}
},
"SellerFeedbackType" : {
"description": "Information about the seller's feedback, including the percentage of positive feedback, and the total number of ratings received.",
"type" : "object",
"required" : [ "FeedbackCount" ],
"properties" : {
"SellerPositiveFeedbackRating" : {
"description": "The percentage of positive feedback for the seller in the past 365 days.",
"type" : "number",
"format": "double"
},
"FeedbackCount" : {
"description": "The number of ratings received about the seller.",
"type" : "integer",
"format": "int64"
}
}
},
"ErrorList": {
"type": "array",
"description": "A list of error responses returned when a request is unsuccessful.",
"items": {
"$ref": "#/definitions/Error"
}
},
"DetailedShippingTimeType" : {
"description": "The time range in which an item will likely be shipped once an order has been placed.",
"type" : "object",
"properties" : {
"minimumHours" : {
"description": "The minimum time, in hours, that the item will likely be shipped after the order has been placed.",
"type" : "integer",
"format": "int64"
},
"maximumHours" : {
"description": "The maximum time, in hours, that the item will likely be shipped after the order has been placed.",
"type" : "integer",
"format": "int64"
},
"availableDate" : {
"description": "The date when the item will be available for shipping. Only displayed for items that are not currently available for shipping.",
"type" : "number"
},
"availabilityType" : {
"description": "Indicates whether the item is available for shipping now, or on a known or an unknown date in the future. If known, the availableDate property indicates the date that the item will be available for shipping. Possible values: NOW, FUTURE_WITHOUT_DATE, FUTURE_WITH_DATE.",
"type" : "string",
"enum": [
"NOW",
"FUTURE_WITHOUT_DATE",
"FUTURE_WITH_DATE"
Updated models
2020-08-14 08:37:01 +08:00
],
"x-docgen-enum-table-extension": [
{
"value": "NOW",
"description": "The item is available for shipping now."
},
{
"value": "FUTURE_WITHOUT_DATE",
"description": "The item will be available for shipping on an unknown date in the future."
},
{
"value": "FUTURE_WITH_DATE",
"description": "The item will be available for shipping on a known date in the future."
}
Initial commit
2020-07-30 08:33:17 +08:00
]
}
}
},
"ShipsFromType" : {
"description": "The state and country from where the item is shipped.",
"type" : "object",
"properties" : {
"State" : {
"description": "The state from where the item is shipped.",
"type" : "string"
},
"Country" : {
"description": "The country from where the item is shipped.",
"type" : "string"
}
}
},
"Error": {
"description": "Error response returned when the request is unsuccessful.",
"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 in a human-readable form."
},
"details": {
"type": "string",
"description": "Additional information that can help the caller understand or fix the issue."
}
}
}
}
}