Welcome to the GoDataFeed API! You can use our API to access various data endpoints.
\nAPI Status for the API can be found at https://status.godatafeed.com/
\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.
\nAll API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.
\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.
\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(Not currently available) To create a token, make a call to the get authorization endpoint with your consumer key
\nhttps://api.godatafeed.com/v2/authorization
Please use the token in the Authorization header parameter for all API calls.
\nAuthorization: Bearer {{token}}
For 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”.
\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.
\nMake sure to replace Token with your Consumer Key.
GoDataFeed date/times are stored in UTC. When querying use ISO-8601 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
\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.
\nGoDataFeed expects for the API Token to be included in all API requests to the server in the Header of the request.
\nAuthorization: Bearer {{token}}
The 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.
\nAll API endpoints will return the following default response fields along with endpoint specific response objects and a 200 status code.
\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.
\nFor endpoints which allow paging, several properties are returned in the Paging container to provide additional information about the pagination.
Paging object
\n\n\nPagination Example:
\nGET https://api.godatafeed.com/v2/stores?pageNumber=1&pageSize=50
For 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.
Sorting object
\n\n\nSorting Example:
\nGET https://api.godatafeed.com/v2/stores?sortBy=Name&sortOrder=Asc
The GoDataFeed API uses the following error codes:
\nPlease see https://developer.godatafeed.com
\nThe header authorization token required by this api
\n","key":"Authorization","type":"text","value":"Bearer {{base_token}}"}],"body":{"mode":"raw","raw":"{\n\t\"PlanCode\":\"{{store_plancode}}\",\n\t\"PlanFrequency\":\"{{store_planfreq}}\",\n\t\"DefaultContactEmailAddresses\":\"{{store_emails}}\",\n\t\"DomainName\": \"{{store_domain}}\",\n\t\"StoreName\": \"{{store_name}}\",\n\t\"TimeZoneType\": \"{{store_timezonetype}}\"\n}"},"url":"{{base_url}}/v2/stores/:storeNumber/create","description":"This request creates and activates a store. Check the ChangePlanType property in the Get Plans response to see which plans can be used in the Create Store request. StoreNumber and StoreName must be unique. Request object and path parameter is required
Request object
\n","urlObject":{"path":["v2","stores",":storeNumber","create"],"host":["{{base_url}}"],"query":[],"variable":[{"description":{"content":"A reference string for this store. Generally, this is used to keep the reference/Id of this Store in some external system to facilitate matching up the GoDataFeed store record to that system.
\n","type":"text/plain"},"type":"any","value":"{{store_number}}","key":"storeNumber"}]}},"response":[{"id":"ec668528-fece-40d5-a165-2be88e22f6a0","name":"200 Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"description":"The header authorization token required by this api","key":"Authorization","type":"text","value":"Bearer {{base_token}}"}],"body":{"mode":"raw","raw":"{\n\t\"PlanCode\":\"{{store_plancode}}\",\n\t\"PlanFrequency\":\"{{store_planfreq}}\",\n\t\"DefaultContactEmailAddresses\":\"{{store_emails}}\",\n\t\"DomainName\": \"{{store_domain}}\",\n\t\"StoreName\": \"{{store_name}}\",\n\t\"TimeZoneType\": \"{{store_timezonetype}}\"\n}"},"url":{"raw":"{{base_url}}/v2/stores/:storeNumber/create","host":["{{base_url}}"],"path":["v2","stores",":storeNumber","create"],"variable":[{"description":"A reference string for this store. Generally, this is used to keep the reference/Id of this Store in some external system to facilitate matching up the GoDataFeed store record to that system.","key":"storeNumber","value":"{{store_number}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"Success\": true,\n \"Message\": \"\"\n}"}],"_postman_id":"10995ed7-6f9a-4af0-9b34-2e33187a353e"},{"name":"Read TimeZones","id":"866bff7a-9618-4562-8c4a-6f7e1ed1600c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"The header authorization token required by this api
\n","key":"Authorization","type":"text","value":"Bearer {{base_token}}"}],"body":{"mode":"raw","raw":""},"url":"{{base_url}}/v2/stores/timezones","description":"This request returns a list of available system time zones.
\nResponse object
\n","urlObject":{"path":["v2","stores","timezones"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"71052651-4ce0-4a80-a933-7924758286ee","name":"200 Success","originalRequest":{"method":"GET","header":[{"description":"The header authorization token required by this api","key":"Authorization","type":"text","value":"Bearer {{base_token}}"}],"body":{"mode":"raw","raw":""},"url":"{{base_url}}/v2/stores/timezones"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.5"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Fri, 01 Feb 2019 21:27:22 GMT"},{"key":"Content-Length","value":"1668"}],"cookie":[],"responseTime":null,"body":"{\n \"Success\": true,\n \"Message\": \"\",\n \"TimeZones\": [\n {\n \"TimeZoneType\": \"CET\",\n \"TimeZoneDescription\": \"(GMT +1:00) Central European Standard Time\"\n }\n ]\n}"}],"_postman_id":"866bff7a-9618-4562-8c4a-6f7e1ed1600c"},{"name":"Read Plans","id":"ab76662f-c101-4640-8629-5975d5d28c8f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"The header authorization token required by this api
\n","key":"Authorization","type":"text","value":"Bearer {{base_token}}"}],"body":{"mode":"raw","raw":""},"url":"{{base_url}}/v2/stores/:storeNumber/plans?isPublic=true","description":"This request returns a list of available plans for the account to use in the Create Store request and/or plans which can be used for a specific store in the Change Plan request. This request can be filtered by IsPublic which is optional.
Response object
\n","urlObject":{"path":["v2","stores",":storeNumber","plans"],"host":["{{base_url}}"],"query":[{"description":{"content":"(Optional) When provided plans will be filtered by isPublic
\n","type":"text/plain"},"key":"isPublic","value":"true"}],"variable":[{"description":{"content":"(Optional) When storeNumber is specified the response will indicate by ChangePlanType which plans the store can migrate to using the ChangePlan request
\n","type":"text/plain"},"type":"any","value":"{{store_number}}","key":"storeNumber"}]}},"response":[{"id":"7d701379-1f0c-40f3-ac0c-c68b33cd9ceb","name":"200 Success","originalRequest":{"method":"GET","header":[{"description":"The header authorization token required by this api","key":"Authorization","type":"text","value":"Bearer {{base_token}}"}],"body":{"mode":"raw","raw":""},"url":{"raw":"{{base_url}}/v2/stores/:storeNumber/plans?isPublic=false","host":["{{base_url}}"],"path":["v2","stores",":storeNumber","plans"],"query":[{"key":"isPublic","value":"false","description":"(Optional) When provided plans will be filtered by isPublic"}],"variable":[{"description":"(Optional) When storeNumber is specified the response will indicate by ChangePlanType which plans the store can migrate to using the ChangePlan request","key":"storeNumber","value":"{{store_number}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.5"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Fri, 01 Feb 2019 21:23:57 GMT"},{"key":"Content-Length","value":"1572"}],"cookie":[],"responseTime":null,"body":"{\n \"Success\": true,\n \"Message\": \"\",\n \"Plans\": [\n {\n \"PlanCode\": \"{{store_plancode}}\",\n \"PlanName\": \"{{store_planname}}\",\n \"Description\": \"Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.\",\n \"PlanFrequencies\": [\n \"{{store_planfreq}}\"\n ],\n \"ChangePlanType\": \"{{store_changeplantype}}\",\n \"IsPublic\": false\n }\n ]\n}"}],"_postman_id":"ab76662f-c101-4640-8629-5975d5d28c8f"},{"name":"Generate Login Link","id":"22c6024f-4ae6-4c3f-9aab-cfab8d35486b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"The header authorization token required by this api
\n","key":"Authorization","type":"text","value":"Bearer {{base_token}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"EmailAddress\":\"ws_testuser_1@mailinator.com\",\n\t\"FirstName\": \"Geralt\",\n\t\"LastName\":\"of Rivia\"\n}"},"url":"{{base_url}}/v2/stores/51329575/login","description":"This request returns a login link for the specified user and store. Request object and path parameter are Required
\nRequest object
\nResponse object
\n","urlObject":{"path":["v2","stores","51329575","login"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"c6e44ea9-e912-4e03-b696-6f77ae63e644","name":"200 Success","originalRequest":{"method":"POST","header":[{"description":"The header authorization token required by this api","key":"Authorization","type":"text","value":"Bearer {{base_token}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"EmailAddress\":\"{{store_email}}\",\n\t\"FirstName\": \"{{store_firstname}}\",\n\t\"LastName\":\"{{store_lastname}}\"\n}"},"url":{"raw":"{{base_url}}/v2/stores/:storeNumber/login","host":["{{base_url}}"],"path":["v2","stores",":storeNumber","login"],"variable":[{"description":"The id reference of the store","key":"storeNumber","value":"{{store_number}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.5"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Fri, 01 Feb 2019 21:21:38 GMT"},{"key":"Content-Length","value":"236"}],"cookie":[],"responseTime":null,"body":"{\n \"Success\": true,\n \"Message\": \"\",\n \"LoginUrl\": \"subdomain.domain.com/sso/login?token={{token}}\"\n}"}],"_postman_id":"22c6024f-4ae6-4c3f-9aab-cfab8d35486b"},{"name":"Read Store","id":"2f5756b9-ce3f-4f8a-89db-baeca08d4080","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"The header authorization token required by this api
\n","key":"Authorization","type":"text","value":"Bearer {{base_token}}"}],"url":"{{base_url}}/v2/stores/:storeNumber/","description":"This request returns a single store's details. Path parameter is Required
\nResponse object
\n","urlObject":{"path":["v2","stores",":storeNumber",""],"host":["{{base_url}}"],"query":[],"variable":[{"description":{"content":"The id reference of the store
\n","type":"text/plain"},"type":"any","value":"{{store_number}}","key":"storeNumber"}]}},"response":[{"id":"7e65e228-c13f-4aa8-a2b0-9f714bcb724d","name":"200 Success","originalRequest":{"method":"GET","header":[{"description":"The header authorization token required by this api","key":"Authorization","type":"text","value":"Bearer {{base_token}}"}],"url":{"raw":"{{base_url}}/v2/stores/:storeNumber/","host":["{{base_url}}"],"path":["v2","stores",":storeNumber",""],"variable":[{"description":"The id reference of the store","key":"storeNumber","value":"{{store_number}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.5"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Fri, 01 Feb 2019 21:19:21 GMT"},{"key":"Content-Length","value":"517"}],"cookie":[],"responseTime":null,"body":"{\n \"Success\": true,\n \"Message\": \"\",\n \"Store\": {\n \"StoreNumber\": \"{{store_number}}\",\n \"StoreName\": \"{{store_name}}\",\n \"IsActive\": true,\n \"DefaultContactEmailAddresses\": \"{{store_emails}}\",\n \"DomainName\": \"{{store_domain}}\",\n \"TimeZoneDescription\": \"(GMT -5:00) Eastern Standard Time\",\n \"TimeZoneType\": \"EST\",\n \"DateCreated\": \"2018-10-24T15:37:27.04Z\",\n \"DateUpdated\": \"2018-10-24T15:37:27.04Z\",\n \"DateDeactivated\": null,\n \"DateActivated\": \"2018-10-24T15:37:28.04Z\",\n \"PlanCode\": \"{{store_plancode}}\",\n \"PlanFrequency\": \"{{store_planfreq}}\"\n }\n}"}],"_postman_id":"2f5756b9-ce3f-4f8a-89db-baeca08d4080"},{"name":"List Stores","id":"103fe14e-fb58-417f-bd00-ebbf51a72451","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"The header authorization token required by this api
\n","key":"Authorization","type":"text","value":"Bearer {{base_token}}"}],"body":{"mode":"raw","raw":""},"url":"{{base_url}}/v2/stores?storeNumbers={{store_numbers}}&storeName={{store_name}}&planCode={{store_plancode}}&pageNumber={{base_pagenumber}}&pageSize={{base_pagesize}}&sortBy={{store_sortby}}&sortOrder={{base_sortorder}}&isActive=true","description":"This request returns all stores associated with the account token. This request can be filtered, sorted, and paged. All parameters are optional.
\nResponse object
\n","urlObject":{"path":["v2","stores"],"host":["{{base_url}}"],"query":[{"description":{"content":"Filters response by store numbers specified as a comma-delimitted list
\n","type":"text/plain"},"key":"storeNumbers","value":"{{store_numbers}}"},{"description":{"content":"Filters response by store names that contain the specified value
\n","type":"text/plain"},"key":"storeName","value":"{{store_name}}"},{"description":{"content":"Filters response by subscription plan code
\n","type":"text/plain"},"key":"planCode","value":"{{store_plancode}}"},{"description":{"content":"The specific page of objects to return
\n","type":"text/plain"},"key":"pageNumber","value":"{{base_pagenumber}}"},{"description":{"content":"Number of objects to return per page
\n","type":"text/plain"},"key":"pageSize","value":"{{base_pagesize}}"},{"description":{"content":"The value to sort results by
\n","type":"text/plain"},"key":"sortBy","value":"{{store_sortby}}"},{"description":{"content":"The direction to sort results by
\n","type":"text/plain"},"key":"sortOrder","value":"{{base_sortorder}}"},{"description":{"content":"Filter by active stores
\n","type":"text/plain"},"key":"isActive","value":"true"}],"variable":[]}},"response":[{"id":"dab23a22-d635-481e-9037-c6c1b5392294","name":"200 Success","originalRequest":{"method":"GET","header":[{"description":"The header authorization token required by this api","key":"Authorization","type":"text","value":"Bearer {{base_token}}"}],"body":{"mode":"raw","raw":""},"url":{"raw":"{{base_url}}/v2/stores?storeNumbers={{store_numbers}}&storeName={{store_name}}&planCode={{store_plancode}}&pageNumber={{base_pagenumber}}&pageSize={{base_pagesize}}&sortBy={{store_sortby}}&sortOrder={{base_sortorder}}&isActive=true","host":["{{base_url}}"],"path":["v2","stores"],"query":[{"key":"storeNumbers","value":"{{store_numbers}}","description":"Filters response by store numbers specified as a comma-delimitted list "},{"key":"storeName","value":"{{store_name}}","description":"Filters response by store names that contain the specified value"},{"key":"planCode","value":"{{store_plancode}}","description":"Filters response by subscription plan code"},{"key":"pageNumber","value":"{{base_pagenumber}}","description":"The specific page of objects to return"},{"key":"pageSize","value":"{{base_pagesize}}","description":"Number of objects to return per page"},{"key":"sortBy","value":"{{store_sortby}}","description":"The value to sort results by"},{"key":"sortOrder","value":"{{base_sortorder}}","description":"The direction to sort results by"},{"key":"isActive","value":"true","description":"Filter by active stores"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.5"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Fri, 01 Feb 2019 21:13:36 GMT"},{"key":"Content-Length","value":"750"}],"cookie":[],"responseTime":null,"body":"{\n \"Success\": true,\n \"Message\": \"\",\n \"Paging\": {\n \"TotalRecords\": 1,\n \"TotalPages\": 1,\n \"PageNumber\": 1,\n \"PageSize\": 50,\n \"MaxPageSize\": 50\n },\n \"Sorting\": {\n \"SortBy\": \"Name\",\n \"SortOrder\": \"Asc\",\n \"AllowedSortOrder\": \"Asc, Desc\",\n \"AllowedSortBy\": \"Name, Number\"\n },\n \"Stores\": [\n {\n \"StoreNumber\": \"{{store_number}}\",\n \"StoreName\": \"{{store_name}}\",\n \"IsActive\": true,\n \"DefaultContactEmailAdressess\": \"{{store_email}}\",\n \"DomainName\": \"{{store_domain}}\",\n \"TimeZoneType\": \"EST\",\n \"TimeZoneDescription\": \"(GMT -5:00) Eastern Standard Time\",\n \"DateCreated\": \"2018-10-24T15:37:27.04Z\",\n \"DateUpdated\": \"2019-02-27T20:18:10.813Z\",\n \"DateDeactivated\": null,\n \"DateActivated\": \"2019-02-27T20:18:13.093Z\",\n \"PlanCode\": \"{{store_plancode}}\",\n \"PlanFrequency\": \"{{store_planfreq}}\"\n }\n ]\n}"}],"_postman_id":"103fe14e-fb58-417f-bd00-ebbf51a72451"},{"name":"Update Store","id":"85d1f352-d689-4674-be13-77443cb9937e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"description":"The header authorization token required by this api
\n","key":"Authorization","type":"text","value":"Bearer {{base_token}}"}],"body":{"mode":"raw","raw":"{\n \"DefaultContactEmailAddresses\": \"{{store_emails}}\",\n \"DomainName\": \"{{store_domain}}\",\n \"StoreName\": \"{{store_name}}\",\n \"TimeZoneType\": \"{{store_timezonetype}}\"\n}"},"url":"{{base_url}}/v2/stores/:storeNumber/update","description":"This request updates a given store's details, such as store name, domain, email and timezone. Request object a path parameters are required
\nRequest object
\n\n\n","urlObject":{"path":["v2","stores",":storeNumber","update"],"host":["{{base_url}}"],"query":[],"variable":[{"description":{"content":"Note: please use Change Plan to update either
\nPlanCodeorPlanFrequency
The id reference of the store
\n","type":"text/plain"},"type":"any","value":"{{store_number}}","key":"storeNumber"}]}},"response":[{"id":"f356e74d-1b7b-44c9-aff1-18eaeaea5d0f","name":"200 Success","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"description":"The header authorization token required by this api","key":"Authorization","type":"text","value":"Bearer {{base_token}}"}],"body":{"mode":"raw","raw":"{\n \"DefaultContactEmailAddresses\": \"{{store_emails}}\",\n \"DomainName\": \"{{store_domain}}\",\n \"StoreName\": \"{{store_name}}\",\n \"TimeZoneType\": \"{{store_timezonetype}}\"\n}"},"url":{"raw":"{{base_url}}/v2/stores/:storeNumber/update","host":["{{base_url}}"],"path":["v2","stores",":storeNumber","update"],"variable":[{"description":"The id reference of the store","key":"storeNumber","value":"{{store_number}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"Success\": true,\n \"Message\": \"\"\n}"}],"_postman_id":"85d1f352-d689-4674-be13-77443cb9937e"},{"name":"Change Plan","id":"f3fe3840-4924-4d74-b067-2177da9d146a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"description":"The header authorization token required by this api
\n","key":"Authorization","type":"text","value":"Bearer {{base_token}}"}],"body":{"mode":"raw","raw":"{\n\t\"planCode\":\"{{store_plancode}}\",\n\t\"planFrequency\":\"{{store_planfreq}}\",\n\t\"changePlanType\":\"{{store_changeplantype}}\"\n}"},"url":"{{base_url}}/v2/stores/:storeNumber/changeplan","description":"This request changes an active store's current subscription plan. Check the ChangePlanType property in the Get Plans response to see which plans can be used in the Change Plan request for the specified store. Request object and path parameter is required
Request object
\n\n\n","urlObject":{"path":["v2","stores",":storeNumber","changeplan"],"host":["{{base_url}}"],"query":[],"variable":[{"description":{"content":"Note: please use Deactivate Store request to cancel the store's subscription
\n
The id reference of the store
\n","type":"text/plain"},"type":"any","value":"{{store_number}}","key":"storeNumber"}]}},"response":[{"id":"42575b92-eff0-48b0-8679-0a96f4afd612","name":"200 Success","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{base_token}}","description":"The header authorization token required by this api","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"planCode\":\"{{store_plancode}}\",\n\t\"planFrequency\":\"{{store_planfreq}}\",\n\t\"changePlanType\":\"{{store_changeplantype}}\"\n}"},"url":{"raw":"{{base_url}}/v2/stores/:storeNumber/changeplan","host":["{{base_url}}"],"path":["v2","stores",":storeNumber","changeplan"],"variable":[{"key":"storeNumber","value":"{{store_number}}","description":"The id reference of the store"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"Success\": true,\n \"Message\": \"\"\n}"}],"_postman_id":"f3fe3840-4924-4d74-b067-2177da9d146a"},{"name":"Activate Store","id":"4df01f05-7976-4981-a542-acb6e9792706","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"description":"The header authorization token required by this api
\n","key":"Authorization","type":"text","value":"Bearer {{base_token}}"}],"body":{"mode":"raw","raw":"{\r\n \"planCode\": \"{{store_plancode}}\",\r\n \"planFrequency\": \"{{store_planfreq}}\"\r\n}"},"url":"{{base_url}}/v2/stores/:storeNumber/activate","description":"This request activates a store on the specified plan. Request object and path parameter is required
\nRequest object
\n","urlObject":{"path":["v2","stores",":storeNumber","activate"],"host":["{{base_url}}"],"query":[],"variable":[{"description":{"content":"The id reference of the store
\n","type":"text/plain"},"type":"any","value":"{{store_number}}","key":"storeNumber"}]}},"response":[{"id":"9977607b-58a0-418f-aa3d-71b0895f36c7","name":"200 Success","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"description":"The header authorization token required by this api","key":"Authorization","type":"text","value":"Bearer {{base_token}}"}],"body":{"mode":"raw","raw":"{\r\n \"planCode\": \"{{store_plancode}}\",\r\n \"planFrequency\": \"{{store_planfreq}}\"\r\n}"},"url":{"raw":"{{base_url}}/v2/stores/:storeNumber/activate","host":["{{base_url}}"],"path":["v2","stores",":storeNumber","activate"],"variable":[{"description":"The id reference of the store","key":"storeNumber","value":"{{store_number}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"Success\": true,\n \"Message\": \"\"\n}"}],"_postman_id":"4df01f05-7976-4981-a542-acb6e9792706"},{"name":"Deactivate Store","id":"71480554-a50f-4c52-89bb-df0a25060ef6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"description":"The header authorization token required by this api
\n","key":"Authorization","type":"text","value":"Bearer {{base_token}}"}],"body":{"mode":"raw","raw":""},"url":"{{base_url}}/v2/stores/:storeNumber/deactivate","description":"This request cancels a store subscription and deactivates the store. Path parameter is required
\n","urlObject":{"path":["v2","stores",":storeNumber","deactivate"],"host":["{{base_url}}"],"query":[],"variable":[{"description":{"content":"The id reference of the store
\n","type":"text/plain"},"type":"any","value":"{{store_number}}","key":"storeNumber"}]}},"response":[{"id":"85b150e7-52e2-44b8-9981-2bda132b86d8","name":"200 Success","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"description":"The header authorization token required by this api","key":"Authorization","type":"text","value":"Bearer {{base_token}}"}],"body":{"mode":"raw","raw":""},"url":{"raw":"{{base_url}}/v2/stores/:storeNumber/deactivate","host":["{{base_url}}"],"path":["v2","stores",":storeNumber","deactivate"],"variable":[{"description":"The id reference of the store","key":"storeNumber","value":"{{store_number}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"Success\": true,\n \"Message\": \"\"\n}"}],"_postman_id":"71480554-a50f-4c52-89bb-df0a25060ef6"},{"name":"Delete Store","id":"c5210b53-f7e5-4a42-8362-46bd4f801520","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"description":"The header authorization token required by this api
\n","key":"Authorization","type":"text","value":"Bearer {{base_token}}"}],"body":{"mode":"raw","raw":""},"url":"{{base_url}}/v2/stores/:storeNumber/delete","description":"Caution: this request permanently removes a deactivated store from the account and cannot be reversed. Please note, this request will not work if the store is active. You must first deactivate the store before you can delete the store. Path parameter is required
\n","urlObject":{"path":["v2","stores",":storeNumber","delete"],"host":["{{base_url}}"],"query":[],"variable":[{"description":{"content":"The id reference of the store
\n","type":"text/plain"},"type":"any","value":"{{store_number}}","key":"storeNumber"}]}},"response":[{"id":"6ccfcd6a-c6f5-4e6d-9b13-10dda2396445","name":"200 Success","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"description":"The header authorization token required by this api","key":"Authorization","type":"text","value":"Bearer {{base_token}}"}],"body":{"mode":"raw","raw":""},"url":{"raw":"{{base_url}}/v2/stores/:storeNumber/delete","host":["{{base_url}}"],"path":["v2","stores",":storeNumber","delete"],"variable":[{"description":"The id reference of the store","key":"storeNumber","value":"{{store_number}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"Success\": true,\n \"Message\": \"\"\n}"}],"_postman_id":"c5210b53-f7e5-4a42-8362-46bd4f801520"}],"id":"1b075c55-db99-44c1-a568-92cc7682d1a9","event":[{"listen":"prerequest","script":{"id":"5b5c98ad-22d7-4ade-ba1e-0cb547e6b7d9","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"513214aa-d26a-4931-9065-0a3b571466b1","type":"text/javascript","exec":[""]}}],"_postman_id":"1b075c55-db99-44c1-a568-92cc7682d1a9","description":""},{"name":"Feeds","item":[{"name":"Read Feed","id":"ddd4823c-d475-4ac4-b657-c7a422f8f9a2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"description":"The header authorization token required by this api
\n","key":"Authorization","value":"Bearer {{base_token}}"}],"url":"{{base_url}}/v2/feeds/:feedNumber/","description":"This request returns a single feed's details. Path parameter is required
\nResponse object
\n","urlObject":{"path":["v2","feeds",":feedNumber",""],"host":["{{base_url}}"],"query":[],"variable":[{"description":{"content":"The id reference of the feed
\n","type":"text/plain"},"type":"any","value":"{{feed_number}}","key":"feedNumber"}]}},"response":[{"id":"741e53bc-a934-4423-8a86-2d6de3d4882f","name":"200 Success","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{base_token}}","description":"The header authorization token required by this api"}],"url":{"raw":"{{base_url}}/v2/feeds/:feedNumber/","host":["{{base_url}}"],"path":["v2","feeds",":feedNumber",""],"variable":[{"key":"feedNumber","value":"{{feed_number}}","description":"The id reference of the feed"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.5"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Fri, 01 Feb 2019 21:00:34 GMT"},{"key":"Content-Length","value":"682"}],"cookie":[],"responseTime":null,"body":"{\n \"Success\": true,\n \"Message\": \"\",\n \"Feed\": {\n \"FeedNumber\": \"{{feed_number}}\",\n \"FeedName\": \"{{feed_name}}\",\n \"FileName\": \"product-feed.csv\",\n \"ProcessingStatus\": \"Completed\",\n \"ProcessingStatusError\": null,\n \"DateLastError\": null,\n \"DateLastCompiledSuccessfully\": \"2018-10-24T15:37:27.04Z\",\n \"DateLastSubmittedSuccessfully\": null,\n \"DateLastPulledSuccessfully\": null,\n \"CompilationTotalCount\": 10329,\n \"CompilationValidCount\": 0,\n \"CompilationWarningCount\": 10329,\n \"CompilationErrorCount\": 0,\n \"ChannelProcessingReportErrorCount\": 0,\n \"ChannelProcessingReportWarningCount\": 0,\n \"SubmissionProductCount\": null,\n \"IsActive\": true\n }\n}"}],"_postman_id":"ddd4823c-d475-4ac4-b657-c7a422f8f9a2"},{"name":"List Feeds","id":"6464e7f1-dfeb-4889-ace8-3a05607d75ab","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"description":"The header authorization token required by this api
\n","key":"Authorization","value":"Bearer {{base_token}}"}],"url":"{{base_url}}/v2/feeds?pageNumber={{base_pagenumber}}&pageSize={{base_pagesize}}&sortBy={{feed_sortby}}&sortOrder={{base_sortorder}}&feedNumbers={{feed_numbers}}&storeNumbers={{store_numbers}}&hasProcessingStatusError=true&hasCompiledValidationErrors=true&hasChannelProcessingReportErrors=true&isActive=true&feedName={{feed_name}}","description":"This request returns a list of feeds. This request can be filtered, sorted, and paged. All parameters are optional.
\nResponse object
\n","urlObject":{"path":["v2","feeds"],"host":["{{base_url}}"],"query":[{"description":{"content":"The specific page of objects to return
\n","type":"text/plain"},"key":"pageNumber","value":"{{base_pagenumber}}"},{"description":{"content":"Number of objects to return per page
\n","type":"text/plain"},"key":"pageSize","value":"{{base_pagesize}}"},{"description":{"content":"The value to sort results by
\n","type":"text/plain"},"key":"sortBy","value":"{{feed_sortby}}"},{"description":{"content":"The direction to sort results by
\n","type":"text/plain"},"key":"sortOrder","value":"{{base_sortorder}}"},{"description":{"content":"Returns specific feeds. When this parameter is provided, all other parameters will be ignored
\n","type":"text/plain"},"key":"feedNumbers","value":"{{feed_numbers}}"},{"description":{"content":"Returns all feeds for the specified store numbers. When not provided all feeds will be returned for all stores unless the feedNumbers parameter is provided.
\n","type":"text/plain"},"key":"storeNumbers","value":"{{store_numbers}}"},{"description":{"content":"Filters feeds by processing status error
\n","type":"text/plain"},"key":"hasProcessingStatusError","value":"true"},{"description":{"content":"Filters feeds that have compiled and contain validation errors
\n","type":"text/plain"},"key":"hasCompiledValidationErrors","value":"true"},{"description":{"content":"Filters feeds that have submitted and have processing report errors from the channel
\n","type":"text/plain"},"key":"hasChannelProcessingReportErrors","value":"true"},{"description":{"content":"Filters feeds that are active
\n","type":"text/plain"},"key":"isActive","value":"true"},{"description":{"content":"Search for feeds by feed name
\n","type":"text/plain"},"key":"feedName","value":"{{feed_name}}"}],"variable":[]}},"response":[{"id":"2676b80b-bb07-4d1f-a206-4c90556d3710","name":"200 Success","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{base_token}}","description":"The header authorization token required by this api"}],"url":{"raw":"{{base_url}}/v2/feeds?pageNumber={{base_pagenumber}}&pageSize={{base_pagesize}}&sortBy={{base_sortby}}&sortOrder={{base_sortorder}}&feedNumbers={{feed_numbers}}&storeNumbers={{store_numbers}}&hasProcessingStatusError=true&hasCompiledValidationErrors=true&hasChannelProcessingReportErrors=true&isActive=true&feedName={{feed_name}}","host":["{{base_url}}"],"path":["v2","feeds"],"query":[{"key":"pageNumber","value":"{{base_pagenumber}}","description":"The specific page of objects to return"},{"key":"pageSize","value":"{{base_pagesize}}","description":"Number of objects to return per page"},{"key":"sortBy","value":"{{base_sortby}}","description":"The value to sort results by"},{"key":"sortOrder","value":"{{base_sortorder}}","description":"The direction to sort results by"},{"key":"feedNumbers","value":"{{feed_numbers}}","description":"Returns specific feeds. When this parameter is provided, all other parameters will be ignored"},{"key":"storeNumbers","value":"{{store_numbers}}","description":"Returns all feeds for the specified store numbers. When not provided all feeds will be returned for all stores unless the feedNumbers parameter is provided."},{"key":"hasProcessingStatusError","value":"true","description":"Filters feeds by processing status error"},{"key":"hasCompiledValidationErrors","value":"true","description":"Filters feeds that have compiled and contain validation errors"},{"key":"hasChannelProcessingReportErrors","value":"true","description":"Filters feeds that have submitted and have processing report errors from the channel"},{"key":"isActive","value":"true","description":"Filters feeds that are active"},{"key":"feedName","value":"{{feed_name}}","description":"Search for feeds by feed name"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.5"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Fri, 01 Feb 2019 20:36:34 GMT"},{"key":"Content-Length","value":"1705"}],"cookie":[],"responseTime":null,"body":"{\n \"Success\": true,\n \"Message\": \"\",\n \"FeedList\": [\n {\n \"Store\": {\n \"StoreNumber\": \"{{store_number}}\",\n \"StoreName\": \"{{store_name}}\"\n },\n \"Feeds\": [\n {\n \"FeedNumber\": \"{{feed_number}}\",\n \"FeedName\": \"{{feed_name}}\",\n \"FileName\": \"product-feed.csv\",\n \"ProcessingStatus\": \"Completed\",\n \"ProcessingStatusError\": null,\n \"DateLastError\": null,\n \"DateLastCompiledSuccessfully\": \"2019-02-11T19:45:17.88Z\",\n \"DateLastSubmittedSuccessfully\": null,\n \"DateLastPulledSuccessfully\": null,\n \"CompilationTotalCount\": 10329,\n \"CompilationValidCount\": 0,\n \"CompilationWarningCount\": 10329,\n \"CompilationErrorCount\": 0,\n \"ChannelProcessingReportErrorCount\": 0,\n \"ChannelProcessingReportWarningCount\": 0,\n \"SubmissionProductCount\": 0,\n \"IsActive\": true\n }\n ]\n }\n ]\n}"}],"_postman_id":"6464e7f1-dfeb-4889-ace8-3a05607d75ab"},{"name":"Read Feed Validation Reports","id":"9a9dd0a7-7d9a-4d30-8580-8328107986f5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{base_token}}","description":"The header authorization token required by this api
\n"}],"url":"{{base_url}}/v2/feeds/:feedNumber/validation?pageNumber={{base_pagenumber}}&pageSize={{base_pagesize}}&sortOrder={{base_sortorder}}&sortBy={{validation_sortby}}","description":"This request returns validation report messages for products in a feed in a .JSON formatted response object list. Path parameter is required
\n","urlObject":{"path":["v2","feeds",":feedNumber","validation"],"host":["{{base_url}}"],"query":[{"description":{"content":"The specific page of objects to return
\n","type":"text/plain"},"key":"pageNumber","value":"{{base_pagenumber}}"},{"description":{"content":"Number of objects to return per page
\n","type":"text/plain"},"key":"pageSize","value":"{{base_pagesize}}"},{"description":{"content":"The direction to sort results by
\n","type":"text/plain"},"key":"sortOrder","value":"{{base_sortorder}}"},{"description":{"content":"The value to sort results by
\n","type":"text/plain"},"key":"sortBy","value":"{{validation_sortby}}"}],"variable":[{"description":{"content":"The id reference of the feed
\n","type":"text/plain"},"type":"any","value":"{{feed_number}}","key":"feedNumber"}]}},"response":[{"id":"d7f112c2-f243-45d2-942a-dc43b514d55f","name":"200 Success","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","disabled":true},{"key":"Authorization","value":"Bearer {{base_token}}","description":"The header authorization token required by this api"}],"url":{"raw":"{{base_url}}/v2/feeds/:feedNumber/validation?pageNumber={{base_pagenumber}}&pageSize={{base_pagesize}}&sortOrder={{base_sortorder}}&sortBy={{validation_sortby}}","host":["{{base_url}}"],"path":["v2","feeds",":feedNumber","validation"],"query":[{"key":"pageNumber","value":"{{base_pagenumber}}","description":"The specific page of objects to return"},{"key":"pageSize","value":"{{base_pagesize}}","description":"Number of objects to return per page"},{"key":"sortOrder","value":"{{base_sortorder}}","description":"The direction to sort results by"},{"key":"sortBy","value":"{{validation_sortby}}","description":"The value to sort results by"}],"variable":[{"key":"feedNumber","value":"{{feed_number}}","description":"The id reference of the feed"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.5"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Fri, 01 Feb 2019 21:11:55 GMT"},{"key":"Content-Length","value":"562"}],"cookie":[],"responseTime":null,"body":"{\n \"Success\": true,\n \"Message\": \"\",\n \"Paging\": {\n \"TotalRecords\": 20658,\n \"TotalPages\": 20658,\n \"PageNumber\": 1,\n \"PageSize\": 1,\n \"MaxPageSize\": 5000\n },\n \"Sorting\": {\n \"SortBy\": \"Sku\",\n \"SortOrder\": \"Asc\",\n \"AllowedSortOrder\": \"Asc, Desc\",\n \"AllowedSortBy\": \"Sku, Type\"\n },\n \"FeedValidationList\": [\n {\n \"Sku\": \"10\",\n \"ValidationType\": \"Warning\",\n \"ValidationMessage\": \"If no values for `availability` are provided, the `availability` will be set to \\\"in stock\\\" by default.\"\n }\n ]\n}"}],"_postman_id":"9a9dd0a7-7d9a-4d30-8580-8328107986f5"},{"name":"Download Feed File","id":"eb5fce76-ca9f-487f-9e59-3c3a0d16152f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"The header authorization token required by this api
\n","key":"Authorization","value":"Bearer {{base_token}}"}],"url":"{{base_url}}/v2/feeds/:feedNumber/download","description":"This request downloads the feed file for the requested feed and returns a zipped .CSV file. Path parameter is required
\n","urlObject":{"path":["v2","feeds",":feedNumber","download"],"host":["{{base_url}}"],"query":[],"variable":[{"description":{"content":"The id reference of the feed
\n","type":"text/plain"},"type":"any","value":"{{feed_number}}","key":"feedNumber"}]}},"response":[],"_postman_id":"eb5fce76-ca9f-487f-9e59-3c3a0d16152f"}],"id":"7349c1bf-8895-4f3d-9d9f-71ce6e048de9","description":"Feed api endpoints.
\n","event":[{"listen":"prerequest","script":{"id":"b7aa88ad-ea31-414f-9e8e-3e7aef491132","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"54ee6103-1b04-4770-aab2-ee530ba94539","type":"text/javascript","exec":[""]}}],"_postman_id":"7349c1bf-8895-4f3d-9d9f-71ce6e048de9"}],"id":"271c0a8b-d495-44f2-bd0c-1749b8816812","description":"Our lastest version of the GoDataFeed API.\nV2 Private release 2/1/19.\nThis version of the API is currently not publicly available. \nPlease contact GoDataFeed for more information if interested in using this API.
\n","event":[{"listen":"prerequest","script":{"id":"b8382d23-c49a-4091-8f9e-b80f1e02e0e0","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"cb5b54de-1d95-47df-b453-cdaf0b592965","type":"text/javascript","exec":[""]}}],"_postman_id":"271c0a8b-d495-44f2-bd0c-1749b8816812"}],"event":[{"listen":"prerequest","script":{"id":"3ed7adb5-66ab-4712-a64f-0b43dc6e37a1","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"22796260-cef7-4456-a51f-908ce7452028","type":"text/javascript","exec":[""]}}],"variable":[{"key":"info_base_pagenumber","value":"The specific page of objects to return"},{"key":"info_base_pagesize","value":"Number of objects to return per page"},{"key":"info_base_sortby","value":"The value to sort results by"},{"key":"info_base_sortorder","value":"The direction to sort results by"},{"key":"info_base_token","value":"The header authorization token required by this api"},{"key":"info_feed_number","value":"The id reference of the feed"},{"key":"info_feed_numbers","value":"A comma delimitted list of feed numbers"},{"key":"info_store_number","value":"The id reference of the store"},{"key":"info_store_numbers","value":"A comma delimitted list of store numbers"}]}