List product prices

GET /api/v2/products/{productId}/prices.json

Get or search for one or more product prices for a single product using a range of accepted query parameters.

Scopes

Requires either the products or products.readonly OAuth scope.

Path parameters

productId required
The product ID is required.

Query parameters

accessRoleId:in
Filter results by one or more Access Roles in a comma-separated list of IDs.

currency
Filter results by ISO-4217 currency code (e.g. GBP).

geozoneId:in
Filter results by one or more Geozones in a comma-separated list of IDs.

id:in
Return prices for a product by a comma-separated list of IDs.

id:min
Return product prices with an ID greater than or equal to that specified.

id:max
Return product prices with an ID less than or equal to that specified.

id:after
Return product prices with an ID greater than that specified.

id:before
Return product prices with an ID less than that specified.

quantity
Filter results by quantity threshold.

startOn:min
Return product prices with an effective start date greater than or equal to the date supplied in Y-m-d format.

startOn:max
Return product prices with an effective start date less than or equal to the date supplied in Y-m-d format.

startOn:after
Return product prices with an effective start date greater than the date supplied in Y-m-d format.

startOn:before
Return product prices with an effective start date less than the date supplied in Y-m-d format.

status

Return product prices by status:

current
future
past

type

Return product prices by type:

buy
hire
subscription

JSON response

Evance will return a JSON object containing the following properties:

success
A successful search request containing zero or more results will always return a true value.

status
An integer matching the HTTP response code. A successful request will have a status of 200.

data
An array containing zero or more Product Price data objects.

pagination
Search results include a pagination object contain information about the current page, total pages, the limit per page and the total number of results available.

limit - the number of results to return per page
page - the current page number
total - the total number of available results
totalPages - the total number of available pages of results

links
An object containing links to traverse available search results.

self - the URL for the current search.
previous - a URL for the previous results page, or null if there isn't one.
next - a URL for the next results page, or null if there isn't one

Example response


{
    "success": true,
    "status": 200,
    "data": [
        {
            "id": 48646,
            "productId": 3066,
            "status": "current",
            "type": "buy",
            "quantity": 1,
            "price": 9.99,
            "unit": "each",
            "minimumUnits": 1,
            "rrp": null,
            "standardPrice": 9.99,
            "isTaxIncluded": true,
            "isLowestInClass": true,
            "inClassCount": 1,
            "currency": "GBP",
            "startOn": "2022-04-19",
            "accessRoleId": null,
            "geozoneId": null
        }
    ],
    "pagination": {
        "page": 1,
        "limit": 100,
        "total": 1,
        "totalPages": 1
    },
    "links": {
        "self": "https://examples.evance.me/api/v2/products/3066/prices.json",
        "previous": null,
        "next": null
    }
}

List product prices

Scopes

Path parameters

Query parameters

JSON response

Example response

Website builder

Themes

Partners

Resources

Evance