v1

latestOpenAPI 3.1.02026-07-241040774.6 KB

Listar pedidos

get/orders

Query parameters

codestring

Código de referência do pedido no sistema da loja.

statusstring

Status do pedido. Valores possíveis: pending, paid, canceled ou failed

customer_idstring

Código do cliente.

created_sincestring date

Data de início do período de criação a ser listado.

created_untilstring date

Data de final do período de criação a ser listado.

pageinteger

Página atual.

sizeinteger

Quantidade de itens.

Response

200

Example response

{
  "data": [
    {
      "id": "or_28dN9w7CLU79kDjL",
      "code": "62LVFN7I4R",
      "amount": 2990,
      "currency": "BRL",
      "closed": true,
      "items": [
        {
          "id": "oi_d478RMAS3bC74PrL",
          "description": "Chaveiro do Tesseract",
          "amount": 2990,
          "quantity": 1,
          "status": "active",
          "created_at": "2017-04-19T16:01:09Z",
          "updated_at": "2017-04-19T16:01:09Z"
        }
      ],
      "customer": {
        "id": "cus_eaEXlZvhBfeGlDOm",
        "name": "Tony Stark",
        "email": "f1492621-4f39-45f7-adfb-82a373a0a85c@avengers.com",
        "created_at": "2017-04-19T16:01:09Z",
        "updated_at": "2017-04-19T16:01:09Z"
      },
      "status": "paid",
      "created_at": "2017-04-19T16:01:09Z",
      "updated_at": "2017-04-19T16:01:11Z",
      "closed_at": "2017-04-19T16:01:11Z",
      "charges": [
        {
          "id": "ch_gmnW101c9YTvQVLB",
          "code": "62LVFN7I4R",
          "gateway_id": "ef5e977b-93d2-485a-b15d-36e5eb3d8cf5",
          "amount": 2990,
          "status": "paid",
          "currency": "BRL",
          "payment_method": "credit_card",
          "paid_at": "2017-04-19T16:01:11Z",
          "created_at": "2017-04-19T16:01:09Z",
          "updated_at": "2017-04-19T16:01:09Z",
          "customer": {
            "id": "cus_eaEXlZvhBfeGlDOm",
            "name": "Tony Stark",
            "email": "f1492621-4f39-45f7-adfb-82a373a0a85c@avengers.com",
            "created_at": "2017-04-19T16:01:09Z",
            "updated_at": "2017-04-19T16:01:09Z"
          }
        }
      ]
    }
  ],
  "paging": {
    "total": 406,
    "next": "https://api.mundipagg.com:4443/core/v1/orders?page=2&size=2"
  }
}