v1

latestOpenAPI 3.0.02026-07-26376212496.4 KB

Pedidos - Pedido

Listar pedidos

Lista os pedidos de uma loja em um determinado período, respeitando determinados filtros

get/{alias}/orders

Path parameters

aliasstring required

Alias da loja

Query parameters

includestring[]

Incluir relacionamentos adicionais

[
  "?include=customer,items"
]

affiliation_idinteger[]

Afiliações ou gateways associados ao pedido (ex: Appmax, PagSeguro).

gateway_idinteger[]

Gateway específico de pagamento utilizado no pedido.

bling'sent' | 'not_sent'

Indica se o pedido foi enviado ao Bling.

tinystring[]

Filtra pedidos enviados ou não ao Tiny.

sync_by_erpboolean

Indica se o pedido foi sincronizado com algum ERP (ex: Bling, Tiny).

promocode_idinteger[]

Cupons de desconto aplicados ao pedido.

product_idinteger[]

IDs dos produtos incluídos no pedido.

status_idinteger[]

Status atual do pedido.

payment_methodstring[]

Meio de pagamento utilizado no pedido.

shipment_servicestring[]

Forma de entrega utilizada (Correios, transportadora, retirada).

channel'store' | 'payment_retry'

Canal de venda do pedido.

datestring

Filtro de datas do pedido. Suporta created_at, updated_at, cancelled_at, captured_at e shipping_date.

stock_idinteger

ID do estoque de origem do pedido.

numberinteger

Número exato do pedido.

customer_documentstring

Documento do cliente associado ao pedido (CPF ou CNPJ).

customizationstring[]

Filtra pedidos com ou sem personalizações.

product_type'is_digital' | 'is_physical'

Filtra pedidos por tipo de produto (digital ou físico).

qstring

Termo de busca genérico.

Filtros de pedidos

{
  "bling": "?bling=sent",
  "channel": "?channel=store",
  "date": "?date=created_at:2024-06-01|2024-06-30",
  "customer_document": "?customer_document=12345678900",
  "product_type": "?product_type=is_digital",
  "q": "?q=joao"
}

Response

Conjunto de pedidos disponíveis na loja

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"
            }
          }
        }
      }
    }
  ]
}