Shops
Note: We are in the process of renaming Shops to Business Profiles
Shops play a central role in most transactions within our system. They can represent physical storefronts or digital web shops. The API calls below enable you to retrieve Shop data by listing Shops or retrieving a single Shop.
Most transactions and activities take place at a certain Shop, and so it's often a required parameter in POST endpoints.
List Shops
Retrieve all Shops belonging to an Account. In case this call is used for a Loyalty flow, then please check for a Loyalty program. None of the Loyalty API calls where a Shop ID is required will work if the Shop used is not linked to a Loyalty Program.
GET
https://api.piggy.eu/api//shopsHeaders
Authorization
Bearer {{ access_token | api_key }}Accept
application/jsonResponse Example
Show more
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
{
"data": [
{
"uuid": "123123",
"name": "Krusty Krab",
"type": "physical",
"reference": null
},
{
"uuid": "12312312312312",
"name": "Chum Bucket Online",
"type": "web",
"reference": ""
},
{
"uuid": "2222e1242t3324535",
"name": "Conch Street",
"type": "physical",
"reference": ""
},
],
"meta": {}
}Get Shop
Retrieve information of your Shop. This call is useful for getting insights into individual shop settings and attributes.
GET
https://api.piggy.eu/api//shops/{{shop_uuid}}Headers
ParamsAuthorization
Bearer {{ access_token | api_key }}Accept
application/jsonshop_uuidstringREQUIREDThe UUID of the Shop you want to retrieve.
Response Example
Show more
1
2
3
4
5
6
7
8
9
{
"data": {
"uuid": "123123",
"name": "Krusty Krab",
"type": "physical",
"reference": null
},
"meta": {}
}Code
Message
1008Shop not found.