POST /variant-inventory-updates.json

Bearer auth

application/json

Body Required

actionResource string | null

Action resource

Values are adjustment, inventory_transfer_item, fulfillment_item, dropshipment_item, goods_receipt_item, inventory_feed_variant, sale_return_item, purchase_return_item, sale_item, or purchase_item.
actionType string | null Required

Action type

Values are create, update, destroy, or manual. Default value is manual.
adjustmentId integer(int32) | null

Adjustment
adjustments integer(int32) | null

Adjustments
available integer(int32) | null

Available
dropshipmentItemId integer(int32) | null

Dropshipment item
dropshipmentItems integer(int32) | null

Dropshipment items
feeds integer(int32) | null

Feeds
fulfillmentItemId integer(int32) | null

Fulfillment item
goodsReceiptItemId integer(int32) | null

Goods receipt item
hasFeeds boolean | null

Has feeds
inventoryAllocated integer(int32) | null

Inventory allocated
inventoryFeedVariantId integer(int32) | null

Inventory feed variant
inventoryQuantity integer(int32) | null

Inventory quantity
inventoryTransferItemId integer(int32) | null

Inventory transfer item
inventoryTrigger string | null

Inventory trigger

Values are automated or manual.
purchaseItemId integer(int32) | null

Purchase item
purchaseReturnItemId integer(int32) | null

Purchase return item
received integer(int32) | null

Received
saleItemId integer(int32) | null

Sale item
saleReturnItemId integer(int32) | null

Sale return item
shipped integer(int32) | null

Shipped
sold integer(int32) | null

Sold
totalIn integer(int32) | null

Total in
totalOut integer(int32) | null

Total out
transfersIn integer(int32) | null

Transfers in
transfersOut integer(int32) | null

Transfers out
userId integer(int32) | null

User
variantId integer(int32) | null

Variant

Responses

200 application/json

Successful response
Hide response attributes Show response attributes object
- actionResource string | null
  
  Action resource
  
  Values are adjustment, inventory_transfer_item, fulfillment_item, dropshipment_item, goods_receipt_item, inventory_feed_variant, sale_return_item, purchase_return_item, sale_item, or purchase_item.
- actionType string | null Required
  
  Action type
  
  Values are create, update, destroy, or manual. Default value is manual.
- adjustmentId integer(int32) | null
  
  Adjustment
- adjustments integer(int32) | null
  
  Adjustments
- available integer(int32) | null
  
  Available
- createdAt string(date-time)
  
  Created at
- dropshipmentItemId integer(int32) | null
  
  Dropshipment item
- dropshipmentItems integer(int32) | null
  
  Dropshipment items
- feeds integer(int32) | null
  
  Feeds
- fulfillmentItemId integer(int32) | null
  
  Fulfillment item
- goodsReceiptItemId integer(int32) | null
  
  Goods receipt item
- hasFeeds boolean | null
  
  Has feeds
- id integer(int32)
  
  Id
- inventoryAllocated integer(int32) | null
  
  Inventory allocated
- inventoryFeedVariantId integer(int32) | null
  
  Inventory feed variant
- inventoryQuantity integer(int32) | null
  
  Inventory quantity
- inventoryTransferItemId integer(int32) | null
  
  Inventory transfer item
- inventoryTrigger string | null
  
  Inventory trigger
  
  Values are automated or manual.
- purchaseItemId integer(int32) | null
  
  Purchase item
- purchaseReturnItemId integer(int32) | null
  
  Purchase return item
- received integer(int32) | null
  
  Received
- saleItemId integer(int32) | null
  
  Sale item
- saleReturnItemId integer(int32) | null
  
  Sale return item
- shipped integer(int32) | null
  
  Shipped
- sold integer(int32) | null
  
  Sold
- totalIn integer(int32) | null
  
  Total in
- totalOut integer(int32) | null
  
  Total out
- transfersIn integer(int32) | null
  
  Transfers in
- transfersOut integer(int32) | null
  
  Transfers out
- updatedAt string(date-time)
  
  Updated at
- userId integer(int32) | null
  
  User
- variantId integer(int32) | null
  
  Variant

POST /variant-inventory-updates.json

curl \
 --request POST 'http://api.example.com/v1/variant-inventory-updates.json' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"actionResource":"adjustment","actionType":"manual","adjustmentId":42,"adjustments":42,"available":42,"dropshipmentItemId":42,"dropshipmentItems":42,"feeds":42,"fulfillmentItemId":42,"goodsReceiptItemId":42,"hasFeeds":true,"inventoryAllocated":42,"inventoryFeedVariantId":42,"inventoryQuantity":42,"inventoryTransferItemId":42,"inventoryTrigger":"automated","purchaseItemId":42,"purchaseReturnItemId":42,"received":42,"saleItemId":42,"saleReturnItemId":42,"shipped":42,"sold":42,"totalIn":42,"totalOut":42,"transfersIn":42,"transfersOut":42,"userId":42,"variantId":42}'

Request examples

{
  "actionResource": "adjustment",
  "actionType": "manual",
  "adjustmentId": 42,
  "adjustments": 42,
  "available": 42,
  "dropshipmentItemId": 42,
  "dropshipmentItems": 42,
  "feeds": 42,
  "fulfillmentItemId": 42,
  "goodsReceiptItemId": 42,
  "hasFeeds": true,
  "inventoryAllocated": 42,
  "inventoryFeedVariantId": 42,
  "inventoryQuantity": 42,
  "inventoryTransferItemId": 42,
  "inventoryTrigger": "automated",
  "purchaseItemId": 42,
  "purchaseReturnItemId": 42,
  "received": 42,
  "saleItemId": 42,
  "saleReturnItemId": 42,
  "shipped": 42,
  "sold": 42,
  "totalIn": 42,
  "totalOut": 42,
  "transfersIn": 42,
  "transfersOut": 42,
  "userId": 42,
  "variantId": 42
}

Response examples (200)

{
  "actionResource": "adjustment",
  "actionType": "manual",
  "adjustmentId": 42,
  "adjustments": 42,
  "available": 42,
  "createdAt": "2025-05-04T09:42:00Z",
  "dropshipmentItemId": 42,
  "dropshipmentItems": 42,
  "feeds": 42,
  "fulfillmentItemId": 42,
  "goodsReceiptItemId": 42,
  "hasFeeds": true,
  "id": 42,
  "inventoryAllocated": 42,
  "inventoryFeedVariantId": 42,
  "inventoryQuantity": 42,
  "inventoryTransferItemId": 42,
  "inventoryTrigger": "automated",
  "purchaseItemId": 42,
  "purchaseReturnItemId": 42,
  "received": 42,
  "saleItemId": 42,
  "saleReturnItemId": 42,
  "shipped": 42,
  "sold": 42,
  "totalIn": 42,
  "totalOut": 42,
  "transfersIn": 42,
  "transfersOut": 42,
  "updatedAt": "2025-05-04T09:42:00Z",
  "userId": 42,
  "variantId": 42
}