COconstructor
Variations

Retrieve variations

🔐 This endpoint requires HTTP authentication (either Basic or Bearer). For authenticating with Bearer token, required scopes are: catalog(r).

Retrieve all item variations, optionally filtered by id(s).

get/v2/variations

Request

  • Base URL
    https://ac.cnstrc.com
  • URL
    https://ac.cnstrc.com/v2/variations
  • Auth
    • HTTP basic
    • or HTTP bearer

Query parameters

keystring required

The key of the index to use.

Example:key_K2pX7vBnU0bgA5xp
sectionstring

The section of the index to use. Defaults to Products.

Example:Products
idstring[]

The ID(s) of the variations to return.

[
  "red-nike-shoes"
]
item_idstring[]

The item ID(s) of variations to return.

[
  "nike-shoes"
]
next_page_cursorstring

Pagination cursor from which to start returning results. Cannot be used together with page or offset.

num_results_per_pageinteger

The number of results per page to return.

Example:100
pageinteger

The page of results to return.

Example:1
offsetinteger

The number of results to skip from the beginning. Cannot be used together with page.

cstring

The ID of the client and version that the request is coming from, such as cio-js-2.90.

Example:cio-js-2.90

Response

OK

total_countinteger

Total number of variations. Omitted when using cursor-based pagination (next_page_cursor).

next_page_cursorstring

Pagination cursor to use to receive the next page of results. The value is returned by the previous page response. Cannot be used together with page or offset.

Example response

{
  "total_count": 100,
  "variations": [
    {
      "data": {
        "keywords": [
          "running"
        ],
        "url": "http://www.example.com/product/123",
        "image_url": "http://www.example.com/images/product.jpg",
        "group_ids": [
          "shoes"
        ],
        "description": "A comfortable running shoe with cushioned sole",
        "active": true,
        "is_default": true
      }
    }
  ],
  "next_page_cursor": "red-nike-shoes"
}

Changes

No recorded changes to this operation across all 1 revision of this API.