API version

API reference / Get product by id

Get product by id

GET/v1/products/{product_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.

Authorization

x-api-keystringRequired

Your secret API key. Include it with every request.

Path parameters

product_idstringRequired

The unique identifier for the product you want to retrieve.

Response

idstringRequired

external_idstringRequired

skustring[]Required

codestringRequired

namestringRequired

descriptionstringRequired

statusProductStatusEnumRequired

Available options:APPROVEDPARTIALLY_APPROVEDPENDINGARCHIVED

product_categorystringRequired

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

product_subcategorystringRequired

Tax subcategory display label of the product (e.g. 'General Clothing'). List supported values from GET /products/categories.

tax_exemptbooleanRequired

sourceSourceEnumRequired

Available options:BIGCOMMERCEBESTBUYBUNNYCHARGEBEESHOPIFYSHOPLINEECWIDSTRIPEAMAZONTIKTOKCUSTOMUNKNOWNIMPORTZUORAAPIDECKQUICKBOOKSAPIAPPLE_APP_STOREGOOGLE_APP_STOREWALMARTPAYPALNETSUITEXEROMAXIORECURLYSALESFORCEETSYEBAYWIXSQUARESPACEWOOCOMMERCEMAGENTOMACYSBILLING_PLATFORMDEELRIPPLINGGUSTOFACEBOOKFRESHBOOKSOTHERORDWAYINSTAGRAMPINTERESTWAYFAIRWISHPOSTARGETNEWEGGGROUPONGOOGLE_EXPRESSNOCNOCMERCADO_LIBREMODALYSTNORDSTROMFAIREFRISBII_BILLINGSHOPWAREZOHOZOHO_BOOKSSAGE-INTACCTAIRWALLEXORBZENSKARMICROSOFT_DYNAMICS_365KICKSTARTERINTERNAL_ERPRILLETCAMPFIREKILL_BILLPROVISIONVERTEX_O_SERIESCHECKOUTCHAMPDUALENTRYODOOBILL_COMINTUIT_ENTERPRISE_SUITEACUMATICAPLENTYONEHYPERLINEOPENMETERSALEOR

connection_idstringRequired

classification_failedbooleanRequired

store_namestring

source_taxonomy_typestring

source_taxonomy_codestring

source_taxonomy_idstring

source_taxonomy_namestring

source_taxonomy_categoriesobject[]

source_taxonomy_metadataobject

200

Successfully retrieved product by id

401

Unauthenticated request.

404

Resource Not Found

422

Validation error

500

Internal server error

cURL

GET /v1/products/{product_id}

-H "x-api-key: ***"

Example request

https://api.trykintsugi.com/v1/products/{product_id}

Response

{

"id": "prod_xR9t8P1wMK6aQ",

"external_id": "prod_123",

"code": "CODE_1234",

"name": "Test Product",

"description": "This is a test product description.",

"status": "APPROVED",

"product_category": "Physical",

"product_subcategory": "General Clothing",

"tax_exempt": false,

"source": "SHOPIFY",

"classification_failed": false

}