List User Stores

Pending

GET

https://api.mpc.dev.placewise.com/v1/stores

API Permit:Stores:Api:Customers:Stores:List

API Context:Customers

Authorizations:User

List of all active stores

URL Parameters

Parameter	Description	Type
search	search filter	string
ids	filter by store ids	array
page_no	page number	integer
per_page	limit	integer

All parameters are optional

Example

When successful, returns an array of store objects structured like below. Some values may be omitted if were not provided:

{
    "stores": [
        {
            "id": 1,
            "parent_id": null,
            "store_id": null,
            "department_id": null,
            "name": "Store name",
            "department": null,
            "floor": null,
            "location": null,
            "zones": [],
            "description": null,
            "tenant_categories": [],
            "status": "active",
            "customer_id": 10,
            "customer_name": "Customer Name",
            "logo_url": "logo"
        }
    ],
    "pagination_info": {
        "total_count": 1,
        "per_page": 100,
        "total_pages": 1,
        "current_page": 1,
        "next_page": null,
        "prev_page": null,
        "is_first_page": true,
        "is_last_page": false,
        "is_out_of_range": false
    }
}

Request

Header Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Ruby

curl --location --request GET 'https://api.mpc.dev.placewise.com/v1/stores' \
--header 'X-User-Agent;' \
--header 'X-Product-Name;' \
--header 'X-Loyalty-Club-Slug;' \
--header 'X-Customer;' \
--header 'Authorization: Bearer '

Responses

🟢200Success

application/json

Body

Example

{}

Delete Store

List Store Categories

List User Stores

URL Parameters#

Example#

Request

Request Code Samples

Responses

URL Parameters

Example