Path parameters
-
id
integer(int64) Required Numeric ID of the instance
Minimum value is
1.
Body
Required
allocation
object | null | array | boolean | integer | number | string Allocation
-
basePrice
number | null Base price
-
bundleQuantity
integer(int32) | null Required Bundle quantity
Default value is
0. -
bundleSaleItemId
integer(int32) | null Bundle sale item
-
channelCompareAtPrice
number | null Channel compare at price
-
channelPrice
number | null Channel price
-
cloneSaleItemId
integer(int32) | null Clone sale item
-
commercialInvoicePrice
number | null Commercial invoice price
-
costPrice
number | null Cost price
-
createdAt
string(date-time) Created at
-
discount
number | null Discount
discountAllocated
object | null | array | boolean | integer | number | string Discount allocated
discounts
object | null | array | boolean | integer | number | string Discounts
-
displayTax
number | null Display tax
-
dropshipProviderAddressId
integer(int32) | null Dropship provider address
-
dropshipProviderId
integer(int32) | null Dropship provider
-
externalId
string | null External
-
externalVariantId
string | null External variant
-
id
integer(int32) Id
-
inventoryProcessed
integer(int32) Required Inventory processed
Default value is
0. -
isBundle
boolean Required Is bundle
Default value is
false. -
location
string | null Location
-
locked
boolean Required Locked
Default value is
false. -
manualRouting
string | null Manual routing
Values are
dropshiporfulfill. -
name
string Required Name
notes
object | null | array | boolean | integer | number | string Notes
-
orderRouting
string | null Required Order routing
Values are
automated,manual, orignore. Default value isautomated. -
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
priceDisplay
object | null | array | boolean | integer | number | string Price display
-
priceExtended
number | null Price extended
properties
object | null | array | boolean | integer | number | string Properties
-
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. -
quantityRefunded
integer(int32) Required Quantity refunded
Default value is
0. -
quantityReturned
integer(int32) Required Quantity returned
Default value is
0. -
saleId
integer(int32) Required Sale
-
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. -
unallocated
boolean | null Required Unallocated
Default value is
false. -
updatedAt
string(date-time) Updated at
-
variantId
integer(int32) | null Variant
-
warehouseId
integer(int32) | null Warehouse
PUT
/sale-items/{id}.json
curl \
--request PUT 'http://api.example.com/v1/sale-items/{id}.json' \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "Content-Type: application/json" \
--data '{"allocation":{},"basePrice":42.0,"bundleQuantity":0,"bundleSaleItemId":42,"channelCompareAtPrice":42.0,"channelPrice":42.0,"cloneSaleItemId":42,"commercialInvoicePrice":42.0,"costPrice":42.0,"createdAt":"2025-05-04T09:42:00Z","discount":42.0,"discountAllocated":{},"discounts":{},"displayTax":42.0,"dropshipProviderAddressId":42,"dropshipProviderId":42,"externalId":"string","externalVariantId":"string","id":42,"inventoryProcessed":0,"isBundle":false,"location":"string","locked":false,"manualRouting":"dropship","name":"string","notes":{},"orderRouting":"automated","preventDuplicates":false,"price":0,"priceBase":{},"priceDisplay":{},"priceExtended":42.0,"properties":{},"quantity":1,"quantityCancelled":0,"quantityInvoiced":0,"quantityRefunded":0,"quantityReturned":0,"saleId":42,"subtotal":0,"tax":0,"taxRate":42.0,"taxable":false,"unallocated":false,"updatedAt":"2025-05-04T09:42:00Z","variantId":42,"warehouseId":42}'
Request examples
{
"allocation": {},
"basePrice": 42.0,
"bundleQuantity": 0,
"bundleSaleItemId": 42,
"channelCompareAtPrice": 42.0,
"channelPrice": 42.0,
"cloneSaleItemId": 42,
"commercialInvoicePrice": 42.0,
"costPrice": 42.0,
"createdAt": "2025-05-04T09:42:00Z",
"discount": 42.0,
"discountAllocated": {},
"discounts": {},
"displayTax": 42.0,
"dropshipProviderAddressId": 42,
"dropshipProviderId": 42,
"externalId": "string",
"externalVariantId": "string",
"id": 42,
"inventoryProcessed": 0,
"isBundle": false,
"location": "string",
"locked": false,
"manualRouting": "dropship",
"name": "string",
"notes": {},
"orderRouting": "automated",
"preventDuplicates": false,
"price": 0,
"priceBase": {},
"priceDisplay": {},
"priceExtended": 42.0,
"properties": {},
"quantity": 1,
"quantityCancelled": 0,
"quantityInvoiced": 0,
"quantityRefunded": 0,
"quantityReturned": 0,
"saleId": 42,
"subtotal": 0,
"tax": 0,
"taxRate": 42.0,
"taxable": false,
"unallocated": false,
"updatedAt": "2025-05-04T09:42:00Z",
"variantId": 42,
"warehouseId": 42
}