Shipsidekick LogoShipsidekick Docs
API/Products

List variants for a product

Retrieve all variants for a specific product. Results are filtered to variants the authenticated user has access to.

GET
/products/{productId}/variants

Path Parameters

productIdRequiredstring

Unique identifier of the product

Format: "uuid"

Query Parameters

searchstring

Search term to filter variants

sortBystring

Field to sort by

sortOrderstring

Order to sort by

Default: "desc"Value in: "asc" | "desc"
includeArchivedboolean

Whether to include archived variants

Default: false
curl -X GET "https://www.shipsidekick.com/api/v1/products/12345678-90ab-cdef-1234-567890abcdef/variants?search=string&sortBy=string&sortOrder=asc"

Successful operation

{
  "object": "list",
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
      "productId": "dcd53ddb-8104-4e48-8cc0-5df1088c6113",
      "title": "string",
      "sku": "string",
      "skuAliases": [
        "string"
      ],
      "barcode": "string",
      "asin": "string",
      "ean": "string",
      "isbn": "string",
      "upc": "string",
      "price": 0.1,
      "compareAtPrice": 0.1,
      "wholesalePrice": 0.1,
      "costPrice": 0,
      "currency": "usd",
      "position": 0,
      "taxable": true,
      "discountable": true,
      "requiresShipping": true,
      "inventoryPolicy": "deny",
      "inventoryAllocationStrategy": "string",
      "selectedOptions": [
        {
          "name": "string",
          "value": "string"
        }
      ],
      "image": "http://example.com",
      "weight": 0.1,
      "weightUnit": "oz",
      "dimensions": {
        "length": 0.1,
        "width": 0.1,
        "height": 0.1
      },
      "dimensionsUnit": "in",
      "tracksInventory": false,
      "tariffCode": "string",
      "countryOfOrigin": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "archivedAt": "2019-08-24T14:15:22Z",
      "featuredMediaId": "ae12f69f-58ad-4875-a887-b7bcc16d920b",
      "product": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
        "isBundle": false,
        "name": "string",
        "slug": "string",
        "description": "string",
        "options": [
          {
            "name": "string",
            "values": [
              "string"
            ]
          }
        ],
        "brand": "string",
        "vendor": "string",
        "manufacturer": "string",
        "eccn": "string",
        "imageUrl": "http://example.com",
        "imageFile": "string",
        "variants": [
          {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
            "productId": "dcd53ddb-8104-4e48-8cc0-5df1088c6113",
            "title": "string",
            "sku": "string",
            "skuAliases": [
              "string"
            ],
            "barcode": "string",
            "asin": "string",
            "ean": "string",
            "isbn": "string",
            "upc": "string",
            "price": 0.1,
            "compareAtPrice": 0.1,
            "wholesalePrice": 0.1,
            "costPrice": 0,
            "currency": "usd",
            "position": 0,
            "taxable": true,
            "discountable": true,
            "requiresShipping": true,
            "inventoryPolicy": "deny",
            "inventoryAllocationStrategy": "string",
            "selectedOptions": [
              {
                "name": "string",
                "value": "string"
              }
            ],
            "image": "http://example.com",
            "weight": 0.1,
            "weightUnit": "oz",
            "dimensions": {
              "length": 0.1,
              "width": 0.1,
              "height": 0.1
            },
            "dimensionsUnit": "in",
            "tracksInventory": false,
            "tariffCode": "string",
            "countryOfOrigin": "string",
            "createdAt": "2019-08-24T14:15:22Z",
            "updatedAt": "2019-08-24T14:15:22Z",
            "archivedAt": "2019-08-24T14:15:22Z",
            "featuredMediaId": "ae12f69f-58ad-4875-a887-b7bcc16d920b",
            "product": {
              "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
              "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
              "isBundle": false,
              "name": "string",
              "slug": "string",
              "description": "string",
              "options": [
                {
                  "name": "string",
                  "values": [
                    "string"
                  ]
                }
              ],
              "brand": "string",
              "vendor": "string",
              "manufacturer": "string",
              "eccn": "string",
              "imageUrl": "http://example.com",
              "imageFile": "string",
              "variants": [],
              "createdAt": "2019-08-24T14:15:22Z",
              "updatedAt": "2019-08-24T14:15:22Z",
              "archivedAt": "2019-08-24T14:15:22Z",
              "featuredMediaId": "ae12f69f-58ad-4875-a887-b7bcc16d920b",
              "productVariants": [
                {
                  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
                  "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
                  "productId": "dcd53ddb-8104-4e48-8cc0-5df1088c6113",
                  "title": "string",
                  "sku": "string",
                  "skuAliases": [
                    "string"
                  ],
                  "barcode": "string",
                  "asin": "string",
                  "ean": "string",
                  "isbn": "string",
                  "upc": "string",
                  "price": 0.1,
                  "compareAtPrice": 0.1,
                  "wholesalePrice": 0.1,
                  "costPrice": 0,
                  "currency": "usd",
                  "position": 0,
                  "taxable": true,
                  "discountable": true,
                  "requiresShipping": true,
                  "inventoryPolicy": "deny",
                  "inventoryAllocationStrategy": "string",
                  "selectedOptions": [
                    {
                      "name": "string",
                      "value": "string"
                    }
                  ],
                  "image": "http://example.com",
                  "weight": 0.1,
                  "weightUnit": "oz",
                  "dimensions": {
                    "length": 0.1,
                    "width": 0.1,
                    "height": 0.1
                  },
                  "dimensionsUnit": "in",
                  "tracksInventory": false,
                  "tariffCode": "string",
                  "countryOfOrigin": "string",
                  "createdAt": "2019-08-24T14:15:22Z",
                  "updatedAt": "2019-08-24T14:15:22Z",
                  "archivedAt": "2019-08-24T14:15:22Z",
                  "featuredMediaId": "ae12f69f-58ad-4875-a887-b7bcc16d920b",
                  "product": {
                    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
                    "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
                    "isBundle": false,
                    "name": "string",
                    "slug": "string",
                    "description": "string",
                    "options": [
                      {
                        "name": "string",
                        "values": [
                          "string"
                        ]
                      }
                    ],
                    "brand": "string",
                    "vendor": "string",
                    "manufacturer": "string",
                    "eccn": "string",
                    "imageUrl": "http://example.com",
                    "imageFile": "string",
                    "variants": [],
                    "createdAt": "2019-08-24T14:15:22Z",
                    "updatedAt": "2019-08-24T14:15:22Z",
                    "archivedAt": "2019-08-24T14:15:22Z",
                    "featuredMediaId": "ae12f69f-58ad-4875-a887-b7bcc16d920b",
                    "productVariants": [],
                    "serviceObjects": [
                      {
                        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
                        "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
                        "serviceId": "8f8bb40f-b96b-40fe-9064-5031fbe483f9",
                        "type": "string",
                        "key": "string",
                        "value": null,
                        "createdAt": "2019-08-24T14:15:22Z",
                        "updatedAt": "2019-08-24T14:15:22Z",
                        "service": {
                          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
                          "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
                          "type": "string",
                          "description": "string",
                          "createdAt": "2019-08-24T14:15:22Z",
                          "updatedAt": "2019-08-24T14:15:22Z",
                          "archivedAt": "2019-08-24T14:15:22Z",
                          "settings": {}
                        }
                      }
                    ],
                    "media": [
                      null
                    ],
                    "featuredMedia": {}
                  },
                  "inventoryLevels": [
                    null
                  ],
                  "inventoryLocations": [
                    null
                  ],
                  "supplierProducts": [
                    null
                  ],
                  "packagings": [
                    null
                  ],
                  "serviceObjects": [
                    null
                  ],
                  "bom": {},
                  "bomLineItems": [
                    null
                  ],
                  "media": [
                    null
                  ],
                  "featuredMedia": {},
                  "unitsOfMeasure": [
                    null
                  ]
                }
              ],
              "serviceObjects": [
                {
                  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
                  "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
                  "serviceId": "8f8bb40f-b96b-40fe-9064-5031fbe483f9",
                  "type": "string",
                  "key": "string",
                  "value": null,
                  "createdAt": "2019-08-24T14:15:22Z",
                  "updatedAt": "2019-08-24T14:15:22Z",
                  "service": {
                    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
                    "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
                    "type": "string",
                    "description": "string",
                    "createdAt": "2019-08-24T14:15:22Z",
                    "updatedAt": "2019-08-24T14:15:22Z",
                    "archivedAt": "2019-08-24T14:15:22Z",
                    "settings": {}
                  }
                }
              ],
              "media": [
                null
              ],
              "featuredMedia": {}
            },
            "inventoryLevels": [
              null
            ],
            "inventoryLocations": [
              null
            ],
            "supplierProducts": [
              null
            ],
            "packagings": [
              null
            ],
            "serviceObjects": [
              null
            ],
            "bom": {},
            "bomLineItems": [
              null
            ],
            "media": [
              null
            ],
            "featuredMedia": {},
            "unitsOfMeasure": [
              null
            ]
          }
        ],
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z",
        "archivedAt": "2019-08-24T14:15:22Z",
        "featuredMediaId": "ae12f69f-58ad-4875-a887-b7bcc16d920b",
        "productVariants": [
          {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
            "productId": "dcd53ddb-8104-4e48-8cc0-5df1088c6113",
            "title": "string",
            "sku": "string",
            "skuAliases": [
              "string"
            ],
            "barcode": "string",
            "asin": "string",
            "ean": "string",
            "isbn": "string",
            "upc": "string",
            "price": 0.1,
            "compareAtPrice": 0.1,
            "wholesalePrice": 0.1,
            "costPrice": 0,
            "currency": "usd",
            "position": 0,
            "taxable": true,
            "discountable": true,
            "requiresShipping": true,
            "inventoryPolicy": "deny",
            "inventoryAllocationStrategy": "string",
            "selectedOptions": [
              {
                "name": "string",
                "value": "string"
              }
            ],
            "image": "http://example.com",
            "weight": 0.1,
            "weightUnit": "oz",
            "dimensions": {
              "length": 0.1,
              "width": 0.1,
              "height": 0.1
            },
            "dimensionsUnit": "in",
            "tracksInventory": false,
            "tariffCode": "string",
            "countryOfOrigin": "string",
            "createdAt": "2019-08-24T14:15:22Z",
            "updatedAt": "2019-08-24T14:15:22Z",
            "archivedAt": "2019-08-24T14:15:22Z",
            "featuredMediaId": "ae12f69f-58ad-4875-a887-b7bcc16d920b",
            "product": {
              "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
              "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
              "isBundle": false,
              "name": "string",
              "slug": "string",
              "description": "string",
              "options": [
                {
                  "name": "string",
                  "values": [
                    "string"
                  ]
                }
              ],
              "brand": "string",
              "vendor": "string",
              "manufacturer": "string",
              "eccn": "string",
              "imageUrl": "http://example.com",
              "imageFile": "string",
              "variants": [
                {
                  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
                  "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
                  "productId": "dcd53ddb-8104-4e48-8cc0-5df1088c6113",
                  "title": "string",
                  "sku": "string",
                  "skuAliases": [
                    "string"
                  ],
                  "barcode": "string",
                  "asin": "string",
                  "ean": "string",
                  "isbn": "string",
                  "upc": "string",
                  "price": 0.1,
                  "compareAtPrice": 0.1,
                  "wholesalePrice": 0.1,
                  "costPrice": 0,
                  "currency": "usd",
                  "position": 0,
                  "taxable": true,
                  "discountable": true,
                  "requiresShipping": true,
                  "inventoryPolicy": "deny",
                  "inventoryAllocationStrategy": "string",
                  "selectedOptions": [
                    {
                      "name": "string",
                      "value": "string"
                    }
                  ],
                  "image": "http://example.com",
                  "weight": 0.1,
                  "weightUnit": "oz",
                  "dimensions": {
                    "length": 0.1,
                    "width": 0.1,
                    "height": 0.1
                  },
                  "dimensionsUnit": "in",
                  "tracksInventory": false,
                  "tariffCode": "string",
                  "countryOfOrigin": "string",
                  "createdAt": "2019-08-24T14:15:22Z",
                  "updatedAt": "2019-08-24T14:15:22Z",
                  "archivedAt": "2019-08-24T14:15:22Z",
                  "featuredMediaId": "ae12f69f-58ad-4875-a887-b7bcc16d920b",
                  "product": {
                    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
                    "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
                    "isBundle": false,
                    "name": "string",
                    "slug": "string",
                    "description": "string",
                    "options": [
                      {
                        "name": "string",
                        "values": [
                          "string"
                        ]
                      }
                    ],
                    "brand": "string",
                    "vendor": "string",
                    "manufacturer": "string",
                    "eccn": "string",
                    "imageUrl": "http://example.com",
                    "imageFile": "string",
                    "variants": [],
                    "createdAt": "2019-08-24T14:15:22Z",
                    "updatedAt": "2019-08-24T14:15:22Z",
                    "archivedAt": "2019-08-24T14:15:22Z",
                    "featuredMediaId": "ae12f69f-58ad-4875-a887-b7bcc16d920b",
                    "productVariants": [],
                    "serviceObjects": [
                      {
                        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
                        "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
                        "serviceId": "8f8bb40f-b96b-40fe-9064-5031fbe483f9",
                        "type": "string",
                        "key": "string",
                        "value": null,
                        "createdAt": "2019-08-24T14:15:22Z",
                        "updatedAt": "2019-08-24T14:15:22Z",
                        "service": {
                          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
                          "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
                          "type": "string",
                          "description": "string",
                          "createdAt": "2019-08-24T14:15:22Z",
                          "updatedAt": "2019-08-24T14:15:22Z",
                          "archivedAt": "2019-08-24T14:15:22Z",
                          "settings": {}
                        }
                      }
                    ],
                    "media": [
                      null
                    ],
                    "featuredMedia": {}
                  },
                  "inventoryLevels": [
                    null
                  ],
                  "inventoryLocations": [
                    null
                  ],
                  "supplierProducts": [
                    null
                  ],
                  "packagings": [
                    null
                  ],
                  "serviceObjects": [
                    null
                  ],
                  "bom": {},
                  "bomLineItems": [
                    null
                  ],
                  "media": [
                    null
                  ],
                  "featuredMedia": {},
                  "unitsOfMeasure": [
                    null
                  ]
                }
              ],
              "createdAt": "2019-08-24T14:15:22Z",
              "updatedAt": "2019-08-24T14:15:22Z",
              "archivedAt": "2019-08-24T14:15:22Z",
              "featuredMediaId": "ae12f69f-58ad-4875-a887-b7bcc16d920b",
              "productVariants": [],
              "serviceObjects": [
                {
                  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
                  "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
                  "serviceId": "8f8bb40f-b96b-40fe-9064-5031fbe483f9",
                  "type": "string",
                  "key": "string",
                  "value": null,
                  "createdAt": "2019-08-24T14:15:22Z",
                  "updatedAt": "2019-08-24T14:15:22Z",
                  "service": {
                    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
                    "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
                    "type": "string",
                    "description": "string",
                    "createdAt": "2019-08-24T14:15:22Z",
                    "updatedAt": "2019-08-24T14:15:22Z",
                    "archivedAt": "2019-08-24T14:15:22Z",
                    "settings": {}
                  }
                }
              ],
              "media": [
                null
              ],
              "featuredMedia": {}
            },
            "inventoryLevels": [
              null
            ],
            "inventoryLocations": [
              null
            ],
            "supplierProducts": [
              null
            ],
            "packagings": [
              null
            ],
            "serviceObjects": [
              null
            ],
            "bom": {},
            "bomLineItems": [
              null
            ],
            "media": [
              null
            ],
            "featuredMedia": {},
            "unitsOfMeasure": [
              null
            ]
          }
        ],
        "serviceObjects": [
          {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
            "serviceId": "8f8bb40f-b96b-40fe-9064-5031fbe483f9",
            "type": "string",
            "key": "string",
            "value": null,
            "createdAt": "2019-08-24T14:15:22Z",
            "updatedAt": "2019-08-24T14:15:22Z",
            "service": {
              "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
              "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
              "type": "string",
              "description": "string",
              "createdAt": "2019-08-24T14:15:22Z",
              "updatedAt": "2019-08-24T14:15:22Z",
              "archivedAt": "2019-08-24T14:15:22Z",
              "settings": {}
            }
          }
        ],
        "media": [
          null
        ],
        "featuredMedia": {}
      },
      "inventoryLevels": [
        null
      ],
      "inventoryLocations": [
        null
      ],
      "supplierProducts": [
        null
      ],
      "packagings": [
        null
      ],
      "serviceObjects": [
        null
      ],
      "bom": {},
      "bomLineItems": [
        null
      ],
      "media": [
        null
      ],
      "featuredMedia": {},
      "unitsOfMeasure": [
        null
      ]
    }
  ],
  "totalCount": 0,
  "hasMore": true,
  "limit": 0,
  "nextCursor": "string"
}

Get product by ID GET

Retrieve a specific product by its unique identifier. Results are filtered to products the authenticated user has access to.

Get product variant by ID GET

Retrieve a specific product variant by its unique identifier within a product. Results are filtered to variants the authenticated user has access to.