Get list of stores

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Query Parameters

count?integer

Number of results

Default20

Rangevalue <= 200

after?string

Id or base64 encoded cursor(id + sortKey)

before?string

Id or base64 encoded cursor(id + sortKey)

orderBy?string

The sort key, sorting by id by default

direction?string

Direction of sorting

Value in"asc" | "desc"

id?integer

Id of a physical store. The id is required when retailer want to make a call to specified store.

status?string

Status of a store, indicates whether the store is open to customers

Value in"OPEN" | "CLOSED" | "CLOSED_FOR_MAINTENANCE"

externalId?string

External id of a store, retailers can specify their own id for the store via this field

We would send this field in the payload of checkout webhook with key storeExternalId

For example, we will include "storeExternalId": "store0001" in the payload of checkout webhook if retailer specifies this field with "store0001"

deploymentStatus?string

Deployment status of a store, indicated whether the store is live, under deployment or testing

Value in"LIVE" | "TESTING" | "DEPLOYMENT" | "DECOMMISSIONED"

aifiUniqueStoreId?string

Unique identifier across all AiFi stores. it will only be filled in by TechOPS/deployment engineers

Response Body

`application/json`

curl -X GET "https://oasis-api.public.sandbox.oasis.aifi.com/api/admin/v2/stores"

{
  "stores": [
    {
      "aifiUniqueStoreId": "string",
      "status": "OPEN",
      "deploymentStatus": "LIVE",
      "addressLine1": "string",
      "addressCity": "string",
      "addressRegion": "string",
      "addressCountry": "AC",
      "addressPostalCode": "string",
      "id": "string",
      "store": {
        "oasisApiStoreId": 0,
        "aifiUniqueStoreId": "string"
      },
      "name": "",
      "displayableName": "",
      "thirdPartyId": "string",
      "storeUrl": "string",
      "maxPeople": 0,
      "storeConfigId": 0,
      "externalId": "string",
      "health": "online",
      "address": {}
    }
  ],
  "pagination": {
    "previous": {
      "count": 0,
      "before": "string",
      "direction": "asc"
    },
    "next": {
      "count": 0,
      "after": "string",
      "direction": "asc"
    }
  }
}

Empty

{
  "message": "Invalid request body",
  "type": "E_INVALID_BODY",
  "errors": [
    {
      "error": "\"email\" is required",
      "rule": "any.required",
      "field": "\"email\""
    }
  ]
}

Get list of stores

Authorization

Query Parameters

Response Body

200application/json

401

422application/json

`application/json`

`application/json`