PUT /purchase-items/{id}.json

Bearer auth

Path parameters

id integer(int64) Required

Numeric ID of the instance

Minimum value is 1.

application/json

Body Required

bundlePurchaseItemId integer(int32) | null

Bundle purchase item
bundleQuantity integer(int32) | null Required

Bundle quantity

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

Clone purchase item
commissionRefund string | null Required

Commission refund

Values are none or full. Default value is none.
commissionRetained number | null Required

Commission retained

Default value is 0.
commissionTaxRate number | null Required

Commission tax rate

Default value is 0.
commissionTaxRetained number | null Required

Commission tax retained

Default value is 0.
createdAt string(date-time)

Created at
dropshipProviderInventoryFeedVariantId integer(int32) | null

Dropship provider inventory feed variant
exchangeIso string | null

Exchange iso
exchangeRate number(float) | null

Exchange rate
id integer(int32)

Id
inventoryProcessed integer(int32) Required

Inventory processed

Default value is 0.
isBundle boolean Required

Is bundle

Default value is false.
locked boolean Required

Locked

Default value is false.
name string Required

Name
notes object | null | array | boolean | integer | number | string

Notes

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
preventDuplicates boolean | null Required

Prevent duplicates

Default value is false.
price number Required

Price

Default value is 0.
priceBase object | null | array | boolean | integer | number | string

Price base

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
priceDisplay object | null | array | boolean | integer | number | string

Price display

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
priceExtended number | null

Price extended
properties object | null | array | boolean | integer | number | string

Properties

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
purchaseId integer(int32) Required

Purchase
purchaseImportExternalId string | null

Purchase import external
quantity integer(int32) Required

Quantity

Default value is 1.
quantityCancelled integer(int32) Required

Quantity cancelled

Default value is 0.
quantityInvoiced integer(int32) Required

Quantity invoiced

Default value is 0.
quantityReturned integer(int32) Required

Quantity returned

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

Sale item
subtotal number Required

Subtotal

Default value is 0.
tax number Required

Tax

Default value is 0.
taxRate number(float) | null

Tax rate
taxable boolean Required

Taxable

Default value is false.
updatedAt string(date-time)

Updated at
variantId integer(int32) | null

Variant

PUT /purchase-items/{id}.json

curl \
 --request PUT 'http://api.example.com/v1/purchase-items/{id}.json' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"bundlePurchaseItemId":42,"bundleQuantity":0,"clonePurchaseItemId":42,"commissionRefund":"none","commissionRetained":0,"commissionTaxRate":0,"commissionTaxRetained":0,"createdAt":"2025-05-04T09:42:00Z","dropshipProviderInventoryFeedVariantId":42,"exchangeIso":"string","exchangeRate":42.0,"id":42,"inventoryProcessed":0,"isBundle":false,"locked":false,"name":"string","notes":{},"preventDuplicates":false,"price":0,"priceBase":{},"priceDisplay":{},"priceExtended":42.0,"properties":{},"purchaseId":42,"purchaseImportExternalId":"string","quantity":1,"quantityCancelled":0,"quantityInvoiced":0,"quantityReturned":0,"saleItemId":42,"subtotal":0,"tax":0,"taxRate":42.0,"taxable":false,"updatedAt":"2025-05-04T09:42:00Z","variantId":42}'

Request examples

{
  "bundlePurchaseItemId": 42,
  "bundleQuantity": 0,
  "clonePurchaseItemId": 42,
  "commissionRefund": "none",
  "commissionRetained": 0,
  "commissionTaxRate": 0,
  "commissionTaxRetained": 0,
  "createdAt": "2025-05-04T09:42:00Z",
  "dropshipProviderInventoryFeedVariantId": 42,
  "exchangeIso": "string",
  "exchangeRate": 42.0,
  "id": 42,
  "inventoryProcessed": 0,
  "isBundle": false,
  "locked": false,
  "name": "string",
  "notes": {},
  "preventDuplicates": false,
  "price": 0,
  "priceBase": {},
  "priceDisplay": {},
  "priceExtended": 42.0,
  "properties": {},
  "purchaseId": 42,
  "purchaseImportExternalId": "string",
  "quantity": 1,
  "quantityCancelled": 0,
  "quantityInvoiced": 0,
  "quantityReturned": 0,
  "saleItemId": 42,
  "subtotal": 0,
  "tax": 0,
  "taxRate": 42.0,
  "taxable": false,
  "updatedAt": "2025-05-04T09:42:00Z",
  "variantId": 42
}

PUT /purchase-items/{id}.json

Path parameters

Body Required

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

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

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

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