Criação de entrega

curl --request POST \
  --url 'https://sandbox.api.gohusky.net/createOrderList?token=' \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "specifications": {
      "origin": "NomeDoSeuSistema",
      "return": false,
      "geocoding": false,
      "orderId": "01",
      "token": "Token-Loja/embarcador/Restaurante",
      "package": {
        "size": 0
      },
      "startDate": "02/01/2006 15:04:05",
      "ifood_reference": "12345678"
    },
    "addresses": {
      "dropoff": {
        "name": "Francisco",
        "phone": "00000000000",
        "address": "R. Xavier Curado",
        "streetNumber": "25",
        "neighborhood": "Ipiranga",
        "city": "São Paulo",
        "state": "São paulo",
        "country": "Brasil",
        "lat": "-23.584644",
        "lng": "-46.608366",
        "payment": {
          "method": "ONLINE",
          "value": 100
        },
        "comp": "apto",
        "obs": "Observações adicionais",
        "useSavedAddress": false
      },
      "pickup": {
        "name": "Nome do remetente",
        "phone": "00000000000",
        "address": "Endereço de coleta",
        "streetNumber": "123",
        "neighborhood": "Centro",
        "city": "São Paulo",
        "state": "SP",
        "country": "Brasil",
        "obs": "Observações",
        "geocoding": false,
        "lat": "-23.584644",
        "lng": "-46.608366"
      }
    }
  }
]
'

[
  {
    "success": 1,
    "message": "Solicitação recebida com sucesso!",
    "tracking": "6b0187ae9bb6a5cb809308508133d32e83c5efe0e9fb297fea8283505a3b23dc",
    "orderId": "123"
  }
]

POST

createOrderList

Criação de entrega

curl --request POST \
  --url 'https://sandbox.api.gohusky.net/createOrderList?token=' \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "specifications": {
      "origin": "NomeDoSeuSistema",
      "return": false,
      "geocoding": false,
      "orderId": "01",
      "token": "Token-Loja/embarcador/Restaurante",
      "package": {
        "size": 0
      },
      "startDate": "02/01/2006 15:04:05",
      "ifood_reference": "12345678"
    },
    "addresses": {
      "dropoff": {
        "name": "Francisco",
        "phone": "00000000000",
        "address": "R. Xavier Curado",
        "streetNumber": "25",
        "neighborhood": "Ipiranga",
        "city": "São Paulo",
        "state": "São paulo",
        "country": "Brasil",
        "lat": "-23.584644",
        "lng": "-46.608366",
        "payment": {
          "method": "ONLINE",
          "value": 100
        },
        "comp": "apto",
        "obs": "Observações adicionais",
        "useSavedAddress": false
      },
      "pickup": {
        "name": "Nome do remetente",
        "phone": "00000000000",
        "address": "Endereço de coleta",
        "streetNumber": "123",
        "neighborhood": "Centro",
        "city": "São Paulo",
        "state": "SP",
        "country": "Brasil",
        "obs": "Observações",
        "geocoding": false,
        "lat": "-23.584644",
        "lng": "-46.608366"
      }
    }
  }
]
'

[
  {
    "success": 1,
    "message": "Solicitação recebida com sucesso!",
    "tracking": "6b0187ae9bb6a5cb809308508133d32e83c5efe0e9fb297fea8283505a3b23dc",
    "orderId": "123"
  }
]

Authorizations

token

string

query

required

Token de autenticação via query parameter. Pode representar o ID público da operação (Operador Logístico) ou o ID público do embarcador (Restaurante, loja, farmácia).

Query Parameters

live_mode

boolean

required

Especifica o ambiente para executar a requisição.

customer

boolean

required

Define o tipo de autenticação: true = Embarcador (Restaurante, Loja, Farmácia) false = Operação (Operador Logístico)

Body

application/json

specifications

object

required

Especificações da entrega

Show child attributes

specifications.origin

string

required

Identificação da origem da entrega (ex.: Nome PDV, Televendas, etc.)

Example:

"NomeDoSeuSistema"

specifications.return

boolean

required

Indica se a entrega terá retorno para a origem

Example:

false

specifications.geocoding

boolean

required

Define se a API deve geocodificar automaticamente o endereço informado

Example:

false

specifications.orderId

string

required

Número de identificação da entrega em um sistema externo

Example:

"01"

specifications.token

string

required

Token da Embarcador/loja relacionado à entrega

Example:

"Token-Loja/embarcador/Restaurante"

specifications.package

object

required

Informações do pacote da entrega

Show child attributes

specifications.package.size

number

Tamanho do pacote da entrega

Example:

0

specifications.startDate

string<datetime>

Data e hora em que o serviço deve ser realizado (fuso horário UTC)

Example:

"02/01/2006 15:04:05"

specifications.ifood_reference

string

Se for uma entrega para um pedido do iFood, informe o código localizador do pedido iFood

Example:

"12345678"

addresses

object

required

Pontos da entrega (Ponto de entrega e Ponto de coleta)

Show child attributes

addresses.dropoff

object

required

Ponto de entrega

Show child attributes

addresses.dropoff.name

string

required

Nome do destinatário

Example:

"Francisco"

addresses.dropoff.phone

string

required

Telefone do destinatário

Example:

"00000000000"

addresses.dropoff.address

string

required

Endereço completo de entrega

Example:

"R. Xavier Curado"

addresses.dropoff.streetNumber

string

required

Número do endereço de entrega

Example:

"25"

addresses.dropoff.neighborhood

string

required

Bairro do endereço de entrega

Example:

"Ipiranga"

addresses.dropoff.city

string

required

Cidade do endereço de entrega

Example:

"São Paulo"

addresses.dropoff.state

string

required

Estado do endereço de entrega

Example:

"São paulo"

addresses.dropoff.country

string

required

País do endereço de entrega

Example:

"Brasil"

addresses.dropoff.lat

string

required

Latitude do endereço de entrega

Example:

"-23.584644"

addresses.dropoff.lng

string

required

Longitude do endereço de entrega

Example:

"-46.608366"

addresses.dropoff.payment

object

required

Show child attributes

addresses.dropoff.payment.method

enum<string>

required

Método de pagamento

Available options:

ONLINE,

CASH,

TERMINAL

Example:

"ONLINE"

addresses.dropoff.payment.value

number

required

Valor do pagamento

Example:

100

addresses.dropoff.comp

string

Complemento do endereço de entrega

Example:

"apto"

addresses.dropoff.obs

string

Observações adicionais do endereço de entrega

Example:

"Observações adicionais"

addresses.dropoff.useSavedAddress

boolean

Indica se deve ser usado o endereço salvo na base de contatos para o destinatário.
true = Ignora o endereço informado e usa o endereço salvo na base de contatos. Se não houver endereço salvo, será usado o endereço informado.
false = Usa o endereço informado

Example:

false

addresses.pickup

object

(Opcional) Ponto de coleta. Se não for enviado, será usado o endereço cadastrado em nosso sistema para a loja.

Show child attributes

addresses.pickup.name

string

required

Nome do remetente

Example:

"Nome do remetente"

addresses.pickup.phone

string

required

Telefone do remetente

Example:

"00000000000"

addresses.pickup.address

string

required

Endereço de coleta

Example:

"Endereço de coleta"

addresses.pickup.streetNumber

string

required

Número do endereço de coleta

Example:

"123"

addresses.pickup.neighborhood

string

required

Bairro do endereço de coleta

Example:

"Centro"

addresses.pickup.city

string

required

Cidade do endereço de coleta

Example:

"São Paulo"

addresses.pickup.state

string

required

Estado do endereço de coleta

Example:

"SP"

addresses.pickup.country

string

required

País do endereço de coleta

Example:

"Brasil"

addresses.pickup.obs

string

required

Observações do endereço de coleta

Example:

"Observações"

addresses.pickup.geocoding

boolean

required

Define se a API deve geocodificar automaticamente o endereço informado

Example:

false

addresses.pickup.lat

string

required

Latitude do endereço de coleta

Example:

"-23.584644"

addresses.pickup.lng

string

required

Longitude do endereço de coleta

Example:

"-46.608366"

Response

Requisição processada com sucesso.

IMPORTANTE: se o valor do campo 'success' for diferente de 1, houve um erro na criação da entrega. Em caso de erro, valide o campo 'message' para mais detalhes.

Sucesso · object[]
Erro · object[]

success

integer

Indica se a requisição foi processada com sucesso. 1 = Sucesso, qualquer outro valor indica que houve um erro.

Example:

1

message

string

Mensagem de retorno da solicitação

Example:

"Solicitação recebida com sucesso!"

tracking

string

Identificador da entrega

Example:

"6b0187ae9bb6a5cb809308508133d32e83c5efe0e9fb297fea8283505a3b23dc"

orderId

string

Número da entrega na operação

Example:

"123"

Cotação de entrega Consulta de Status da entrega

⌘I

Introdução

Embarcadores

Entregas

Entregadores

Webhooks

Criação de entrega

Authorizations

Query Parameters

Body

Response