{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"7d83f12c-4d90-4818-9ba2-be579e30e455","name":"GoDataFeed API v2 Reference","description":"\nWelcome to the GoDataFeed API! You can use our API to access various data endpoints.\n\n**API Status** for the API can be found at https://status.godatafeed.com/\n\nYou can view examples in the dark area to the right, and you can switch the programming language of the examples with the tabs in the top right.\n\nAll API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.\n\nYou can change the environment from the dropdown at the top. **Public** contains sample data, **No Environment** will replace all sample data with placeholders. Click the run in postman button to import the entire Api documentation into your local postman app to quickly make calls against the API.\n\n<br />\n\n_________\n\n# Authorization\n\nGoDataFeed uses Tokens to allow access to the API. In order to obtain authorization to use the GoDataFeed API, you need to first setup a Consumer Key in the GoDataFeed Control Panel. The Consumer Key is used to generate Access Tokens that are then used in all subsequent API calls.\n\n(Not currently available) To create a token, make a call to the get authorization endpoint with your consumer key\n\n`https://api.godatafeed.com/v2/authorization`\n\nPlease use the token in the Authorization header parameter for all API calls.\n\n`Authorization: Bearer {{token}}`\n\n\n## Access Token Lifespan\n\nFor additional security, Access Tokens can be configured to expire after a pre-determined duration from the time they are generated, this is referred to as the Access Token Lifespan. Setting the Access Token Lifespan is done through the GoDataFeed Control Panel with the following options: “Never Expires”, “7 Days”, “14 Days” and “30 Days”.  \n\nIt’s important to note that the developer of the consuming application has the option of generating access tokens as frequently as needed (once an hour, once a day, etc.); the more frequent a token is refreshed the more secure the consuming application will be.\n\nMake sure to replace  `Token`  with your Consumer Key.\n\n<br />\n\n_________\n\n# Date/Time Format\nGoDataFeed date/times are stored in UTC. When querying use [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) format for queries.\nAn example of a DateTime response value is \"2018-10-24T15:37:27.04Z\". Also, some API's use nullable DateTime values indicated by DateTime? which may return the value null\n\n<br />\n\n_________\n\n# API Call Limits\n\nThe GoDataFeed API call uses the “leaky bucket” algorithm for call throttling. This allows you to make an unlimited number of calls over time, as long as you don’t exceed the bucket size. The bucket size defaults to 50 calls, with a leak rate of 2 calls per second. Therefore, you can make 2 calls per second with occasional burst of 50 calls at once. If you overflow the bucket, you’ll get a 429 response.\n\nGoDataFeed expects for the API Token to be included in all API requests to the server in the Header of the request.\n\n`Authorization: Bearer {{token}}`\n\n<br />\n\n_________\n\n# Request Parameters and Objects\nThe V2 API uses url route path parameters and query parameters. In the documentation, path parameters are shown as a variable in the url with the following syntax \":variable\". Required path/query parameters and request objects will be indicated in the docs for each api. Query parameters are not case sensitive.\n\n<br />\n\n_________\n\n# Response Object\n\nAll API endpoints will return the following default response fields along with endpoint specific response objects and a 200 status code.\n\n |Property|Description            |\n|-----|-----------------------------|\n|`Success`|Indicates whether the requested endpoint has successfully processed the request. |\n|`Message`|Returns any generated error messages when success is false.   |\n|`Paging`|Returned by endpoints that support paging |\n|`Sorting`|Returned by endpoints that support sorting            |\n\n<br />\n\n_________\n\n# Pagination and Sorting\n\nThe response body will always provide containers with details about paging and sorting for those endpoints which allow paging and sorting. Paging and sorting parameters are optional on these endpoints. When not provided, default values will be used.\n\n## Paging Response\n\nFor endpoints which allow paging, several properties are returned in the `Paging`  container to provide additional information about the pagination.\n\n**Paging object**\n\n|Property          |Type  |Details                |\n|------------------|------|-----------------------|\n|`Paging`        |Container|The list of paging properties|\n|`TotalRecords`   |Integer|The total number of records|\n|`TotalPages`   |Integer|The total number of pages|\n|`PageNumber`        |Integer|The specific page of objects to return|\n|`PageSize`        |Integer|Number of objects to return per page|\n|`MaxPageSize`        |Integer| The endpoint-specific maximum number of records our system will return|\n\n> **Pagination Example:** `GET https://api.godatafeed.com/v2/stores?pageNumber=1&pageSize=50`\n\n\n## Sorting Response\n\nFor endpoints which allow sorting, several properties are returned in the `Sorting`  container to provide additional information about the sort order and sorting capabilities of the end point.\n\n**Sorting object**\n\n|Property          |Type  |Details                |\n|------------------|------|-----------------------|\n|`Sorting`        |Container|The list of sorting properties|\n|`SortBy`        |String|The sort property of the response body|\n|`SortOrder`   |String|The sort order of the response body|\n|`AllowedSortOrder`        |String|The allowed sort order values to be used in the request params|\n|`AllowedSortBy`        |String|The endpoint-specific allowed sort property values to be used in the request params|\n\n\n> **Sorting Example:** `GET https://api.godatafeed.com/v2/stores?sortBy=Name&sortOrder=Asc`\n\n<br />\n\n_________\n\n# Errors Codes\n\nThe GoDataFeed API uses the following error codes:\n\n |Error Code|Description            |\n|-----|-----------------------------|\n|`400`|Bad Request – Your request is invalid.            |\n|`401`|Unauthorized – Your API key is not authorized.    |\n|`403`|Forbidden – The endpoint requested is hidden for administrators only.|\n|`404`|Not Found – The specified endpoint could not be found.            |\n|`405`|Method Not Allowed – You tried to access an endpoint with an invalid method.            |\n|`406`|Not Acceptable – You requested a format that isn’t json.|\n|`410`|Gone – The endpoint requested has been removed from our servers.            |\n|`429`|Too Many Requests – Slow down!           |\n|`500`|Internal Server Error – We had a problem with our server. Try again later.|\n|`503`|Service Unavailable – We’re temporarily offline for maintenance. Please try again later.|\n\n<br />\n\n_________\n\n# Version 1 of GoDataFeed API\nPlease see https://developer.godatafeed.com\n\n<br />","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"624879","team":20725,"collectionId":"7d83f12c-4d90-4818-9ba2-be579e30e455","publishedId":"RztkN9EE","public":true,"publicUrl":"https://developers.godatafeed.com","privateUrl":"https://go.postman.co/documentation/624879-7d83f12c-4d90-4818-9ba2-be579e30e455","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","version":"8.10.0","publishDate":"2019-01-29T20:01:14.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"Public - API Reference","id":"ede501b3-5464-4f53-b3c4-b9329218cb46","owner":"624879","values":[{"key":"base_url","value":"https://api.godatafeed.io","enabled":true},{"key":"base_pagesize","value":"50","enabled":true},{"key":"base_pagenumber","value":"1","enabled":true},{"key":"base_sortby","value":"Name","enabled":true},{"key":"base_sortorder","value":"Asc","enabled":true},{"key":"store_number","value":"Store_1","enabled":true},{"key":"store_numbers","value":"Store_1,Store_2,Store_3","enabled":true},{"key":"store_plancode","value":"Plan_1","enabled":true},{"key":"store_planfreq","value":"Monthly","enabled":true},{"key":"store_name","value":"Test Store","enabled":true},{"key":"store_email","value":"Hello@TestStore.com","enabled":true},{"key":"store_domain","value":"teststore.com","enabled":true},{"key":"store_timezonetype","value":"EST","enabled":true},{"key":"store_firstname","value":"John","enabled":true},{"key":"store_lastname","value":"Smith","enabled":true},{"key":"store_emails","value":"Hello@TestStore.com;Goodbye@TestStore.com","enabled":true},{"key":"store_changeplantype","value":"Upgrade","enabled":true},{"key":"base_token","value":"fakeToken123","enabled":true},{"key":"feed_number","value":"Feed_1","enabled":true},{"key":"feed_numbers","value":"Feed_1,Feed_2","enabled":true},{"key":"feed_name","value":"Test Feed","enabled":true},{"key":"store_sortby","value":"Name","enabled":true},{"key":"feed_sortby","value":"Name","enabled":true},{"key":"validation_sortby","value":"Sku","enabled":true},{"key":"store_planname","value":"Test Plan","enabled":true},{"key":"fromDate","value":"2020-12-02T00:00:00Z","enabled":true},{"key":"toDate","value":"2020-13-02T23:59:59Z","enabled":true},{"key":"fromGDFImportDate","value":"2020-12-02T00:00:00Z","enabled":true},{"key":"toGDFImportDate","value":"2020-13-02T23:59:59Z","enabled":true},{"key":"page","value":"1","enabled":true},{"key":"pageSize","value":"100","enabled":true},{"key":"status","value":"NEW","enabled":true},{"key":"storeOrderNumber","value":"123456789","enabled":true},{"key":"includeDisabled","value":"true","enabled":true}],"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/d19fe6e065ef2960ce3ada9a68f553d9e1a383cb3e3d8794ec052a05f9761648","favicon":"https://res.cloudinary.com/postman/image/upload/v1628624456/team/lxomth7iiog6hhemn83p.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":"Public - API Reference","value":"624879-ede501b3-5464-4f53-b3c4-b9329218cb46"}],"canonicalUrl":"https://developers.godatafeed.com/view/metadata/RztkN9EE"}