Aurora API: Product Price
Product Price
Get
Deferred: Conditional (limit up to 500 entries for non deferred requests). For more details see the Aurora API Guide.
This method returns product prices. Using tracking functionality it is possible to retrieve only recently changed prices.
Example Request:
<?xml version="1.0" encoding="utf-8"?>
<AuroraRequestEnvelope>
<Header>
<AuthToken></AuthToken>
</Header>
<Requests>
<Request>
<Product>
<Price>
<Get>
<Limit>100</Limit>
</Get>
</Price>
</Product>
</Request>
</Requests>
</AuroraRequestEnvelope>
Request Fields
| Field | Values | API Version | Description | Required |
|---|---|---|---|---|
| Interval | String interval | 1.4+ | Filters out products which were created or modified within the date/time interval specified. Interval is calculated from the current timestamp. Options: P indicates the period (required) nY indicates the number of years nM indicates the number of months nD indicates the number of days T indicates the start of a time section (required if you are going to specify hours, minutes, or seconds) nH indicates the number of hours nM indicates the number of minutes nS indicates the number of seconds Samples: P1M - filters out products which were created/modified in the last month P10D - filters out products which were created/modified in the last 10 days * P0DT5H - filters out products which were created/modified in the last 5 hours | No. Only one of 'Interval' or 'DateStart'/'DateEnd' is permitted |
| DateStart | yyyy-mm-dd | 1.4+ | Filters out products which were created or modified on or after the date provided | No. Only one of 'Interval' or 'DateStart'/'DateEnd' is permitted |
| DateEnd | yyyy-mm-dd | 1.4+ | Filters out products which were created or modified on or before the date provided | No. Only one of 'Interval' or 'DateStart'/'DateEnd' is permitted |
| ProductReferences | Container | 1.4+ | No. Only one of 'ProductReferences', 'ProductEANs' 'ProductIDs', 'VariationReferences' is permitted | |
| ProductReferences:search | all | products | variations | 1.4+ | Defaulting to "all", this attribute of the "ProductReferences" tag controls whether both the Main Product References and the Variation References should be searched, or just one or the other. | No |
| ProductReferences.ProductReference | String | 1.4+ | Any number of product references can be provided using a separate 'ProductReference' tag for each | Only if 'ProductReferences' is provided |
| ProductEANs | Container | 1.4+ | No. Only one of 'ProductReferences', 'ProductEANs' 'ProductIDs', 'VariationReferences' is permitted | |
| ProductEANs.ProductEAN | String | 1.4+ | Any number of product EANs can be provided using a separate 'ProductEAN' tag for each | Only if 'ProductEANs' is provided |
| VariationReferences | Container | 1.4+ | No. Only one of 'ProductReferences', 'ProductEANs' 'ProductIDs', 'VariationReferences' is permitted | |
| VariationReferences.VariationReference | String | 1.4+ | Any number of variation references can be provided using a separate 'VariationReference' tag for each | Only if 'VariationReferences' is provided |
| ProductIDs | Container | 1.4+ | No. Only one of 'ProductReferences', 'ProductEANs' 'ProductIDs', 'VariationReferences' is permitted | |
| ProductIDs.ProductID | Integer > 0 | 1.4+ | Any number of product IDs can be provided using a separate 'ProductID' tag for each | Only if 'ProductIDs' is provided |
| CategoryIDs | Container | 1.4+ | No | |
| CategoryIDs.CategoryID | Integer > 0 | 1.4+ | Any number of category IDs can be provided using a separate 'CategoryID' tag for each | Only if 'CategoryIDs' is provided |
| AdditionalField | Container | 1.4+ | No | |
| AdditionalField.FieldID | Integer > 0 | 1.4+ | The Aurora ID of the Product Additional Field | Only if 'AdditionalField' is provide and only one of 'FieldID' or 'FieldValue' is required |
| AdditionalField.FieldName | String | 1.4+ | The name of the Product Additional Field | Only if 'AdditionalField' is provide and only one of 'FieldID' or 'FieldValue' is required |
| AdditionalField.FieldValues | Container | 1.4+ | Only if 'AdditionalField' is provided | |
| AdditionalField.FieldValues.FieldValue | String | 1.4+ | Any number of field values can be provided using a separate 'FieldValue' tag for each | Only if 'AdditionalField.FieldValues' is provided |
| DisplayProduct | 0 | 1 | 1.4+ | Stipulate that you wish only to see Live products (1) or not (0). By default, both live and non-live products are returned. | No |
| Currencies | Container | 1.4+ | No | |
| Currencies.Currency | String | 1.4+ | Any number of currency ISO codes can be provided using a separate 'Currency' tag for each. If none provided, system will return prices in a system default currency. If '*' provided, system will return prices in all available currencies | Only if 'Currencies' is provided |
| PriceGroup | String | 1.5+ | The name of the Price Group to retrieve prices for. If not provided, prices for the default price group will be returned | No |
| Tracking | changed | unsent | 1.4+ | For more details see RequestTracking | No |
| Limit | Integer > 0 | 1.4+ | The number of products to return before beginning to page | No |
| Paging | Container | 1.4+ | For more details see Paging | No |
| Paging.Token | String | 1.4+ | This is the Token string issued from any previous ProductPriceGet call featuring paging. Providing this will have the API collect the data from the previously generated set of data, ensuring accurate and consistent dataset results for every page. You cannot change the request properties previously provided when using a Token, so these are ignored by the API. | No |
| Paging.Limit | Integer > 0 | 1.4+ | The number of results to return in the page being requested | No |
| Paging.Page | Integer > 0 | 1.4+ | The page number to return the results for | No |
| OrderBy | String | n/a | This is provided for future use, but currently is not effective | No |
Response fields
| Field | Values | API Version | Description |
|---|---|---|---|
| ProductID | Integer > 0 | 1.4+ | The Internal ID Aurora uses to identify a Product. |
| ProductReference | String | 1.4+ | Product reference |
| ProductPrices | Container | 1.4+ | Contains all the details of the product's base prices. |
| ProductPrices.Currency | Container | 1.4+ | Contains all the details for a particular currency. |
| ProductPrices.Currency.ISO | 3 Character String | 1.4+ | Currency ISO code |
| ProductPrices.Currency.Price | Float | 1.4+ | Product price |
| ProductPrices.Currency.PriceRRP | Float | 1.4+ | Recommended retail price |
| ProductPrices.Currency.PriceWas | Float | 1.4+ | Previous price |
| ProductPrices.Currency.PriceBundle | Float | 1.4+ | Price for a bundle |
| Variations | Container | 1.4+ | Contains all product variations |
| Variations.Variation | Container | 1.4+ | Contains a single product variation |
| Variations.Variation.VariationID | Integer | 1.4+ | The Internal ID Aurora uses to identify a Product Variation |
| Variations.Variation.VariationReference | String | 1.4+ | Variation reference |
| Variations.Variation.VariationPrices | Container | 1.4+ | Contains all the details of the product's variant's base prices. |
| Variations.Variation.VariationPrices.Currency | Container | 1.4+ | Contains all the details for a particular currency. |
| Variations.Variation.VariationPrices.Currency.ISO | 3 Character String | 1.4+ | Currency ISO code |
| Variations.Variation.VariationPrices.Currency.Price | Float | 1.4+ | Variation price |
| Variations.Variation.VariationPrices.Currency.PriceRRP | Float | 1.4+ | Recommended retail price |
| Variations.Variation.VariationPrices.Currency.PriceWas | Float | 1.4+ | Previous price |
Product Price Tracking
RequestTracking is supported.
To retrieve 100 product prices which were changed within last 30 days:
<?xml version="1.0" encoding="utf-8"?>
<AuroraRequestEnvelope>
<Header>
<AuthToken></AuthToken>
</Header>
<Requests>
<Request>
<Product>
<Price>
<Get>
<Tracking>changed</Tracking>
<Limit>100</Limit>
</Get>
</Price>
</Product>
</Request>
</Requests>
</AuroraRequestEnvelope>
To retrieve 100 product prices which were changed within last 30 days using automatic tracking:
<?xml version="1.0" encoding="utf-8"?>
<AuroraRequestEnvelope>
<Header>
<AuthToken></AuthToken>
</Header>
<Requests>
<Request>
<Product>
<Price>
<Get tracking="automatic">
<Tracking>changed</Tracking>
<Limit>100</Limit>
</Get>
</Price>
</Product>
</Request>
</Requests>
</AuroraRequestEnvelope>
Please note that the prices returned by the Product Price Get API do not have Price Promotion discount applied.
Updated over 2 years ago