POST /v1/commerce/products/{productID}/variants/batch

POST/v1/commerce/products/{productID}/variants/batch

Authorization

bearerAuthbearerAuthrequired

apiKeyAuthapiKeyAuthrequired

Path parameters

productIDstringrequired

Request body

requiredapplication/json

createCreateProductVariantHTTPBody[] | null

Show properties

Array of CreateProductVariantHTTPBody

digital_delivery_urlstring

image_urlstring

option_valuesobject

price_amountinteger<int64>

min 0

price_delta_amountinteger<int64>

skustring

stock_qtyinteger<int32>

min 0

titlestringrequired

deletestring[] | null

updateUpdateProductVariantHTTPBody[] | null

Show properties

Array of UpdateProductVariantHTTPBody

digital_delivery_urlstring

image_urlstring

option_valuesobject

price_amountinteger<int64>

min 0

price_delta_amountinteger<int64>

skustring

stock_qtyinteger<int32>

min 0

titlestringrequired

variant_idstringrequired

Responses

200OK

createdProductVariant[] | nullrequired

Show properties

Array of ProductVariant

digital_delivery_urlstring

idstringrequired

image_urlstring

option_valuesobject

price_amountinteger<int64>

price_delta_amountinteger<int64>required

product_idstringrequired

skustring

stock_qtyinteger<int32>required

titlestringrequired

deletedstring[] | nullrequired

updatedProductVariant[] | nullrequired

Show properties

Array of ProductVariant

digital_delivery_urlstring

idstringrequired

image_urlstring

option_valuesobject

price_amountinteger<int64>

price_delta_amountinteger<int64>required

product_idstringrequired

skustring

stock_qtyinteger<int32>required

titlestringrequired

defaultError

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

Request

curl -X POST "/v1/commerce/products/string/variants/batch" \
  -H "Content-Type: application/json" \
  -d '{
  "create": [
    {
      "digital_delivery_url": "string",
      "image_url": "string",
      "option_values": {},
      "price_amount": 0,
      "price_delta_amount": 0,
      "sku": "string",
      "stock_qty": 0,
      "title": "string"
    }
  ],
  "delete": [
    "string"
  ],
  "update": [
    {
      "digital_delivery_url": "string",
      "image_url": "string",
      "option_values": {},
      "price_amount": 0,
      "price_delta_amount": 0,
      "sku": "string",
      "stock_qty": 0,
      "title": "string",
      "variant_id": "string"
    }
  ]
}'

const response = await fetch("/v1/commerce/products/string/variants/batch", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "create": [
    {
      "digital_delivery_url": "string",
      "image_url": "string",
      "option_values": {},
      "price_amount": 0,
      "price_delta_amount": 0,
      "sku": "string",
      "stock_qty": 0,
      "title": "string"
    }
  ],
  "delete": [
    "string"
  ],
  "update": [
    {
      "digital_delivery_url": "string",
      "image_url": "string",
      "option_values": {},
      "price_amount": 0,
      "price_delta_amount": 0,
      "sku": "string",
      "stock_qty": 0,
      "title": "string",
      "variant_id": "string"
    }
  ]
})
});

import requests

response = requests.post(
    "/v1/commerce/products/string/variants/batch",
    headers={
        "Content-Type": "application/json"
    },
    json={
  "create": [
    {
      "digital_delivery_url": "string",
      "image_url": "string",
      "option_values": {},
      "price_amount": 0,
      "price_delta_amount": 0,
      "sku": "string",
      "stock_qty": 0,
      "title": "string"
    }
  ],
  "delete": [
    "string"
  ],
  "update": [
    {
      "digital_delivery_url": "string",
      "image_url": "string",
      "option_values": {},
      "price_amount": 0,
      "price_delta_amount": 0,
      "sku": "string",
      "stock_qty": 0,
      "title": "string",
      "variant_id": "string"
    }
  ]
},
)

Response

{
  "created": [
    {
      "digital_delivery_url": "string",
      "id": "string",
      "image_url": "string",
      "option_values": {},
      "price_amount": 0,
      "price_delta_amount": 0,
      "product_id": "string",
      "sku": "string",
      "stock_qty": 0,
      "title": "string"
    }
  ],
  "deleted": [
    "string"
  ],
  "updated": [
    {
      "digital_delivery_url": "string",
      "id": "string",
      "image_url": "string",
      "option_values": {},
      "price_amount": 0,
      "price_delta_amount": 0,
      "product_id": "string",
      "sku": "string",
      "stock_qty": 0,
      "title": "string"
    }
  ]
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}