Create product
The Create Product API allows users to manually create a new product in the system. This includes specifying product details such as category, subcategory, and tax exemption status, etc. You can retrieve supported categories and subcategories from the GET /products/categories endpoint, or browse the full catalog with descriptions and examples in the Product Categories guide.
Idempotent on ``(organization_id, external_id, source)`` for connectionless
creates (CP-4726): a re-POST of an existing identity returns ``200``. A live
match is unchanged; a previously deleted match is revived (status returns to
``PENDING``). Use PUT to update fields.
Authorization
Body
A unique external identifier for the product.
The name of the product.
A description of the product.
The approval status of the product.
APPROVEDPARTIALLY_APPROVEDPENDINGARCHIVEDThe high-level category of the product.
PhysicalDigitalMiscServicesTax subcategory display label within the category (e.g. 'General Clothing'). Together with product_category it resolves to a product tax code; an unrecognized pair returns 400. List supported values from GET /products/categories.
Specifies whether the product is tax-exempt.
Indicates the source of the product.
BIGCOMMERCEBESTBUYBUNNYCHARGEBEESHOPIFYSHOPLINEECWIDSTRIPEAMAZONTIKTOKCUSTOMUNKNOWNIMPORTZUORAAPIDECKQUICKBOOKSAPIAPPLE_APP_STOREGOOGLE_APP_STOREWALMARTPAYPALNETSUITEXEROMAXIORECURLYSALESFORCEETSYEBAYWIXSQUARESPACEWOOCOMMERCEMAGENTOMACYSBILLING_PLATFORMDEELRIPPLINGGUSTOFACEBOOKFRESHBOOKSOTHERORDWAYINSTAGRAMPINTERESTWAYFAIRWISHPOSTARGETNEWEGGGROUPONGOOGLE_EXPRESSNOCNOCMERCADO_LIBREMODALYSTNORDSTROMFAIREFRISBII_BILLINGSHOPWAREZOHOZOHO_BOOKSSAGE-INTACCTAIRWALLEXORBZENSKARMICROSOFT_DYNAMICS_365KICKSTARTERINTERNAL_ERPRILLETCAMPFIREKILL_BILLPROVISIONVERTEX_O_SERIESCHECKOUTCHAMPDUALENTRYODOOBILL_COMINTUIT_ENTERPRISE_SUITEACUMATICAPLENTYONEHYPERLINEOPENMETERSALEORResponse
APPROVEDPARTIALLY_APPROVEDPENDINGARCHIVEDMain category of the product. For example, Physical, Digital, etc. You can retrieve supported categories from GET /products/categories endpoint
Tax subcategory display label of the product (e.g. 'General Clothing'). List supported values from GET /products/categories.
BIGCOMMERCEBESTBUYBUNNYCHARGEBEESHOPIFYSHOPLINEECWIDSTRIPEAMAZONTIKTOKCUSTOMUNKNOWNIMPORTZUORAAPIDECKQUICKBOOKSAPIAPPLE_APP_STOREGOOGLE_APP_STOREWALMARTPAYPALNETSUITEXEROMAXIORECURLYSALESFORCEETSYEBAYWIXSQUARESPACEWOOCOMMERCEMAGENTOMACYSBILLING_PLATFORMDEELRIPPLINGGUSTOFACEBOOKFRESHBOOKSOTHERORDWAYINSTAGRAMPINTERESTWAYFAIRWISHPOSTARGETNEWEGGGROUPONGOOGLE_EXPRESSNOCNOCMERCADO_LIBREMODALYSTNORDSTROMFAIREFRISBII_BILLINGSHOPWAREZOHOZOHO_BOOKSSAGE-INTACCTAIRWALLEXORBZENSKARMICROSOFT_DYNAMICS_365KICKSTARTERINTERNAL_ERPRILLETCAMPFIREKILL_BILLPROVISIONVERTEX_O_SERIESCHECKOUTCHAMPDUALENTRYODOOBILL_COMINTUIT_ENTERPRISE_SUITEACUMATICAPLENTYONEHYPERLINEOPENMETERSALEORAn existing product matched on external_id and source; no new product was created. A live match is returned unchanged. A previously deleted match is revived and re-enters classification (its status returns to PENDING), so it may differ from its pre-deletion state.
Successfully created product
Unauthenticated request.
Validation error
Internal server error