Detalhes da entrega

Obter detalhes da entrega

curl --request GET \
  --url https://opendelivery.gohusky.net/logistic/v1/logistics/delivery/{orderId} \
  --header 'Authorization: Bearer <token>'

{
  "deliveryId": "123e4567-e89b-12d3-a456-426614174000",
  "orderId": "ORDER-12345",
  "orderDisplayId": "ORD-12345",
  "merchant": {
    "id": "MERCHANT-001",
    "name": "Restaurante Exemplo"
  },
  "customerName": "João Silva",
  "events": [
    {
      "type": "PENDING",
      "datetime": "2024-01-15T10:30:00.000Z"
    },
    {
      "type": "ACCEPTED",
      "datetime": "2024-01-15T10:35:00.000Z"
    }
  ],
  "vehicle": {
    "type": [
      "MOTORBIKE_BAG"
    ],
    "container": "NORMAL"
  },
  "deliveryPrice": {
    "value": 8.5,
    "currency": "BRL"
  },
  "times": {
    "deliveryEtaDate": "2024-01-15T11:30:00.000Z",
    "maxDeliveryTime": "2024-01-15T12:00:00.000Z",
    "isDeliveryFinished": false
  },
  "deliveryPerson": {
    "id": "DELIVERY-001",
    "name": "Entregador Exemplo"
  }
}

GET

logistics

delivery

{orderId}

Obter detalhes da entrega

curl --request GET \
  --url https://opendelivery.gohusky.net/logistic/v1/logistics/delivery/{orderId} \
  --header 'Authorization: Bearer <token>'

{
  "deliveryId": "123e4567-e89b-12d3-a456-426614174000",
  "orderId": "ORDER-12345",
  "orderDisplayId": "ORD-12345",
  "merchant": {
    "id": "MERCHANT-001",
    "name": "Restaurante Exemplo"
  },
  "customerName": "João Silva",
  "events": [
    {
      "type": "PENDING",
      "datetime": "2024-01-15T10:30:00.000Z"
    },
    {
      "type": "ACCEPTED",
      "datetime": "2024-01-15T10:35:00.000Z"
    }
  ],
  "vehicle": {
    "type": [
      "MOTORBIKE_BAG"
    ],
    "container": "NORMAL"
  },
  "deliveryPrice": {
    "value": 8.5,
    "currency": "BRL"
  },
  "times": {
    "deliveryEtaDate": "2024-01-15T11:30:00.000Z",
    "maxDeliveryTime": "2024-01-15T12:00:00.000Z",
    "isDeliveryFinished": false
  },
  "deliveryPerson": {
    "id": "DELIVERY-001",
    "name": "Entregador Exemplo"
  }
}

Este endpoint retorna todas as informações relacionadas a uma entrega, incluindo:

Dados do pedido e merchant
Status e eventos da entrega
Informações do veículo e entregador
Preços e tempos
Problemas reportados (se houver)

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.

Path Parameters

orderId

string

required

Identificador único do pedido

Response

Detalhes da entrega retornados com sucesso

deliveryId

string<uuid>

Identificador único da entrega

Example:

"123e4567-e89b-12d3-a456-426614174000"

orderId

string

Identificador único do pedido

Example:

"ORDER-12345"

orderDisplayId

string

Identificador de exibição do pedido

Example:

"ORD-12345"

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"

customerName

string

Nome do cliente

Example:

"João Silva"

events

object[]

Lista de eventos da entrega

Show child attributes

events.type

enum<string>

required

Tipo do evento

Available options:

PENDING,

ACCEPTED,

REJECTED,

PICKUP_ONGOING,

ARRIVED_AT_MERCHANT,

ORDER_PICKED,

DELIVERY_ONGOING,

ARRIVED_AT_CUSTOMER,

ORDER_DELIVERED,

RETURNING_TO_MERCHANT,

RETURNED_TO_MERCHANT,

DELIVERY_FINISHED,

CANCELLED

Example:

"ACCEPTED"

events.datetime

string<date-time>

required

Data e hora do evento (ISO 8601)

Example:

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

problem

object[]

Lista de problemas reportados

Show child attributes

problem.type

string

Tipo do problema

Example:

"PAYMENT_PROBLEMS"

problem.datetime

string<date-time>

Data e hora do problema (ISO 8601)

Example:

"2024-01-15T11:00:00.000Z"

problem.resolved

boolean

Se o problema foi resolvido

Example:

false

problem.message

string

Mensagem sobre o problema

Example:

"Cliente não possui o valor exato"

vehicle

object

Show child attributes

vehicle.type

enum<string>[]

Tipos de veículo

Available options:

MOTORBIKE_BAG,

MOTORBIKE_BOX,

CAR,

BICYCLE,

SCOOTER,

VUC

vehicle.container

enum<string>

Tipo de container

Available options:

NORMAL,

THERMIC

deliveryPrice

object

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"

times

object

Show child attributes

times.deliveryEtaDate

string<date-time>

Data e hora estimada para entrega (ISO 8601)

Example:

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

times.maxDeliveryTime

string<date-time>

Data e hora máxima para entrega (ISO 8601)

Example:

"2024-01-15T12:00:00.000Z"

times.isDeliveryFinished

boolean

Se a entrega foi finalizada

Example:

false

times.deliveryFinishDate

string<date-time>

Data e hora de finalização da entrega (ISO 8601, apenas se isDeliveryFinished for true)

Example:

"2024-01-15T11:45:00.000Z"

deliveryPerson

object

Show child attributes

deliveryPerson.id

string

Identificador do entregador

Example:

"DELIVERY-001"

deliveryPerson.name

string

Nome do entregador

Example:

"Entregador Exemplo"

combinedOrdersIds

string[]

IDs de pedidos combinados

Example:

["ORDER-123", "ORDER-124"]

externalTrackingURL

string<uri>

URL externa para rastreamento

Example:

"https://tracking.example.com/ORDER-12345"

Cancelar Entrega Cotação de entrega

⌘I

Introdução

Autenticação

Entregas

Cotação de entrega

Webhooks

Detalhes da entrega

Authorizations

Path Parameters

Response