Listar vendas

Para consultar as vendas no sistema, faça uma requisição para o endpoint abaixo:

Endpoint

GET /api/v1/order/

Parâmetros de requisição

Name	Type	Description
page	Integer	Número da página em caso de paginação disponível.
from	Date	Data de início do filtro de pedidos.
to	Date	Data de fim do filtro de pedidos.
status	String	Status para filtro dos pedidos. Aceita múltiplos valores separados por vírgula (ex: paid,unpaid). Valores: created, paid, unpaid, waiting_payment, chargeback, refund, canceled, complete, pending, risk_analysis, dispute.
src	String	Parâmetro utilizado no momento do pedido para identificar a transação.
ref	String	Parâmetro utilizado no momento do pedido para identificar a transação.
product_id	Integer	ID do produto para filtrar pedidos.
taxvat	String	CPF ou CNPJ do comprador para filtrar pedidos.

Respostas

200: OK

{
  "data": [
    {
      "token": "3e1d9542-09fe-4b8b-9800-38f99f5b2147",
      "order_number": "1654112455",
      "public_key": "t9rb",
      "status": "paid",
      "origin": "checkout",
      "src": "<src>",
      "ref": "<ref>",
      "created_at": "2021-08-01 16:40:55",
      "updated_at": "2022-06-01 16:40:55",
      "checkout": {
        "name": "Checkout Software SaaS",
        "key": "plano-one"
      },
      "customer": {
        "email": "carlos46@example.com",
        "fullname": "Dr. Martinho Vila Bittencourt",
        "taxvat": "085.276.039-69",
        "telephone": "95889-6971"
      },
      "address": {
        "postcode": "54522-135",
        "street": "Rua dos Araçás",
        "number": "96",
        "complement": "",
        "city": "Cabo de Santo Agostinho",
        "region": "Rio Grande do Sul",
        "district": "Operário"
      },
      "payment": {
        "name": "Cartão de Crédito",
        "method": "credit",
        "link_to_pay": "https://sandbox.azpag.dev/order/pay/t9rb/1654112455",
        "digitable": null,
        "due_date": null
      },
      "totals": {
        "subtotal": "99.00",
        "fee": "0.00",
        "total": "99.00",
        "net": "99.00"
      },
      "items": []
    },
    {
      "token": "d8ef73a2-03e7-4141-97ce-b85d5f720d8b",
      "order_number": "165411244",
      "public_key": "t934rb",
      "status": "paid",
      "origin": "checkout",
      "src": "<src>",
      "ref": "<ref>",
      "created_at": "2021-08-01 16:40:55",
      "updated_at": "2022-06-01 16:40:55",
      "checkout": {
        "name": "Checkout Software SaaS",
        "key": "plano-one"
      },
      "customer": {
        "email": "carlos46@example.com",
        "fullname": "Dr. Martinho Vila Bittencourt",
        "taxvat": "085.276.039-69",
        "telephone": "95889-6971"
      },
      "address": {
        "postcode": "54522-135",
        "street": "Rua dos Araçás",
        "number": "96",
        "complement": "",
        "city": "Cabo de Santo Agostinho",
        "region": "Rio Grande do Sul",
        "district": "Operário"
      },
      "payment": {
        "name": "Cartão de Crédito",
        "method": "credit",
        "link_to_pay": "https://sandbox.azpag.dev/order/pay/t934rb/165411244",
        "digitable": null,
        "due_date": null
      },
      "totals": {
        "subtotal": "99.00",
        "fee": "0.00",
        "total": "99.00",
        "net": "99.00"
      },
      "items": []
    }
  ],
  "links": {
    "first": "https://sandbox.azpag.dev/api/v1/order?page=1",
    "last": "https://sandbox.azpag.dev/api/v1/order?page=23",
    "prev": null,
    "next": "https://sandbox.azpag.dev/api/v1/order?page=2"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "links": [
      {
        "url": null,
        "label": "Anterior",
        "active": false
      },
      {
        "url": "https://sandbox.azpag.dev/api/v1/order?page=1",
        "label": "1",
        "active": true
      },
      {
        "url": "https://sandbox.azpag.dev/api/v1/order?page=2",
        "label": "Próximo",
        "active": false
      }
    ],
    "path": "https://sandbox.azpag.dev/api/v1/order",
    "per_page": 50,
    "to": 50,
    "total": 2
  }
}

429: Too Many Requests

{
  "hasError": true,
  "response": "Too many requests."
}

500: Internal Server Error

{
  "hasError": true,
  "response": "Error on server, try again."
}