Update Product Pricing API v2022-05-01 getCompetitiveSummary.
This commit is contained in:
Gibran Waldron
parent
11e00a792a
commit
368f916efe
|
|
@ -38,7 +38,8 @@
|
|||
"required": true,
|
||||
"schema": {
|
||||
"$ref": "#/definitions/GetFeaturedOfferExpectedPriceBatchRequest"
|
||||
}
|
||||
},
|
||||
"description": "The batch of `getFeaturedOfferExpectedPrice` requests."
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
|
|
@ -436,6 +437,36 @@
|
|||
"type": "string",
|
||||
"description": "Unique request reference identifier."
|
||||
}
|
||||
},
|
||||
"x-amzn-api-sandbox": {
|
||||
"static": [
|
||||
{
|
||||
"request": {
|
||||
"parameters": {
|
||||
"body": {
|
||||
"value": {
|
||||
"requests": [
|
||||
{
|
||||
"marketplaceId": "MARKETPLACE_ID",
|
||||
"sku": "INVALID_SKU",
|
||||
"method": "GET",
|
||||
"uri": "/products/pricing/2022-05-01/offer/featuredOfferExpectedPrice"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"response": {
|
||||
"errors": [
|
||||
{
|
||||
"code": "INVALID_SKU",
|
||||
"message": "The requested SKU does not exist for the seller in the requested marketplace."
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"401": {
|
||||
|
|
@ -640,6 +671,110 @@
|
|||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"referencePrices": [
|
||||
{
|
||||
"name": "CompetitivePriceThreshold",
|
||||
"price": {
|
||||
"amount": 18.11,
|
||||
"currencyCode": "USD"
|
||||
}
|
||||
}
|
||||
],
|
||||
"lowestPricedOffers": [
|
||||
{
|
||||
"lowestPricedOffersInput":{
|
||||
"itemCondition": "New",
|
||||
"offerType": "Consumer"
|
||||
},
|
||||
"offers": [
|
||||
{
|
||||
"listingPrice": {
|
||||
"currencyCode": "USD",
|
||||
"amount": 17.15
|
||||
},
|
||||
"shippingOptions": [
|
||||
{
|
||||
"shippingOptionType": "DEFAULT",
|
||||
"price": {
|
||||
"amount": 2.50,
|
||||
"currencyCode": "USD"
|
||||
}
|
||||
}
|
||||
],
|
||||
"points": {
|
||||
"pointsMonetaryValue": {
|
||||
"amount": 0.50,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
"pointsNumber": 50
|
||||
},
|
||||
"primeDetails": {
|
||||
"eligibility": "REGIONAL"
|
||||
},
|
||||
"subCondition": "New",
|
||||
"sellerId": "A2ZWOLFOFDPJL1",
|
||||
"fulfillmentType": "MFN"
|
||||
},
|
||||
{
|
||||
"listingPrice": {
|
||||
"amount": 18.11,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
"shippingOptions": [
|
||||
{
|
||||
"shippingOptionType": "DEFAULT",
|
||||
"price": {
|
||||
"amount": 2.50,
|
||||
"currencyCode": "USD"
|
||||
}
|
||||
}
|
||||
],
|
||||
"points": {
|
||||
"pointsNumber": 3,
|
||||
"pointsMonetaryValue": {
|
||||
"amount": 0.03,
|
||||
"currencyCode": "USD"
|
||||
}
|
||||
},
|
||||
"primeDetails": {
|
||||
"eligibility": "NATIONAL"
|
||||
},
|
||||
"sellerId": "A3DJR8M9Y3OUPG",
|
||||
"subCondition": "New",
|
||||
"fulfillmentType": "MFN"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"lowestPricedOffersInput": {
|
||||
"itemCondition": "Used",
|
||||
"offerType": "Consumer"
|
||||
},
|
||||
"offers": [
|
||||
{
|
||||
"listingPrice": {
|
||||
"CurrencyCode": "USD",
|
||||
"Amount": 12.00
|
||||
},
|
||||
"shippingOptions": [
|
||||
{
|
||||
"shippingOptionType": "DEFAULT",
|
||||
"price": {
|
||||
"amount": 2.50,
|
||||
"currencyCode": "USD"
|
||||
}
|
||||
}
|
||||
],
|
||||
"primeDetails": {
|
||||
"eligibility": "REGIONAL"
|
||||
},
|
||||
"subCondition": "Acceptable",
|
||||
"sellerId": "A3DH5AGPM3JVAB",
|
||||
"fulfillmentType": "AFN"
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -658,7 +793,19 @@
|
|||
"asin": "B00ZIAODGE",
|
||||
"marketplaceId": "ATVPDKIKX0DER",
|
||||
"includedData": [
|
||||
"featuredBuyingOptions"
|
||||
"featuredBuyingOptions",
|
||||
"referencePrices",
|
||||
"lowestPricedOffers"
|
||||
],
|
||||
"lowestPricedOffersInputs": [
|
||||
{
|
||||
"itemCondition": "New",
|
||||
"offerType": "Consumer"
|
||||
},
|
||||
{
|
||||
"itemCondition": "Used",
|
||||
"offerType": "Consumer"
|
||||
}
|
||||
],
|
||||
"uri": "/products/pricing/2022-05-01/items/competitiveSummary",
|
||||
"method": "GET"
|
||||
|
|
@ -765,7 +912,112 @@
|
|||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"referencePrices": [
|
||||
{
|
||||
"name": "CompetitivePriceThreshold",
|
||||
"price": {
|
||||
"amount": 18.11,
|
||||
"currencyCode": "USD"
|
||||
}
|
||||
}
|
||||
],
|
||||
"lowestPricedOffers": [
|
||||
{
|
||||
"lowestPricedOffersInput":{
|
||||
"itemCondition": "New",
|
||||
"offerType": "Consumer"
|
||||
},
|
||||
"offers": [
|
||||
{
|
||||
"listingPrice": {
|
||||
"currencyCode": "USD",
|
||||
"amount": 17.15
|
||||
},
|
||||
"shippingOptions": [
|
||||
{
|
||||
"shippingOptionType": "DEFAULT",
|
||||
"price": {
|
||||
"amount": 2.50,
|
||||
"currencyCode": "USD"
|
||||
}
|
||||
}
|
||||
],
|
||||
"points": {
|
||||
"pointsMonetaryValue": {
|
||||
"amount": 0.50,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
"pointsNumber": 50
|
||||
},
|
||||
"primeDetails": {
|
||||
"eligibility": "REGIONAL"
|
||||
},
|
||||
"subCondition": "New",
|
||||
"sellerId": "A2ZWOLFOFDPJL1",
|
||||
"fulfillmentType": "MFN"
|
||||
},
|
||||
{
|
||||
"listingPrice": {
|
||||
"amount": 18.11,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
"shippingOptions": [
|
||||
{
|
||||
"shippingOptionType": "DEFAULT",
|
||||
"price": {
|
||||
"amount": 2.50,
|
||||
"currencyCode": "USD"
|
||||
}
|
||||
}
|
||||
],
|
||||
"points": {
|
||||
"pointsNumber": 3,
|
||||
"pointsMonetaryValue": {
|
||||
"amount": 0.03,
|
||||
"currencyCode": "USD"
|
||||
}
|
||||
},
|
||||
"primeDetails": {
|
||||
"eligibility": "NATIONAL"
|
||||
},
|
||||
"sellerId": "A3DJR8M9Y3OUPG",
|
||||
"subCondition": "New",
|
||||
"fulfillmentType": "MFN"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"lowestPricedOffersInput": {
|
||||
"itemCondition": "Used",
|
||||
"offerType": "Consumer"
|
||||
},
|
||||
"offers": [
|
||||
{
|
||||
"listingPrice": {
|
||||
"currencyCode": "USD",
|
||||
"amount": 12.00
|
||||
},
|
||||
"shippingOptions": [
|
||||
{
|
||||
"shippingOptionType": "DEFAULT",
|
||||
"price": {
|
||||
"amount": 2.50,
|
||||
"currencyCode": "USD"
|
||||
}
|
||||
}
|
||||
],
|
||||
"primeDetails": {
|
||||
"eligibility": "REGIONAL"
|
||||
},
|
||||
"subCondition": "Acceptable",
|
||||
"sellerId": "A3DH5AGPM3JVAB",
|
||||
"fulfillmentType": "AFN"
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
|
||||
}
|
||||
},
|
||||
{
|
||||
|
|
@ -804,6 +1056,39 @@
|
|||
},
|
||||
"schema": {
|
||||
"$ref": "#/definitions/Errors"
|
||||
},
|
||||
"x-amzn-api-sandbox": {
|
||||
"static": [
|
||||
{
|
||||
"request": {
|
||||
"parameters": {
|
||||
"body": {
|
||||
"value": {
|
||||
"requests": [
|
||||
{
|
||||
"asin": "11_AABB_123",
|
||||
"marketplaceId": "ATVPDKIKX0DER",
|
||||
"includedData": [
|
||||
"featuredBuyingOptions"
|
||||
],
|
||||
"uri": "/products/pricing/2022-05-01/items/competitiveSummary",
|
||||
"method": "GET"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"response": {
|
||||
"errors": [
|
||||
{
|
||||
"code": "INVALID_ASIN",
|
||||
"message": "11_AABB_123 is not a valid ASIN"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"403": {
|
||||
|
|
@ -956,7 +1241,8 @@
|
|||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
],
|
||||
"description": "Schema for an individual featured offer expected price response."
|
||||
},
|
||||
"CompetitiveSummaryBatchRequest": {
|
||||
"description": "The `competitiveSummary` batch request data.",
|
||||
|
|
@ -1007,6 +1293,15 @@
|
|||
},
|
||||
"minItems": 1
|
||||
},
|
||||
"lowestPricedOffersInputs": {
|
||||
"type": "array",
|
||||
"description": "The list of `lowestPricedOffersInput` parameters used to build the `lowestPricedOffers` in the response. This attribute is valid only if `lowestPricedOffers` is requested in `includedData`.",
|
||||
"items": {
|
||||
"$ref": "#/definitions/LowestPricedOffersInput"
|
||||
},
|
||||
"minItems": 0,
|
||||
"maxItems": 5
|
||||
},
|
||||
"method": {
|
||||
"description": "HTTP method type",
|
||||
"$ref": "#/definitions/HttpMethod"
|
||||
|
|
@ -1021,9 +1316,33 @@
|
|||
"type": "string",
|
||||
"description": "The supported types of data in the `getCompetitiveSummary` API.",
|
||||
"enum": [
|
||||
"featuredBuyingOptions"
|
||||
"featuredBuyingOptions",
|
||||
"referencePrices",
|
||||
"lowestPricedOffers"
|
||||
]
|
||||
},
|
||||
"LowestPricedOffersInput": {
|
||||
"description": "The input required for building the `LowestPricedOffers` data in the response.",
|
||||
"type": "object",
|
||||
"required": [
|
||||
"itemCondition",
|
||||
"offerType"
|
||||
],
|
||||
"properties": {
|
||||
"itemCondition": {
|
||||
"type": "string",
|
||||
"description": "The condition of the item offer that was requested for the `LowestPricedOffers`. The default `itemCondition` is `New`.",
|
||||
"$ref": "#/definitions/Condition"
|
||||
},
|
||||
"offerType": {
|
||||
"type": "string",
|
||||
"description": "The type of offers requested for the `LowestPricedOffers`. The `offerType` options are `Consumer` or `Business`. The default `offerType` is `Consumer`.",
|
||||
"enum": [
|
||||
"CONSUMER"
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"CompetitiveSummaryBatchResponse": {
|
||||
"description": "The response schema of the `competitiveSummaryBatch` operation.",
|
||||
"type": "object",
|
||||
|
|
@ -1088,9 +1407,40 @@
|
|||
"$ref": "#/definitions/FeaturedBuyingOption"
|
||||
}
|
||||
},
|
||||
"lowestPricedOffers": {
|
||||
"description": "A list of the lowest priced offers for the given ASIN `marketplaceId` combination.",
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/definitions/LowestPricedOffer"
|
||||
}
|
||||
},
|
||||
"referencePrices": {
|
||||
"description": "A list of reference prices for the given ASIN `marketplaceId` combination.",
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/definitions/ReferencePrice"
|
||||
}
|
||||
},
|
||||
"errors": {
|
||||
"description": "A list of errors",
|
||||
"$ref": "#/definitions/Errors"
|
||||
"$ref": "#/definitions/ErrorList"
|
||||
}
|
||||
}
|
||||
},
|
||||
"ReferencePrice": {
|
||||
"description": "The reference price for the given ASIN `marketplaceId` combination. ",
|
||||
"type": "object",
|
||||
"required": [
|
||||
"name",
|
||||
"price"
|
||||
],
|
||||
"properties": {
|
||||
"name": {
|
||||
"description": "The name of the reference price like `CompetitivePriceThreshold`."
|
||||
},
|
||||
"price": {
|
||||
"description": "The reference price for the ASIN `marketplaceId` combination. ",
|
||||
"$ref": "#/definitions/MoneyType"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -1149,6 +1499,30 @@
|
|||
}
|
||||
]
|
||||
},
|
||||
"LowestPricedOffer": {
|
||||
"description": "The lowest priced offer for the requested item condition and offer type.",
|
||||
"type": "object",
|
||||
"required": [
|
||||
"lowestPricedOffersInput",
|
||||
"offers"
|
||||
],
|
||||
"properties": {
|
||||
"lowestPricedOffersInput": {
|
||||
"description": "The filtering criteria used to retrieve this lowest-priced offers correspond to the `lowestPricedOffersInputs` received in the request.",
|
||||
"type": "object",
|
||||
"$ref": "#/definitions/LowestPricedOffersInput"
|
||||
},
|
||||
"offers": {
|
||||
"description": "A list of up to 20 lowest priced offers that match the criteria specified in the `lowestPricedOffersInput` parameter.",
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/definitions/Offer"
|
||||
},
|
||||
"minItems": 1,
|
||||
"maxItems": 20
|
||||
}
|
||||
}
|
||||
},
|
||||
"Offer": {
|
||||
"description": "The offer data of a product.",
|
||||
"type": "object",
|
||||
|
|
@ -1167,6 +1541,79 @@
|
|||
"description": "Item Condition.",
|
||||
"$ref": "#/definitions/Condition"
|
||||
},
|
||||
"subCondition": {
|
||||
"type": "string",
|
||||
"description": "The item subcondition for the offer.",
|
||||
"enum": [
|
||||
"New",
|
||||
"Mint",
|
||||
"VeryGood",
|
||||
"Good",
|
||||
"Acceptable",
|
||||
"Poor",
|
||||
"Club",
|
||||
"OEM",
|
||||
"Warranty",
|
||||
"RefurbishedWarranty",
|
||||
"Refurbished",
|
||||
"OpenBox",
|
||||
"Other"
|
||||
],
|
||||
"x-docgen-enum-table-extension": [
|
||||
{
|
||||
"value": "New",
|
||||
"description": "New"
|
||||
},
|
||||
{
|
||||
"value": "Mint",
|
||||
"description": "Mint"
|
||||
},
|
||||
{
|
||||
"value": "VeryGood",
|
||||
"description": "VeryGood"
|
||||
},
|
||||
{
|
||||
"value": "Good",
|
||||
"description": "Good"
|
||||
},
|
||||
{
|
||||
"value": "Acceptable",
|
||||
"description": "Acceptable"
|
||||
},
|
||||
{
|
||||
"value": "Poor",
|
||||
"description": "Poor"
|
||||
},
|
||||
{
|
||||
"value": "Club",
|
||||
"description": "Club"
|
||||
},
|
||||
{
|
||||
"value": "OEM",
|
||||
"description": "OEM"
|
||||
},
|
||||
{
|
||||
"value": "Warranty",
|
||||
"description": "Warranty"
|
||||
},
|
||||
{
|
||||
"value": "RefurbishedWarranty",
|
||||
"description": "RefurbishedWarranty"
|
||||
},
|
||||
{
|
||||
"value": "Refurbished",
|
||||
"description": "Refurbished"
|
||||
},
|
||||
{
|
||||
"value": "OpenBox",
|
||||
"description": "OpenBox"
|
||||
},
|
||||
{
|
||||
"value": "Other",
|
||||
"description": "Other"
|
||||
}
|
||||
]
|
||||
},
|
||||
"fulfillmentType": {
|
||||
"$ref": "#/definitions/FulfillmentType",
|
||||
"description": "The fulfillment type for the offer. Possible values are AFN (Amazon Fulfillment Network) and MFN (Merchant Fulfillment Network)."
|
||||
|
|
@ -1185,6 +1632,42 @@
|
|||
"points": {
|
||||
"description": "The number of Amazon Points offered with the purchase of an item, and their monetary value. Note that the Points element is only returned in Japan (JP).",
|
||||
"$ref": "#/definitions/Points"
|
||||
},
|
||||
"primeDetails": {
|
||||
"description": "Amazon Prime details.",
|
||||
"$ref": "#/definitions/PrimeDetails"
|
||||
}
|
||||
}
|
||||
},
|
||||
"PrimeDetails": {
|
||||
"description": "Amazon Prime details.",
|
||||
"type": "object",
|
||||
"required": [
|
||||
"eligibility"
|
||||
],
|
||||
"properties": {
|
||||
"eligibility": {
|
||||
"description": "Indicates whether the offer is an Amazon Prime offer.",
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"NATIONAL",
|
||||
"REGIONAL",
|
||||
"NONE"
|
||||
],
|
||||
"x-docgen-enum-table-extension": [
|
||||
{
|
||||
"value": "NATIONAL",
|
||||
"description": "Indicates that this offer has Prime eligibility throughout the entire marketplace."
|
||||
},
|
||||
{
|
||||
"value": "REGIONAL",
|
||||
"description": "Indicates that this offer has Prime eligibility in some(but not all) regions in the marketplace."
|
||||
},
|
||||
{
|
||||
"value": "NONE",
|
||||
"description": "Indicates that this offer is not an Amazon Prime offer in any regions."
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -1356,7 +1839,8 @@
|
|||
"description": "The current active price of the offer.",
|
||||
"$ref": "#/definitions/Price"
|
||||
}
|
||||
}
|
||||
},
|
||||
"description": "Schema for `currentFeaturedOffer` or `competingFeaturedOffer`."
|
||||
},
|
||||
"HttpHeaders": {
|
||||
"description": "A mapping of additional HTTP headers to send/receive for an individual request within a batch.",
|
||||
|
|
@ -1505,7 +1989,8 @@
|
|||
"type": "number",
|
||||
"description": "The monetary value."
|
||||
}
|
||||
}
|
||||
},
|
||||
"description": "Currency type and monetary value. Schema for demonstrating pricing info."
|
||||
},
|
||||
"Price": {
|
||||
"type": "object",
|
||||
|
|
@ -1525,7 +2010,8 @@
|
|||
"description": "The number of Amazon Points offered with the purchase of an item, and their monetary value.",
|
||||
"$ref": "#/definitions/Points"
|
||||
}
|
||||
}
|
||||
},
|
||||
"description": "Schema for item's price information, including listing price, shipping price, and Amazon points."
|
||||
},
|
||||
"Points": {
|
||||
"type": "object",
|
||||
|
|
@ -1539,7 +2025,8 @@
|
|||
"description": "The monetary value of the points.",
|
||||
"$ref": "#/definitions/MoneyType"
|
||||
}
|
||||
}
|
||||
},
|
||||
"description": "The number of Amazon Points offered with the purchase of an item, and their monetary value."
|
||||
},
|
||||
"FulfillmentType": {
|
||||
"type": "string",
|
||||
|
|
|
|||
Loading…
Reference in New Issue