POST /sale-items.json
Body Required
allocation object | null | array | boolean | integer | number | string
-
basePrice number | null
Base price
-
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
-
discount number | null
Discount
discountAllocated object | null | array | boolean | integer | number | string
Any of: Discount allocated
Discount allocated
Discount allocated
Discount allocated
Discount allocated
Discount allocated
-
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
-
Inventory processed
Default value is
0. -
Is bundle
Default value is
false. -
location string | null
Location
-
Locked
Default value is
false. -
manualRouting string | null
Manual routing
Values are
dropshiporfulfill. -
Name
-
Order routing
Values are
automated,manual, orignore. Default value isautomated. -
Prevent duplicates
Default value is
false. -
Price
Default value is
0. priceDisplay object | null | array | boolean | integer | number | string
-
priceExtended number | null
Price extended
properties object | null | array | boolean | integer | number | string
-
Quantity
Default value is
1. -
Quantity cancelled
Default value is
0. -
Quantity invoiced
Default value is
0. -
Quantity refunded
Default value is
0. -
Quantity returned
Default value is
0. -
Sale
-
Subtotal
Default value is
0. -
Tax
Default value is
0. -
taxRate number(float) | null
Tax rate
-
Taxable
Default value is
false. -
Unallocated
Default value is
false. -
variantId integer(int32) | null
Variant
-
warehouseId integer(int32) | null
Warehouse
POST /sale-items.json
curl \
-X POST http://api.example.com/v1/sale-items.json \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{"allocation":{},"basePrice":42.0,"bundleQuantity":0,"bundleSaleItemId":42,"channelCompareAtPrice":42.0,"channelPrice":42.0,"cloneSaleItemId":42,"commercialInvoicePrice":42.0,"costPrice":42.0,"discount":42.0,"discountAllocated":{},"discounts":{},"displayTax":42.0,"dropshipProviderAddressId":42,"dropshipProviderId":42,"externalId":"string","externalVariantId":"string","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,"variantId":42,"warehouseId":42}'
Request example
{
"allocation": {},
"basePrice": 42.0,
"bundleQuantity": 0,
"bundleSaleItemId": 42,
"channelCompareAtPrice": 42.0,
"channelPrice": 42.0,
"cloneSaleItemId": 42,
"commercialInvoicePrice": 42.0,
"costPrice": 42.0,
"discount": 42.0,
"discountAllocated": {},
"discounts": {},
"displayTax": 42.0,
"dropshipProviderAddressId": 42,
"dropshipProviderId": 42,
"externalId": "string",
"externalVariantId": "string",
"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,
"variantId": 42,
"warehouseId": 42
}
Response examples (200)
{
"allocation": {},
"basePrice": 42.0,
"bundleQuantity": 0,
"bundleSaleItemId": 42,
"channelCompareAtPrice": 42.0,
"channelPrice": 42.0,
"cloneSaleItemId": 42,
"commercialInvoicePrice": 42.0,
"costPrice": 42.0,
"createdAt": "2024-05-04T09:42:00+00:00",
"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": "2024-05-04T09:42:00+00:00",
"variantId": 42,
"warehouseId": 42
}