Admin api stores

Get one gondola information

GET
/api/admin/v2/stores/{storeId}/gondolas/{gondolaId}

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.

gondolaId*integer

Id of a gondola

Query Parameters

includeCoordinates?boolean
Defaultfalse
includeGlobalCoordinates?boolean
Defaultfalse
includeBins?boolean
Defaultfalse

Response Body

application/json

application/json

curl -X GET "https://oasis-api.public.sandbox.oasis.aifi.com/api/admin/v2/stores/0/gondolas/2"
{
  "dimensions": {
    "x": "0.8978",
    "y": "0.0254",
    "z": "2.1645"
  },
  "rotation": {
    "x": "0.8978",
    "y": "0.0254",
    "z": "2.1645"
  },
  "translation": {
    "x": "0.8978",
    "y": "0.0254",
    "z": "2.1645"
  },
  "globalCoordinates": {
    "rotation": {
      "x": "0.8978",
      "y": "0.0254",
      "z": "2.1645"
    },
    "translation": {
      "x": "0.8978",
      "y": "0.0254",
      "z": "2.1645"
    }
  },
  "id": 2,
  "shelves": {
    "dimensions": {
      "x": "0.8978",
      "y": "0.0254",
      "z": "2.1645"
    },
    "rotation": {
      "x": "0.8978",
      "y": "0.0254",
      "z": "2.1645"
    },
    "translation": {
      "x": "0.8978",
      "y": "0.0254",
      "z": "2.1645"
    },
    "globalCoordinates": {
      "rotation": {
        "x": "0.8978",
        "y": "0.0254",
        "z": "2.1645"
      },
      "translation": {
        "x": "0.8978",
        "y": "0.0254",
        "z": "2.1645"
      }
    },
    "id": "2-5",
    "shelfIndex": 5,
    "bins": [
      {
        "dimensions": {
          "x": "0.8978",
          "y": "0.0254",
          "z": "2.1645"
        },
        "rotation": {
          "x": "0.8978",
          "y": "0.0254",
          "z": "2.1645"
        },
        "translation": {
          "x": "0.8978",
          "y": "0.0254",
          "z": "2.1645"
        },
        "globalCoordinates": {
          "rotation": {
            "x": "0.8978",
            "y": "0.0254",
            "z": "2.1645"
          },
          "translation": {
            "x": "0.8978",
            "y": "0.0254",
            "z": "2.1645"
          }
        },
        "id": 0,
        "index": 0
      }
    ]
  },
  "name": "string",
  "disabledAt": "2019-08-24T14:15:22Z"
}
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.