Husky Tecnologia (Portuguese)

https://docs.gohusky.net/
Admin
missing description
Tokens:3,766
Snippets:12
Trust Score:5.4
Update:10 months ago
Show doc for...
Tokens:
Raw
### Example Success Response (JSON)

Source: https://docs.gohusky.net/api-open-delivery/cotacao-de-entrega/availability

An example of a successful response for checking delivery availability. It includes the calculated delivery price and details about available vehicles.

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

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

### Example Unauthorized Error (JSON)

Source: https://docs.gohusky.net/api-open-delivery/cotacao-de-entrega/availability

An example of an error response when the request is unauthorized. This occurs if the provided API token is invalid or missing.

```json
{
  "title": "Não autorizado",
  "status": 401
}
```

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

### Example Invalid Request Error (JSON)

Source: https://docs.gohusky.net/api-open-delivery/cotacao-de-entrega/availability

An example of an error response when the request is invalid. Typically indicates a bad request format or missing parameters.

```json
{
  "title": "Erro inesperado.",
  "status": 400
}
```

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

### DRIVER_CREATED Webhook

Source: https://docs.gohusky.net/api-reference/webhooks/webhook

This webhook is triggered when a new driver is created. It includes details about the event, context, and the driver resource.

```APIDOC
## DRIVER_CREATED Webhook

### Description
This webhook is triggered when a new driver is created. It includes details about the event, context, and the driver resource.

### Method
POST

### Endpoint
/websites/gohusky_net/webhooks

### Parameters
#### Request Body
- **event** (string) - Required - The type of event.
- **event_id** (string) - Required - A unique identifier for the event.
- **date** (string) - Required - The date and time of the event.
- **event_context** (string) - Required - A token representing the operation.
- **resource** (object) - Required - Contains information about the created driver.
  - **driver** (*ref: '#/components/schemas/DriverObject'*) - Required - Details of the driver.

### Request Example
```json
{
  "event": "DRIVER_CREATED",
  "event_id": "<string>",
  "date": "2020-06-26 22:24:30",
  "event_context": "1234567890",
  "resource": {
    "driver": {}
  }
}
```

### Response
#### Success Response (200)
(No specific response body documented for success.)
```

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

### FLEET_QUEUE Webhook

Source: https://docs.gohusky.net/api-reference/webhooks/webhook

This webhook provides information about the fleet's queue, including order counts and tracking codes.

```APIDOC
## FLEET_QUEUE Webhook

### Description
This webhook provides information about the fleet's queue, including order counts and tracking codes.

### Method
POST

### Endpoint
/websites/gohusky_net/webhooks

### Parameters
#### Request Body
- **event** (string) - Required - The type of event.
- **event_id** (string) - Required - A unique identifier for the event.
- **date** (string) - Required - The date and time of the event.
- **resource** (object) - Required - Contains details about the fleet queue.
  - **status** (string) - Required - The status of the fleet queue.
  - **fleet_id** (integer) - Required - The ID of the fleet.
  - **fleet_name** (string) - Required - The name of the fleet.
  - **orders_count** (integer) - Required - The number of orders in the fleet's queue.
  - **tracking_codes** (array) - Required - A list of tracking codes for orders in the queue.
    - (string) - Description: Identifications of the orders in the fleet's queue.

### Request Example
```json
{
  "event": "FLEET_QUEUE",
  "event_id": "<string>",
  "date": "2020-06-26 22:24:30",
  "resource": {
    "status": "left",
    "fleet_id": 1209,
    "fleet_name": "Embarcador Teste",
    "orders_count": 10,
    "tracking_codes": [
      "051aa70b607f97beeba3f5f9ee2a6b984a9f1489c3a74d6083afc59e1685cb2a",
      "051aa70b607f97beeba3f5f9ee2a6b984a9f1489c3a74d6083afc59e1685cb2b"
    ]
  }
}
```

### Response
#### Success Response (200)
(No specific response body documented for success.)
```

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

### DRIVER_UPDATED Webhook

Source: https://docs.gohusky.net/api-reference/webhooks/webhook

This webhook is triggered when a driver's information is updated. It includes details about the event, context, and the driver resource.

```APIDOC
## DRIVER_UPDATED Webhook

### Description
This webhook is triggered when a driver's information is updated. It includes details about the event, context, and the driver resource.

### Method
POST

### Endpoint
/websites/gohusky_net/webhooks

### Parameters
#### Request Body
- **event** (string) - Required - The type of event.
- **event_id** (string) - Required - A unique identifier for the event.
- **date** (string) - Required - The date and time of the event.
- **event_context** (string) - Required - A token representing the operation.
- **resource** (object) - Required - Contains information about the updated driver.
  - **driver** (*ref: '#/components/schemas/DriverObject'*) - Required - Details of the driver.

### Request Example
```json
{
  "event": "DRIVER_UPDATED",
  "event_id": "<string>",
  "date": "2020-06-26 22:24:30",
  "event_context": "1234567890",
  "resource": {
    "driver": {}
  }
}
```

### Response
#### Success Response (200)
(No specific response body documented for success.)
```

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

### Check Availability Response Schema (JSON)

Source: https://docs.gohusky.net/api-open-delivery/cotacao-de-entrega/availability

Defines the structure for a successful response when checking delivery availability. Includes delivery price details and information about available vehicles, such as their types and container compatibility.

```json
{
  "type": "object",
  "properties": {
    "deliveryPrice": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PriceData"
        }
      ]
    },
    "vehicles": {
      "allOf": [
        {
          "type": "object",
          "required": [
            "availableVehicles",
            "vehiclesAvailable"
          ],
          "properties": {
            "availableVehicles": {
              "type": "integer",
              "description": "Quantidade total de veículos disponíveis",
              "minimum": 0,
              "example": 15
            },
            "vehiclesAvailable": {
              "type": "object",
              "required": [
                "type",
                "container"
              ],
              "properties": {
                "type": {
                  "type": "array",
                  "description": "Tipos de veículos disponíveis",
                  "items": {
                    "type": "string",
                    "enum": [
                      "MOTORBIKE_BAG",
                      "MOTORBIKE_BOX",
                      "CAR",
                      "BICYCLE",
                      "SCOOTER",
                      "VUC"
                    ]
                  },
                  "example": [
                    "MOTORBIKE_BAG",
                    "CAR"
                  ]
                },
                "container": {
                  "type": "string",
                  "enum": [
                    "NORMAL",
                    "THERMIC"
                  ],
                  "description": "Tipo de container disponível",
                  "example": "NORMAL"
                }
              }
            }
          }
        }
      ]
    }
  ],
  "refIdentifier": "#/components/schemas/CheckAvailabilityResponse",
  "requiredProperties": [
    "deliveryPrice",
    "vehicles"
  ]
}
```

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

### DRIVER_STATUS_UPDATED Webhook

Source: https://docs.gohusky.net/api-reference/webhooks/webhook

This webhook is triggered when a driver's status is updated. It includes details about the event, resource, and context.

```APIDOC
## DRIVER_STATUS_UPDATED Webhook

### Description
This webhook is triggered when a driver's status is updated. It includes details about the event, resource, and context.

### Method
POST

### Endpoint
/websites/gohusky_net/webhooks

### Parameters
#### Request Body
- **event** (string) - Required - The type of event.
- **event_id** (string) - Required - A unique identifier for the event.
- **date** (string) - Required - The date and time of the event.
- **resource** (object) - Required - Contains information about the updated driver status.
  - **new_status** (string) - Required - The new status of the driver.
- **event_context** (string) - Required - A token representing the operation.

### Request Example
```json
{
  "event": "DRIVER_STATUS_UPDATED",
  "event_id": "<string>",
  "date": "2020-06-26 22:24:30",
  "resource": {
    "new_status": "INACTIVE"
  },
  "event_context": "1234567890"
}
```

### Response
#### Success Response (200)
(No specific response body documented for success.)
```

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

### Address Data Schema (JSON)

Source: https://docs.gohusky.net/api-open-delivery/cotacao-de-entrega/availability

Defines the structure for address data. Requires country, state, city, district, street, and number. Specifies the country format as ISO 3166-1.

```json
{
  "type": "object",
  "required": [
    "country",
    "state",
    "city",
    "district",
    "street",
    "number"
  ],
  "properties": {
    "country": {
      "type": "string",
      "description": "País (sigla). Padrão ISO 3166-1."
    },
    "state": {
      "type": "string",
      "description": "Estado."
    },
    "city": {
      "type": "string",
      "description": "Cidade."
    },
    "district": {
      "type": "string",
      "description": "Bairro."
    },
    "street": {
      "type": "string",
      "description": "Rua."
    },
    "number": {
      "type": "string",
      "description": "Número."
    },
    "complement": {
      "type": "string",
      "description": "Complemento.",
      "nullable": true
    },
    "postalCode": {
      "type": "string",
      "description": "CEP."
    }
  }
}
```

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

### Error Response Schema (JSON)

Source: https://docs.gohusky.net/api-open-delivery/cotacao-de-entrega/availability

Defines the structure for error responses. Includes a descriptive error title and the HTTP status code.

```json
{
  "type": "object",
  "properties": {
    "title": {
      "allOf": [
        {
          "type": "string",
          "description": "Mensagem de erro descritiva",
          "example": "Não autorizado"
        }
      ]
    },
    "status": {
      "allOf": [
        {
          "type": "integer",
          "description": "Código de status HTTP",
          "example": 401
        }
      ]
    }
  ],
  "refIdentifier": "#/components/schemas/ErrorResponse",
  "requiredProperties": [
    "title",
    "status"
  ]
}
```

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

### CLIENT_STATUS_UPDATED Webhook

Source: https://docs.gohusky.net/api-reference/webhooks/webhook

This webhook is triggered when a client's status is updated. It includes details about the event and the resource.

```APIDOC
## CLIENT_STATUS_UPDATED Webhook

### Description
This webhook is triggered when a client's status is updated. It includes details about the event and the resource.

### Method
POST

### Endpoint
/websites/gohusky_net/webhooks

### Parameters
#### Request Body
- **event** (string) - Required - The type of event.
- **event_id** (string) - Required - A unique identifier for the event.
- **date** (string) - Required - The date and time of the event.
- **resource** (object) - Required - Contains information about the updated resource.
  - **new_status** (string) - Required - The new status of the client.
- **event_context** (object) - Required - Additional context for the event.

### Request Example
```json
{
  "event": "CLIENT_STATUS_UPDATED",
  "event_id": "<string>",
  "date": "2020-06-26 22:24:30",
  "resource": {
    "new_status": "INACTIVE"
  },
  "event_context": {}
}
```

### Response
#### Success Response (200)
(No specific response body documented for success.)
```

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

### Check Delivery Availability

Source: https://docs.gohusky.net/api-open-delivery/cotacao-de-entrega/availability

This endpoint checks the availability of delivery vehicles and calculates the estimated delivery price based on the provided order details.

```APIDOC
## POST /websites/gohusky_net/check-availability

### Description
Checks the availability of delivery vehicles and calculates the estimated delivery price based on the provided order details. It returns the delivery price and information about available vehicles.

### Method
POST

### Endpoint
/websites/gohusky_net/check-availability

### Parameters
#### Request Body
- **latitude** (number) - Required - Latitude of the delivery location.
- **longitude** (number) - Required - Longitude of the delivery location.
- **vehicle** (object) - Required - Details about the vehicle.
  - **type** (array of strings) - Required - Type of vehicle required (e.g., MOTORBIKE_BAG, CAR).
  - **container** (string) - Required - Type of container required (e.g., NORMAL, THERMIC).
- **limitTimes** (object) - Optional - Time limits for pickup and delivery.
  - **pickupLimit** (integer) - Optional - Maximum pickup time in minutes.
  - **deliveryLimit** (integer) - Optional - Maximum delivery time in minutes.
  - **orderCreatedAt** (string) - Optional - The creation timestamp of the order.
- **totalOrderPrice** (object) - Required - The total price of the order.
  - **value** (number) - Required - The monetary value.
  - **currency** (string) - Required - The currency of the value (e.g., BRL).
- **orderDeliveryFee** (object) - Required - The delivery fee for the order.
  - **value** (number) - Required - The monetary value.
  - **currency** (string) - Required - The currency of the value (e.g., BRL).
- **totalWeight** (integer) - Required - The total weight of the package in grams.
- **packageVolume** (integer) - Required - The volume of the package in cubic centimeters.
- **packageQuantity** (integer) - Required - The number of packages.
- **specialInstructions** (string) - Optional - Any special instructions for the delivery.
- **additionalPricePercentual** (number) - Optional - Additional price as a percentage.
- **onlinePayment** (boolean) - Optional - Indicates if the payment is made online.

### Request Example
```json
{
  "latitude": -23.5675,
  "longitude": -46.6925,
  "vehicle": {
    "type": ["MOTORBIKE_BAG"],
    "container": "NORMAL"
  },
  "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
}
```

### Response
#### Success Response (200)
- **deliveryPrice** (object) - The calculated delivery price.
  - **value** (number) - The monetary value.
  - **currency** (string) - The currency of the value.
- **vehicles** (object) - Information about available vehicles.
  - **availableVehicles** (integer) - Total number of available vehicles.
  - **vehiclesAvailable** (object) - Details of vehicles available for the request.
    - **type** (array of strings) - Types of vehicles available.
    - **container** (string) - Type of container available.

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

#### Error Response (400)
- **title** (string) - A descriptive error message.
- **status** (integer) - The HTTP status code.

#### Error Response Example
```json
{
  "title": "Requisição inválida",
  "status": 400
}
```

#### Error Response (401)
- **title** (string) - A descriptive error message.
- **status** (integer) - The HTTP status code.

#### Error Response Example
```json
{
  "title": "Não autorizado",
  "status": 401
}
```
```
Tokens:
Raw