GoHusky API

https://husky-tecnologia.github.io/public-api
Admin
GoHusky API is a logistics platform for delivery and shipments, providing all necessary information...
Tokens:16,711
Snippets:47
Trust Score:8.3
Update:11 months ago
Show doc for...
Tokens:
Raw
### Query Order Status Response - JSON Example

Source: https://husky-tecnologia.github.io/public-api/index

This is an example JSON response for the order status query endpoint. It includes details about the order, its current status, update timestamps, and any associated reasons or history.

```json
{
  "success": 1,
  "message": "Requisição realizada com sucesso.",
  "found": {
    "orderTracking": "051aa70b607f97beeba3f5f9ee2a6b984a9f1489c3a74d6083afc59e1685cb2a",
    "orderId": "1",
    "status": "Não Finalizado",
    "updatedAt": "2025-01-28 16:37:43",
    "reason": 5,
    "fleet": {
      "id": 2033,
      "name": "Matheus Costa K."
    },
    "status_history": [
      {
        "status": "Em Aberto",
        "timestamp": "2025-01-27 13:11:45"
      }
    ]
  }
}
```

--------------------------------

### Webhook Event Payload Example (JSON)

Source: https://husky-tecnologia.github.io/public-api/index

This is an example of a JSON payload for a webhook event, specifically for ORDER_CREATED. It includes details about the event, such as its ID, date, context, customer, and the resource associated with the event, which in this case is an order with detailed pickup and dropoff information.

```JSON
{
  "event": "ORDER_CREATED",
  "event_id": "string",
  "date": "2020-06-26 22:24:30",
  "event_context": "1234567890",
  "customer": "1234567890",
  "resource": {
    "order": {
      "addresses": {
        "pickup": {
          "name": "BIM FILMES",
          "phone": "1234567890",
          "address": "Rua dos Andradas, 1155 - Centro Histórico, Porto Alegre - RS, Brasil",
          "lat": -30.030161,
          "lng": -51.230108,
          "comp": "5858",
          "neighborhood": "Centro Histórico",
          "city": "Porto Alegre",
          "state": "RS",
          "country": "Brasil",
          "obs": "Observações adicionais"
        },
        "dropoff": {
          "name": "BIM FILMES",
          "phone": "1234567890",
          "address": "Rua dos Andradas, 1155 - Centro Histórico, Porto Alegre - RS, Brasil",
          "lat": -30.030161,
          "lng": -51.230108,
          "comp": "5858",
          "neighborhood": "Centro Histórico",
          "city": "Porto Alegre",
          "state": "RS",
          "country": "Brasil",
          "obs": "Observações adicionais"
        }
      },
      "orderDetails": {
        "client": "1234567890",
        "subclient": "1234567890",
        "tracking": "051aa70b607f97beeba3f5f9ee2a6b984a9f1489c3a74d6083afc59e1685cb2a",
        "number": 1234567890,
        "cod": "1234567890",
        "requester": "1234567890",
        "size": 0,
        "status": 1,
        "fleet": 1,
        "scheduled": 1,
        "sign": 1,
        "signName": "John Doe",
        "signTime": "2020-06-26 22:24:30",
        "price": 100,
        "waitingPrice": 100,
        "costCenter": 1,
        "opObs": "Observações adicionais",
        "optionalService": 1,
        "vehicle": 1,
        "return": 1,
        "paymentType": 1,
        "distance": 100,
        "times": {
          "created": "2020-06-26 22:24:30",
          "schedule": "2020-06-26 22:24:30",
          "pickup": "2020-06-26 22:24:30",
          "started": "2020-06-26 22:24:30",
          "dropoff": "2020-06-26 22:24:30",
          "closed": "2020-06-26 22:24:30",
          "eta": "2020-06-26 22:24:30"
        }
      }
    }
  }
}
```

--------------------------------

### List Webhooks (GET /notifications)

Source: https://husky-tecnologia.github.io/public-api/index

Retrieves a list of all registered webhooks for the provided token. Requires authentication via query parameters (TokenQuery, CustomerQuery) and accepts a 'live_mode' boolean to specify the environment (production or homologation).

```HTTP
GET https://sandbox.api.gohusky.net/notifications?live_mode=false
GET https://api.gohusky.net/notifications?live_mode=true
```

--------------------------------

### Create Delivery Response (JSON)

Source: https://husky-tecnologia.github.io/public-api/index

Example JSON response from the `createOrderList` endpoint. It indicates the success of the request, provides a status message, a tracking code, and the order ID. This response confirms that the delivery request has been processed.

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

--------------------------------

### Check Order Price Request Payload (JSON)

Source: https://husky-tecnologia.github.io/public-api/index

Example JSON payload for the `checkOrderPrice` endpoint. It includes token, geocoding preference, return preference, and pickup/destination details. This is used to get a price quote for a delivery.

```json
{
  "token": "4156165165165165165165165165165165165165165165165",
  "geocoding": true,
  "return": true,
  "pickup": {
    "address": "Francisco Cabeda",
    "lat": -30,
    "lng": -50,
    "streetNumber": "81",
    "neighborhood": "Centro",
    "city": "Santana do Livramento",
    "state": "RS",
    "country": "BR"
  },
  "destiny": {
    "address": "Francisco Cabeda",
    "lat": -30,
    "lng": -50,
    "streetNumber": "81",
    "neighborhood": "Centro",
    "city": "Santana do Livramento",
    "state": "RS",
    "country": "BR"
  }
}
```

--------------------------------

### GET /unfinishedStatusReasons

Source: https://husky-tecnologia.github.io/public-api/index

Retrieves a list of available reasons for changing a delivery to the 'Unfinished' status. This endpoint supports both production and sandbox environments.

```APIDOC
## GET /unfinishedStatusReasons

### Description
Obtém os motivos disponíveis para alterar uma entrega para o status "Não Finalizado".

### Method
GET

### Endpoint
`/unfinishedStatusReasons`

### Query Parameters
- **live_mode** (boolean) - Required - Especifica o ambiente para executar a requisição. `true` = Ambiente de Produção, `false` = Ambiente de Homologação.

### Request Example
```json
{
  "live_mode": false
}
```

### Response
#### Success Response (200)
- **code** (integer) - The status reason code.
- **name** (string) - The description of the status reason.

#### Response Example
```json
[
  {
    "code": 1,
    "name": "Cliente não encontrado"
  }
]
```

#### Error Responses
- **401**: Token inválido ou não autorizado
- **404**: Token não informado corretamente
- **405**: Método não permitido
```

--------------------------------

### GET /getFleetDetails

Source: https://husky-tecnologia.github.io/public-api/index

Retrieves information about a fleet driver based on their ID. This endpoint allows querying in both production and sandbox environments.

```APIDOC
## GET /getFleetDetails

### Description
Obtém informações de um entregador com base no seu ID.

### Method
GET

### Endpoint
`/getFleetDetails`

### Query Parameters
- **live_mode** (boolean) - Required - Especifica o ambiente para executar a requisição. `true` = Ambiente de Produção, `false` = Ambiente de Homologação.
- **fleetId** (integer) - Required - Identificador do entregador.

### Request Example
```json
{
  "live_mode": false,
  "fleetId": 12345
}
```

### Response
#### Success Response (200)
- **fleet_driver** (string) - The driver's full name.
- **fleet_alias** (string) - The driver's alias or nickname.
- **fleet_photo** (string) - URL to the driver's photo.
- **fleet_plate** (string) - The vehicle's license plate.
- **fleet_cel** (string) - The driver's mobile number.
- **fleet_app_version** (string) - The version of the app the driver is using.
- **fleet_rg** (string) - The driver's RG number.
- **fleet_cpf** (string) - The driver's CPF number.

#### Response Example
```json
{
  "fleet_driver": "João da Silva",
  "fleet_alias": "joão",
  "fleet_photo": "https://gohusky.s3.sa-east-1.amazonaws.com/389d0e3ff95784714a04fd93c4bf14db78e39dcf6a96655270bff5fa541df08e.png",
  "fleet_plate": "",
  "fleet_cel": "51996766591",
  "fleet_app_version": "1.6.8",
  "fleet_rg": "",
  "fleet_cpf": ""
}
```

#### Error Responses
- **400**: ID do entregador não informado
- **401**: Token inválido ou não autorizado
- **404**: Token não informado corretamente
- **405**: Método não permitido
```

--------------------------------

### Create Delivery Request Payload (JSON)

Source: https://husky-tecnologia.github.io/public-api/index

Example JSON payload for the `createOrderList` endpoint, used for creating deliveries. It's an array of objects, each defining specifications and addresses for a delivery, including origin, destination, and package details. Supports both individual and batch deliveries.

```json
[
  {
    "specifications": {
      "origin": "NomeDoSeuSistema",
      "return": false,
      "geocoding": false,
      "orderId": "01",
      "token": "Token-Loja/embarcador/Restaurante",
      "startDate": "02/01/2006 15:04:05",
      "package": {
        "size": "0"
      },
      "ifood_reference": "12345678"
    },
    "addresses": {
      "dropoff": {
        "name": "Francisco",
        "phone": "00000000000",
        "address": "R. Xavier Curado",
        "streetNumber": "25",
        "comp": "apto",
        "neighborhood": "Ipiranga",
        "city": "São Paulo",
        "state": "São paulo",
        "country": "Brasil",
        "obs": "Observações adicionais",
        "lat": "-23.584644",
        "lng": "-46.608366",
        "useSavedAddress": false,
        "payment": {
          "method": "ONLINE",
          "value": 100
        }
      },
      "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": true,
        "lat": "-23.584644",
        "lng": "-46.608366"
      }
    }
  }
]
```

--------------------------------

### Get Unfinished Status Reasons API Endpoint

Source: https://husky-tecnologia.github.io/public-api/index

Retrieves a list of available reasons to change a delivery to 'Unfinished' status. Requires authentication and accepts a 'live_mode' boolean parameter to specify the environment (production or sandbox).

```json
[
  {
    "code": 1,
    "name": "Cliente não encontrado"
  }
]
```

--------------------------------

### Check Order Price Response (JSON)

Source: https://husky-tecnologia.github.io/public-api/index

Example JSON response from the `checkOrderPrice` endpoint. It contains the calculated price and the estimated distance for the delivery. This response is typically received after a successful price quote request.

```json
{
  "price": "28.30",
  "distance": 10.123
}
```

--------------------------------

### Get Fleet Driver Details API Endpoint

Source: https://husky-tecnologia.github.io/public-api/index

Fetches detailed information about a specific fleet driver using their unique fleet ID. This endpoint requires authentication and the 'fleetId' as a query parameter. The 'live_mode' parameter selects the operational environment.

```json
[
  {
    "fleet_driver": "João da Silva",
    "fleet_alias": "joão",
    "fleet_photo": "https://gohusky.s3.sa-east-1.amazonaws.com/389d0e3ff95784714a04fd93c4bf14db78e39dcf6a96655270bff5fa541df08e.png",
    "fleet_plate": "",
    "fleet_cel": "51996766591",
    "fleet_app_version": "1.6.8",
    "fleet_rg": "",
    "fleet_cpf": ""
  }
]
```

--------------------------------

### POST /orderReady - Mark Order as Ready

Source: https://husky-tecnologia.github.io/public-api/index

This endpoint allows you to mark an order as ready for pickup or delivery. It requires a tracking code and a boolean indicating readiness. Available for both sandbox and production environments.

```APIDOC
## POST /orderReady

### Description
Marks an order as ready. This endpoint is intended for testing and development in the sandbox environment, and for production use in the production environment.

### Method
POST

### Endpoint
- Sandbox: `https://sandbox.api.gohusky.net/orderReady`
- Production: `https://api.gohusky.net/orderReady`

### Parameters
#### Request Body
- **tracking** (string) - Required - The tracking code of the order.
- **ready** (boolean) - Required - Set to `true` to mark the order as ready.

### Request Example
```json
{
  "tracking": "051aa70b607f97beeba3f5f9ee2a6b984a9f1489c3a74d6083afc59e1685cb2a",
  "ready": true
}
```

### Response
#### Success Response (200)
- **status** (integer) - The HTTP status code indicating success.
- **message** (string) - A message confirming the successful update.

#### Response Example
```json
{
  "status": 200,
  "message": "Entrega atualizada com sucesso!"
}
```

#### Error Responses
- **400**: Bad Request - Error updating delivery.
- **401**: Unauthorized - Invalid or no token provided.
- **404**: Not Found - Token not correctly informed.
- **405**: Method Not Allowed - HTTP method not permitted.
```

--------------------------------

### POST /createStore

Source: https://husky-tecnologia.github.io/public-api/index

Creates a new store (embarcador) in the Husky Tecnologia system. Supports both production and sandbox environments.

```APIDOC
## POST /createStore

### Description
Creates a new store (embarcador) in the Husky Tecnologia system. Supports both production and sandbox environments.

### Method
POST

### Endpoint
- Production: `https://api.gohusky.net/createStore`
- Sandbox: `https://sandbox.api.gohusky.net/createStore`

### Query Parameters
- **live_mode** (boolean) - Required - Specifies the environment for the request. `true` for Production, `false` for Sandbox.

### Request Body
- **basicInfo** (object) - Required - Basic information of the embarcador.
  - **name** (string) - Required - Name of the embarcador.
  - **phone** (string) - Required - Phone number of the embarcador.
  - **user** (string) - Required - User associated with the embarcador.
  - **pass** (string) - Required - Password for the embarcador user.
  - **label** (string) - Required - Label for the embarcador.
  - **active** (boolean) - Required - Indicates if the embarcador is active.
- **address** (object) - Required - Address of the embarcador.
  - **street** (string) - Required - Street name and number.
  - **comp** (string) - Optional - Complement or suite number.
  - **lat** (number) - Required - Latitude coordinate.
  - **lng** (number) - Required - Longitude coordinate.
  - **neighborhood** (string) - Required - Neighborhood.
  - **city** (string) - Required - City.
  - **state** (string) - Required - State.
  - **country** (string) - Required - Country.

### Request Example
```json
{
  "basicInfo": {
    "name": "Embarcador Teste",
    "phone": "51323366656",
    "user": "loja.1tes3t2e@lojateste.com",
    "pass": "1234",
    "label": "Teste",
    "active": true
  },
  "address": {
    "street": "Rua dos Andradas, 1234",
    "comp": "Sala 1201",
    "lat": -45.4648,
    "lng": -45.5468,
    "neighborhood": "Centro Histórico",
    "city": "Porto Alegre",
    "state": "Rio Grande do Sul",
    "country": "Brasil"
  }
}
```

### Response
#### Success Response (200)
- **success** (integer) - Indicates success (1 for success).
- **message** (string) - Confirmation message.
- **token** (string) - API token for subsequent requests.

#### Response Example
```json
{
  "success": 1,
  "message": "Solicitação recebida com sucesso!",
  "token": "4156165165165165165165165165165165165165165165165165165165165165"
}
```

#### Error Responses
- **400**: Bad Request - Error creating embarcador.
- **401**: Unauthorized - Invalid or expired token.
- **404**: Not Found - Token not provided correctly.
- **405**: Method Not Allowed - HTTP method not permitted.
```

--------------------------------

### POST /createOrderList

Source: https://husky-tecnologia.github.io/public-api/index

Creates one or multiple deliveries in the system. Supports individual or batch delivery creation.

```APIDOC
## POST /createOrderList

### Description
Creates deliveries in the system, supporting both single and multiple deliveries in a batch. Requires authorization via query parameters.

### Method
POST

### Endpoint
- Sandbox: `https://sandbox.api.gohusky.net/createOrderList`
- Production: `https://api.gohusky.net/createOrderList`

### Parameters
#### Query Parameters
- **live_mode** (boolean) - Required - Specifies the environment for the request. `true` for Production, `false` for Sandbox.

#### Request Body
- **specifications** (object) - Required - Delivery specifications.
  - **origin** (string) - Required - Origin system name.
  - **return** (boolean) - Required - Whether to return the order.
  - **geocoding** (boolean) - Required - Whether to perform geocoding.
  - **orderId** (string) - Required - Unique order identifier.
  - **token** (string) - Required - Authorization token.
  - **startDate** (string) - Required - Start date and time for the delivery (format: MM/DD/YYYY HH:MM:SS).
  - **package** (object) - Required - Package details.
    - **size** (string) - Required - Package size identifier.
  - **ifood_reference** (string) - Optional - iFood reference number.
- **addresses** (object) - Required - Delivery address details.
  - **dropoff** (object) - Required - Dropoff location details.
    - **name** (string) - Required - Recipient's name.
    - **phone** (string) - Required - Recipient's phone number.
    - **address** (string) - Required - Street name.
    - **streetNumber** (string) - Optional - Street number.
    - **comp** (string) - Optional - Complement information (e.g., apartment number).
    - **neighborhood** (string) - Required - Neighborhood.
    - **city** (string) - Required - City name.
    - **state** (string) - Required - State abbreviation.
    - **country** (string) - Required - Country code.
    - **obs** (string) - Optional - Additional observations.
    - **lat** (string) - Required - Latitude.
    - **lng** (string) - Required - Longitude.
    - **useSavedAddress** (boolean) - Required - Whether to use a saved address.
    - **payment** (object) - Optional - Payment details for the delivery.
      - **method** (string) - Required - Payment method (e.g., "ONLINE").
      - **value** (number) - Required - Payment amount.
  - **pickup** (object) - Required - Pickup location details (same structure as dropoff, but without payment details).

### Request Example
```json
[
  {
    "specifications": {
      "origin": "NomeDoSeuSistema",
      "return": false,
      "geocoding": false,
      "orderId": "01",
      "token": "Token-Loja/embarcador/Restaurante",
      "startDate": "02/01/2006 15:04:05",
      "package": {
        "size": "0"
      },
      "ifood_reference": "12345678"
    },
    "addresses": {
      "dropoff": {
        "name": "Francisco",
        "phone": "00000000000",
        "address": "R. Xavier Curado",
        "streetNumber": "25",
        "comp": "apto",
        "neighborhood": "Ipiranga",
        "city": "São Paulo",
        "state": "São paulo",
        "country": "Brasil",
        "obs": "Observações adicionais",
        "lat": "-23.584644",
        "lng": "-46.608366",
        "useSavedAddress": false,
        "payment": {
          "method": "ONLINE",
          "value": 100
        }
      },
      "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": true,
        "lat": "-23.584644",
        "lng": "-46.608366"
      }
    }
  }
]
```

### Response
#### Success Response (200)
- **success** (integer) - Indicates if the request was successful.
- **message** (string) - A message confirming the request was received.
- **tracking** (string) - The tracking code for the created delivery.
- **orderId** (string) - The identifier of the created order.

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

#### Error Responses
- **400** - Bad Request: Invalid request format or missing required fields.
- **401** - Unauthorized: Invalid or missing token.
- **404** - Not Found: Token not provided correctly.
- **405** - Method Not Allowed: Incorrect HTTP method used.
```

--------------------------------

### List Webhooks

Source: https://husky-tecnologia.github.io/public-api/index

Retrieves a list of all registered webhooks for the provided token. Supports live mode selection.

```APIDOC
## GET /notifications

### Description
Fetches all registered webhooks for the provided token. This endpoint can be used to test or retrieve existing webhook configurations.

### Method
GET

### Endpoint
`/notifications`

### Query Parameters
- **live_mode** (boolean) - Required - Specifies the environment for the request. `true` for Production, `false` for Homologation.

### Request Example
```json
{
  "example": ""
}
```

### Response
#### Success Response (200)
- **id** (string) - The unique identifier for the webhook.
- **event** (string) - The type of event to receive notifications for.
- **url** (string) - The URL where notifications will be sent.

#### Response Example
```json
[
  {
    "id": "NTF-5e42e2b9f3645",
    "event": "ORDER_STATUS_UPDATED",
    "url": "https://www.seusite.com.br/url"
  }
]
```

#### Error Responses
- **401**: Token invalid or unauthorized.
- **404**: Token not informed correctly.
- **405**: Method not allowed.
```

--------------------------------

### Create Webhook (POST /notifications)

Source: https://husky-tecnologia.github.io/public-api/index

Registers a new webhook for receiving notifications. Requires authentication via query parameters (TokenQuery, CustomerQuery) and a 'live_mode' boolean. The request body must include the 'event' type and the 'url' for receiving notifications. Supports various event types including 'all'.

```HTTP
POST https://sandbox.api.gohusky.net/notifications?live_mode=false
Content-Type: application/json

{
  "event": "ORDER_STATUS_UPDATED",
  "url": "https://www.seusite.com.br/url"
}
```

```HTTP
POST https://api.gohusky.net/notifications?live_mode=true
Content-Type: application/json

{
  "event": "ORDER_STATUS_UPDATED",
  "url": "https://www.seusite.com.br/url"
}
```

--------------------------------

### POST /orderReady

Source: https://husky-tecnologia.github.io/public-api/index

Informs that an order is ready for pickup by the delivery person. Requires authorization.

```APIDOC
## POST /orderReady

### Description
Notifies that an order is ready to be picked up by the delivery person. Requires authorization via query parameters.

### Method
POST

### Endpoint
(Endpoint details for this specific function are not provided in the input text. Please refer to the base API URL and append `/orderReady`)

### Parameters
#### Query Parameters
- **live_mode** (boolean) - Required - Specifies the environment for the request. `true` for Production, `false` for Sandbox.

#### Request Body
- **tracking** (string) - Required - The tracking identifier for the delivery.
- **ready** (boolean) - Required - Defines if the delivery is ready for pickup. `true` if ready, `false` otherwise.
```

--------------------------------

### Create Store Success Response

Source: https://husky-tecnologia.github.io/public-api/index

This JSON response indicates a successful store creation request. It includes a success flag, a confirmation message, and a generated token for further API interactions.

```json
{
  "success": 1,
  "message": "Solicitação recebida com sucesso!",
  "token": "4156165165165165165165165165165165165165165165165165165165165165"
}
```

--------------------------------

### POST /importKML

Source: https://husky-tecnologia.github.io/public-api/index

Imports a KML file for a specific embarcador. Supports both production and sandbox environments.

```APIDOC
## POST /importKML

### Description
Imports a KML file for a specific embarcador. Supports both production and sandbox environments.

### Method
POST

### Endpoint
- Production: `https://api.gohusky.net/importKML`
- Sandbox: `https://sandbox.api.gohusky.net/importKML`

### Query Parameters
- **live_mode** (boolean) - Required - Specifies the environment for the request. `true` for Production, `false` for Sandbox.

### Request Body
- **kml** (file) - Required - KML file for import (binary).

### Response
#### Success Response (200)
- **success** (integer) - Indicates success (1 for success).
- **message** (string) - Confirmation message.

#### Response Example
```json
{
  "success": 1,
  "message": "KML importado com sucesso!"
}
```

#### Error Responses
- **400**: Bad Request - Error importing KML.
- **401**: Unauthorized - Invalid or expired token.
- **404**: Not Found - Token not provided correctly.
- **405**: Method Not Allowed - HTTP method not permitted.
```

--------------------------------

### POST /checkOrderPrice

Source: https://husky-tecnologia.github.io/public-api/index

Allows you to check the price of an order by providing pickup and destination details. It supports both sandbox and production environments.

```APIDOC
## POST /checkOrderPrice

### Description
Checks the price of an order based on pickup and destination information. Supports both sandbox and production environments.

### Method
POST

### Endpoint
- Sandbox: `https://sandbox.api.gohusky.net/checkOrderPrice`
- Production: `https://api.gohusky.net/checkOrderPrice`

### Parameters
#### Request Body
- **token** (string) - Required - Authentication token.
- **geocoding** (boolean) - Optional - Whether to perform geocoding.
- **return** (boolean) - Optional - Whether to return order details.
- **pickup** (object) - Required - Pickup location details.
  - **address** (string) - Required - Street name.
  - **lat** (number) - Required - Latitude.
  - **lng** (number) - Required - Longitude.
  - **streetNumber** (string) - Optional - Street number.
  - **neighborhood** (string) - Optional - Neighborhood.
  - **city** (string) - Required - City name.
  - **state** (string) - Required - State abbreviation.
  - **country** (string) - Required - Country code.
- **destiny** (object) - Required - Destination location details (same structure as pickup).

### Request Example
```json
{
  "token": "4156165165165165165165165165165165165165165165165165165165165165",
  "geocoding": true,
  "return": true,
  "pickup": {
    "address": "Francisco Cabeda",
    "lat": -30,
    "lng": -50,
    "streetNumber": "81",
    "neighborhood": "Centro",
    "city": "Santana do Livramento",
    "state": "RS",
    "country": "BR"
  },
  "destiny": {
    "address": "Francisco Cabeda",
    "lat": -30,
    "lng": -50,
    "streetNumber": "81",
    "neighborhood": "Centro",
    "city": "Santana do Livramento",
    "state": "RS",
    "country": "BR"
  }
}
```

### Response
#### Success Response (200)
- **price** (string) - The calculated price of the order.
- **distance** (number) - The calculated distance for the order.

#### Response Example
```json
{
  "price": "28.30",
  "distance": 10.123
}
```

#### Error Responses
- **400** - Bad Request: Error during price calculation.
- **401** - Unauthorized: Invalid or missing token.
- **404** - Not Found: Token not provided correctly.
- **405** - Method Not Allowed: Incorrect HTTP method used.
```

--------------------------------

### Mark Order as Ready - JSON Payload

Source: https://husky-tecnologia.github.io/public-api/index

This snippet shows the JSON payload required to mark an order as ready. It includes the tracking code and a boolean flag indicating readiness. This is used with the orderReady endpoint.

```json
{
  "tracking": "051aa70b607f97beeba3f5f9ee2a6b984a9f1489c3a74d6083afc59e1685cb2a",
  "ready": true
}
```

--------------------------------

### Shipper Creation API

Source: https://husky-tecnologia.github.io/public-api/index

API endpoint for creating a new shipper in the Husky system. Requires authentication via token.

```APIDOC
## POST /customers

### Description
Creates a shipper in the Husky system.

### Method
POST

### Endpoint
`https://api.gohusky.net/customers` (or sandbox equivalent)

### Parameters
#### Query Parameters
- **TokenQuery** (string) - Required - Authentication token.
- **CustomerQuery** (string) - Required - Customer identifier.

#### Request Body
- **name** (string) - Required - Name of the shipper.
- **document** (string) - Required - Document number (e.g., CPF or CNPJ).
- **phone** (string) - Required - Shipper's phone number.
- **email** (string) - Optional - Shipper's email address.
- **address** (object) - Required - Shipper's address details.
    - **street** (string) - Required
    - **number** (string) - Required
    - **neighborhood** (string) - Required
    - **city** (string) - Required
    - **state** (string) - Required
    - **zipcode** (string) - Required
    - **complement** (string) - Optional

### Request Example
```json
{
  "name": "Example Shipper Name",
  "document": "12345678901234",
  "phone": "11987654321",
  "email": "shipper@example.com",
  "address": {
    "street": "Rua Exemplo",
    "number": "123",
    "neighborhood": "Centro",
    "city": "São Paulo",
    "state": "SP",
    "zipcode": "01000000",
    "complement": "Apto 1"
  }
}
```

### Responses
#### Success Response (201)
Indicates that the shipper was created successfully. Returns the details of the created shipper.
- **id** (string) - The unique identifier of the created shipper.
- **name** (string) - Name of the shipper.
- **document** (string) - Document number.
- **phone** (string) - Phone number.
- **email** (string) - Email address.
- **address** (object) - Address details.

#### Error Responses
- **400** - Bad Request (e.g., missing or invalid parameters)
- **401** - Unauthorized (Invalid token or customer query)
- **409** - Conflict (Shipper with the same document already exists)
```

--------------------------------

### POST /rateDelivery

Source: https://husky-tecnologia.github.io/public-api/index

Requests a delivery quote, returning the cost and distance. Supports both production and sandbox environments.

```APIDOC
## POST /rateDelivery

### Description
Requests a delivery quote, returning the cost and distance. Supports both production and sandbox environments.

### Method
POST

### Endpoint
- Production: `https://api.gohusky.net/rateDelivery`
- Sandbox: `https://sandbox.api.gohusky.net/rateDelivery`

### Query Parameters
- **live_mode** (boolean) - Required - Specifies the environment for the request. `true` for Production, `false` for Sandbox.

### Request Body
- **token** (string) - Required - Embarcador's API token.
- **geocoding** (boolean) - Required - Defines if the API should automatically geocode the provided address.
- **return** (boolean) - Required - Defines if the delivery includes a return to origin. `true` for return, `false` otherwise.
- **pickup** (object) - Optional - Pickup point for the delivery. If not provided, the system's default address for the embarcador will be used.
  - (Fields for pickup address would go here, e.g., street, city, lat, lng)
- **destiny** (object) - Required - Delivery destination.
  - (Fields for destiny address would go here, e.g., street, city, lat, lng)

### Response
#### Success Response (200)
- (Details of the quote, cost, and distance would be provided here.)

#### Error Responses
- **400**: Bad Request - Error quoting delivery.
- **401**: Unauthorized - Invalid or expired token.
- **404**: Not Found - Token not provided correctly.
- **405**: Method Not Allowed - HTTP method not permitted.

### Rate Limit
100 requests per minute.
```

--------------------------------

### Create Store Request Payload

Source: https://husky-tecnologia.github.io/public-api/index

This JSON payload is used to create a new store. It includes basic information such as name, phone, user credentials, and an active status, along with the store's address details including street, complement, coordinates, neighborhood, city, state, and country.

```json
{
  "basicInfo": {
    "name": "Embarcador Teste",
    "phone": "51323366656",
    "user": "loja.1tes3t2e@lojateste.com",
    "pass": "1234",
    "label": "Teste",
    "active": true
  },
  "address": {
    "street": "Rua dos Andradas, 1234",
    "comp": "Sala 1201",
    "lat": -45.4648,
    "lng": -45.5468,
    "neighborhood": "Centro Histórico",
    "city": "Porto Alegre",
    "state": "Rio Grande do Sul",
    "country": "Brasil"
  }
}
```

--------------------------------

### POST /nearestStore

Source: https://husky-tecnologia.github.io/public-api/index

Searches for embarcadores that serve a specific location based on provided coordinates. Supports both production and sandbox environments.

```APIDOC
## POST /nearestStore

### Description
Searches for embarcadores that serve a specific location based on provided coordinates. Supports both production and sandbox environments.

### Method
POST

### Endpoint
- Production: `https://api.gohusky.net/nearestStore`
- Sandbox: `https://sandbox.api.gohusky.net/nearestStore`

### Query Parameters
- **live_mode** (boolean) - Required - Specifies the environment for the request. `true` for Production, `false` for Sandbox.

### Request Body
- **orderInfo** (object) - Required - Information for the search.
  - **lat** (number) - Required - Latitude of the location.
  - **lng** (number) - Required - Longitude of the location.
  - **label** (string) - Optional - An optional label for the search.

### Request Example
```json
{
  "orderInfo": {
    "lat": -30.029819,
    "lng": -51.229321,
    "label": "Label opcional"
  }
}
```

### Response
#### Success Response (200)
- **totalDistance** (number) - The total distance to the nearest embarcador.
- **area** (string) - Information about the service area.

#### Response Example
```json
{
  "totalDistance": 0,
  "area": "string"
}
```

#### Error Responses
- **400**: Bad Request - Error locating embarcador.
- **401**: Unauthorized - Invalid or expired token.
- **404**: Not Found - Token not provided correctly.
- **405**: Method Not Allowed - HTTP method not permitted.
```

--------------------------------

### Register Webhook

Source: https://husky-tecnologia.github.io/public-api/index

Registers a new webhook for event notifications. Allows specifying the event type and the notification URL. Supports live mode selection.

```APIDOC
## POST /notifications

### Description
Registers a webhook for receiving event notifications. You can specify the type of event and the URL to send notifications to. Supports live mode selection.

### Method
POST

### Endpoint
`/notifications`

### Query Parameters
- **live_mode** (boolean) - Required - Specifies the environment for the request. `true` for Production, `false` for Homologation.

### Request Body
- **event** (string) - Required - Type of event for notification. Can be a specific event or `all` for all events.
- **url** (string) - Required - The URL to receive webhook notifications.

### Request Example
```json
{
  "event": "ORDER_STATUS_UPDATED",
  "url": "https://www.seusite.com.br/url"
}
```

### Response
#### Success Response (200)
- **id** (string) - The unique identifier for the newly registered webhook.
- **event** (string) - The type of event for which the notification is registered.
- **url** (string) - The URL where notifications will be sent.

#### Response Example
```json
[
  {
    "id": "NTF-5e42e35a958f0",
    "event": "ORDER_STATUS_UPDATED",
    "url": "https://www.seusite.com.br/url"
  }
]
```

#### Error Responses
- **400**: Error registering notification.
- **401**: Token invalid or unauthorized.
- **404**: Token not informed correctly.
- **405**: Method not allowed.
```
Tokens:
Raw