List Specifications
GET
/api/v2/specifications.json
Get or search for one or more specification headings using a range of accepted query parameters.
Scopes
Requires either the products
or products.readonly
OAuth scope.
Query Parameters
Accepts the following query parameters:
id:in
Return specifications by a comma-separated list of IDs. |
id:min
Return specifications with an ID greater than or equal to that specified. |
id:max
Return specifications with an ID less than or equal to that specified. |
id:after
Return specifications with an ID greater than that specified. |
id:before
Return specifications with an ID less than that specified. |
reference:in
Return specifications matching references in a comma separated list (case-insensitive). |
title:in
Return specifications matching titles in a comma separated list (case-insensitive). |
type
Return specifications by type:
|
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 Specification 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.
|
links
An object containing links to traverse available search results.
|
Example response
{
"success": true,
"status": 200,
"data": [
{
"id": 53245,
"reference": "color",
"title": "Colour",
"description": null,
"uri": null,
"type": "swatch",
"sequence": 1
},
{
"id": 75648,
"reference": "size",
"title": "Size",
"description": null,
"uri": null,
"type": "string",
"sequence": 2
}
],
"pagination": {
"page": 1,
"limit": 100,
"total": 2,
"totalPages": 1
},
"links": {
"self": "https://examples.evance.me/api/v2/specifications.json",
"previous": null,
"next": null
}
}