List Product Variants

GET 
/commerce/products/:productId/variants

List product variants for a specified user and credential set

Request

Path Parameters

productId stringrequired

The ID of the product you want to get the product variants for.

Query Parameters

credentialId stringrequired

The ID of the credential.

pageNumber string

The page number of the results. Default is 1.

pageSize int32

The maximum number of results to show on a page. Default is 50. Maximum is 100.

title string

A string used to retrieve product variants with a specific title.

titleContains string

A string used to retrieve product variants with a title containing a specific value.

titleNotEquals string

A string that should not match the title of product variants to be retrieved.

price float

The exact price used to retrieve product variants with a matching price.

priceMin float

The minimum allowed value for filtering product variants based on their price.

priceMax float

The maximum allowed value for filtering product variants based on their price.

priceNotEquals float

A value that should not match the price of product variants to be retrieved.

sku string

A string used to retrieve product variants with a specific SKU (Stock Keeping Unit) value.

skuContains string

A string used to retrieve product variants with an SKU containing a specific value.

skuNotEquals string

A string that should not match the SKU of product variants to be retrieved.

remoteCreatedAtMin date

Filter objects created in the third-party application after a specified date.

remoteCreatedAtMax date

Filter objects created in the third-party application before a specified date.

remoteUpdatedAtMin date

Filter objects last updated in the third-party application after a specified date.

remoteUpdatedAtMax date

Filter objects last updated in the third-party application before a specified date.

createdAtMin date

Filter objects created after a specified date.

createdAtMax date

Filter objects created before a specified date.

updatedAtMin date

Filter objects last updated after a specified date.

updatedAtMax date

Filter objects last updated before a specified date.

Header Parameters

Authorization stringrequired

Default value: bearer YOUR_API_KEY

Responses

200

200

application/json

Schema

Schema

any

Result

{
  "variants": [
      {
        "remoteId": "200100200100",
        "productId": "00112233-4455-6677-8899-aabbccddeeff",
        "remoteCreatedAt": "2023-11-19T17:00:17.000Z",
        "remoteUpdatedAt": "2023-11-19T17:00:17.000Z",
        "remoteDeleted": false,
        "createdAt": "2024-02-22T11:17:53.264Z",
        "updatedAt": "2024-02-22T13:54:03.445Z"
        "title": "Medium",
        "price": "25.00",
        "sku": "SHIRT-M",
        "optionValues": [
          {
            "name": "Size", 
            "value": "Medium"
          }
        ],
        "inventory": {"totalCount": 50},
        "weight": [
          {
            "value": 9.525451098148434,
            "unit": "kg"
          },
          {
            "value": 9525.451098148435,
            "unit": "g"
          },
          {
            "value": 336.00076203608785,
            "unit": "oz"
          },
          {
            "value": 20.999999999999996,
            "unit": "lb"
          }
        ],
        "id": "11001100-1122-3344-5566-77889900aabb"
      }
    ]
  }
}

400

400

application/json

Schema

Schema

object

Example (from schema)

{}

Result

{}

Loading...