POST /channel-variants.json
Body Required
-
cacheHash string | null
Cache hash
-
Channel
-
costPriceRetries integer(int32) | null
Cost price retries
-
costPriceRetry boolean | null
Cost price retry
costPriceUpdate object | null | array | boolean | integer | number | string
Any of: Cost price update
Cost price update
Cost price update
Cost price update
Cost price update
Cost price update
-
errorMessage string | null
Error message
-
externalCreatedAt string(date-time) | null
External created at
-
externalGroupId string | null
External group
-
externalId string | null
External
-
externalSku string | null
External sku
-
hash string | null
Hash
-
inventoryRetries integer(int32) | null
Inventory retries
-
inventoryRetry boolean | null
Inventory retry
inventoryUpdate object | null | array | boolean | integer | number | string
Any of: Inventory update
Inventory update
Inventory update
Inventory update
Inventory update
Inventory update
-
metaFieldsHash string | null
Meta fields hash
-
parentHash string | null
Parent hash
-
priceListHash string | null
Price list hash
-
priceListRetry boolean | null
Price list retry
-
priceRetries integer(int32) | null
Price retries
-
priceRetry boolean | null
Price retry
priceUpdate object | null | array | boolean | integer | number | string
publishUpdate object | null | array | boolean | integer | number | string
-
Source
Values are
bigCommerce
,custom
,duoplane
,elasticPath
,magento
,salesforce
,shopify
, orwooCommerce
. Default value isshopify
. -
Status
Values are
initialized
,connected
,error
,pending
,ignore
, oracknowledging
. Default value ispending
. -
variantId integer(int32) | null
Variant
-
variantParcelsHash string | null
Variant parcels hash
POST
/channel-variants.json
curl \
-X POST http://api.example.com/v1/channel-variants.json \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{"cacheHash":"string","channelId":42,"costPriceRetries":42,"costPriceRetry":true,"costPriceUpdate":{},"errorMessage":"string","externalCreatedAt":"2024-05-04T09:42:00+00:00","externalGroupId":"string","externalId":"string","externalSku":"string","hash":"string","inventoryRetries":42,"inventoryRetry":true,"inventoryUpdate":{},"metaFieldsHash":"string","parentHash":"string","priceListHash":"string","priceListRetry":true,"priceRetries":42,"priceRetry":true,"priceUpdate":{},"publishUpdate":{},"source":"shopify","status":"pending","variantId":42,"variantParcelsHash":"string"}'
Request example
{
"cacheHash": "string",
"channelId": 42,
"costPriceRetries": 42,
"costPriceRetry": true,
"costPriceUpdate": {},
"errorMessage": "string",
"externalCreatedAt": "2024-05-04T09:42:00+00:00",
"externalGroupId": "string",
"externalId": "string",
"externalSku": "string",
"hash": "string",
"inventoryRetries": 42,
"inventoryRetry": true,
"inventoryUpdate": {},
"metaFieldsHash": "string",
"parentHash": "string",
"priceListHash": "string",
"priceListRetry": true,
"priceRetries": 42,
"priceRetry": true,
"priceUpdate": {},
"publishUpdate": {},
"source": "shopify",
"status": "pending",
"variantId": 42,
"variantParcelsHash": "string"
}
Response examples (200)
{
"cacheHash": "string",
"channelId": 42,
"costPriceRetries": 42,
"costPriceRetry": true,
"costPriceUpdate": {},
"createdAt": "2024-05-04T09:42:00+00:00",
"errorMessage": "string",
"externalCreatedAt": "2024-05-04T09:42:00+00:00",
"externalGroupId": "string",
"externalId": "string",
"externalSku": "string",
"hash": "string",
"id": 42,
"inventoryRetries": 42,
"inventoryRetry": true,
"inventoryUpdate": {},
"metaFieldsHash": "string",
"parentHash": "string",
"priceListHash": "string",
"priceListRetry": true,
"priceRetries": 42,
"priceRetry": true,
"priceUpdate": {},
"publishUpdate": {},
"source": "shopify",
"status": "pending",
"updatedAt": "2024-05-04T09:42:00+00:00",
"variantId": 42,
"variantParcelsHash": "string"
}