POST /sale-items.json

POST /sale-items.json
application/json

Body Required

Responses

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
}