POST /inventory-feed-variants.json

application/json

Body Required

allocationBufferOverride integer(int32) | null

Allocation buffer override
barcode string | null

Barcode
cachedCompareAtPrice string | null

Cached compare at price
cachedHandle string | null

Cached handle
cachedName string | null

Cached name
cachedRetailPrice string | null

Cached retail price
cachedTags array[string] | null

Cached tags
changesPending boolean | null Required

Changes pending

Default value is false.
compareAtPrice number | null

Compare at price
costPrice number | null

Cost price
countryOfOrigin string | null

Country of origin
description string | null

Description
distanceUnit string | null Required

Distance unit

Values are in or cm. Default value is in.
externalGroupId string | null

External group
externalId string | null

External
externalUrl string | null

External url
grams number(float) | null Required

Grams

Default value is 0.
handle string | null

Handle
hash string | null

Hash
hsCode string | null

Hs code
images object | null | array | boolean | integer | number | string Required

Any of:
object-1 object | null array-2 array | null boolean-3 boolean | null integer-4 integer | null number-5 number | null string-6 string | null

Images

Default value is [] (empty).

Images

Default value is [] (empty).

Images

Default value is [] (empty).

Images

Default value is [] (empty).

Images

Default value is [] (empty).

Images

Default value is [] (empty).
inventoryFeedId integer(int32) Required

Inventory feed
inventoryPolicy string | null Required

Inventory policy

Values are ignore, deny, continue, dropship, or track. Default value is track.
inventoryQuantity integer(int32) | null

Inventory quantity
inventoryQuantityOverride string | null

By enabling this feature, you can manually set the inventory quantity for a specific variant in the inventory feed. This allows you to have more control over the displayed inventory quantity on the marketplace. If the quantity in the feed changes, the value you enter for the override will take precedence.

Values are none, manual, or maximum.
inventoryUpdatedAt string(date-time) | null Required

Inventory updated at

Default value is {} (empty).
lastFetchedAt string(date-time) | null

Last fetched at
locations object | null | array | boolean | integer | number | string

Any of:
object-1 object | null array-2 array | null boolean-3 boolean | null integer-4 integer | null number-5 number | null string-6 string | null

Locations

Locations

Locations

Locations

Locations

Locations
manualInventoryPolicy boolean | null

Manual inventory policy
manualInventoryQuantity integer(int32) | null

Manual inventory quantity
messages object | null | array | boolean | integer | number | string

Any of:
object-1 object | null array-2 array | null boolean-3 boolean | null integer-4 integer | null number-5 number | null string-6 string | null

Messages

Messages

Messages

Messages

Messages

Messages
metaFields object | null | array | boolean | integer | number | string

Any of:
object-1 object | null array-2 array | null boolean-3 boolean | null integer-4 integer | null number-5 number | null string-6 string | null

Meta fields

Meta fields

Meta fields

Meta fields

Meta fields

Meta fields
mpn string | null

Mpn
name string | null

Name
options object | null | array | boolean | integer | number | string Required

Any of:
object-1 object | null array-2 array | null boolean-3 boolean | null integer-4 integer | null number-5 number | null string-6 string | null

Options

Default value is [] (empty).

Options

Default value is [] (empty).

Options

Default value is [] (empty).

Options

Default value is [] (empty).

Options

Default value is [] (empty).

Options

Default value is [] (empty).
originalCompareAtPrice number | null

Original compare at price
originalInventoryQuantity integer(int32) | null

Original inventory quantity
originalRetailPrice number | null

Original retail price
originalSku string | null

Original sku
packingDepth integer(int32) | null Required

Packing depth

Default value is 0.
packingHeight integer(int32) | null Required

Packing height

Default value is 0.
packingWidth integer(int32) | null Required

Packing width

Default value is 0.
position integer(int32) | null

Position
priceUpdatedAt string(date-time) | null Required

Price updated at

Default value is {} (empty).
pricingOverride string | null Required

Pricing override

Values are none, manual, minimumGuidePrice, minimumGuidePricePercent, minimumGuidePriceFixed, or percent. Default value is none.
pricingOverrideUplift number | null

Pricing override uplift
productType string | null

Product type
publishProblem object | null | array | boolean | integer | number | string

Any of:
object-1 object | null array-2 array | null boolean-3 boolean | null integer-4 integer | null number-5 number | null string-6 string | null

Publish problem

Publish problem

Publish problem

Publish problem

Publish problem

Publish problem
requiresShipping boolean | null Required

Requires shipping

Default value is true.
retailPrice number | null

Retail price
retriedPublishingAt string(date-time) | null

Retried publishing at
retriedPublishingTimes integer(int32) | null

Retried publishing times
retryPublishing boolean | null

Retry publishing
retryPublishingParams object | null | array | boolean | integer | number | string

Any of:
object-1 object | null array-2 array | null boolean-3 boolean | null integer-4 integer | null number-5 number | null string-6 string | null

Retry publishing params

Retry publishing params

Retry publishing params

Retry publishing params

Retry publishing params

Retry publishing params
reviewReasonId integer(int32) | null

Review reason
reviewStatus string | null Required

Review status

Values are notReviewed, approved, pending, or rejected. Default value is notReviewed.
status string Required

Status

Values are pending, connected, error, removed, publishing, or queued. Default value is pending.
tags array[string] | null Required

Tags

Default value is [] (empty).
taxable boolean | null Required

Taxable

Default value is true.
uniqueOn string | null Required

Unique on

Values are none or externalId. Default value is none.
variantId integer(int32) | null

Variant
vendorName string | null

Vendor name
vendorSku string Required

Vendor sku

Responses

200 application/json

Successful response
Hide response attributes Show response attributes object
- allocationBufferOverride integer(int32) | null
  
  Allocation buffer override
- barcode string | null
  
  Barcode
- cachedCompareAtPrice string | null
  
  Cached compare at price
- cachedHandle string | null
  
  Cached handle
- cachedName string | null
  
  Cached name
- cachedRetailPrice string | null
  
  Cached retail price
- cachedTags array[string] | null
  
  Cached tags
- changesPending boolean | null Required
  
  Changes pending
  
  Default value is false.
- compareAtPrice number | null
  
  Compare at price
- costPrice number | null
  
  Cost price
- countryOfOrigin string | null
  
  Country of origin
- createdAt string(date-time)
  
  Created at
- description string | null
  
  Description
- distanceUnit string | null Required
  
  Distance unit
  
  Values are in or cm. Default value is in.
- externalGroupId string | null
  
  External group
- externalId string | null
  
  External
- externalUrl string | null
  
  External url
- grams number(float) | null Required
  
  Grams
  
  Default value is 0.
- handle string | null
  
  Handle
- hash string | null
  
  Hash
- hsCode string | null
  
  Hs code
- id integer(int32)
  
  Id
- images object | null | array | boolean | integer | number | string Required
  
  Any of:
  object-1 object | null array-2 array | null boolean-3 boolean | null integer-4 integer | null number-5 number | null string-6 string | null
  
  Images
  
  Default value is [] (empty).
  
  Images
  
  Default value is [] (empty).
  
  Images
  
  Default value is [] (empty).
  
  Images
  
  Default value is [] (empty).
  
  Images
  
  Default value is [] (empty).
  
  Images
  
  Default value is [] (empty).
- inventoryFeedId integer(int32) Required
  
  Inventory feed
- inventoryPolicy string | null Required
  
  Inventory policy
  
  Values are ignore, deny, continue, dropship, or track. Default value is track.
- inventoryQuantity integer(int32) | null
  
  Inventory quantity
- inventoryQuantityOverride string | null
  
  By enabling this feature, you can manually set the inventory quantity for a specific variant in the inventory feed. This allows you to have more control over the displayed inventory quantity on the marketplace. If the quantity in the feed changes, the value you enter for the override will take precedence.
  
  Values are none, manual, or maximum.
- inventoryUpdatedAt string(date-time) | null Required
  
  Inventory updated at
  
  Default value is {} (empty).
- lastFetchedAt string(date-time) | null
  
  Last fetched at
- locations object | null | array | boolean | integer | number | string
  
  Any of:
  object-1 object | null array-2 array | null boolean-3 boolean | null integer-4 integer | null number-5 number | null string-6 string | null
  
  Locations
  
  Locations
  
  Locations
  
  Locations
  
  Locations
  
  Locations
- manualInventoryPolicy boolean | null
  
  Manual inventory policy
- manualInventoryQuantity integer(int32) | null
  
  Manual inventory quantity
- messages object | null | array | boolean | integer | number | string
  
  Any of:
  object-1 object | null array-2 array | null boolean-3 boolean | null integer-4 integer | null number-5 number | null string-6 string | null
  
  Messages
  
  Messages
  
  Messages
  
  Messages
  
  Messages
  
  Messages
- metaFields object | null | array | boolean | integer | number | string
  
  Any of:
  object-1 object | null array-2 array | null boolean-3 boolean | null integer-4 integer | null number-5 number | null string-6 string | null
  
  Meta fields
  
  Meta fields
  
  Meta fields
  
  Meta fields
  
  Meta fields
  
  Meta fields
- mpn string | null
  
  Mpn
- name string | null
  
  Name
- options object | null | array | boolean | integer | number | string Required
  
  Any of:
  object-1 object | null array-2 array | null boolean-3 boolean | null integer-4 integer | null number-5 number | null string-6 string | null
  
  Options
  
  Default value is [] (empty).
  
  Options
  
  Default value is [] (empty).
  
  Options
  
  Default value is [] (empty).
  
  Options
  
  Default value is [] (empty).
  
  Options
  
  Default value is [] (empty).
  
  Options
  
  Default value is [] (empty).
- originalCompareAtPrice number | null
  
  Original compare at price
- originalInventoryQuantity integer(int32) | null
  
  Original inventory quantity
- originalRetailPrice number | null
  
  Original retail price
- originalSku string | null
  
  Original sku
- packingDepth integer(int32) | null Required
  
  Packing depth
  
  Default value is 0.
- packingHeight integer(int32) | null Required
  
  Packing height
  
  Default value is 0.
- packingWidth integer(int32) | null Required
  
  Packing width
  
  Default value is 0.
- position integer(int32) | null
  
  Position
- priceUpdatedAt string(date-time) | null Required
  
  Price updated at
  
  Default value is {} (empty).
- pricingOverride string | null Required
  
  Pricing override
  
  Values are none, manual, minimumGuidePrice, minimumGuidePricePercent, minimumGuidePriceFixed, or percent. Default value is none.
- pricingOverrideUplift number | null
  
  Pricing override uplift
- productType string | null
  
  Product type
- publishProblem object | null | array | boolean | integer | number | string
  
  Any of:
  object-1 object | null array-2 array | null boolean-3 boolean | null integer-4 integer | null number-5 number | null string-6 string | null
  
  Publish problem
  
  Publish problem
  
  Publish problem
  
  Publish problem
  
  Publish problem
  
  Publish problem
- requiresShipping boolean | null Required
  
  Requires shipping
  
  Default value is true.
- retailPrice number | null
  
  Retail price
- retriedPublishingAt string(date-time) | null
  
  Retried publishing at
- retriedPublishingTimes integer(int32) | null
  
  Retried publishing times
- retryPublishing boolean | null
  
  Retry publishing
- retryPublishingParams object | null | array | boolean | integer | number | string
  
  Any of:
  object-1 object | null array-2 array | null boolean-3 boolean | null integer-4 integer | null number-5 number | null string-6 string | null
  
  Retry publishing params
  
  Retry publishing params
  
  Retry publishing params
  
  Retry publishing params
  
  Retry publishing params
  
  Retry publishing params
- reviewReasonId integer(int32) | null
  
  Review reason
- reviewStatus string | null Required
  
  Review status
  
  Values are notReviewed, approved, pending, or rejected. Default value is notReviewed.
- status string Required
  
  Status
  
  Values are pending, connected, error, removed, publishing, or queued. Default value is pending.
- tags array[string] | null Required
  
  Tags
  
  Default value is [] (empty).
- taxable boolean | null Required
  
  Taxable
  
  Default value is true.
- uniqueOn string | null Required
  
  Unique on
  
  Values are none or externalId. Default value is none.
- updatedAt string(date-time)
  
  Updated at
- variantId integer(int32) | null
  
  Variant
- vendorName string | null
  
  Vendor name
- vendorSku string Required
  
  Vendor sku

POST /inventory-feed-variants.json

curl \
 -X POST http://api.example.com/v1/inventory-feed-variants.json \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"allocationBufferOverride":42,"barcode":"string","cachedCompareAtPrice":"string","cachedHandle":"string","cachedName":"string","cachedRetailPrice":"string","cachedTags":["string"],"changesPending":false,"compareAtPrice":42.0,"costPrice":42.0,"countryOfOrigin":"string","description":"string","distanceUnit":"in","externalGroupId":"string","externalId":"string","externalUrl":"string","grams":0,"handle":"string","hash":"string","hsCode":"string","images":[],"inventoryFeedId":42,"inventoryPolicy":"track","inventoryQuantity":42,"inventoryQuantityOverride":"none","inventoryUpdatedAt":{},"lastFetchedAt":"2024-05-04T09:42:00+00:00","locations":{},"manualInventoryPolicy":true,"manualInventoryQuantity":42,"messages":{},"metaFields":{},"mpn":"string","name":"string","options":[],"originalCompareAtPrice":42.0,"originalInventoryQuantity":42,"originalRetailPrice":42.0,"originalSku":"string","packingDepth":0,"packingHeight":0,"packingWidth":0,"position":42,"priceUpdatedAt":{},"pricingOverride":"none","pricingOverrideUplift":42.0,"productType":"string","publishProblem":{},"requiresShipping":true,"retailPrice":42.0,"retriedPublishingAt":"2024-05-04T09:42:00+00:00","retriedPublishingTimes":42,"retryPublishing":true,"retryPublishingParams":{},"reviewReasonId":42,"reviewStatus":"notReviewed","status":"pending","tags":[],"taxable":true,"uniqueOn":"none","variantId":42,"vendorName":"string","vendorSku":"string"}'

Request example

{
  "allocationBufferOverride": 42,
  "barcode": "string",
  "cachedCompareAtPrice": "string",
  "cachedHandle": "string",
  "cachedName": "string",
  "cachedRetailPrice": "string",
  "cachedTags": [
    "string"
  ],
  "changesPending": false,
  "compareAtPrice": 42.0,
  "costPrice": 42.0,
  "countryOfOrigin": "string",
  "description": "string",
  "distanceUnit": "in",
  "externalGroupId": "string",
  "externalId": "string",
  "externalUrl": "string",
  "grams": 0,
  "handle": "string",
  "hash": "string",
  "hsCode": "string",
  "images": [],
  "inventoryFeedId": 42,
  "inventoryPolicy": "track",
  "inventoryQuantity": 42,
  "inventoryQuantityOverride": "none",
  "inventoryUpdatedAt": {},
  "lastFetchedAt": "2024-05-04T09:42:00+00:00",
  "locations": {},
  "manualInventoryPolicy": true,
  "manualInventoryQuantity": 42,
  "messages": {},
  "metaFields": {},
  "mpn": "string",
  "name": "string",
  "options": [],
  "originalCompareAtPrice": 42.0,
  "originalInventoryQuantity": 42,
  "originalRetailPrice": 42.0,
  "originalSku": "string",
  "packingDepth": 0,
  "packingHeight": 0,
  "packingWidth": 0,
  "position": 42,
  "priceUpdatedAt": {},
  "pricingOverride": "none",
  "pricingOverrideUplift": 42.0,
  "productType": "string",
  "publishProblem": {},
  "requiresShipping": true,
  "retailPrice": 42.0,
  "retriedPublishingAt": "2024-05-04T09:42:00+00:00",
  "retriedPublishingTimes": 42,
  "retryPublishing": true,
  "retryPublishingParams": {},
  "reviewReasonId": 42,
  "reviewStatus": "notReviewed",
  "status": "pending",
  "tags": [],
  "taxable": true,
  "uniqueOn": "none",
  "variantId": 42,
  "vendorName": "string",
  "vendorSku": "string"
}

Response examples (200)

{
  "allocationBufferOverride": 42,
  "barcode": "string",
  "cachedCompareAtPrice": "string",
  "cachedHandle": "string",
  "cachedName": "string",
  "cachedRetailPrice": "string",
  "cachedTags": [
    "string"
  ],
  "changesPending": false,
  "compareAtPrice": 42.0,
  "costPrice": 42.0,
  "countryOfOrigin": "string",
  "createdAt": "2024-05-04T09:42:00+00:00",
  "description": "string",
  "distanceUnit": "in",
  "externalGroupId": "string",
  "externalId": "string",
  "externalUrl": "string",
  "grams": 0,
  "handle": "string",
  "hash": "string",
  "hsCode": "string",
  "id": 42,
  "images": [],
  "inventoryFeedId": 42,
  "inventoryPolicy": "track",
  "inventoryQuantity": 42,
  "inventoryQuantityOverride": "none",
  "inventoryUpdatedAt": {},
  "lastFetchedAt": "2024-05-04T09:42:00+00:00",
  "locations": {},
  "manualInventoryPolicy": true,
  "manualInventoryQuantity": 42,
  "messages": {},
  "metaFields": {},
  "mpn": "string",
  "name": "string",
  "options": [],
  "originalCompareAtPrice": 42.0,
  "originalInventoryQuantity": 42,
  "originalRetailPrice": 42.0,
  "originalSku": "string",
  "packingDepth": 0,
  "packingHeight": 0,
  "packingWidth": 0,
  "position": 42,
  "priceUpdatedAt": {},
  "pricingOverride": "none",
  "pricingOverrideUplift": 42.0,
  "productType": "string",
  "publishProblem": {},
  "requiresShipping": true,
  "retailPrice": 42.0,
  "retriedPublishingAt": "2024-05-04T09:42:00+00:00",
  "retriedPublishingTimes": 42,
  "retryPublishing": true,
  "retryPublishingParams": {},
  "reviewReasonId": 42,
  "reviewStatus": "notReviewed",
  "status": "pending",
  "tags": [],
  "taxable": true,
  "uniqueOn": "none",
  "updatedAt": "2024-05-04T09:42:00+00:00",
  "variantId": 42,
  "vendorName": "string",
  "vendorSku": "string"
}

POST /inventory-feed-variants.json

Body Required

images object | null | array | boolean | integer | number | string Required

locations object | null | array | boolean | integer | number | string

messages object | null | array | boolean | integer | number | string

metaFields object | null | array | boolean | integer | number | string

options object | null | array | boolean | integer | number | string Required

publishProblem object | null | array | boolean | integer | number | string

retryPublishingParams object | null | array | boolean | integer | number | string

Responses

images object | null | array | boolean | integer | number | string Required

locations object | null | array | boolean | integer | number | string

messages object | null | array | boolean | integer | number | string

metaFields object | null | array | boolean | integer | number | string

options object | null | array | boolean | integer | number | string Required

publishProblem object | null | array | boolean | integer | number | string

retryPublishingParams object | null | array | boolean | integer | number | string