{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"a6b26423-611d-4c0b-b572-80b01460d1fe","name":"Developer API Reference","description":"![alt text](https://res.cloudinary.com/shoffr/image/upload/v1602427304/brands/3255469.jpg \"Shoffr New Retail\")\n\nOur API resources helps developers ingest ecommerce and retail catalog to Vizury Feedbus. \n\nIf you are using our APIs for Ecommerce use-cases you may integrate only Products. If you are running retail use-cases continue to ingest variants, outlets and stocks data. \n\nIf you have any questions please contact our sales team.\n\n# Configuration\nAll API requests on shoffr accepts JSON in request body and requires that the content-type: application/json header be specified for all such requests.\n\nThe API will always respond with a JSON object.\n\nDepending on response context, resources may be returned as single object or as arrays of objects, nested within the response object.\n\n## Base URL\n\n<api><code class=\"prettyprint\">https://api.shoffr.io/v3</code></api>\n\n<code class=\"prettyprint\">Version 3</code>\n\n\n## Header Parameters\n\nName |  Located in  | Required | Type\n--------- | ------- |  ------- |------- |\nX-Shoffr-Access-Token|\theader\t|\tYes\t|string\nX-Source|\theader|\t\tYes |\tstring\nX-Customer|\theader|\t\tYes |\tstring\n\n\n - X-Shoffr-Access-Token &nbsp;Access token used to consume the shoffr APIs,You can find the token under your account section in retail portal.\n\n - X-Source &nbsp;To track the API request source.ex:mobile,web,facebook,instagram.\n \n - X-Customer &nbsp;Customer ID is required to track the events of the customer journey. \n\n## Pagination\n\n**Query**\n\nParameter |  Description\n--------- | ------- | \nper_page |\tReturn up to this number of objects per response. Must be an integer between 1 and 500. Defaults to 10.\npage |\tA cursor for use in pagination. Returns the n-th chunk of per_page objects.\n\n**Links**\n\nPagination in the API is handled via the Link header standard.\n\nAPI methods that return a collection of results are always paginated.\n\nPaginated results will include a Link response header with the following information.\n\n - next  : The corresponding URL is the link to the next page.\n \n - prev  : The corresponding URL is the link to the previous page.\n \n - last  : The corresponding URL is the link to the last page.\n \n - first : when the header is not set, there is only one page, the first page, of results.\n \n - self  : A self link is a link to the page on which the link appears.\n\n# Authentication\nEvery API resources expects an API key to be included in all API requests headers.\n\nIn order to get your own personal API key, You must follow the below steps\n\n- Login to Retail Portal\n\n- Navigate to Account > Settings & copy your developer key\n\n( Do not share this key with anyone )\n\nInclude this Developer key in header as described below.\n\n**Authorization: bearer TOKEN**\n\nAn invalid access returns status 401.\n\n# Error Codes\nOur API's uses the following error codes:\n\n\nError Code | Meaning\n---------- | -------\n400 | Bad Request -- Your request sucks.\n401 | Unauthorized -- Your API key is wrong.\n403 | Forbidden -- The kitten requested is hidden for administrators only.\n404 | Not Found -- The specified kitten could not be found.\n405 | Method Not Allowed -- You tried to access a kitten with an invalid method.\n406 | Not Acceptable -- You requested a format that isn't json.\n410 | Gone -- The kitten requested has been removed from our servers.\n418 | I'm a teapot.\n429 | Too Many Requests -- You're requesting too many kittens! Slow down!\n500 | Internal Server Error -- We had a problem with our server. Try again later.\n503 | Service Unavailable -- We're temporarily offline for maintenance. Please try again later.\n\n# Rate limit\nAll shoffr API's have very high rate limits.<br /> \nYou can perform bulk data in & data out operations, however If you exceed the limits, Shoffr will start returning a **429 Too Many Requests** HTTP status code.\nApplications exceeding rate limits contineously will be permanently disabled.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"3260230","team":78047,"collectionId":"a6b26423-611d-4c0b-b572-80b01460d1fe","publishedId":"SWEB2vh9","public":true,"publicUrl":"https://docs.shoffr.io","privateUrl":"https://go.postman.co/documentation/3260230-a6b26423-611d-4c0b-b572-80b01460d1fe","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.1","publishDate":"2020-10-11T14:57:32.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"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/19e1c067e46e7f5887301f25fa283b9e11fc54d7fc170ce3a5daf5c230ad2f1c","favicon":"https://res.cloudinary.com/postman/image/upload/v1602428080/team/asfbt1bnnbv9xnsn6xa0.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://docs.shoffr.io/view/metadata/SWEB2vh9"}