Sign in
Products

Get product by id

The Get Product By ID API retrieves detailed information about a single product by its unique ID. This API helps in viewing the specific details of a product, including its attributes, status, and categorization.

get/v1/products/{product_id}

Path parameters

product_idstring required

The unique identifier for the product you want to retrieve.

The unique identifier for the product you want to retrieve.

Headers

x-organization-idstring nullable required

The unique identifier for the organization making the request

The unique identifier for the organization making the request

Response

Successfully retrieved product by id

idstring required
external_idstring required
skustring[] nullable required
codestring required
namestring required
descriptionstring nullable required
status'APPROVED' | 'PARTIALLY_APPROVED' | 'PENDING' | 'ARCHIVED' 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' | 'SHOPLINE' | 'ECWID' | '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' | 'MACYS' | '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' | 'RILLET' | 'CAMPFIRE' | 'KILL_BILL' | 'PROVISION' | 'VERTEX_O_SERIES' | 'CHECKOUTCHAMP' | 'DUALENTRY' | 'ODOO' | 'BILL_COM' | 'INTUIT_ENTERPRISE_SUITE' | 'ACUMATICA' required
connection_idstring nullable required
classification_failedboolean nullable required
store_namestring nullable
source_taxonomy_typestring nullable
source_taxonomy_codestring nullable
source_taxonomy_idstring nullable
source_taxonomy_namestring nullable
source_taxonomy_categoriesobject[] nullable
source_taxonomy_metadataobject nullable

Changes

Changed in 1 of the 4 revisions of this API.5159

  • 6ba4f4c774c35159See the full diff
    • ▲

      added the new required header request parameter x-organization-id

      new-required-request-parameter

    • ▲

      response property classification_failed list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • ▲

      response property connection_id list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • ▲

      response property description list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • ▲

      response property sku list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • ●

      added the new ACUMATICA enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new ARCHIVED enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new BILL_COM enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new CAMPFIRE enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new CHECKOUTCHAMP enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new DUALENTRY enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new ECWID enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new INTUIT_ENTERPRISE_SUITE enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new KILL_BILL enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new MACYS enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new ODOO enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PROVISION enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new RILLET enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new SHOPLINE enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new VERTEX_O_SERIES enum value to the response property for the response status

      response-property-enum-value-added

    • ○

      the endpoint scheme security APIKeyHeader was added to the API

      api-security-added

    • ○

      the endpoint scheme security APIKeyHeader AND CustomHeader was removed from the API

      api-security-removed

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    This revision's changelog hit the recording limit, so it may not list every change to this endpoint.

    This revision also has 362 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog