Pedidos

Esta documentação cobre os endpoints relacionados às operações de pedidos (order). Aqui você encontrará detalhes sobre como criar, obter e desbloquear pedidos.

Criar pedido

Cria um novo pedido.

POST https://api-v2.linkbolt.com.br/order

Autenticação

Para acessar este endpoint, você deve primeiro obter um Bearer Token fazendo login com seu email e senha.

Autenticação

Nome	Tipo	Descrição
Authorization	string	Bearer Token (ex.: Bearer seu_token)

Corpo da requisição

{
  "externalId": "22331",
  "deliveryAt": "2024-06-28T06:00:00",
  "address": {
    "street": "R. Guarujá",
    "number": "31",
    "neighborhood": "Saúde",
    "city": "São Paulo",
    "state": "SP",
    "postalCode": "04052-110",
    "complement": "Casa 02"
  },
  "instructions": "Não bater na porta",
  "customer": {
    "name": "Adriano",
    "phoneNumber": "11998880009"
  }
}

Name	Type	Description
externalId*	string	Identificador externo do pedido.
deliveryAt*	string	Data e hora da entrega no formato ISO 8601 em UTC (ex.: 2024-06-28T06:00:00).
instructions	string	Instruções de entrega. Ex: "Não bater na porta"
address*	object	Informações do endereço de entrega.
address.street*	string	Rua do endereço.
address.number	string	Número do endereço.
address.neighborhood*	string	Bairro do endereço.
address.city*	string	Cidade do endereço.
address.state*	string	Estado do endereço.
address.postalCode*	string	CEP do endereço.
address.complement	string	Complemento do endereço.
customer*	object	Informações do cliente.
customer.name*	string	Nome do cliente.
customer.phoneNumber*	string	Número de telefone do cliente.

201 Created

{
  "success": true,
  "data": {
    "id": 1234
  }
}

400 Bad Request

Dados da requisição inválidos

401 Unauthorized

{
  "success": false,
  "message": "Unauthorized - No token provided"
}

Desbloquear pedidos

Desbloqueia os pedidos, para serem roteirizados.

POST https://api-v2.linkbolt.com.br/order/unlock

Autenticação

Para acessar este endpoint, você deve primeiro obter um Bearer Token fazendo login com seu email e senha.

Autenticação

Nome	Tipo	Descrição
Authorization	string	Bearer Token (ex.: Bearer seu_token)

Corpo da requisição

{
 "orders": [1234, 4432, 4535]
}

Nome	Tipo	Descrição
orders	array	Conjunto de pedidos para serem desbloqueados

Resposta

200 OK

{
    "success": true,
    "data": {
        "successOrders": [
            {
                "id": 109,
                "externalId": "22330"
            },
            {
                "id": 110,
                "externalId": "22331"
            }
        ],
        "failedOrders": [
            {
                "id": 108,
                "externalId": "22329"
            }
        ],
        "unlockedOrders": [
            {
                "id": 109,
                "externalId": "22330"
            },
            {
                "id": 110,
                "externalId": "22331"
            }
        ]
    }
}

400 Orders failed

{
  "success": false,
  "message": "All orders have failed"
}

400 Orders required

{
  "success": false,
  "message": "Orders is required"
}

401 Unauthorized

{
  "success": false,
  "message": "Unauthorized - No token provided"
}