Create a single product

post

https://api.epicorretailcloud.com/api/inventory/v1/product/

Perform Post HTTP Request

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Serializer used for the default Create aspect

store_ids

array of integers

required

A list of the stores to which this product will be assigned. Specify '0' for All Stores.

store_ids*

sku

string

required

length between 1 and 40

The SKU of the product.

description

string

required

length ≤ 50

The description of the product.

category_id

integer

required

The ID of the category assigned to the product.

price_by

integer

enum

required

The price by method.

0 - Store
2 - Enterprise
3 - Prompt for Price

Allowed:

price

string | null

^-?\d{0,9}(?:\.\d{0,4})?$

The retail price of the product. If null or not provided, product will be prompt for price.

desired_gp_percent

string

required

^-?\d{0,3}(?:\.\d{0,4})?$

The desired GP percentage.

default_selling_uom_id

integer

required

The ID of the default selling unit of measure.

order_quantity_multiple

string

required

^-?\d{0,9}(?:\.\d{0,8})?$

The default purchasing multiple for the product.

supplier_id

integer

required

The ID of the primary supplier.

default_purchasing_uom_id

integer

required

The ID of the default purchasing Unit of Measure.

product_tags

array of strings

Tags for the product.

product_tags

extended_description

string

length ≤ 1000

The extended description of the product.

replacement_cost

string | null

^-?\d{0,9}(?:\.\d{0,4})?$

The replacement cost.

default_selling_multiple

string

^-?\d{0,9}(?:\.\d{0,8})?$

The default selling multiple for the product.

upc

string

length between 1 and 50

The primary UPC code for the product.

upc_uom_id

integer

The id of the unit of measure used for the UPC code.

manufacturer_sku

string

length ≤ 40

The manufacturer's SKU number for product.

is_discountable

boolean

Can this product be discounted?

fractional_qty_type

integer

enum

The Fractional Quantity Type for the product.

0 - None
1 - POS Only
2 - Purchasing Only
3 - Both POS and Purchasing

Allowed:

serialization

integer

enum

Product serial number settings

1 - Not Serialized
2 - Recorded When Received
3 - Recorded Only When Sold

Allowed:

stocking_uom_id

integer

The unit of measure used for inventory stocking purposes.

track_inventory

boolean

Are on-hand inventory levels tracked for this item?

is_returnable

boolean

Can this item be returned by a customer?

is_taxable

boolean

Is this item taxable?

is_sellable

boolean

Can this item be sold?

prompt_pos_note

boolean

Prompt for POS Note?

season_id

integer

The ID of the season code.

related_item_code_id

integer

The ID of the related item code.

tax_code_id

integer

The ID of the tax code.

projected_weekly_velocity

string

^-?\d{0,9}(?:\.\d{0,8})?$

The projected weekly velocity.

min_op

string

^-?\d{0,9}(?:\.\d{0,8})?$

The minimum order point.

max_allowed_qoh

string

^-?\d{0,9}(?:\.\d{0,8})?$

The maximum allowed quantity on order.

is_op_protected

boolean

Is Order Point protected?

order_point

string

^-?\d{0,9}(?:\.\d{0,8})?$

The order point.

max_stock

string

^-?\d{0,9}(?:\.\d{0,8})?$

The max stock.

stocking_multiple

string

^-?\d{0,9}(?:\.\d{0,8})?$

The stocking multiple.

Headers

X-Active-Store

integer

required

The id of the active store to be used for this API invocation

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Response

201