{"componentChunkName":"component---src-templates-simple-markdown-js","path":"/api/products/","matchPath":"","result":{"data":{"markdownRemark":{"html":"<h1 style=\"position:relative;\"><a href=\"#carriyo-products-api\" aria-label=\"carriyo products api permalink\" class=\"anchor before\"><svg aria-hidden=\"true\" focusable=\"false\" height=\"16\" version=\"1.1\" viewBox=\"0 0 16 16\" width=\"16\"><path fill-rule=\"evenodd\" d=\"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"></path></svg></a><div class=\"hidden-anchor\" id=\"carriyo-products-api\"></div>Carriyo Products API</h1>\n<p><a href=\"/docs/oas/products.yaml\"><strong>Download OpenAPI specification</strong></a></p>\n<p>The Carriyo Products API lets you manage your product catalogue in Carriyo. Products are referenced by shipments, orders, returns, and inventory — keeping your catalogue in Carriyo up to date ensures accurate downstream data.</p>\n<h2 style=\"position:relative;\"><a href=\"#key-resources\" aria-label=\"key resources permalink\" class=\"anchor before\"><svg aria-hidden=\"true\" focusable=\"false\" height=\"16\" version=\"1.1\" viewBox=\"0 0 16 16\" width=\"16\"><path fill-rule=\"evenodd\" d=\"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"></path></svg></a><div class=\"hidden-anchor\" id=\"key-resources\"></div>Key Resources</h2>\n<ul>\n<li>\n<a href=\"/docs/api/products/products/\">Products</a>\n — Create, read, update, and delete products in your catalogue\n</li>\n</ul>\n<h2 style=\"position:relative;\"><a href=\"#what-you-can-do\" aria-label=\"what you can do permalink\" class=\"anchor before\"><svg aria-hidden=\"true\" focusable=\"false\" height=\"16\" version=\"1.1\" viewBox=\"0 0 16 16\" width=\"16\"><path fill-rule=\"evenodd\" d=\"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"></path></svg></a><div class=\"hidden-anchor\" id=\"what-you-can-do\"></div>What You Can Do</h2>\n<ul>\n<li>\n<strong>List and search</strong>\n your catalogue with filtering, sorting, pagination, and free-text search\n</li>\n<li>\n<strong>Look up</strong>\n individual products by Carriyo \n<code class=\"language-text\">product_id</code>\n, your \n<code class=\"language-text\">product_ref</code>\n, or \n<code class=\"language-text\">sku</code>\n</li>\n<li>\n<strong>Create, update, and delete</strong>\n products one at a time, or in bulk\n</li>\n<li>\n<strong>Capture cross-border attributes</strong>\n like HS code, country of origin, material composition, dangerous goods, and battery details\n</li>\n<li>\n<strong>Attach custom metadata</strong>\n via \n<code class=\"language-text\">carriyo_metadata</code>\n name/value pairs\n</li>\n</ul>\n<h2 style=\"position:relative;\"><a href=\"#identifiers\" aria-label=\"identifiers permalink\" class=\"anchor before\"><svg aria-hidden=\"true\" focusable=\"false\" height=\"16\" version=\"1.1\" viewBox=\"0 0 16 16\" width=\"16\"><path fill-rule=\"evenodd\" d=\"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"></path></svg></a><div class=\"hidden-anchor\" id=\"identifiers\"></div>Identifiers</h2>\n<p>Each product can be referenced by three identifiers:</p>\n<table>\n<thead>\n<tr>\n<th>Identifier</th>\n<th>Source</th>\n<th>Uniqueness</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code class=\"language-text\">product_id</code></td>\n<td>Assigned by Carriyo</td>\n<td>Unique per tenant</td>\n</tr>\n<tr>\n<td><code class=\"language-text\">product_ref</code></td>\n<td>Supplied by you</td>\n<td>Recommended unique within a merchant</td>\n</tr>\n<tr>\n<td><code class=\"language-text\">sku</code></td>\n<td>Supplied by you</td>\n<td>Not guaranteed unique — lookups return an array</td>\n</tr>\n</tbody>\n</table>","headings":[{"value":"Carriyo Products API","depth":1},{"value":"Key Resources","depth":2},{"value":"What You Can Do","depth":2},{"value":"Identifiers","depth":2}]},"contentItem":{"data":{"lastModified":"2026-05-05T11:00:19.000Z","enableToc":null,"disableLastModified":null,"tocMaxDepth":null,"requestLogin":false}},"siteConfig":{"enableToc":false,"disableLastModified":false,"tocMaxDepth":4}},"pageContext":{"matchPath":"","id":"3a6157cd-118e-5e15-9b5f-aba21fd263aa__redocly content/api/products/","seo":{"title":"Carriyo Products API","description":null,"image":"","keywords":null,"jsonLd":null,"lang":null,"siteUrl":null},"pageId":"api/products/index.md","pageBaseUrl":"/api/products/index","type":"markdown","toc":{"enable":true,"maxDepth":4,"headings":[{"depth":1,"value":"Carriyo Products API","id":"carriyo-products-api"},{"depth":2,"value":"Key Resources","id":"key-resources"},{"depth":2,"value":"What You Can Do","id":"what-you-can-do"},{"depth":2,"value":"Identifiers","id":"identifiers"}]},"data":{"title":""},"catalogInfo":null,"link":"/api/products/","sidebarName":"api","isLanding":false,"showPrevButton":null,"showNextButton":null,"apiVersions":null,"apiVersionId":null,"isDefaultApiVersion":null}},"staticQueryHashes":["1123603147","1302185487","1344209882","1398840060","1520077861","1975142765","2667623876","2950305614","3240152602","3743992808","561138138"]}