Listar las tiendas del token

GET

/stores

• Servidor de la API. El valor de host lo proporciona IDBI.

Devuelve las tiendas a las que da acceso el token, ordenadas por nombre: la tienda del token, si es un token de tienda, o todas las tiendas de la organización, si es un token de organización. La respuesta no está paginada.

Use el campo id de cada tienda como storeKey en las demás operaciones.

Authorizations

• OpenApiKey
• OpenApiToken

Responses

200

Las tiendas a las que da acceso el token, cada una con su id, su nombre y su código externo. Úselas para obtener los storeKey que piden las demás operaciones.

• Van ordenadas por nombre y la respuesta no está paginada.
• Un token de tienda trae una sola tienda; un token de organización trae todas las de la organización.
• external_id es null si la tienda no tiene código externo.

object

data

required

Array<object>

object

id

required

Identificador de la tienda. Úselo como storeKey.

string format: uuid

name

required

Nombre de la tienda.

string

external_id

required

Código externo de la tienda. Es null si no tiene.

string | null

Examples

Token de tienda

{
  "data": [
    {
      "id": "6a8c0e2f-5b7d-4d9b-9e3a-4f6b8d0c2e53",
      "name": "Tienda Centro",
      "external_id": "T01"
    }
  ]
}

Token de organización con dos tiendas

{
  "data": [
    {
      "id": "6a8c0e2f-5b7d-4d9b-9e3a-4f6b8d0c2e53",
      "name": "Tienda Centro",
      "external_id": "T01"
    },
    {
      "id": "f1b3d5a7-2c4e-4b68-9d0f-7a9c1e3b5d84",
      "name": "Tienda Norte",
      "external_id": null
    }
  ]
}

401

Credenciales ausentes, inválidas, deshabilitadas o vencidas. El campo error.description indica el motivo.

Formato de error de la autenticación y del control de acceso del token.

object

error

required

Detalle del error, con su código, su mensaje y su descripción.

object

code

required

Siempre es 0.

integer

message

required

Mensaje del error.

string

description

required

Detalle del error, cuando existe.

string | null

Examples

Falta una de las cabeceras

{
  "error": {
    "code": 0,
    "message": "No autorizado",
    "description": "El token es obligatorio"
  }
}

Token que no corresponde a la clave

{
  "error": {
    "code": 0,
    "message": "No autorizado",
    "description": "El token es inválido"
  }
}

Clave inexistente

{
  "error": {
    "code": 0,
    "message": "No autorizado",
    "description": "El token no fue encontrado"
  }
}

Token deshabilitado

{
  "error": {
    "code": 0,
    "message": "No autorizado",
    "description": "El token está deshabilitado"
  }
}

Token vencido

{
  "error": {
    "code": 0,
    "message": "No autorizado",
    "description": "El token expiró"
  }
}