Get the list of all the merchant's shops
Use this request to get the list of all the merchant's shops registered in the system.
Request
The requests must:
- use HTTP Basic authentication with your PSP ID and secret key as a username and a password respectively;
- have the
Content-Typeheader set toapplication/json; - have the
Acceptheader set toapplication/json; - be UTF-8 encoded.
Send a GET request to {YOUR DWH URL}/api/v1/shops?merchant_id={MERCHANT_ID}, where {MERCHANT_ID} is an identifier of the merchant account in the system.
Request example
~~~ccurl -v "{YOUR DWH URL}/api/v1/shops?merchant_id=1" \ -H "Authorization: Basic MTpwc3BfMV9rZXk=" \ -H "Content-Type: application/json" \ -H "Accept: application/json" ~~~
Response
The response contains the following parameters:
| Parameter | Type | Description |
|---|---|---|
| data | array | An array of the merchant's shop accounts. Each element represents an object with shop account details. |
| enabled * required | boolean | A status of the merchant's shop account. Possible values: true, if the shop is active;false, if the shop is inactive. |
| id * required | integer | An identifier of the merchant's shop account in the system. |
| name * required | string | A name of the merchant's shop. |
Info
Array data are sorted by a creation date of a shop account in the descending order.
Response example
{ "data": [ { "enabled":true, "id":2, "name":"Shop 2 Name" }, { "enabled":true, "id":1, "name":"Shop 1 Name" } ]}