{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"3d85fae4-df40-4a34-ab79-f42098ebf359","name":"Commerce Ocean eCommerce API v1.0","description":"# API Documentation\n\n---\n\n### About Commerce Ocean\n\nCommerce Ocean is a leading provider of innovative ecommerce solutions designed to empower businesses with seamless and efficient online retail capabilities. With a robust platform and a suite of advanced tools, Commerce Ocean helps businesses of all sizes to establish and grow their online presence. Our commitment to excellence and customer satisfaction drives us to continually enhance our offerings and provide top-notch support to our clients. Visit our website at [Commerce Ocean](https://commerceocean.com) for more information.\n\n---\n\n### API Overview\n\nThe Commerce Ocean API provides a comprehensive set of endpoints to interact with our ecommerce platform. This documentation covers the available endpoints, their parameters, request and response formats, and examples to help you integrate seamlessly with our services.\n\n### Base URL\n\nThe base URL for all API requests is: {{baseurl}}\n\n### Authentication\n\nAll API requests require an `apiKey` to authenticate. Include your API key in the request headers as shown below:\n\n`GET /{{route}}/catalog/categories`\n\n`Host: {{baseurl}}`\n\n`apiKey: {{apiKey}}`\n\n### Endpoints\n\n#### Catalog\n\n##### Categories\n\n- **Description**: Retrieve a list of categories for a specific store.\n    \n- **Endpoint**: `GET /{{route}}/catalog/categories`\n    \n- **Parameters**:\n    \n    - `storeId` (integer, required): The ID of the store. Example values: 0, 1, 2, etc.\n        \n    - `level` (integer, required): The level of categories to retrieve. Example value: 4.\n        \n- **Request Example:**\n    \n\n```\nGET /{{route}}/catalog/categories?storeId=1&level=4\nHost: {{baseurl}}\napiKey: {{apiKey}}\n\n ```\n\n- **Response Example:**\n    \n\n``` json\n{\n    \"success\": true,\n    \"message\": \"\",\n    \"categories\": [\n        {\n            \"id\": \"2\",\n            \"name\": \"Default Category\",\n            \"position\": \"1\",\n            \"hasChildren\": true,\n            \"children\": [\n                {\n                    \"id\": \"1224\",\n                    \"name\": \"Home\",\n                    \"position\": \"1\",\n                    \"hasChildren\": true,\n                    \"children\": [\n                        {\n                            \"id\": \"1226\",\n                            \"name\": \"Furniture\",\n                            \"position\": \"1\",\n                            \"hasChildren\": true,\n                            \"image\": \"https://woodiro.com/media/catalog/product/b/j/bjoerksta-picture-and-frame-sand-dunes-aluminum-color__1176892_pe895324_s5_zy7jqvmzssicjb5g.jpg\",\n                            \"children\": [\n                                {\n                                    \"id\": \"1528\",\n                                    \"name\": \"Decor\",\n                                    \"position\": \"1\",\n                                    \"hasChildren\": false,\n                                    \"image\": \"https://woodiro.com/media/catalog/product/b/j/bjoerksta-picture-and-frame-sand-dunes-aluminum-color__1176892_pe895324_s5_zy7jqvmzssicjb5g.jpg\"\n                                },\n                                {\n                                    \"id\": \"1529\",\n                                    \"name\": \"Office\",\n                                    \"position\": \"2\",\n                                    \"hasChildren\": false,\n                                    \"image\": \"https://woodiro.com/media/catalog/product/b/e/bekant-desk-sit-stand-black-stained-ash-veneer-black__0734928_pe739646_s5_gzz9dhculpypf16v.jpg\"\n                                }\n                                // Additional categories...\n                            ]\n                        }\n                        // Additional subcategories...\n                    ]\n                }\n                // Additional categories...\n            ]\n        }\n        // Additional top-level categories...\n    ]\n}\n\n ```\n\n### Additional Endpoints\n\nExpand the documentation by adding details for each endpoint under relevant sections such as:\n\n- **Products**\n    \n    - List Products\n        \n    - Get Product Details\n        \n- **Customers**\n    \n    - Get Customer Details\n        \n    - Create/Update/Delete Customer\n        \n- **Orders**\n    \n    - List Orders\n        \n    - Get Order Details\n        \n    - Create/Update/Delete Order\n        \n\n### Error Handling\n\nAll API responses include a `success` boolean and a `message` field to help you understand the outcome of your requests. Standard HTTP status codes are used to indicate the success or failure of an API call.\n\n### Support\n\nFor any questions or issues, please contact our support team at [support@commerceocean.com](https://null).","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"16991199","team":667395,"collectionId":"3d85fae4-df40-4a34-ab79-f42098ebf359","publishedId":"2sA3e1BA6X","public":true,"publicUrl":"https://api.commerceocean.com","privateUrl":"https://go.postman.co/documentation/16991199-3d85fae4-df40-4a34-ab79-f42098ebf359","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"0068ff"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":"Explore the Commerce Ocean API Documentation for detailed guides on integrating with our ecommerce platform. Access endpoints for Catalog, Customer, Checkout, and more to streamline your online retail operations."},{"name":"title","value":"Commerce Ocean API Documentation | Comprehensive Guide to Integrate with Our Platform"}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/05675a2d-db33-4cbc-9eb4-99270b0ea326/bG9nby13aGl0ZS5wbmc=","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"0068ff"}},{"name":"light","logo":"https://content.pstmn.io/7ec47bb9-3f73-4a78-9549-3b88aee07e1a/bG9nby1taWQucG5n","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"0068ff"}}]}},"version":"8.10.1","publishDate":"2024-07-06T23:35:57.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"Commerce Ocean API Documentation | Comprehensive Guide to Integrate with Our Platform","description":"Explore the Commerce Ocean API Documentation for detailed guides on integrating with our ecommerce platform. Access endpoints for Catalog, Customer, Checkout, and more to streamline your online retail operations."},"logos":{"logoLight":"https://content.pstmn.io/7ec47bb9-3f73-4a78-9549-3b88aee07e1a/bG9nby1taWQucG5n","logoDark":"https://content.pstmn.io/05675a2d-db33-4cbc-9eb4-99270b0ea326/bG9nby13aGl0ZS5wbmc="}},"statusCode":200},"environments":[{"name":"Development","id":"ab1d089d-bcd4-4d92-a59b-fc11ec41a609","owner":"16991199","values":[{"key":"Token","value":"","enabled":true,"type":"any"}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/d95d9183efcd619a72d2f8111c39780ba72e04f3d60ce2cda8ea857e4e5c7406","favicon":"https://res.cloudinary.com/postman/image/upload/v1630651469/team/tf2aosaxao3wonurtwdi.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"Development","value":"16991199-ab1d089d-bcd4-4d92-a59b-fc11ec41a609"}],"canonicalUrl":"https://api.commerceocean.com/view/metadata/2sA3e1BA6X"}