Skip to main content

Create a product

Create a product.

Authorizations:Token
Request Body Schema:
The new Product resource
og_meta_tags_typestringDefault: "A"Enum: "A""C"Example: "A"
og_meta_tagsstring
market_pricenumber
pin_codes_enabledboolean
auto_pin_codesboolean
participate_saleboolean
discount_typestringDefault: "sale_percent"Example: "sale_percent"
sale_price_valuenumber
apply_sale_to_wholesaleboolean
available_for_backorderbooleanDefault: trueExample: true
backorder_limitintegerExample: "0"
cost_pricenumberExample: "5.75"
fitment_typestringDefault: "regular"Example: "regular"
fitmentsArray of strings
stickersArray of integers
facebook_marketing_enabledbooleanDefault: trueExample: true
google_feed_enabledbooleanDefault: trueExample: true
tagsArray of stringsExample: new
skustring[1 .. 32] charactersExample: "0001"
namestring[1 .. 255] charactersExample: "Product name"
descriptionstringExample: "Full description"
brief_descriptionstringExample: "Description"
meta_tagsstring
meta_description_typestringDefault: "A"Enum: "A""C"Example: "A"
meta_descriptionstring
meta_titlestring
pricenumberExample: "9.99"
enabledbooleanDefault: trueExample: true
weightnumberExample: "1.5"
free_shippingboolean
taxablebooleanDefault: trueExample: true
arrival_datestring or nullExample: "2021-10-22T00:00:00+00:00"
inventory_traceablebooleanDefault: trueExample: true
amountintegerDefault: 1000Example: "1000"
product_classstring or nullExample: "Fashion"
tax_classstring or nullExample: "VAT"
membershipsArray of stringsExample: Wholesaler
clean_urlstring

Responses

201Product resource created
Response schema:
Product resource created
og_meta_tagsstring
market_pricenumber
pin_codes_enabledboolean
auto_pin_codesboolean
participate_saleboolean
discount_typestringDefault: "sale_percent"Example: "sale_percent"
sale_price_valuenumber
apply_sale_to_wholesaleboolean
available_for_backorderboolean
backorder_limitinteger
cost_pricenumber
fitment_typestringDefault: "regular"Example: "regular"
fitmentsArray of strings
stickersArray of integers
facebook_marketing_enabledboolean
google_feed_enabledboolean
tagsArray of objects
Array
idinteger
namestring
idinteger
skustring
namestring
descriptionstring
brief_descriptionstring
meta_tagsstring
meta_descriptionstring
meta_titlestring
pricenumber
enabledboolean
weightnumber
free_shippingboolean
taxableboolean
create_datestring
update_datestring
arrival_datestring
inventory_traceableboolean
amountinteger
product_classobject or null
  • object
idinteger
namestring
tax_classobject or null
  • object
idinteger
namestring
membershipsArray of objects
Array
idinteger
namestring
enabledboolean
clean_urlstring
imagesArray of objects
Array
idinteger
positioninteger
altstring
urlstring
widthinteger
heightinteger
400Invalid input
422Unprocessable entity