Cotação de entrega

Verificar disponibilidade e preços de entrega

curl --request POST \
  --url https://opendelivery.gohusky.net/logistic/v1/logistics/availability \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "merchant": {
    "id": "MERCHANT-001",
    "name": "Restaurante Exemplo"
  },
  "pickupAddress": {
    "country": "Brasil",
    "state": "SP",
    "city": "São Paulo",
    "district": "Centro",
    "street": "Rua Exemplo",
    "number": "123",
    "postalCode": "01310-100",
    "latitude": -23.5505,
    "longitude": -46.6333
  },
  "returnToMerchant": false,
  "canCombine": false,
  "deliveryAddress": {
    "country": "Brasil",
    "state": "SP",
    "city": "São Paulo",
    "district": "Pinheiros",
    "street": "Av. Exemplo",
    "number": "456",
    "postalCode": "05433-000",
    "latitude": -23.5675,
    "longitude": -46.6925
  },
  "vehicle": {
    "type": [
      "MOTORBIKE_BAG"
    ],
    "container": "NORMAL",
    "containerSize": null,
    "instruction": null
  },
  "limitTimes": {
    "pickupLimit": 30,
    "deliveryLimit": 60,
    "orderCreatedAt": "2024-01-15T10:30:00.000Z"
  },
  "totalOrderPrice": {
    "value": 45.5,
    "currency": "BRL"
  },
  "orderDeliveryFee": {
    "value": 8.5,
    "currency": "BRL"
  },
  "totalWeight": 500,
  "packageVolume": 2000,
  "packageQuantity": 1,
  "specialInstructions": null,
  "additionalPricePercentual": null,
  "onlinePayment": true
}
'

{
  "deliveryPrice": {
    "value": 8.5,
    "currency": "BRL"
  },
  "vehicles": {
    "availableVehicles": 15,
    "vehiclesAvailable": {
      "type": [
        "MOTORBIKE_BAG",
        "CAR"
      ],
      "container": "NORMAL"
    }
  }
}

POST

logistics

availability

Verificar disponibilidade e preços de entrega

curl --request POST \
  --url https://opendelivery.gohusky.net/logistic/v1/logistics/availability \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "merchant": {
    "id": "MERCHANT-001",
    "name": "Restaurante Exemplo"
  },
  "pickupAddress": {
    "country": "Brasil",
    "state": "SP",
    "city": "São Paulo",
    "district": "Centro",
    "street": "Rua Exemplo",
    "number": "123",
    "postalCode": "01310-100",
    "latitude": -23.5505,
    "longitude": -46.6333
  },
  "returnToMerchant": false,
  "canCombine": false,
  "deliveryAddress": {
    "country": "Brasil",
    "state": "SP",
    "city": "São Paulo",
    "district": "Pinheiros",
    "street": "Av. Exemplo",
    "number": "456",
    "postalCode": "05433-000",
    "latitude": -23.5675,
    "longitude": -46.6925
  },
  "vehicle": {
    "type": [
      "MOTORBIKE_BAG"
    ],
    "container": "NORMAL",
    "containerSize": null,
    "instruction": null
  },
  "limitTimes": {
    "pickupLimit": 30,
    "deliveryLimit": 60,
    "orderCreatedAt": "2024-01-15T10:30:00.000Z"
  },
  "totalOrderPrice": {
    "value": 45.5,
    "currency": "BRL"
  },
  "orderDeliveryFee": {
    "value": 8.5,
    "currency": "BRL"
  },
  "totalWeight": 500,
  "packageVolume": 2000,
  "packageQuantity": 1,
  "specialInstructions": null,
  "additionalPricePercentual": null,
  "onlinePayment": true
}
'

{
  "deliveryPrice": {
    "value": 8.5,
    "currency": "BRL"
  },
  "vehicles": {
    "availableVehicles": 15,
    "vehiclesAvailable": {
      "type": [
        "MOTORBIKE_BAG",
        "CAR"
      ],
      "container": "NORMAL"
    }
  }
}

Este endpoint permite verificar se há veículos disponíveis para realizar uma entrega e obter informações sobre os preços antes de criar uma nova solicitação de entrega. Informações retornadas:

Preço de entrega calculado
Veículos disponíveis e seus tipos
Quantidade total de veículos disponíveis

Authorizations

Authorization

string

header

required

Token de acesso OAuth 2.0 obtido através do endpoint /oauth/token.

Use o formato: Authorization: Bearer {access_token}

O token deve ser incluído em todas as requisições aos endpoints protegidos.

Body

application/json

pickupAddress

object

required

Endereço de coleta do pedido.

Show child attributes

pickupAddress.country

string

required

País (sigla). Padrão ISO 3166-1.

Required string length: 2

Example:

"BR"

pickupAddress.state

string

required

Estado (sigla). Padrão ISO 3166-2.

Example:

"SP"

pickupAddress.city

string

required

Cidade

Example:

"São Paulo"

pickupAddress.district

string

required

Bairro

Example:

"Centro"

pickupAddress.street

string

required

Rua

Example:

"Rua Exemplo"

pickupAddress.number

string

required

Número

Example:

"123"

pickupAddress.postalCode

string

CEP

Example:

"01310-100"

pickupAddress.complement

string

Complemento

Example:

"Apto 45"

pickupAddress.reference

string

Ponto de referência

Example:

"Próximo ao metrô"

pickupAddress.latitude

number<float>

Latitude do endereço

Example:

-23.5505

pickupAddress.longitude

number<float>

Longitude do endereço

Example:

-46.6333

pickupAddress.pickupLocation

string

Local de coleta específico

Example:

"Balcão"

pickupAddress.parkingSpace

boolean

Se há espaço para estacionamento

Example:

true

pickupAddress.instructions

string

Instruções específicas para o endereço

Example:

"Entregar na recepção"

returnToMerchant

boolean

required

Informa se o entregador deve retornar ao endereço de coleta após a entrega ter sido efetuada.

Example:

false

canCombine

boolean

required

Se a entrega pode ser combinada com outras

Example:

false

deliveryAddress

object

required

Endereço de entrega do pedido.

Show child attributes

deliveryAddress.country

string

required

País (sigla). Padrão ISO 3166-1.

Required string length: 2

Example:

"BR"

deliveryAddress.state

string

required

Estado (sigla). Padrão ISO 3166-2.

Example:

"SP"

deliveryAddress.city

string

required

Cidade

Example:

"São Paulo"

deliveryAddress.district

string

required

Bairro

Example:

"Centro"

deliveryAddress.street

string

required

Rua

Example:

"Rua Exemplo"

deliveryAddress.number

string

required

Número

Example:

"123"

deliveryAddress.postalCode

string

CEP

Example:

"01310-100"

deliveryAddress.complement

string

Complemento

Example:

"Apto 45"

deliveryAddress.reference

string

Ponto de referência

Example:

"Próximo ao metrô"

deliveryAddress.latitude

number<float>

Latitude do endereço

Example:

-23.5505

deliveryAddress.longitude

number<float>

Longitude do endereço

Example:

-46.6333

deliveryAddress.pickupLocation

string

Local de coleta específico

Example:

"Balcão"

deliveryAddress.parkingSpace

boolean

Se há espaço para estacionamento

Example:

true

deliveryAddress.instructions

string

Instruções específicas para o endereço

Example:

"Entregar na recepção"

vehicle

object

required

Show child attributes

vehicle.type

enum<string>[]

required

Tipos de veículo aceitos para a entrega

Minimum array length: 1

Available options:

MOTORBIKE_BAG,

MOTORBIKE_BOX,

CAR,

BICYCLE,

SCOOTER,

VUC

Example:

["MOTORBIKE_BAG"]

vehicle.container

enum<string>

required

Tipo de container necessário

Available options:

NORMAL,

THERMIC

Example:

"NORMAL"

vehicle.containerSize

enum<string>

Tamanho do container (opcional, apenas para container térmico)

Available options:

SMALL,

MEDIUM,

LARGE,

EXTRA_LARGE

Example:

"MEDIUM"

vehicle.instruction

string

Instruções específicas sobre o veículo/container

Example:

"Manter refrigerado"

limitTimes

object

required

Show child attributes

limitTimes.pickupLimit

integer

Tempo limite para coleta em minutos

Required range: x >= 0

Example:

30

limitTimes.deliveryLimit

integer

Tempo limite para entrega em minutos

Required range: x >= 0

Example:

60

limitTimes.orderCreatedAt

string<date-time>

Data e hora de criação do pedido (ISO 8601)

Example:

"2024-01-15T10:30:00.000Z"

totalOrderPrice

object

required

Show child attributes

totalOrderPrice.value

number<float>

required

Valor monetário

Required range: x >= 0

Example:

45.5

totalOrderPrice.currency

enum<string>

required

Moeda. Padrão ISO 4217.

Available options:

BRL,

USD,

EUR

Required string length: 3

Example:

"BRL"

totalWeight

integer

required

Peso total do pedido em gramas

Required range: x >= 0

Example:

500

merchant

object

Show child attributes

merchant.id

string

required

Identificador único do merchant

Example:

"MERCHANT-001"

merchant.name

string

required

Nome do merchant

Example:

"Restaurante Exemplo"

orderDeliveryFee

object

Show child attributes

orderDeliveryFee.value

number<float>

required

Valor monetário

Required range: x >= 0

Example:

45.5

orderDeliveryFee.currency

enum<string>

required

Moeda. Padrão ISO 4217.

Available options:

BRL,

USD,

EUR

Required string length: 3

Example:

"BRL"

packageVolume

integer

Volume do pacote em centímetros cúbicos

Required range: x >= 0

Example:

2000

packageQuantity

integer

Quantidade de pacotes

Required range: x >= 1

Example:

1

specialInstructions

string

Instruções especiais para a entrega

Example:

"Produto frágil"

additionalPricePercentual

number<float>

Percentual adicional no preço (0-100)

Required range: 0 <= x <= 100

Example:

10.5

onlinePayment

boolean

Se o pagamento é online

Example:

true

Response

Disponibilidade e preços calculados com sucesso

deliveryPrice

object

required

Show child attributes

deliveryPrice.value

number<float>

required

Valor monetário

Required range: x >= 0

Example:

45.5

deliveryPrice.currency

enum<string>

required

Moeda. Padrão ISO 4217.

Available options:

BRL,

USD,

EUR

Required string length: 3

Example:

"BRL"

vehicles

object

required

Show child attributes

vehicles.availableVehicles

integer

required

Quantidade total de veículos disponíveis

Required range: x >= 0

Example:

15

vehicles.vehiclesAvailable

object

required

Show child attributes

vehicles.vehiclesAvailable.type

enum<string>[]

required

Tipos de veículos disponíveis

Available options:

MOTORBIKE_BAG,

MOTORBIKE_BOX,

CAR,

BICYCLE,

SCOOTER,

VUC

Example:

["MOTORBIKE_BAG", "CAR"]

vehicles.vehiclesAvailable.container

enum<string>

required

Tipo de container disponível

Available options:

NORMAL,

THERMIC

Example:

"NORMAL"

Detalhes da entrega Tracking Event

⌘I

Introdução

Autenticação

Entregas

Detalhes da entrega

Webhooks

Cotação de entrega

Authorizations

Body

Response