{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"90d5d5e1-13e3-470e-b28a-c96c93c326b6","name":"iVendi Connect API","description":"A set of APIs that may be used by iVendi partners to access functionality of the iVendi Connected Retailing platform.\n\nContact Support: [support@ivendi.com](https://mailto:support@ivendi.com)  \nName: iVendi Support\n\n## Authorization\n\niVendi's APIs are for use by affiliated partners, but they can be further classified as: -\n\n- **Public** - These apis have no authentication, and a partner can call these apis from the client or server.\n    \n- **Private** - These are secure apis which should only be called from the server.\n    \n\nAs part of the partner onboarding, iVendi will supply the partner with: -\n\n- **API Key** - Both public and private apis require the api key specified on the x-api-key header. The api key identifies the partner so we can detect abnormal api usage patterns and provide better support services.\n    \n- **Client Id & Secret -** Authentication tokens are used on the private apis for secure service-to-service communication. The dealer will create a service account within Transact, generating an api client id and secret. The calling service uses these details to access the token endpoint to obtain the JWT access token. Using bearer token authetication, this access token will be sent on the Authorization header of every private api request. This token will contain the oAuth scopes that grant permission for the partner to access the relevant endpoints.\n    \n\n### Authorization error response\n\nIf an access token is missing, malformed, or invalid, you will receive an HTTP `401 Unauthorized` response code.\n\n## Date Formats\n\nWhere a date is sent in a request or received in a response, if it is just the date component it will be in the format: YYYY-MM-DD\n\nIf there is a date and time component it will be in the format: YYYY-MM-DD hh:mm:ss with the time always being in UTC.\n\n## Language & Locale\n\nSome APIs can accept requests for the response to be in a specific language and locale pair. This is indicated by the presence of an \"Accepts-Language\" header on the API.\n\n## API Version\n\nAPI versioning is in the format:\n\n- An update to the indicates a non-breaking change - for example the addition of new attributes to a json schema.\n    \n- An update to the represents a potentially breaking change - for example where existing attributes or functionality have been removed.\n    \n\n## Webhooks\n\nSome end points are processed asynchronously, and have the ability to specify a webhook URL. When the status of the requested resource is updated, a POST will be sent to the specificied URL containing a payload that looks like:\n\n`{`\n\n`\"Id\" : \"\",`\n\n`\"Category\" : \"\"`\n\n`}`\n\nWhere:\n\n- \"Id\" is the Globally Unique IDentifier for the item (which will have been returned on the original POST to the end point where the webhook URL was provided).\n    \n- \"Category\" is the type of resource that this webhook POST relates to. For Eligibility Checks the value will be \"Eligibility\" and for Applications Submissions the value will be \"Application\".\n    \n\nWhen a webhook is retrieved, the latest status can be retrieved by calling the corresponding GET for that resource with the Id.\n\nTo ensure the requests are coming from iVendi, a range of IP addresses can be provided which you can whitelist. Please reach out on [support@ivendi.com](https://mailto:support@ivendi.com) to request these IP addresses.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"24960513","team":540539,"collectionId":"90d5d5e1-13e3-470e-b28a-c96c93c326b6","publishedId":"2s93RQSu1G","public":true,"publicUrl":"https://ivendi-connect.ivendi.com","privateUrl":"https://go.postman.co/documentation/24960513-90d5d5e1-13e3-470e-b28a-c96c93c326b6","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"60b444"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/b44b535e-d7d8-42a6-b9c8-ae665b433028/aXZlbmRpX2xvZ29fZGFyay5wbmc=","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"60b444"}},{"name":"light","logo":"https://content.pstmn.io/b44b535e-d7d8-42a6-b9c8-ae665b433028/aXZlbmRpX2xvZ29fZGFyay5wbmc=","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"60b444"}}]}},"version":"8.10.1","publishDate":"2023-10-11T16:21:55.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":"https://content.pstmn.io/b44b535e-d7d8-42a6-b9c8-ae665b433028/aXZlbmRpX2xvZ29fZGFyay5wbmc=","logoDark":"https://content.pstmn.io/b44b535e-d7d8-42a6-b9c8-ae665b433028/aXZlbmRpX2xvZ29fZGFyay5wbmc="}},"statusCode":200},"environments":[],"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/893df7a9beff6bdef1bc3419249dc73405203b5bacdc1df0a518bcac7780a730","favicon":"https://ivendi.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"}],"canonicalUrl":"https://ivendi-connect.ivendi.com/view/metadata/2s93RQSu1G"}