# POST /sale-items.json

**POST /sale-items.json**




## Servers
- http://api.example.com/v1: http://api.example.com/v1 ()


## Authentication methods
- Bearer auth


## Parameters



### Body: application/json (object)

- **allocation** (object | null | array | boolean | integer | number | string)
  Allocation
- **basePrice** (number | null)
  Base price
- **bundleQuantity** (integer(int32) | null)
  Bundle quantity
- **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)
  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
- **inventoryProcessed** (integer(int32))
  Inventory processed
- **isBundle** (boolean)
  Is bundle
- **location** (string | null)
  Location
- **locked** (boolean)
  Locked
- **manualRouting** (string | null)
  Manual routing
- **name** (string)
  Name
- **notes** (object | null | array | boolean | integer | number | string)
  Notes
- **orderRouting** (string | null)
  Order routing
- **preventDuplicates** (boolean | null)
  Prevent duplicates
- **price** (number)
  Price
- **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))
  Quantity
- **quantityCancelled** (integer(int32))
  Quantity cancelled
- **quantityInvoiced** (integer(int32))
  Quantity invoiced
- **quantityRefunded** (integer(int32))
  Quantity refunded
- **quantityReturned** (integer(int32))
  Quantity returned
- **saleId** (integer(int32))
  Sale
- **subtotal** (number)
  Subtotal
- **tax** (number)
  Tax
- **taxRate** (number(float) | null)
  Tax rate
- **taxable** (boolean)
  Taxable
- **unallocated** (boolean | null)
  Unallocated
- **variantId** (integer(int32) | null)
  Variant
- **warehouseId** (integer(int32) | null)
  Warehouse


## Responses
### 200
Successful response

#### Body: application/json (object)
- **allocation** (object | null | array | boolean | integer | number | string)
  Allocation
- **basePrice** (number | null)
  Base price
- **bundleQuantity** (integer(int32) | null)
  Bundle quantity
- **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))
  Inventory processed
- **isBundle** (boolean)
  Is bundle
- **location** (string | null)
  Location
- **locked** (boolean)
  Locked
- **manualRouting** (string | null)
  Manual routing
- **name** (string)
  Name
- **notes** (object | null | array | boolean | integer | number | string)
  Notes
- **orderRouting** (string | null)
  Order routing
- **preventDuplicates** (boolean | null)
  Prevent duplicates
- **price** (number)
  Price
- **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))
  Quantity
- **quantityCancelled** (integer(int32))
  Quantity cancelled
- **quantityInvoiced** (integer(int32))
  Quantity invoiced
- **quantityRefunded** (integer(int32))
  Quantity refunded
- **quantityReturned** (integer(int32))
  Quantity returned
- **saleId** (integer(int32))
  Sale
- **subtotal** (number)
  Subtotal
- **tax** (number)
  Tax
- **taxRate** (number(float) | null)
  Tax rate
- **taxable** (boolean)
  Taxable
- **unallocated** (boolean | null)
  Unallocated
- **updatedAt** (string(date-time))
  Updated at
- **variantId** (integer(int32) | null)
  Variant
- **warehouseId** (integer(int32) | null)
  Warehouse


[Powered by Bump.sh](https://bump.sh)