Create or update product

IMPORTANT: Hike will not accept manual cost price or inventory updates without corresponding purchase orders or sales transactions if weighted Average Cost Price feature is active in Hike.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Product model

This is your IdNumber you received earlier

int32

Parent ID for variant products.

string
required

Product name

string

Product description

string

Unique SKU number.

string

Unique barcode ID

uuid

Product's primary image

int32

Product's brand ID

string

Product's brand name

int32

Season tag ID if its a seasonal product

string

Season tag name if its a seasonal product

string

Supplier code - relevant if using an integrated accounting software

string

Sales code - relevant if using an integrated accounting software

string

Purchase code - relevant if using an integrated accounting software

string

Inventory asset account code - relevant if using an integrated accounting software

string

Season tag name if its a seasonal product

boolean

Season tag name if its a seasonal product

boolean

IS this a product with variants?

boolean

Inventory tracking status (on/off)

boolean

Allow selling when recorded inventory is 0 or less.

double

Amount of additional reward points awarded to customer on purchase of this product.

date-time

Record first created date

date-time

Record last update date

boolean

Activate/disable meta title and description - useful for eCommerce

string

Meta title for SEO

string

Meta description for SEO

string

Season tag name if its a seasonal product

boolean

EnableUnitOfMeasure

product_tags
array of objects

Custom product filter tags

product_tags
product_type
array of objects

Product's parent type (category)

product_type
sales_channels
array of objects

Activated sales channels e.g.: POS, eCommerce.

sales_channels
product_outlets
array of objects

Outlets this product is available at

product_outlets
product_suppliers
array of objects

Associated suppliers

product_suppliers
product_attributes
array of objects

Product attributes (e.g.: colour, size)

product_attributes
product_variants
array of objects

Prodyct variants (e.g.: Blue/5, Red/5, Green/5)

product_variants
additional_images
array of objects

Additional (optional) product images

additional_images
product_extras
array of objects

Extra options available with this product e.g.: Extra cheese

product_extras
product_unit_of_measures
array of objects

Custom product filter tags

product_unit_of_measures
boolean

Is active or not?

int32
Headers
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Response
200

OK

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here!