Recursos para IA
Buscar caixas

Este endpoint permite buscar os caixas associados ao usuário do Access Token, utilizando diversos filtros e informações de paginação. Em caso de sucesso, a requisição retornará uma resposta com o status 200.

GET

https://api.mercadopago.com/v2/pos
Request parameters
Header
Authorization
string

OBRIGATÓRIO

Access Token obtido através do painel de desenvolvedores. Obrigatório ser enviado em todas as requisições.
Query
external_id
string
Filtra os resultados pelo identificador externo do caixa, definido pelo sistema integrador no momento de sua criação.
store_id
string
Filtra os resultados pelo identificador da loja à qual as caixas pertencem. Não pode ser usado junto com external_store_id na mesma requisição.
external_store_id
string
Filtra os resultados pelo identificador externo da loja, definido pelo sistema integrador. Não pode ser usado junto com store_id na mesma requisição.
category
integer
Filtra os resultados pelo código de categoria MCC atribuído ao caixa. Deve ser um inteiro válido.
Response parameters
paging
object
Contém as informações de paginação dos resultados da busca.
data
array
Contém a lista de caixas encontrados com base nos filtros aplicados.
Erros

400Requisição inválida

conflicting_store_filters

Os filtros store_id e external_store_id não podem ser enviados simultaneamente na mesma requisição. Utilize apenas um deles.

invalid_query_param

Um ou mais parâmetros de consulta contêm um valor inválido. Verifique que category seja um inteiro válido, offset seja um inteiro não negativo e limit seja um inteiro entre 1 e 30.

invalid_store_id

O valor do filtro store_id não é um número válido. Verifique se o valor enviado é um inteiro válido.

401Não autorizado

unauthorized

O valor enviado como Access Token está incorreto ou ausente. Verifique e tente novamente com um Access Token válido.

500Erro interno do servidor

internal_server_error

Ocorreu um erro inesperado no servidor. Trata-se de uma falha transitória não relacionada aos dados da requisição. Tente novamente após alguns instantes.

Request
curl -X GET \
    'https://api.mercadopago.com/v2/pos?external_id=POS_EXT_01&store_id=987654&external_store_id=STORE_EXT_01&category=473000&limit=30'\
    -H 'Content-Type: application/json' \
       -H 'Authorization: Bearer APP_USR-1*********685765-12*********1b4332e5c*********e077d7679*********664' \
    
Response
{
  "paging": {
    "total": 150,
    "offset": 0,
    "limit": 30
  },
  "data": [
    {
      "id": 1234567,
      "name": "POS-001",
      "status": "active",
      "date_created": "2024-01-15T10:30:00Z",
      "date_last_updated": "2024-03-01T08:00:00Z",
      "user_id": 123456,
      "external_id": "SUC001POS001",
      "qr_response": {
        "uuid": "0977011a027c4b4387e52069da4264deae2946af4dcc44ee98a8f1dbb376c8a1",
        "image": "https://www.mercadopago.com/instore/merchant/qr/1234567/abc123.png",
        "template_document": "https://www.mercadopago.com/instore/merchant/qr/1234567/template_abc123.pdf",
        "template_image": "https://www.mercadopago.com/instore/merchant/qr/1234567/template_abc123.png",
        "qr_code": "00020101021226940014BR.GOV.BCB.PIX2572pix-qr-h.mercadopago.com/instore/h/p/v2/abc123"
      },
      "config": {
        "qr": {
          "operating_mode": "pdv"
        }
      }
    }
  ]
}