v1

latestOpenAPI 3.0.02026-07-26376212496.4 KB
Pedidos - Pedido

Visualizar detalhes de um pedido

Visualiza os detalhes de um determinado pedido a partir do seu ID

get/{alias}/orders/{id}

Path parameters

aliasstring required

Alias da loja

idinteger required

ID do pedido

Query parameters

includestring[]

Incluir relacionamentos adicionais

[
  "?include=customer,items"
]

Response

Detalhes do pedido

Example response

{
  "data": [
    {
      "transactions": {
        "data": {
          "created_at": {
            "date": "2000-08-17 10:24:24",
            "timezone_type": 3,
            "timezone": "America/Sao_Paulo"
          },
          "updated_at": {
            "date": "2000-08-17 10:24:24",
            "timezone_type": 3,
            "timezone": "America/Sao_Paulo"
          },
          "capture_date": {
            "date": "2000-08-17 10:24:24",
            "timezone_type": 3,
            "timezone": "America/Sao_Paulo"
          },
          "authorized_at": {
            "date": "2000-08-17 10:24:24",
            "timezone_type": 3,
            "timezone": "America/Sao_Paulo"
          },
          "captured_at": {
            "date": "2000-08-17 10:24:24",
            "timezone_type": 3,
            "timezone": "America/Sao_Paulo"
          },
          "cancelled_at": {
            "date": "2000-08-17 10:24:24",
            "timezone_type": 3,
            "timezone": "America/Sao_Paulo"
          },
          "metadata": [
            {
              "key": "discount_highlight",
              "value": "pix"
            }
          ]
        }
      },
      "date_delivery": {
        "date": "2000-08-17 10:24:24",
        "timezone_type": 3,
        "timezone": "America/Sao_Paulo"
      },
      "metadata": {
        "data": [
          {
            "key": "discount_highlight",
            "value": "pix"
          }
        ]
      },
      "promocode": {
        "data": {
          "code": "TEST",
          "value": 10,
          "used": 22,
          "min_value": 99.99,
          "use_percent": 0.02,
          "payments_ids": "[1, 2, 3, 4]",
          "start_at": {
            "date": "2000-08-17 10:24:24",
            "timezone_type": 3,
            "timezone": "America/Sao_Paulo"
          },
          "end_at": {
            "date": "2000-08-17 10:24:24",
            "timezone_type": 3,
            "timezone": "America/Sao_Paulo"
          },
          "created_at": {
            "date": "2000-08-17 10:24:24",
            "timezone_type": 3,
            "timezone": "America/Sao_Paulo"
          },
          "updated_at": {
            "date": "2000-08-17 10:24:24",
            "timezone_type": 3,
            "timezone": "America/Sao_Paulo"
          }
        }
      },
      "statuses": {
        "data": [
          {
            "created_at": {
              "date": "2000-08-17 10:24:24",
              "timezone_type": 3,
              "timezone": "America/Sao_Paulo"
            },
            "updated_at": {
              "date": "2000-08-17 10:24:24",
              "timezone_type": 3,
              "timezone": "America/Sao_Paulo"
            }
          }
        ]
      },
      "customer": {
        "data": {
          "spreadsheet": {
            "data": {
              "phone": "(16) 98187-5668",
              "phone_number": "981875668",
              "phone_code": "16"
            }
          }
        }
      }
    }
  ]
}