v1

latestOpenAPI 3.0.02026-07-12414931.1 MB

Products

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 GET /products/categories endpoint

post/v1/products

Request body

external_idstring required

A unique external identifier for the product.

namestring required

The name of the product.

descriptionstring

A description of the product.

status'APPROVED' | 'PARTIALLY_APPROVED' | 'PENDING'

product_category'PHYSICAL' | 'DIGITAL' | 'SERVICE' | 'UNKNOWN' | 'MISCELLANEOUS' required

product_subcategory'UNKNOWN' | 'SAAS' | 'DIGITAL_GENERAL' | 'B2B_SAAS' | 'SOFTWARE_ON_PERSONAL_PROPERTY' | 'SOFTWARE_DOWNLOADED' | 'CUSTOM_SOFTWARE_ON_PERSONAL_PROPERTY' | 'CUSTOM_SOFTWARE_DOWNLOADED' | 'CUSTOMIZATION_OF_SOFTWARE' | 'B2C_SAAS' | 'IAAS' | 'SERVICE_GENERAL' | 'PROFESSIONAL_SERVICE' | 'TANGIBLE_PROPERTY_SERVICE' | 'REAL_PROPERTY_SERVICE' | 'BUSINESS_SERVICE' | 'PERSONAL_SERVICE' | 'AMUSEMENT_SERVICE' | 'MEDICAL_SERVICES' | 'SECURITY_SERVICES_ELECTRONIC_MONITORING' | 'FACILITY_MAINTENANCE_REAL_PROPERTY_LABOR_ONLY' | 'COMMERCIAL_RENOVATION_CAPITAL_IMPROVEMENT_LABOR' | 'COMMERCIAL_CONSTRUCTION_EXISTING_BUILDINGS_LABOR' | 'PHYSICAL_GENERAL' | 'GENERAL_CLOTHING' | 'CATERING' | 'GROCERY_FOOD' | 'LEASES_AND_RENTALS_MOTOR_VEHICLES' | 'LEASES_AND_RENTALS_TANGIBLE_MEDIA_PROPERTY' | 'MACHINERY' | 'RAW_MATERIALS' | 'UTILITIES_FUEL' | 'MEDICAL_DEVICES' | 'MEDICINES' | 'NEWSPAPERS' | 'PERIODICALS' | 'GENERAL_OCCASIONAL_SALES' | 'MOTOR_VEHICLES_OCCASIONAL_SALES' | 'GENERAL_OPTIONAL_MAINTENANCE_CONTRACTS' | 'PARTS_PURCHASED_OPTIONAL_MAINTENANCE_CONTRACTS' | 'GENERAL_POLLUTION_CONTROL_EQUIPMENT' | 'GENERAL_TRADE_INS' | 'FOOD_VENDING_MACHINE' | 'MERCHANDISE_VENDING_MACHINE' | 'SUPPLEMENTS' | 'FEMININE_HYGIENE' | 'ORAL_HYGIENE' | 'BEVERAGE_NUTRITION_LABEL_ENERGY_SHOTS_AND_DRINKS' | 'DIETARY_SUPPLEMENTS_SUPPLEMENT_FACTS_LABEL_RETAIL' | 'ADVERTISING_MEDIA_INSERT_DISTRIBUTED_BY_NEWSPAPER' | 'ADVERTISING_MEDIA_INSERT_DISTRIBUTED_BY_MAIL_PACKAGE' | 'MAINTENANCE_SERVICES_MATERIALS' | 'NUTRITION_BARS' | 'SHIPPING' | 'GIFT_CARD' | 'CREDIT_CARD_SURCHARGES' | 'CREDIT_CARD_FEES' | 'MISCELLANEOUS_EXEMPT' | 'DISCOUNT' | 'GIFT_WRAPPING' | 'HANDLING' | 'TAX' | 'DANCE_LESSONS' required

tax_exemptboolean required

Specifies whether the product is tax-exempt.

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'

Response

Successfully created product

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