{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"99138ced-cf45-4062-907e-3120240b1b8b","name":"ConnectedYou Reseller","description":"This is ConnectedYou's reseller APIs. The ConnectedYou API is organized around REST. Our API has predictable resource-oriented URLs, accepts JSON request bodies, returns JSON responses, and uses standard HTTP response codes, authentication, and verbs.\n\n# **API endpoint**\n\nHostname: api.reseller.esim.connectedyou.io\n\nProtocol: https\n\nContent-Type: application/json\n\n## Prerequisites\n\nBefore using the API, ensure you have:\n\n1. **Access** to the ConnectedYou Reseller Portal  \n    URL: [https://reseller.esim.connectedyou.io](https://reseller.esim.connectedyou.io)\n    \n2. **Authentication credentials** (client_id and client_secret)\n    \n3. **Reseller Account ID**\n    \n\n---\n\n## Obtaining Authentication Credentials\n\nTo get your API authentication keys (`client_id` and `client_secret`):\n\n1. Log in to the [Reseller Portal](https://reseller.esim.connectedyou.io/)\n    \n2. Navigate to: **Account** > **Settings** > **Auth Clients**\n    \n3. Either:\n    \n    - Use existing credentials from the Auth Clients list, **or**\n        \n    - Create new credentials by clicking **ADD AUTH CLIENT**\n        \n\n---\n\n## Obtaining Your Reseller Account ID\n\nFor reseller-account-related APIs, you'll need your `reseller_account_id`:\n\n1. Log in to the [Reseller Portal](https://reseller.esim.connectedyou.io/)\n    \n2. Navigate to: **Account** > **Settings** > **Info**\n    \n3. Locate the **Account Number** field - this value is your `reseller_account_id`\n    \n\nNotes:\n\n- Keep your `client_secret` confidential - never expose it in client-side code\n    \n- For security reasons, rotate your credentials periodically\n    \n- Contact support if you need help locating any of these values\n    \n\n# Sorting and Filtering\n\nThe API supports sorting and filtering on most query parameters documented below.\n\n**Sorting**  \nPrepend a hyphen (`-`) to any sortable field for descending order (e.g., `-created_at` sorts newest first).\n\n**Filtering**  \nAvailable filters are endpoint-specific and support exact matching by default.  \nRefer to each endpoint's documentation for supported filterable fields and operators.\n\n# Pagination\n\nThe API supports pagination for list endpoints using `limit` and `offset` parameters.\n\n**Key Features:**\n\n- Returns the total record count with each response\n    \n- Default page size: 100 records\n    \n- Supports forward/backward navigation\n    \n\n**Parameters:**\n\n| Name | Type | Default | Description |\n| --- | --- | --- | --- |\n| `limit` | integer | 100 | Maximum records per response |\n| `offset` | integer | 0 | Starting position in record set |\n\n**Response Includes:**\n\n``` json\n{\n    \"products\": [\n        ...\n    ],\n    \"limit\": 100,\n    \"offset\": 0,\n    \"total\": 1\n}\n\n ```\n\n# Rate Limiting\n\nTo protect our platform, as with most API's, we implement rate limiting at multiple points in the architecture. Clients which exceed the rate limits will recieve 429 responses.\n\n# Idempotent Requests\n\nThe API supports idempotency to safely retry POST requests without causing duplicate Orders to be created.  \nAPI endpoints which affect Ordering eSIMs or Topups _require_ Idempotency keys.\n\nAPI clients must include a unique `idempotent_key` (less than 64 characters) header.  \nIf API clients retry the same request (same payload and `idempotent_key`), they will receive the response payloads of the first request, without causing duplicate Orders.\n\nWe recommend UUIDv4 or high-entropy random strings.\n\n# HTTP Response Status Codes\n\nThe API's are REST/JSON and therefore make use of HTTP status code in responses.\n\n### Success Responses\n\n| Response Code | Description |\n| --- | --- |\n| 200 OK | Request completed succesfully |\n| 201 Created | Request completed succesfully and resulted in the creation of a new record. e.g. a user is added |\n| 202 Accepted | Request is accepted for further processing asynchronously |\n\n### Client Error Responses\n\n| Response Code | Description |\n| --- | --- |\n| 400 Bad Request | A client request is not correct. Likely incorrect formatting or URL. |\n| 401 Unauthorized | The client request did not pass authorization checks. This could be incorrect credentials, or incorrect account or URL. |\n| 402 Payment Required | There was a problem with a payment. |\n| 403 Forbidden | The client request did not pass authentication checks. It could be an expired token, or excessive authentication, or an invalid client IP or server URL. |\n| 404 Not Found | The client request did not match a valid URL. The URL is incorrect. Note: This is also returned if the client credentials are not valid for a specific account number in the URL. |\n| 405 Method Not Allowed | When an incorrect HTTP Method is used to send a request to a particular URL. e.g. a GET method is used when a POST method is expected. |\n| 413 Payload Too Large | The request entity (body) is larger than limits defined by server. |\n| 415 Unsupported Media Type | The request uses the incorrect content type (e.g. application/xml is sent instead of application/json). |\n| 422 Unprocessable Entity | The request parameters can not be processed. |\n| 429 Too Many Requests | The client is exceeding the Rate Limits for the API. |\n\n### Server Error Responses\n\n| Response Code | Description |\n| --- | --- |\n| 500 Internal Server Error | The server failed to succesfully complete the request. This is not expected. |\n| 503 Service Unavailable | Temporary unavailability of the service. |\n| 504 Gateway Timeout | The server is taking too long to complete a request and it has timed out. |","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"19002812","team":566676,"collectionId":"99138ced-cf45-4062-907e-3120240b1b8b","publishedId":"2sB2cRCjc5","public":true,"publicUrl":"https://docs.api.reseller.esim.connectedyou.io","privateUrl":"https://go.postman.co/documentation/19002812-99138ced-cf45-4062-907e-3120240b1b8b","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"278689"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/a4b4b38d-d01a-4e2d-b794-e1bff30932de/Q1lfSWNvbl9XaGl0ZS5wbmc=","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"278689"}},{"name":"light","logo":"https://content.pstmn.io/e52566e3-bf4b-4f40-b411-9cac4fc54f36/b3V0cHV0LW9ubGluZXBuZ3Rvb2xzICgxKSAoMSkucG5n","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"278689"}}]}},"version":"8.10.0","publishDate":"2025-04-14T18:44:33.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":"https://content.pstmn.io/e52566e3-bf4b-4f40-b411-9cac4fc54f36/b3V0cHV0LW9ubGluZXBuZ3Rvb2xzICgxKSAoMSkucG5n","logoDark":"https://content.pstmn.io/a4b4b38d-d01a-4e2d-b794-e1bff30932de/Q1lfSWNvbl9XaGl0ZS5wbmc="}},"statusCode":200},"environments":[{"name":"ConnectedYou Reseller","id":"7b1620f0-0d16-44f5-9257-97ffdcaa8d7f","owner":"9419324","values":[{"key":"base_url","value":"https://api.reseller.esim.connectedyou.io/v1","enabled":true},{"key":"access_token","value":"eyJraWQiOiI5ZVZ0dlJ3U0p6Nlwvc0RBV0R4Y2Vmek","enabled":true},{"key":"reseller_account_id","value":"1234567890","enabled":true},{"key":"order_number","value":"CY10001","enabled":true,"type":"default"},{"key":"client_id","value":"asdjhqwo238912hasd","enabled":true,"type":"default"},{"key":"client_secret","value":"oiqwenoqwen2390asdnkj239sdjn123adawd","enabled":true,"type":"default"},{"key":"iccid","value":"89103000000145323454","enabled":true,"type":"default"}],"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/12aaca71aacc60c71527e9e840c10bbdfa484f89ca70d88a3d55d0de773685ce","favicon":"https://res.cloudinary.com/postman/image/upload/v1685621228/team/t7mb1tvmvrh4ovor5drj.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":"ConnectedYou Reseller","value":"9419324-7b1620f0-0d16-44f5-9257-97ffdcaa8d7f"}],"canonicalUrl":"https://docs.api.reseller.esim.connectedyou.io/view/metadata/2sB2cRCjc5"}