Products

List Product Variations

Get a list of product variations. Please note that all expands will be applied automatically.

GET

/v1/products/variations

curl --request GET \
  --url 'https://public-api.bladepro.io/v1/products/variations?expand=%3Cstring%3E&id%5BEQUALS%5D=123&id%5BIN%5D=123&product.channel.id%5BIN%5D=%3Cstring%3E&product.channel.id%5BNOT_IN%5D=%3Cstring%3E&status%5BIN%5D=%3Cany%3E&status%5BNOT_IN%5D=%3Cany%3E&sku%5BEQUALS%5D=%3Cstring%3E&sku%5BIN%5D=%3Cstring%3E&type.id%5BIN%5D=%3Cstring%3E&is_primary%5BEQUALS%5D=true&sorting=sku'

{
  "data": [
    {
      "components": [
        {
          "barcode": 1234567891020,
          "id": 1,
          "name": "Example Product",
          "quantity": 1,
          "sku": "DEMO-SKU-01"
        }
      ],
      "created": {},
      "descriptions": [
        {
          "created": "2019-11-25T14:52:56.000Z",
          "full_description": "Example product description",
          "id": 1,
          "locale": {
            "code": "en",
            "created": "2019-11-25T14:52:56.000Z",
            "id": 1,
            "modified": "2019-11-25T14:52:56.000Z",
            "name": "English"
          },
          "locale_id": 1,
          "modified": "2019-11-25T14:52:56.000Z",
          "name": "Example Product",
          "product_variation_id": 1
        }
      ],
      "id": 1,
      "is_primary": false,
      "name": "Example product",
      "primary_product_category": {
        "id": 4,
        "name": "Bicycles"
      },
      "product": {
        "channel": {
          "default_warehouse_id": 1,
          "global": false,
          "id": 1,
          "name": "Demo Channel",
          "organisation": {
            "id": 1,
            "name": "Demo Organisation"
          }
        },
        "id": 1
      },
      "sku": "DEMO-SKU-01",
      "status": "active",
      "tags": [
        {
          "description": "Processed by a 3rd party system",
          "name": "Processed",
          "shortcode": "processed"
        }
      ],
      "type": {
        "id": 1,
        "name": "Standard Product",
        "type": "product"
      }
    }
  ],
  "meta": {
    "paging": {
      "page": 1,
      "per_page": 250,
      "records": 1,
      "total_pages": 1,
      "total_records": 1
    },
    "request_reference": "233f2gjwz-c893v86"
  }
}

Fuzzy search available

Scope(s): APP::PRODUCTS::READ

Query Parameters

expandstringquery

Usage: expand=*

Expand components, created, descriptions, descriptions.locale, primary_product_category, product, product.brand, product.channel, product.channel.organisation, tags, type

id[EQUALS]numberquery

Filter for the product variation id. (EQUALS)

id[IN]numberquery

Filter for the product variation id. (IN)

product.channel.id[IN]stringquery

Filter for the product channel. (IN)

product.channel.id[NOT_IN]stringquery

Filter for the product channel. (NOT_IN)

status[IN]anyquery

Filter for the status of the product. (IN)

status[NOT_IN]anyquery

Filter for the status of the product. (NOT_IN)

sku[EQUALS]stringquery

Filter for the product sku. (EQUALS)

sku[IN]stringquery

Filter for the product sku. (IN)

type.id[IN]stringquery

Filter for the product type. (IN)

is_primary[EQUALS]booleanquery

Filter for is this a primary product. (EQUALS)

sortingenum<string>query

Sort by sku, status, created, product.channel.name (prefix with '-' for descending order).

Available options: sku, -sku, status, -status, created, -created, product.channel.name, -product.channel.name

Response

successful operation

componentsany

List of components.

createdobject

The created date.

descriptionsany

List of descriptions.

idnumber

The product variation id.

is_primaryboolean

Is this a primary product.

namestring

The product name.

primary_product_categoryobject

The primary product category.

productobject

Parent product.

Show child attributes

skustring

The product SKU.

statusenum<string>

The status of the product.

Available options: active, draft, discontinued

tagsany

List of applied tags.

typeobject

The product type.

Still need help? Share an idea