Listar Caixas

Listando Caixas

Para listar os caixas criados em nossa plataforma e suas informações, consulte via GET a rota Url/segments/{segmentId}/cashiers.

O SegmentID deverá ser informado, saiba mais em Login via API. O uso de seu Bearer Token também será necessário.

Listar Caixas

GET {Url}/segments/{segmentId}/cashiers

Path Parameters

Name	Type	Description
segmentId	string	ID de Segmento
companies	array	ID das empresas para realizar a listagem

Query Parameters

Name	Type	Description
desc	boolean	Se é ordem decrescente
status	string	Status
dateRange	string	Intervalo de data
initialDate	string	Data inicial
user	string	ID do usuário
event	string	ID do evento
limit	number	Limite de registros por página
page	number	Número da página
finalDate	string	Data final

200 OK

[
  {
    "_id": "string",
    "createdAt": "2020-01-01T00:00:00Z",
    "updatedAt": "2020-01-01T00:00:00Z",
    "segment": "string",
    "company": {
      "_id": "string",
      "createdAt": "2020-01-01T00:00:00Z",
      "updatedAt": "2020-01-01T00:00:00Z",
      "segment": "string",
      "type": "private",
      "document": "string",
      "name": "string",
      "tag": "string",
      "logoUrl": "string",
      "crtId": "string",
      "addresses": [
        {
          "_id": "string",
          "country": "string",
          "state": "string",
          "city": "string",
          "neighborhood": "string",
          "street": "string",
          "number": "string",
          "complement": "string",
          "postalCode": "string"
        }
      ],
      "contacts": [
        {
          "contact": "string",
          "type": "whatsapp"
        }
      ],
      "integration": {
        "praNotas": {
          "authorization": "string",
          "homologation": true,
          "certificate": "string",
          "status": "string",
          "count": 0,
          "serie": "string",
          "csc": "string",
          "cscId": "string"
        },
        "pagaRapido": {
          "authorization": "string",
          "subscription": "string"
        },
        "praSaques": {
          "token": "string"
        }
      },
      "activityBranch": {
        "_id": "string",
        "name": "string",
        "examples": "string",
        "value": "retail"
      },
      "stockSettings": {
        "stockLocalDevice": {
          "_id": "string",
          "createdAt": "2020-01-01T00:00:00Z",
          "updatedAt": "2020-01-01T00:00:00Z",
          "name": "string",
          "company": null,
          "acronym": "string",
          "segment": "string"
        },
        "stockLocalCatalog": {
          "_id": "string",
          "createdAt": "2020-01-01T00:00:00Z",
          "updatedAt": "2020-01-01T00:00:00Z",
          "name": "string",
          "company": null,
          "acronym": "string",
          "segment": "string"
        }
      }
    },
    "origin": "app",
    "device": {
      "_id": "string",
      "createdAt": "2020-01-01T00:00:00Z",
      "updatedAt": "2020-01-01T00:00:00Z",
      "installationId": "string",
      "manufacturer": "string",
      "deviceModel": "string",
      "serial": "string",
      "acquirer": "string",
      "os": "string",
      "systemVersion": "string",
      "appVersion": "string",
      "status": "active",
      "lastSigninAt": {},
      "lastSigninBy": "string",
      "createdBy": "string"
    },
    "event": {
      "_id": "string",
      "createdAt": "2020-01-01T00:00:00Z",
      "updatedAt": "2020-01-01T00:00:00Z",
      "segment": "string",
      "company": {
        "_id": "string",
        "createdAt": "2020-01-01T00:00:00Z",
        "updatedAt": "2020-01-01T00:00:00Z",
        "segment": "string",
        "type": "private",
        "document": "string",
        "name": "string",
        "tag": "string",
        "logoUrl": "string",
        "crtId": "string",
        "addresses": [
          {
            "_id": "string",
            "country": "string",
            "state": "string",
            "city": "string",
            "neighborhood": "string",
            "street": "string",
            "number": "string",
            "complement": "string",
            "postalCode": "string"
          }
        ],
        "contacts": [
          {
            "contact": "string",
            "type": "whatsapp"
          }
        ],
        "integration": {
          "praNotas": {
            "authorization": "string",
            "homologation": true,
            "certificate": "string",
            "status": "string",
            "count": 0,
            "serie": "string",
            "csc": "string",
            "cscId": "string"
          },
          "pagaRapido": {
            "authorization": "string",
            "subscription": "string"
          },
          "praSaques": {
            "token": "string"
          }
        },
        "activityBranch": {
          "_id": "string",
          "name": "string",
          "examples": "string",
          "value": "retail"
        },
        "stockSettings": {
          "stockLocalDevice": {
            "_id": "string",
            "createdAt": "2020-01-01T00:00:00Z",
            "updatedAt": "2020-01-01T00:00:00Z",
            "name": "string",
            "company": null,
            "acronym": "string",
            "segment": "string"
          },
          "stockLocalCatalog": {
            "_id": "string",
            "createdAt": "2020-01-01T00:00:00Z",
            "updatedAt": "2020-01-01T00:00:00Z",
            "name": "string",
            "company": null,
            "acronym": "string",
            "segment": "string"
          }
        }
      },
      "name": "string",
      "startDate": {},
      "endDate": {},
      "prepaid": true
    },
    "user": {
      "_id": "string",
      "createdAt": "2020-01-01T00:00:00Z",
      "updatedAt": "2020-01-01T00:00:00Z",
      "name": "string",
      "avatarUrl": "string",
      "phoneNumber": "string",
      "document": "string",
      "email": "string",
      "status": "active",
      "access": [
        {
          "segment": "string",
          "companies": [
            "string"
          ],
          "group": "string"
        }
      ],
      "screensJourneyConfirmations": [
        "string"
      ],
      "hasConfirmedPageJourneySecondStep": true
    },
    "status": "open",
    "blockedAt": {},
    "closedAt": {},
    "transactions": [
      {
        "_id": "string",
        "createdAt": "2020-01-01T00:00:00Z",
        "updatedAt": "2020-01-01T00:00:00Z",
        "segment": "string",
        "company": "string",
        "device": "string",
        "cardFlag": "string",
        "cashier": "string",
        "order": "string",
        "transactionType": "payment",
        "paymentType": "money",
        "externalPaymentType": "string",
        "cardType": "credit",
        "amount": 0,
        "acquirerTransactionId": "string",
        "canceled": true,
        "observation": "string",
        "status": "string",
        "externalId": "string"
      }
    ],
    "orders": [
      [
        null
      ]
    ],
    "orderAmountMax": 0,
    "orderAmountAvg": 0,
    "moneyPaymentsSum": 0,
    "moneyChangeSum": 0,
    "cardPaymentsSum": 0,
    "boletoPaymentsSum": 0,
    "depositTransactionsSum": 0,
    "withdrawTransactionsSum": 0,
    "moneyReceivedAmount": 0,
    "cardReceivedAmount": 0
  }
]

401 Verifique o Bearer Token utilizado e tente novamente.

[]

404 Verifique a rota e método utilizado e tente novamente.

[]

Caso a requisição esteja correta, o código 200 OK será retornado. Prossiga para as próximas sessões para entender mais sobre nossas funções disponíveis.

Outros Erros: Caso sejam retornados outros erros, favor entrar em contato com o time de integração.