List products

GET /api/v2/products.json

Get or search for one or more products using a range of accepted query parameters.

Scopes

Requires either the products or products.readonly OAuth scope.

Parameters

Accepts the following query parameters:

bandId
Return products associated with a Band ID.
Supplying an empty string will return products without an associated band.

bandId:in
Return products associated with any Band ID supplied within a comma-separated list.

barcode:in
Return products matching any barcode supplied within a comma-separated list.

createdOn:min
Return products with a createdOn datetime greater than or equal to the datetime supplied in ISO-8601 format (e.g. 2024-04-28T17:30:42+01:00)

createdOn:max
Return products with a createdOn datetime less than or equal to the datetime supplied in ISO-8601 format (e.g. 2024-04-28T17:30:42+01:00)

createdOn:after
Return products with a createdOn datetime greater than the datetime supplied in ISO-8601 format (e.g. 2024-04-28T17:30:42+01:00)

createdOn:before
Return products with a createdOn datetime less than the datetime supplied in ISO-8601 format (e.g. 2024-04-28T17:30:42+01:00)

id:in
Return products specified within a comma-separated list of Product IDs.

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

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

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

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

manufacturerId
Return products associated with a Manufacturer ID.
Supplying an empty value will return products without an associated Manufacturer.

manufacturerId:in
Return products associated with any matching Manufacturer ID within a comma-separated list.

modifiedOn:min
Return products with a modifiedOn datetime greater than or equal to the datetime supplied in ISO-8601 format (e.g. 2024-04-28T17:30:42+01:00)

modifiedOn:max
Return products with a modifiedOn datetime less than or equal to the datetime supplied in ISO-8601 format (e.g. 2024-04-28T17:30:42+01:00)

modifiedOn:after
Return products with a modifiedOn datetime greater than the datetime supplied in ISO-8601 format (e.g. 2024-04-28T17:30:42+01:00)

modifiedOn:before
Return products with a modifiedOn datetime less than the datetime supplied in ISO-8601 format (e.g. 2024-04-28T17:30:42+01:00)

partNumber:in
Return products with a matching partNumber within a comma-separated list.

quickfind:in
Return products specified within a comma-separated list of Quickfind codes.

quickfind:min
Return products with a Quickfind code greater than or equal to that specified.

quickfind:max
Return products with a Quickfind code less than or equal to that specified.

quickfind:after
Return products with a Quickfind code greater than that specified.

quickfind:before
Return products with a Quickfind code less than that specified.

sku:in
Return products matching any SKU supplied within a comma-separated list (case-insenstive). We recommend SKUs only contain letters, numbers, dashes and underscores. However, if your SKU contains a comma you should encapsulate the string within double quotes. For example,
sku:in=ABC-123,"CDE,F-456"

status
Return products matching the supplied status:

admin - products only visible to site administrators.
public - products that are available for display to the public.

A product has a public status when it meets the following criteria:

The product is marked as active (isActive=true)
The product is published with a publishStartDate of null or with a date less than or equal to the current date.
The product is published with a publishEndDate of null or with a date in the future.

type
Return products matching the supplied type:

physical
virtual

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 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 products 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 nullif 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": 3066,
            "type": "physical",
            "priceType": "buy",
            "variantOf": null,
            "quickfind": 1,
            "sku": "EX-D1",
            "barcode": "",
            "commodityCode": "",
            "status": "public",
            "isActive": true,
            "title": "Unicorn Tears Gin Liqueur",
            "alias": "/product/unicorn-tears-gin-liqueur",
            "fullDescription": "...",
            "description": "The sweet tears of unicorns, bottled - juicy passion-fruit and tropical mango flavoured",
            "metaTitle": "",
            "metaDescription": "",
            "metaKeywords": "",
            "workflowId": null,
            "manufacturerId": null,
            "range": "",
            "model": "",
            "isMadeToOrder": false,
            "partNumber": "",
            "packagedWeight": 0.75,
            "packagedWidth": 0,
            "packagedHeight": 0,
            "packagedDepth": 0,
            "isDiscontinued": false,
            "discontinuedOn": null,
            "discontinuedBy": null,
            "discontinuedReason": null,
            "createdOn": "2019-11-09T01:02:00+00:00",
            "createdBy": 213,
            "modifiedOn": "2022-01-06T21:19:28+00:00",
            "modifiedBy": 213,
            "publishStartOn": null,
            "publishEndOn": null,
            "isStockLimited": false,
            "lowStockLevel": 0,
            "currentStock": null,
            "taxClassId": 1,
            "leadTimeMin": 0,
            "leadTimeMax": 0,
            "orderQuantityMin": 1,
            "orderQuantityMax": 0,
            "shippingClassId": null,
            "bandId": null,
            "supersededBy": null,
            "isPurchasable": true,
            "isSearchable": true,
            "isFeatured": false,
            "condition": "new",
            "template": null,
            "isIndexable": true,
            "averageRating": null,
            "countRating": 0
        }
    ],
    "pagination": {
        "page": 1,
        "limit": 100,
        "total": 1,
        "totalPages": 1
    },
    "links": {
        "self": "https://examples.evance.me/api/v2/products.json",
        "previous": null,
        "next": null
    }
}

List products

Scopes

Parameters

JSON response

Example response

Website builder

Themes

Partners

Resources

Evance