Fulfillment - Manual da API
  1. Gerenciamento
Fulfillment - Manual da API
  • 🚀 Introdução
  • 🔒 Autenticação
  • 🚦 Rate Limiting
  • 🛟 Suporte
  • Autenticação
    • Autenticação
    • Sessão do usuário
    • Refresh Token
    • Finalizar Sessão
  • Produtos
    • 📦 Conceitos de Produtos
    • Gerenciamento
      • Coleção de produtos
      • Criar um novo produto
      • Detalhes do produto
      • Estoque do Produto
      • Modificar Produto
      • Excluir Produto
    • Controle
      • Controle de Temperatura
      • Controle de Estoque
      • Data de validade & Lote
    • Códigos fiscais
      • Códigos fiscais do produto
      • Adicionar um código fiscal no produto
      • Detalhes do código fiscal do produto
      • Modificar código fiscal do produto
      • Excluir código fiscal do produto
  • Tipos de Operações
    • ♻️ Tipos de Operação
    • 📦 Entrada de Mercadoria
    • Tipos de Operações
    • Tipo de Operação
  • Clientes
    • 👔 Clientes & Parceiros
    • Gerenciamento
      • Coleção de Clientes
      • Novo cliente
      • Detalhes
      • Modificar
      • Excluir
    • Endereços
      • Endereços
      • Adicionar Endereço
      • Detalhes do Endereço
      • Modificar Endereço
  • Pedidos
    • 🛒 Pedidos Fulfillment
    • Gerenciamento
      • Pedidos
        GET
      • Novo Pedido
        POST
      • Detalhes do Pedido
        GET
      • Confirmar Pedido
        POST
      • Update Order
        PUT
    • Workflows
      • Situação atual de um pedido
        GET
      • Fluxos de execução disponíveis
        GET
      • Avançar Workflow
        POST
      • Cancelar Pedido / Workflow
        POST
    • Itens do Pedido
      • Gerenciamento
        • Itens do Pedido
        • Adicionar Item
        • Detalhes do Item
        • Modificar Item
        • Excluir Item
      • Rastreamento
        • Rastreamentos
        • Adicionar Rastreamento
        • Detalhes do Rastreamento
        • Excluir Rastreamento
    • Agendamento
      • Agendamento
        GET
      • Slots Disponíveis
        GET
      • Reservar Slots
        POST
      • Cancelar Agendamento
        POST
      • Confirmar Agendamento
        POST
    • Identificação de Produtos
      • Etiquetas
        GET
      • Gerar Etiquetas
        POST
      • Confirmar impressão
        POST
    • Documentos Fiscais
      • Documentos Fiscais
        GET
      • Documento Fiscal
        POST
      • Detalhes do Documento
        GET
      • Excluir Documento
        DELETE
    • Documentos para Impressão
      • Documentos
        GET
      • Adicionar Documento
        POST
      • Detalhes do Documento
        GET
      • Pré-visualização
        GET
      • Excluir Documento
        DELETE
  • Configurações
    • Webhooks
      • Webhooks
      • Webhook
      • Webhook
      • Webhook
      • Webhook
      • Histórico
      • Estatísticas
      • Teste
      • Eventos Disponíveis
    • Integrações
      • Faturador - Bling
        • Integrações
        • Criar Integração
        • Detalhes da Integração
        • Cancelar Integração
        • Status da Integração
        • Logs
        • Auth Link
    • Enumeração
      • Enumeração
      • Tipos disponíveis
    • Token de API
      • Token de API
      • Criar um novo Token
  • Fiscal
    • Pedidos aguardando nota fiscal
    • Totais - aguardando nota fiscal
  • Locais de Estoque
    • Localizações Exclusivas
    • Ocupação das Localizações
    • Detalhes de uma Localização
    • Produtos de uma Localização
  • Inventário
    • Resumo Geral do Estoque
    • Inventário Detalhado
    • Produtos com Estoque Baixo
    • Consulta Detalhada de Estoque
  1. Gerenciamento

Pedidos

Developing
GET
/api/v1/orders

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Query Params

Responses

🟢200OK
application/json
Body

Example
{
    "success": true,
    "message": "string",
    "search_query": "string",
    "filters": [
        "string"
    ],
    "pagination": {
        "page": 0,
        "per_page": 0,
        "last_page": 0,
        "has_prev_page": true,
        "has_next_page": true,
        "records": {
            "from": 0,
            "to": 0,
            "total": 0
        }
    },
    "data": [
        {
            "order_number": "string",
            "order_type": "string",
            "status": "string",
            "is_confirmed": true,
            "is_packed": true,
            "substatus": {
                "value": "string",
                "label": "string",
                "description": "string"
            },
            "operation_type": {
                "name": "string",
                "description": "string",
                "module": "string",
                "can_be_created_by_customer": true
            },
            "customer": {
                "ulid": "string",
                "name": "string",
                "document": "string"
            },
            "warehouse": {
                "id": 0,
                "name": "string",
                "code": "string"
            },
            "channel": {
                "id": 0,
                "name": "string",
                "slug": "string",
                "channel": "string",
                "channel_label": "string",
                "is_active": true,
                "description": null,
                "metadata": null,
                "created_at": "string",
                "updated_at": "string"
            },
            "recipient_address": {
                "ulid": "string",
                "street": "string",
                "number": "string",
                "complement": null,
                "neighborhood": "string",
                "city": "string",
                "state": "string",
                "zip_code": "string",
                "street_type": null,
                "street_type_label": null,
                "street_side": null,
                "street_side_label": null,
                "reference": null,
                "latitude": null,
                "longitude": null,
                "type": "string",
                "type_label": "string",
                "is_main": null
            },
            "items_summary": {
                "total_items": 0,
                "total_quantity": 0,
                "has_items": true
            },
            "workflow_status": {
                "current_step": 0,
                "total_steps": 0,
                "progress_percentage": 0
            },
            "notes": "string",
            "created_at": "string",
            "created_at_formatted": "string",
            "updated_at": "string",
            "updated_at_formatted": "string"
        }
    ]
}
Previous
🛒 Pedidos Fulfillment
Next
Novo Pedido
Built with