Sign in

v1

latestOpenAPI 3.0.02026-07-12414931.1 MB
Products

Update Product

The Update Product API allows users to modify the details of an existing product identified by its unique product_id. You can retrieve supported categories and subcategories from GET /products/categories endpoint

put/v1/products/{product_id}

Path parameters

product_idstring required

Unique identifier of the product to be updated.

Unique identifier of the product to be updated.

Request body

idstring

The unique identifier of the product to be updated.

external_idstring

External identifier provided for the product, typically by the source system.

skustring[]
namestring required

Name of the product.

descriptionstring

Description of the product.

status'APPROVED' | 'PARTIALLY_APPROVED' | 'PENDING'
product_categorystring required

Main category of the product. For example, Physical, Digital, etc. You can retrieve supported categories from GET /products/categories endpoint

product_subcategorystring required

Subcategory of the product. For example, General Clothing, UNKNOWN, etc. You can retrieve supported subcategories from GET /products/categories endpoint

tax_exemptboolean required

Indicates whether the product is tax-exempt.

classification_failedboolean

Indicates if the product classification failed.

Response

Successfully retrieved product by id

idstring required
external_idstring required
skustring[] required
codestring required
namestring required
descriptionstring required
status'APPROVED' | 'PARTIALLY_APPROVED' | 'PENDING' required
product_categorystring required

Main category of the product. For example, Physical, Digital, etc. You can retrieve supported categories from GET /products/categories endpoint

product_subcategorystring required

Subcategory of the product. For example, General Clothing, UNKNOWN, etc. You can retrieve supported subcategories from GET /products/categories endpoint

tax_exemptboolean required
source'BIGCOMMERCE' | 'BESTBUY' | 'BUNNY' | 'CHARGEBEE' | 'SHOPIFY' | 'STRIPE' | 'AMAZON' | 'TIKTOK' | 'CUSTOM' | 'UNKNOWN' | 'IMPORT' | 'ZUORA' | 'APIDECK' | 'QUICKBOOKS' | 'API' | 'APPLE_APP_STORE' | 'GOOGLE_APP_STORE' | 'WALMART' | 'PAYPAL' | 'NETSUITE' | 'XERO' | 'MAXIO' | 'RECURLY' | 'SALESFORCE' | 'ETSY' | 'EBAY' | 'WIX' | 'SQUARESPACE' | 'WOOCOMMERCE' | 'MAGENTO' | 'BILLING_PLATFORM' | 'DEEL' | 'RIPPLING' | 'GUSTO' | 'FACEBOOK' | 'OTHER' | 'ORDWAY' | 'INSTAGRAM' | 'PINTEREST' | 'WAYFAIR' | 'WISH' | 'POS' | 'TARGET' | 'NEWEGG' | 'GROUPON' | 'GOOGLE_EXPRESS' | 'NOCNOC' | 'MERCADO_LIBRE' | 'MODALYST' | 'NORDSTROM' | 'FAIRE' | 'SHOPWARE' | 'ZOHO' | 'SAGE-INTACCT' | 'AIRWALLEX' | 'ORB' | 'ZENSKAR' | 'MICROSOFT_DYNAMICS_365' | 'KICKSTARTER' | 'INTERNAL_ERP' required
connection_idstring required
classification_failedboolean required