POST /variants.json

POST /variants.json
application/json

Body Required

Responses

POST /variants.json
curl \
 -X POST http://api.example.com/v1/variants.json \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"accountingSync":"active","automaticallyBackorder":"vendor_default","backorderQuantity":0,"barcode":"string","commissionRate":0,"commissionRateRouting":"dropship_provider","commissionRateType":"percentage","costPrice":0,"countryOfOrigin":"string","defaultPurchaseQuantity":1,"denyThreshold":0,"description":"string","distanceUnit":"in","dropshipProviderAddressId":42,"dropshipProviderAddressMapping":"default","dropshipProviderId":42,"dropshipProviderMapping":"brand_name","dynamicInventoryPolicy":true,"fulfillmentPolicy":"vendor_default","grams":0,"hsCode":"string","images":[],"imagesMapped":{},"imagesRaw":{},"inventoryAllocated":0,"inventoryFeeds":0,"inventoryPolicy":"track","inventoryQuantity":0,"inventoryRouting":"inventory_feed","inventorySync":"channel","inventoryType":"tracked","leadTime":42,"levels":{},"lowInventoryQuantity":true,"minInventoryQuantity":0,"minimumGuidePrice":0,"mpn":"string","name":"string","noInventoryPolicy":"replenish","notes":"string","orderSplitting":"default","packingDepth":0,"packingHeight":0,"packingWidth":0,"position":0,"productId":42,"productType":"string","requiresShipping":true,"resellerVisibility":"visible","serialPrefix":"string","serialReference":0,"serialSuffix":"string","sku":"string","tags":["string"],"taxable":true,"totalPurchaseItems":0,"totalSaleItems":0,"vendorId":42,"vendorSku":"string"}'
Request example
{
  "accountingSync": "active",
  "automaticallyBackorder": "vendor_default",
  "backorderQuantity": 0,
  "barcode": "string",
  "commissionRate": 0,
  "commissionRateRouting": "dropship_provider",
  "commissionRateType": "percentage",
  "costPrice": 0,
  "countryOfOrigin": "string",
  "defaultPurchaseQuantity": 1,
  "denyThreshold": 0,
  "description": "string",
  "distanceUnit": "in",
  "dropshipProviderAddressId": 42,
  "dropshipProviderAddressMapping": "default",
  "dropshipProviderId": 42,
  "dropshipProviderMapping": "brand_name",
  "dynamicInventoryPolicy": true,
  "fulfillmentPolicy": "vendor_default",
  "grams": 0,
  "hsCode": "string",
  "images": [],
  "imagesMapped": {},
  "imagesRaw": {},
  "inventoryAllocated": 0,
  "inventoryFeeds": 0,
  "inventoryPolicy": "track",
  "inventoryQuantity": 0,
  "inventoryRouting": "inventory_feed",
  "inventorySync": "channel",
  "inventoryType": "tracked",
  "leadTime": 42,
  "levels": {},
  "lowInventoryQuantity": true,
  "minInventoryQuantity": 0,
  "minimumGuidePrice": 0,
  "mpn": "string",
  "name": "string",
  "noInventoryPolicy": "replenish",
  "notes": "string",
  "orderSplitting": "default",
  "packingDepth": 0,
  "packingHeight": 0,
  "packingWidth": 0,
  "position": 0,
  "productId": 42,
  "productType": "string",
  "requiresShipping": true,
  "resellerVisibility": "visible",
  "serialPrefix": "string",
  "serialReference": 0,
  "serialSuffix": "string",
  "sku": "string",
  "tags": [
    "string"
  ],
  "taxable": true,
  "totalPurchaseItems": 0,
  "totalSaleItems": 0,
  "vendorId": 42,
  "vendorSku": "string"
}
Response examples (200)
{
  "accountingSync": "active",
  "automaticallyBackorder": "vendor_default",
  "backorderQuantity": 0,
  "barcode": "string",
  "commissionRate": 0,
  "commissionRateRouting": "dropship_provider",
  "commissionRateType": "percentage",
  "costPrice": 0,
  "countryOfOrigin": "string",
  "createdAt": "2024-05-04T09:42:00+00:00",
  "defaultPurchaseQuantity": 1,
  "denyThreshold": 0,
  "description": "string",
  "distanceUnit": "in",
  "dropshipProviderAddressId": 42,
  "dropshipProviderAddressMapping": "default",
  "dropshipProviderId": 42,
  "dropshipProviderMapping": "brand_name",
  "dynamicInventoryPolicy": true,
  "fulfillmentPolicy": "vendor_default",
  "grams": 0,
  "hsCode": "string",
  "id": 42,
  "images": [],
  "imagesMapped": {},
  "imagesRaw": {},
  "inventoryAllocated": 0,
  "inventoryFeeds": 0,
  "inventoryPolicy": "track",
  "inventoryQuantity": 0,
  "inventoryRouting": "inventory_feed",
  "inventorySync": "channel",
  "inventoryType": "tracked",
  "leadTime": 42,
  "levels": {},
  "lowInventoryQuantity": true,
  "minInventoryQuantity": 0,
  "minimumGuidePrice": 0,
  "mpn": "string",
  "name": "string",
  "noInventoryPolicy": "replenish",
  "notes": "string",
  "orderSplitting": "default",
  "packingDepth": 0,
  "packingHeight": 0,
  "packingWidth": 0,
  "position": 0,
  "productId": 42,
  "productType": "string",
  "requiresShipping": true,
  "resellerVisibility": "visible",
  "serialPrefix": "string",
  "serialReference": 0,
  "serialSuffix": "string",
  "sku": "string",
  "tags": [
    "string"
  ],
  "taxable": true,
  "totalPurchaseItems": 0,
  "totalSaleItems": 0,
  "updatedAt": "2024-05-04T09:42:00+00:00",
  "vendorId": 42,
  "vendorSku": "string"
}