> For the complete documentation index, see [llms.txt](https://talque.gitbook.io/public/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://talque.gitbook.io/public/json-api/products/talque-product-api.md).

# Talque Product API

## Read products by ID

> Looks up products by catalog and product IDs.

```json
{"openapi":"3.0.3","info":{"title":"Talque Product API","version":"1.0.0"},"paths":{"/api/v1/product/read":{"post":{"summary":"Read products by ID","description":"Looks up products by catalog and product IDs.","parameters":[{"name":"X-TQ-CLIENT-ID","in":"header","required":false,"schema":{"type":"string"},"description":"The API client ID for authentication."},{"name":"X-TQ-SECRET","in":"header","required":false,"schema":{"type":"string"},"description":"The API client secret for authentication."}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"orgId":{"type":"string","description":"The unique identifier of the organization."},"catalogId":{"type":"string","description":"The catalog identifier."},"productIdList":{"type":"array","items":{"type":"string"},"description":"List of product IDs to look up."}},"required":["orgId","catalogId","productIdList"]}}}},"responses":{"200":{"description":"Lookup completed (individual products may still be not found)","content":{"application/json":{"schema":{"type":"object","properties":{"orgId":{"type":"string","description":"The unique identifier of the organization."},"productById":{"type":"object","additionalProperties":{"type":"object","properties":{"success":{"type":"boolean","description":"Whether the product was found."},"reason":{"type":"string","description":"Machine-readable result code."},"model":{"type":["object","null"],"properties":{"productId":{"type":"string","description":"The unique identifier of the product."},"catalogId":{"type":"string","description":"The catalog this product belongs to."},"isPublished":{"type":"boolean","description":"Whether the product is visible to the public."},"isComplete":{"type":"boolean","description":"Whether the product data is complete."},"name":{"$schema":"http://json-schema.org/draft-04/schema","type":"object","properties":{"DE_DE":{"type":"string"},"EN_US":{"type":"string"},"FR_FR":{"type":"string"},"ES_ES":{"type":"string"},"PT_PT":{"type":"string"},"ZH_CN":{"type":"string"},"UK_UA":{"type":"string"},"AR_EG":{"type":"string"},"RU_RU":{"type":"string"},"FA_IR":{"type":"string"},"NL_NL":{"type":"string"}},"additionalProperties":false,"description":"Product name."},"subtitle":{"$schema":"http://json-schema.org/draft-04/schema","type":"object","properties":{"DE_DE":{"type":"string"},"EN_US":{"type":"string"},"FR_FR":{"type":"string"},"ES_ES":{"type":"string"},"PT_PT":{"type":"string"},"ZH_CN":{"type":"string"},"UK_UA":{"type":"string"},"AR_EG":{"type":"string"},"RU_RU":{"type":"string"},"FA_IR":{"type":"string"},"NL_NL":{"type":"string"}},"additionalProperties":false,"description":"Product subtitle."},"description":{"$schema":"http://json-schema.org/draft-04/schema","type":"object","properties":{"DE_DE":{"type":"string"},"EN_US":{"type":"string"},"FR_FR":{"type":"string"},"ES_ES":{"type":"string"},"PT_PT":{"type":"string"},"ZH_CN":{"type":"string"},"UK_UA":{"type":"string"},"AR_EG":{"type":"string"},"RU_RU":{"type":"string"},"FA_IR":{"type":"string"},"NL_NL":{"type":"string"}},"additionalProperties":false,"description":"Product description."},"photo":{"type":["string","null"],"description":"Product photo URL."},"mtime":{"type":"integer","description":"Last modification time of the product (milliseconds since epoch)."},"editMtime":{"type":"integer","description":"Last edit time of the product (milliseconds since epoch)."},"marks":{"type":"array","items":{"type":"string"},"description":"Product marks/labels."},"subMarks":{"type":"array","description":"Sub-marks."},"vendors":{"type":"array","items":{"type":"string"},"description":"Associated vendor IDs."},"isNew":{"type":"boolean","description":"Whether the product is new."},"customData":{"type":"object","description":"Custom field data."}},"required":["productId","catalogId","isPublished","isComplete","name","subtitle","description","mtime","editMtime","marks","subMarks","vendors","isNew","customData"],"description":"The product data, or null if not found."}},"required":["success","reason","model"]},"description":"Map from product ID to its result."}},"required":["orgId","productById"]}}}},"400":{"description":"Bad request (e.g., missing or invalid fields)"},"403":{"description":"Forbidden"},"404":{"description":"Organization not found"}}}}}}
```

## List products in an organization

> Returns products in the organization with optional pagination.

```json
{"openapi":"3.0.3","info":{"title":"Talque Product API","version":"1.0.0"},"paths":{"/api/v1/product/list":{"post":{"summary":"List products in an organization","description":"Returns products in the organization with optional pagination.","parameters":[{"name":"X-TQ-CLIENT-ID","in":"header","required":false,"schema":{"type":"string"},"description":"The API client ID for authentication."},{"name":"X-TQ-SECRET","in":"header","required":false,"schema":{"type":"string"},"description":"The API client secret for authentication."}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"orgId":{"type":"string","description":"The unique identifier of the organization."},"limit":{"type":"integer","description":"Maximum number of products to return."},"cursor":{"type":["string","null"],"description":"Pagination cursor from a previous response."}},"required":["orgId"]}}}},"responses":{"200":{"description":"List of products","content":{"application/json":{"schema":{"type":"object","properties":{"orgId":{"type":"string","description":"The unique identifier of the organization."},"products":{"type":"array","items":{"type":"object","properties":{"productId":{"type":"string","description":"The unique identifier of the product."},"catalogId":{"type":"string","description":"The catalog this product belongs to."},"isPublished":{"type":"boolean","description":"Whether the product is visible to the public."},"isComplete":{"type":"boolean","description":"Whether the product data is complete."},"name":{"$schema":"http://json-schema.org/draft-04/schema","type":"object","properties":{"DE_DE":{"type":"string"},"EN_US":{"type":"string"},"FR_FR":{"type":"string"},"ES_ES":{"type":"string"},"PT_PT":{"type":"string"},"ZH_CN":{"type":"string"},"UK_UA":{"type":"string"},"AR_EG":{"type":"string"},"RU_RU":{"type":"string"},"FA_IR":{"type":"string"},"NL_NL":{"type":"string"}},"additionalProperties":false,"description":"Product name."},"subtitle":{"$schema":"http://json-schema.org/draft-04/schema","type":"object","properties":{"DE_DE":{"type":"string"},"EN_US":{"type":"string"},"FR_FR":{"type":"string"},"ES_ES":{"type":"string"},"PT_PT":{"type":"string"},"ZH_CN":{"type":"string"},"UK_UA":{"type":"string"},"AR_EG":{"type":"string"},"RU_RU":{"type":"string"},"FA_IR":{"type":"string"},"NL_NL":{"type":"string"}},"additionalProperties":false,"description":"Product subtitle."},"description":{"$schema":"http://json-schema.org/draft-04/schema","type":"object","properties":{"DE_DE":{"type":"string"},"EN_US":{"type":"string"},"FR_FR":{"type":"string"},"ES_ES":{"type":"string"},"PT_PT":{"type":"string"},"ZH_CN":{"type":"string"},"UK_UA":{"type":"string"},"AR_EG":{"type":"string"},"RU_RU":{"type":"string"},"FA_IR":{"type":"string"},"NL_NL":{"type":"string"}},"additionalProperties":false,"description":"Product description."},"photo":{"type":["string","null"],"description":"Product photo URL."},"mtime":{"type":"integer","description":"Last modification time of the product (milliseconds since epoch)."},"editMtime":{"type":"integer","description":"Last edit time of the product (milliseconds since epoch)."},"marks":{"type":"array","items":{"type":"string"},"description":"Product marks/labels."},"subMarks":{"type":"array","description":"Sub-marks."},"vendors":{"type":"array","items":{"type":"string"},"description":"Associated vendor IDs."},"isNew":{"type":"boolean","description":"Whether the product is new."},"customData":{"type":"object","description":"Custom field data."}},"required":["productId","catalogId","isPublished","isComplete","name","subtitle","description","mtime","editMtime","marks","subMarks","vendors","isNew","customData"]},"description":"Products in the organization."},"cursor":{"type":["string","null"],"description":"Pagination cursor for the next page."},"more":{"type":"boolean","description":"Whether there are more products to fetch."}},"required":["orgId","products","more"]}}}},"400":{"description":"Bad request (e.g., missing or invalid fields)"},"403":{"description":"Forbidden"},"404":{"description":"Organization not found"}}}}}}
```