Admin api stores

Set store status

PATCH
/api/admin/v2/stores/{storeId}/status

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

storeId*integer

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

Request Body

application/json

status?string

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

Value in"OPEN" | "CLOSED" | "CLOSED_FOR_MAINTENANCE"
employeeInside?boolean

Whether any employee is in the store

deploymentStatus?string

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

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

Response Body

application/json

application/json

curl -X PATCH "https://oasis-api.public.sandbox.oasis.aifi.com/api/admin/v2/stores/0/status" \  -H "Content-Type: application/json" \  -d '{}'
{
  "status": "OPEN",
  "employeeInside": true,
  "deploymentStatus": "LIVE"
}
Empty
{
  "message": "Invalid request body",
  "type": "E_INVALID_BODY",
  "errors": [
    {
      "error": "\"email\" is required",
      "rule": "any.required",
      "field": "\"email\""
    }
  ]
}

How is this guide?

AiFI AI Chat

Beta

Powered by AiFi

Ask docs or API questions to get grounded answers.