{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"d912374c-82f9-44e1-a3e1-f81965882fa2","name":"Cubbo Clients API","description":"# Cubbo Clients API\n\nThe client-facing fulfillment API: create and track orders, manage inventory and replenishments, handle returns, and receive outbound webhooks.\n\n| Environment | Base URL |\n|---|---|\n| Production | `https://api.cubbo.com/v1` |\n| Staging | `https://api-staging.cubbo.com/v1` |\n\n## Setup\n\nSet two Postman **environment** variables:\n\n| Variable | Value |\n|---|---|\n| `clients_api_url` | `https://api.cubbo.com/v1` (or the staging URL) |\n| `clients_api_bearer_token` | the `token` returned by `POST /auth/token` |\n\nEvery request inherits collection-level Bearer auth from `clients_api_bearer_token` — don't set an `Authorization` header per request.\n\n## Quickstart\n\n1. `POST /auth/token` with your `client_id` / `client_secret` → `{ token, expires_in, type }`.\n2. **Cache the token** and reuse it until it is close to expiry (default 24 h). There are no refresh tokens, and re-authenticating on every call is the most common way to hit the rate limits.\n3. Call any endpoint with `Authorization: Bearer <token>`.\n4. For order/shipping/inventory state changes, subscribe to the outbound events in the **Webhooks** folder instead of polling.\n\n## Pagination\n\nList endpoints take `page` (default `1`) and `per_page` (default `10`), and return a `meta` object alongside the data:\n\n```json\n{\n  \"current_page\": 1,\n  \"next_page\": 2,\n  \"prev_page\": null,\n  \"total_pages\": 9,\n  \"first_page\": true,\n  \"last_page\": false,\n  \"per_page\": 10,\n  \"total_count\": 84\n}\n```\n\n`per_page` caps differ per endpoint:\n\n| Endpoint | Max `per_page` | Over the max |\n|---|---|---|\n| `GET /orders` | 100 | silently clamped to 100 |\n| `GET /orders/with-fields` | 100 | `422` |\n| `GET /orders/awaiting-invoice` | 100 | `422` |\n| `GET /returns/awaiting-invoice` | 100 | `422` |\n| `GET /inventory` | 200 | `422` |\n\n**Detecting the last page:** use `next_page == null`. Do not rely on `last_page` — when a query returns no results at all, `total_pages` is `0` and `last_page` is `false`.\n\n## Status codes, errors and rate limits\n\nSee the **Errors** folder.\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"16525878","team":2160923,"collectionId":"d912374c-82f9-44e1-a3e1-f81965882fa2","publishedId":"UV5dcu1j","public":true,"publicUrl":"https://developers.cubbo.com","privateUrl":"https://go.postman.co/documentation/16525878-d912374c-82f9-44e1-a3e1-f81965882fa2","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"005bfe"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.12.3","publishDate":"2021-10-27T02:36:17.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"cubbo Prod","id":"7447733d-2f03-4c08-9eb6-129b4b8fe37d","owner":"16526084","values":[{"key":"app_url","value":"https://api.cubbo.com","enabled":true},{"key":"bearer_token","value":"","enabled":true},{"key":"clients_api_url","value":"https://api.cubbo.com/v1","enabled":true},{"key":"app.autho","value":"cubbo.us.auth0.com","enabled":true},{"key":"auth_email","value":"","enabled":true,"type":"default"},{"key":"auth_password","value":"","enabled":true,"type":"secret"}],"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/5994c4348f3b4d03f1e5c6fffa95d217130d824beb2bf921a53becde11a43706","favicon":"https://cubbo.com/favicon.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":"cubbo Prod","value":"16526084-7447733d-2f03-4c08-9eb6-129b4b8fe37d"}],"canonicalUrl":"https://developers.cubbo.com/view/metadata/UV5dcu1j"}