revers

API change history

A public API provided by Revers.io to easily import your sales

RetrieveStores

Retrieve store for a network

Try it

Request

Request URL

Request headers

  • string
  • string
    Subscription key which provides access to this API. Found in your Profile.

Request body

Responses

200 OK

OK

Representations

{
  "value": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "chain": "string",
      "chainInternalId": "string",
      "name": "string",
      "description": "string",
      "telephones": [
        "string"
      ],
      "fax": "string",
      "mails": [
        "string"
      ],
      "address": {
        "companyName": "string",
        "streetAddress": "string",
        "additionalAddress": "string",
        "doorCode": "string",
        "floor": "string",
        "zipCode": "string",
        "city": "string",
        "countryCode": "string",
        "phone": "string"
      },
      "countryCode": "string",
      "longitude": 0.0,
      "latitude": 0.0,
      "openingHours": [
        {
          "day": "Sunday",
          "hours": [
            {
              "start": "string",
              "end": "string",
              "startToInteger": 0,
              "endToInteger": 0
            }
          ],
          "underCondition": true
        }
      ],
      "openingHoursComments": "string",
      "webSiteUrl": "string"
    }
  ],
  "pagination": {
    "total": 0,
    "page": 0,
    "pageSize": 0,
    "pageCount": 0,
    "hasPreviousPage": true,
    "hasNextPage": true
  },
  "errors": [
    {
      "subject": "string",
      "code": "string",
      "message": "string",
      "developerMessage": "string",
      "moreInfo": "string",
      "field": "string",
      "index": 0,
      "isWarning": true,
      "extraData": "string"
    }
  ],
  "isHandledError": true,
  "failure": true,
  "hasWarnings": true,
  "isNotFound": true
}
{
  "type": "object",
  "properties": {
    "value": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "format": "uuid",
            "type": "string",
            "example": "00000000-0000-0000-0000-000000000000"
          },
          "chain": {
            "type": "string"
          },
          "chainInternalId": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "telephones": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "fax": {
            "type": "string"
          },
          "mails": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "address": {
            "type": "object",
            "properties": {
              "companyName": {
                "type": "string"
              },
              "streetAddress": {
                "type": "string"
              },
              "additionalAddress": {
                "type": "string"
              },
              "doorCode": {
                "type": "string"
              },
              "floor": {
                "type": "string"
              },
              "zipCode": {
                "type": "string"
              },
              "city": {
                "type": "string"
              },
              "countryCode": {
                "type": "string"
              },
              "phone": {
                "type": "string"
              }
            }
          },
          "countryCode": {
            "type": "string"
          },
          "longitude": {
            "format": "double",
            "type": "number"
          },
          "latitude": {
            "format": "double",
            "type": "number"
          },
          "openingHours": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "day": {
                  "enum": [
                    "Sunday",
                    "Monday",
                    "Tuesday",
                    "Wednesday",
                    "Thursday",
                    "Friday",
                    "Saturday"
                  ],
                  "type": "string"
                },
                "hours": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "start": {
                        "type": "string"
                      },
                      "end": {
                        "type": "string"
                      },
                      "startToInteger": {
                        "format": "int32",
                        "type": "integer",
                        "readOnly": true
                      },
                      "endToInteger": {
                        "format": "int32",
                        "type": "integer",
                        "readOnly": true
                      }
                    }
                  }
                },
                "underCondition": {
                  "type": "boolean"
                }
              }
            }
          },
          "openingHoursComments": {
            "type": "string"
          },
          "webSiteUrl": {
            "type": "string"
          }
        }
      }
    },
    "pagination": {
      "type": "object",
      "properties": {
        "total": {
          "format": "int64",
          "type": "integer",
          "readOnly": true
        },
        "page": {
          "format": "int32",
          "type": "integer",
          "readOnly": true
        },
        "pageSize": {
          "format": "int32",
          "type": "integer",
          "readOnly": true
        },
        "pageCount": {
          "format": "int32",
          "type": "integer",
          "readOnly": true
        },
        "hasPreviousPage": {
          "type": "boolean",
          "readOnly": true
        },
        "hasNextPage": {
          "type": "boolean",
          "readOnly": true
        }
      }
    },
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "subject": {
            "type": "string"
          },
          "code": {
            "type": "string"
          },
          "message": {
            "type": "string"
          },
          "developerMessage": {
            "type": "string"
          },
          "moreInfo": {
            "type": "string"
          },
          "field": {
            "type": "string"
          },
          "index": {
            "format": "int32",
            "type": "integer"
          },
          "isWarning": {
            "type": "boolean"
          },
          "extraData": {
            "type": "string"
          }
        }
      }
    },
    "isHandledError": {
      "type": "boolean"
    },
    "failure": {
      "type": "boolean",
      "readOnly": true
    },
    "hasWarnings": {
      "type": "boolean",
      "readOnly": true
    },
    "isNotFound": {
      "type": "boolean",
      "readOnly": true
    }
  }
}

400 Bad Request

A business error happened, details are provided in the response

Representations

401 Unauthorized

You did not provide a valid authentication

Representations

403 Forbidden

The authentication you provided does not allow this action

Representations

Code samples

@ECHO OFF

curl -v -X GET "https://customer-api.revers.io/api/v1/stores"
-H "Authorization: "
-H "Ocp-Apim-Subscription-Key: {subscription key}"

--data-ascii "{body}" 
using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;

namespace CSHttpClientSample
{
    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }
        
        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);

            // Request headers
            client.DefaultRequestHeaders.Add("Authorization", "");
            client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");

            var uri = "https://customer-api.revers.io/api/v1/stores?" + queryString;

            var response = await client.GetAsync(uri);
        }
    }
}	
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class JavaSample 
{
    public static void main(String[] args) 
    {
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("https://customer-api.revers.io/api/v1/stores");


            URI uri = builder.build();
            HttpGet request = new HttpGet(uri);
            request.setHeader("Authorization", "");
            request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");


            // Request body
            StringEntity reqEntity = new StringEntity("{body}");
            request.setEntity(reqEntity);

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null) 
            {
                System.out.println(EntityUtils.toString(entity));
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }
}

<!DOCTYPE html>
<html>
<head>
    <title>JSSample</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
        };
      
        $.ajax({
            url: "https://customer-api.revers.io/api/v1/stores?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Authorization","");
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
            },
            type: "GET",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>
#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
    
    NSString* path = @"https://customer-api.revers.io/api/v1/stores";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"GET"];
    // Request headers
    [_request setValue:@"" forHTTPHeaderField:@"Authorization"];
    [_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

    if (nil != error)
    {
        NSLog(@"Error: %@", error);
    }
    else
    {
        NSError* error = nil;
        NSMutableDictionary* json = nil;
        NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
        NSLog(@"%@", dataString);
        
        if (nil != _connectionData)
        {
            json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
        }
        
        if (error || !json)
        {
            NSLog(@"Could not parse loaded json with error:%@", error);
        }
        
        NSLog(@"%@", json);
        _connectionData = nil;
    }
    
    [pool drain];

    return 0;
}
<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';

$request = new Http_Request2('https://customer-api.revers.io/api/v1/stores');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Authorization' => '',
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_GET);

// Request body
$request->setBody("{body}");

try
{
    $response = $request->send();
    echo $response->getBody();
}
catch (HttpException $ex)
{
    echo $ex;
}

?>
########### Python 2.7 #############
import httplib, urllib, base64

headers = {
    # Request headers
    'Authorization': '',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('customer-api.revers.io')
    conn.request("GET", "/api/v1/stores?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
    # Request headers
    'Authorization': '',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
})

try:
    conn = http.client.HTTPSConnection('customer-api.revers.io')
    conn.request("GET", "/api/v1/stores?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################
require 'net/http'

uri = URI('https://customer-api.revers.io/api/v1/stores')


request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['Authorization'] = ''
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

puts response.body