Shipsidekick LogoShipsidekick Docs
API/Products

Update a product variant

Update an existing product variant's details. Requires full write access to products.

POST
/products/{productId}/variants/{productVariantId}

Request Body

application/jsonRequired
titlestring

Title of the variant

skustring

Stock keeping unit

skuAliasstring

Alternative SKU identifier

barcodestring

Barcode identifier

asinstring

Amazon Standard Identification Number

eanstring

European Article Number

isbnstring

International Standard Book Number

upcstring

Universal Product Code

pricenumber

Retail price

Format: "float"
compareAtPricenumber

Original price for comparison

Format: "float"
wholesalePricenumber

Wholesale price

Format: "float"
costPricenumber

Cost of goods

Format: "float"
currencystring

Currency code

positioninteger

Display order position

taxableboolean

Whether the variant is taxable

discountableboolean

Whether the variant can be discounted

requiresShippingboolean

Whether the variant requires shipping

inventoryPolicystring

Inventory policy for out of stock items

selectedOptionsarray<object>

Selected variant options

imagestring

URL of the variant image

Format: "uri"
weightnumber

Weight of the variant

Format: "float"
weightUnitstring

Unit of weight measurement

dimensionsobject

Physical dimensions

dimensionsUnitstring

Unit of dimension measurement

tracksInventoryboolean

Whether inventory is tracked

tariffCodestring

Harmonized tariff code

countryOfOriginstring

Country where the variant was manufactured

Path Parameters

productIdRequiredstring

Unique identifier of the product

Format: "uuid"
productVariantIdRequiredstring

Unique identifier of the product variant

Format: "uuid"
curl -X POST "https://www.shipsidekick.com/api/v1/products/12345678-90ab-cdef-1234-567890abcdef/variants/98765432-fedc-ba98-7654-321012345678" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Premium Racing Jacket - Blue/Medium",
    "sku": "RCJ-BLUE-M",
    "price": 209.99
  }'

Product variant updated successfully

{
  "object": "product_variant",
  "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
    ]
  }
}

Update a product POST

Update an existing product's details. Requires full write access to products. This endpoint only updates product-level fields. Variant updates are handled through dedicated variant endpoints.

List products GET

Retrieve a list of products with pagination and filtering options