Products

Create or update a product

Upserts by external_id within the store. Sent product_units are merged in place — units omitted from the list are never deleted by this operation (use deleteProductUnit to remove one).

post/api/v1/products

Request

  • Base URL: https://api.firework.com
  • URL: https://api.firework.com/api/v1/products
  • Auth: OAuth 2 (client credentials, token URL /oauth/token, scopes: products:write)

Request body

handlestring
namestring
optionsobject[]
descriptionstring
categorystring
urlstring

Product-level unit field for simple products: applies to the product's single unit.

business_store_idstring required
brandstring
pricenumber

Product-level unit field for simple products: applies to the product's single unit.

quantityinteger

Product-level unit field for simple products: applies to the product's single unit.

skustring nullable

Product-level unit field for simple products: applies to the product's single unit.

external_idstring
original_pricenumber nullable

Product-level unit field for simple products: applies to the product's single unit.

gtinstring nullable

Product-level unit field for simple products: applies to the product's single unit.

mpnstring nullable

Product-level unit field for simple products: applies to the product's single unit.

shippingobject
hide_priceboolean
subtitlestring
barcodestring nullable

Product-level unit field for simple products: applies to the product's single unit.

Response

Upserted product

handlestring nullable
idstring
namestring
optionsobject[]
descriptionstring nullable
categorystring nullable
currencystring nullable
business_store_idstring
brandstring nullable
external_idstring nullable
shippingobject nullable
hide_priceboolean
subtitlestring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.