Skip to main content
PATCH
/
api
/
v1
/
{team_slug}
/
{app_slug}
/
variants
/
bulk
Error
A valid request URL is required to generate request examples
{
  "data": {
    "failed": [
      {
        "id": "<string>",
        "reason": "<string>"
      }
    ],
    "successful": [
      {
        "attributes": [
          {
            "created_at": "<string>",
            "description": "<string>",
            "filterable": true,
            "id": "<string>",
            "key": "<string>",
            "name": "<string>",
            "template_key": "<string>",
            "template_name": "<string>",
            "translatable": true,
            "translations": {
              "description": [
                {
                  "id": "<string>",
                  "locale": "<string>",
                  "value": "<string>"
                }
              ],
              "name": [
                {
                  "id": "<string>",
                  "locale": "<string>",
                  "value": "<string>"
                }
              ]
            },
            "updated_at": "<string>",
            "values": {}
          }
        ],
        "created_at": "<string>",
        "custom_fields": {},
        "id": "<string>",
        "images": [
          {
            "alt": "<string>",
            "app_id": "<string>",
            "attributes": [
              {
                "created_at": "<string>",
                "description": "<string>",
                "filterable": true,
                "id": "<string>",
                "key": "<string>",
                "name": "<string>",
                "template_key": "<string>",
                "template_name": "<string>",
                "translatable": true,
                "translations": {
                  "description": [
                    {
                      "id": "<string>",
                      "locale": "<string>",
                      "value": "<string>"
                    }
                  ],
                  "name": [
                    {
                      "id": "<string>",
                      "locale": "<string>",
                      "value": "<string>"
                    }
                  ]
                },
                "updated_at": "<string>",
                "values": {}
              }
            ],
            "blurhash": "<string>",
            "copyright": "<string>",
            "custom": {},
            "folder_id": "<string>",
            "id": "<string>",
            "parent_id": "<string>",
            "priority": 123,
            "public": true,
            "source_app_id": "<string>",
            "source_id": "<string>",
            "status": "<string>",
            "title": "<string>",
            "translations": {
              "alt": [
                {
                  "id": "<string>",
                  "locale": "<string>",
                  "value": "<string>"
                }
              ],
              "copyright": [
                {
                  "id": "<string>",
                  "locale": "<string>",
                  "value": "<string>"
                }
              ],
              "title": [
                {
                  "id": "<string>",
                  "locale": "<string>",
                  "value": "<string>"
                }
              ]
            },
            "url": "<string>"
          }
        ],
        "listings": {
          "smart": [
            {
              "id": "<string>",
              "slug": "<string>"
            }
          ],
          "static": [
            {
              "id": "<string>",
              "slug": "<string>"
            }
          ]
        },
        "parent_product_id": "<string>",
        "purchase_price": {
          "currency": "<string>",
          "value_cents": 123
        },
        "shipping_attributes": [
          "<string>"
        ],
        "source_app_id": "<string>",
        "source_id": "<string>",
        "status": "<string>",
        "store_group": [
          {
            "created_at": "<string>",
            "id": "<string>",
            "name": "<string>",
            "prices": [
              {
                "amount_cents_with_tax": 123,
                "created_at": "<string>",
                "id": "<string>",
                "market": {
                  "active": true,
                  "country_codes": [
                    "<string>"
                  ],
                  "created_at": "<string>",
                  "currency_code": "<string>",
                  "id": "<string>",
                  "locale": "<string>",
                  "name": "<string>",
                  "slug": "<string>",
                  "updated_at": "<string>"
                },
                "on_sale": true,
                "reference_price_with_tax": 123,
                "sale_end_timestamp": "<string>",
                "sale_price_with_tax": 123,
                "sale_start_timestamp": "<string>",
                "updated_at": "<string>"
              }
            ],
            "slug": "<string>",
            "store_type": "<string>",
            "updated_at": "<string>"
          }
        ],
        "tags": [
          {
            "attributes": [
              {
                "created_at": "<string>",
                "description": "<string>",
                "filterable": true,
                "id": "<string>",
                "key": "<string>",
                "name": "<string>",
                "template_key": "<string>",
                "template_name": "<string>",
                "translatable": true,
                "translations": {
                  "description": [
                    {
                      "id": "<string>",
                      "locale": "<string>",
                      "value": "<string>"
                    }
                  ],
                  "name": [
                    {
                      "id": "<string>",
                      "locale": "<string>",
                      "value": "<string>"
                    }
                  ]
                },
                "updated_at": "<string>",
                "values": {}
              }
            ],
            "created_at": "<string>",
            "filterable": true,
            "id": "<string>",
            "key": "<string>",
            "markets": [
              {
                "active": true,
                "country_codes": [
                  "<string>"
                ],
                "created_at": "<string>",
                "currency_code": "<string>",
                "id": "<string>",
                "locale": "<string>",
                "name": "<string>",
                "slug": "<string>",
                "updated_at": "<string>"
              }
            ],
            "name": "<string>",
            "schedules": [
              {
                "add_category_names": [
                  "<string>"
                ],
                "add_collection_names": [
                  "<string>"
                ],
                "add_tag_names": [
                  "<string>"
                ],
                "execute_at": "<string>",
                "finished_at": "<string>",
                "id": "<string>",
                "item_id": "<string>",
                "item_name": "<string>",
                "item_type": "<string>",
                "remove_category_names": [
                  "<string>"
                ],
                "remove_collection_names": [
                  "<string>"
                ],
                "remove_tag_names": [
                  "<string>"
                ],
                "to_amount_cents_with_tax": 123,
                "to_market_id": "<string>",
                "to_market_status": "<string>",
                "to_on_sale": true,
                "to_sale_amount_cents_with_tax": 123,
                "to_start_sale_timestamp": "<string>",
                "to_status": "<string>",
                "to_stop_sale_timestamp": "<string>",
                "to_store_group_id": "<string>"
              }
            ],
            "source_app_id": "<string>",
            "source_id": "<string>",
            "status": "<string>",
            "translations": {
              "name": [
                {
                  "id": "<string>",
                  "locale": "<string>",
                  "value": "<string>"
                }
              ]
            },
            "updated_at": "<string>"
          }
        ],
        "translations": {
          "name": [
            {
              "id": "<string>",
              "locale": "<string>",
              "value": "<string>"
            }
          ]
        },
        "updated_at": "<string>",
        "validate_stock": true,
        "variant_dimensions": {
          "capacity_milliliter": 1,
          "depth": 1,
          "diameter": 1,
          "height": 1,
          "length": 1,
          "weight": 1,
          "width": 1
        },
        "variant_group_id": "<string>",
        "variant_name": "<string>",
        "variant_number": "<string>",
        "videos": [
          {
            "attributes": [
              {
                "created_at": "<string>",
                "description": "<string>",
                "filterable": true,
                "id": "<string>",
                "key": "<string>",
                "name": "<string>",
                "template_key": "<string>",
                "template_name": "<string>",
                "translatable": true,
                "translations": {
                  "description": [
                    {
                      "id": "<string>",
                      "locale": "<string>",
                      "value": "<string>"
                    }
                  ],
                  "name": [
                    {
                      "id": "<string>",
                      "locale": "<string>",
                      "value": "<string>"
                    }
                  ]
                },
                "updated_at": "<string>",
                "values": {}
              }
            ],
            "description": "<string>",
            "folder_id": "<string>",
            "id": "<string>",
            "path": "<string>",
            "public": true,
            "status": "<string>",
            "title": "<string>",
            "translations": {
              "description": [
                {
                  "id": "<string>",
                  "locale": "<string>",
                  "value": "<string>"
                }
              ],
              "title": [
                {
                  "id": "<string>",
                  "locale": "<string>",
                  "value": "<string>"
                }
              ]
            },
            "variants": [
              {
                "format": "<string>",
                "height": 123,
                "url": "<string>",
                "width": 123
              }
            ]
          }
        ],
        "warehouse_variant_stock": [
          {
            "available_online": true,
            "created_at": "<string>",
            "id": "<string>",
            "inventory_date": "<string>",
            "quantity": 123,
            "updated_at": "<string>",
            "warehouse_name": "<string>",
            "warehouse_slug": "<string>"
          }
        ]
      }
    ]
  },
  "details": [
    "<string>"
  ],
  "success": true
}

Path Parameters

team_slug
string
required

Team slug

app_slug
string
required

App slug

Body

application/json

Variants data to update

variants
object[]
required
Maximum array length: 50

Response

Variants updated successfully

data
object
details
string[]

Additional contextual information about the response. Used to provide supplementary details beyond the main data payload, such as validation warnings or processing notes

success
boolean