Furgonetka.pl API REST

https://furgonetka.pl/api/rest
Admin
Furgonetka.pl API REST provides programmatic access to Furgonetka's logistics and shipping services,...
Tokens:103,312
Snippets:530
Trust Score:9.8
Update:2 months ago
Show doc for...
Tokens:
Raw
### Retrieve Advanced Account Settings

Source: https://furgonetka.pl/api/rest

Example JSON response structure for the GET request to fetch current advanced account settings.

```json
{
  "pickup_address": true,
  "csv_export": true,
  "self_pickup": true,
  "user_reference_number": true,
  "page_format": "A4",
  "file_format": "pdf",
  "api_hash": "string",
  "macos_url": "string",
  "macos_arm64_url": "string",
  "windows_url": "string",
  "settings": {
    "pickup_address": true,
    "csv_export": true,
    "user_reference_number": true,
    "self_pickup": true,
    "description_field": true,
    "payer_cost_center": true
},
  "add_cutting_line": false

}
```

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

### GET /packages

Source: https://furgonetka.pl/api/rest/gielda

Retrieves a list of auctions.

```APIDOC
## GET /packages

### Description
Retrieves a list of auctions by passing the `list_type=auction` query parameter.

### Method
GET

### Endpoint
/packages

### Parameters
#### Query Parameters
- **list_type** (string) - Required - Set to 'auction' to filter for auction listings.
```

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

### Retrieve General Notification Settings Response

Source: https://furgonetka.pl/api/rest

Example JSON response structure for the GET /account/settings/notification/general endpoint.

```json
{
  "settings": [
    {
      "key": "string",
      "name": "string",
      "description": "string",
      "enabled": true
    }
  ]
}
```

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

### Retrieve planned pricelist changes response

Source: https://furgonetka.pl/api/rest

Example JSON response for the GET /account/planned-pricelist-changes endpoint.

```json
{
  "pricelist_changes": [
    {
      "date": "2023-05-25",
      "service": "dpd",
      "url": "https://furgonetka.pl/cennik/planowane-zmiany/1234/dpd/2023-05-25"
    }
  ]
}
```

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

### GET /create-package-command/{uuid}

Source: https://furgonetka.pl/api/rest

Checks the status of a package creation request.

```APIDOC
## GET /create-package-command/{uuid}

### Description
Checks the status of adding a package to the cart.

### Method
GET

### Endpoint
https://api.furgonetka.pl/create-package-command/{uuid}

### Parameters
#### Path Parameters
- **uuid** (string) - Required - Identyfikator operacji ustalany przez klienta.

### Response
#### Success Response (200)
- **status** (string) - Current status of the operation.
- **datetime_change** (string) - Timestamp of the last status change.
- **package_id** (integer) - The ID of the created package.
- **redirect_url** (string) - URL for redirection.

#### Response Example
{
  "status": "queueing",
  "datetime_change": "2020-08-25T13:15:01+02:00",
  "package_id": 12345,
  "redirect_url": "https://furgonetka.pl/potwierdzenie/logowania/{hash}"
}
```

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

### GET /pickup-commands/{uuid}

Source: https://furgonetka.pl/api/rest/packages-instruction

Sprawdza status zlecenia podjazdu kuriera.

```APIDOC
## GET /pickup-commands/{uuid}

### Description
Sprawdza aktualny status zlecenia podjazdu kuriera.

### Method
GET

### Endpoint
/pickup-commands/{uuid}

### Parameters
#### Path Parameters
- **uuid** (string) - Required - Identyfikator zlecenia.

### Response
#### Success Response (200)
- **status** (string) - Status postępu zlecenia.
- **pickup_details** (array) - Szczegóły utworzonych zleceń podjazdu (zawiera `pickup_id` oraz `package_ids`).
```

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

### GET /packages/file/import

Source: https://furgonetka.pl/api/rest

Returns a summary of the shipment import from a file.

```APIDOC
## GET /packages/file/import

### Description
Returns a summary of the shipment import from a file.

### Method
GET

### Endpoint
https://api.furgonetka.pl/packages/file/import

### Response
#### Success Response (200)
- OK

#### Error Responses
- 400: Bad Request
- 401: Unauthorized
- 403: Forbidden
```

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

### Retrieve InPost pickup points response structure

Source: https://furgonetka.pl/api/rest

Example JSON response for the GET /account/services-agreements/inpost/{agreement_id}/dispatch-points endpoint.

```json
{
  "dispatchPoints": [
    {
      "id": "123",
      "name": "Punkt 123",
      "phone": "123456789",
      "email": "sample@mail.com",
      "street": "Owocowa 1/2",
      "postcode": "82-100",
      "city": "Nowy Dwór Gdański",
      "status": "TO_VERIFY"
    }
  ]
}
```

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

### GET /pickup-commands/{uuid}

Source: https://furgonetka.pl/api/rest

Checks the status of a courier pickup request.

```APIDOC
## GET /pickup-commands/{uuid}

### Description
Metoda służy do sprawdzania statusu zamawiania podjazdu kuriera po przesyłkę.

### Method
GET

### Endpoint
https://api.furgonetka.pl/pickup-commands/{uuid}

### Parameters
#### Path Parameters
- **uuid** (string) - Required - Identyfikator operacji ustalany przez klienta.

### Response
#### Success Response (200)
- **details** (object) - Pickup status details including package counts and status information.

#### Error Response (400)
- **errors** (array) - List of validation errors.
```

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

### GET /packages

Source: https://furgonetka.pl/api/rest/packages-instruction

Retrieves a list of shipments with optional filtering and pagination.

```APIDOC
## GET /packages

### Description
Retrieves a list of shipments. Supports filtering by type, pagination, and search queries.

### Method
GET

### Endpoint
/packages

### Parameters
#### Query Parameters
- **list_type** (string) - Optional - Filter by status (e.g., 'waiting', 'sent', 'all', 'tracking')
- **limit** (integer) - Optional - Number of results to return
- **last_package_id** (string) - Optional - ID for pagination
- **query** (string) - Optional - Search query
- **filters** (object) - Optional - Detailed search filters
```

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

### GET /account/settings/advanced

Source: https://furgonetka.pl/api/rest

Retrieves information about the advanced settings of the user account.

```APIDOC
## GET /account/settings/advanced

### Description
Retrieves information about the advanced settings of the user account.

### Method
GET

### Endpoint
https://api.furgonetka.pl/account/settings/advanced

### Response
#### Success Response (200)
- **pickup_address** (boolean) - Indicates if custom pickup address is enabled.
- **csv_export** (boolean) - Indicates if CSV export is enabled.
- **self_pickup** (boolean) - Indicates if self-pickup is enabled.
- **user_reference_number** (boolean) - Indicates if custom reference number is enabled.
- **page_format** (string) - The configured page format.
- **file_format** (string) - The configured file format.
- **api_hash** (string) - API hash string.
- **macos_url** (string) - URL for macOS application.
- **macos_arm64_url** (string) - URL for macOS ARM64 application.
- **windows_url** (string) - URL for Windows application.
- **settings** (object) - Nested settings object.
- **add_cutting_line** (boolean) - Indicates if cutting line is added.
```

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

### GET /documents-command/{uuid}

Source: https://furgonetka.pl/api/rest/packages-instruction

Checks the status of a bulk document preparation request.

```APIDOC
## GET /documents-command/{uuid}

### Description
Checks the status of a bulk document preparation request. When the status is successful or partial_success, a download URL is provided.

### Method
GET

### Endpoint
/documents-command/{uuid}

### Response
#### Success Response (200)
- **status** (string) - Current status of the request.
- **url** (string) - Direct link to download the generated file (zip, pdf, zpl, or epl).
```

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

### GET /services_prices

Source: https://furgonetka.pl/api/rest

Retrieves a list of available courier services and their pricing details.

```APIDOC
## GET /services_prices

### Description
Retrieves a list of available courier services, including pricing, courier details, and additional fees.

### Method
GET

### Endpoint
/services_prices

### Response
#### Success Response (200)
- **services_prices** (array) - List of service pricing objects

#### Response Example
{
  "services_prices": [
    {
      "service_id": 0,
      "service": "dpd",
      "agreement_owner": "furgonetka",
      "available": true,
      "courier_details": {
        "amount_free_insurance": 500,
        "return_cod_days": 7,
        "cod_express": true,
        "avg_delivery_time": 2880
      },
      "lowest_price": {
        "price_gross": 20.76
      },
      "pricing": {
        "price_gross": 20.76,
        "price_net": 16.88,
        "tax": 23
      }
    }
  ]
}
```

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

### PHP Implementation Example

Source: https://furgonetka.pl/api/rest/packages-instruction

A simplified PHP implementation demonstrating the full workflow from authentication to pickup booking.

```php
<?php

declare(strict_types=1);

const API_URL = 'https://api.furgonetka.pl';
const CLIENT_ID = '{client_id}';
const CLIENT_SECRET = '{client_secret}';
const USERNAME = '{username}';
const PASSWORD = '{password}';
const CARRIER = 'dpd';

function formatApiErrors(?array $responseBody): string
{
    if (!empty($responseBody['errors'])) {
        $messages = [];
```

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

### Package Lifecycle Implementation in PHP

Source: https://furgonetka.pl/api/rest/packages-instruction

Demonstrates the full sequence of validating package data, creating a shipment, ordering it, and scheduling a courier pickup.

```php
$packageData = [
    'pickup' => [
        'name' => 'Jan Kowalski',
        'company' => 'Kowalski Sp. z o.o.',
        'email' => 'jan.kowalski@example.pl',
        'phone' => '500600700',
        'street' => 'Marszałkowska 100',
        'city' => 'Warszawa',
        'country_code' => 'PL',
        'postcode' => '00-026',
        'county' => '',
    ],
    'receiver' => [
        'name' => 'Anna Nowak',
        'company' => 'Nowak S.A.',
        'phone' => '600700800',
        'street' => 'Floriańska 15',
        'city' => 'Kraków',
        'country_code' => 'PL',
        'postcode' => '31-021',
        'county' => '',
    ],
    'service_id' => $carrierServiceId,
    'parcels' => [
        [
            'height' => 20,
            'width' => 30,
            'depth' => 40,
            'weight' => 5,
            'quantity' => 1,
            'type' => 'package',
        ],
    ],
];

apiRequest('POST', '/packages/validate', $packageData, 'v2');

echo "Dane przesyłki są poprawne.\n";

// 3. Dodanie przesyłki (tym samym payloadem, który został zweryfikowany w kroku 2).
echo "3. Dodawanie przesyłki...\n";

$package = apiRequest('POST', '/packages', $packageData, 'v2');

$packageId = $package['body']['package_id'];

echo 'Przesyłka dodana, package_id: ' . $packageId . "\n";

// 4. Zamówienie przesyłki.
echo "4. Zamawianie przesyłki...\n";

$orderUuid = generateUuid();
apiRequest('PUT', '/order-commands/' . $orderUuid, [
    'packages' => [
        ['id' => $packageId],
    ],
]);

$orderResult = waitUntilCommandFinished('/order-commands/' . $orderUuid);

if ($orderResult['body']['status'] !== 'successful') {
    throw new RuntimeException('Nie udało się zamówić przesyłki: ' . formatApiErrors($orderResult['body']));
}

echo "Przesyłka zamówiona.\n";

// 5. Sprawdzenie aktualnych szczegółów przesyłki (np. stanu "ordered").
echo "5. Sprawdzanie szczegółów przesyłki...\n";

$packageDetails = apiRequest('GET', '/packages/' . $packageId);

echo 'Stan przesyłki po zamówieniu: ' . $packageDetails['body']['state'] . "\n";

// 6. Pobranie dostępnych terminów podjazdu.
echo "6. Pobieranie dostępnych terminów podjazdu...\n";

$proposals = apiRequest('POST', '/packages/pickup-date-proposals', [
    'packages' => [
        ['id' => $packageId],
    ],
]);

$firstAvailableProposal = null;

foreach ($proposals['body']['packages'][0]['proposals'] ?? [] as $proposal) {
    if ($proposal['available'] === true) {
        $firstAvailableProposal = $proposal;
        break;
    }
}

if ($firstAvailableProposal === null) {
    throw new RuntimeException('Brak dostępnych terminów podjazdu.');
}

echo 'Wybrany termin podjazdu: ' . $firstAvailableProposal['date']
    . ' ' . $firstAvailableProposal['min_time'] . '-' . $firstAvailableProposal['max_time'] . "\n";

// 7. Zamówienie podjazdu na wybrany termin.
echo "7. Zamawianie podjazdu...\n";

$pickupUuid = generateUuid();
apiRequest('PUT', '/pickup-commands/' . $pickupUuid, [
    'packages' => [
        ['id' => $packageId],
    ],
    'pickup_date' => [
        'date' => $firstAvailableProposal['date'],
        'min_time' => $firstAvailableProposal['min_time'],
        'max_time' => $firstAvailableProposal['max_time'],
    ],
]);

$pickupResult = waitUntilCommandFinished('/pickup-commands/' . $pickupUuid);

if ($pickupResult['body']['status'] !== 'successful') {
    throw new RuntimeException('Nie udało się zamówić podjazdu: ' . formatApiErrors($pickupResult['body']));
}

echo "Podjazd zamówiony.\n";
echo "Przesyłka zamówiona, podjazd potwierdzony.\n";
```

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

### Get Package Details Response Sample

Source: https://furgonetka.pl/api/rest

Detailed JSON response structure for retrieving package information.

```json
{
  "package_id": "12345",
  "group_id": "123456",
  "pickup": {
    "name": "string",
    "company": "string",
    "street": "string",
    "postcode": "string",
    "city": "string",
    "country_code": "string",
    "county": "string",
    "email": "string",
    "phone": "string",
    "point": "string",
    "point_label": "string",
    "point_data": {
      "point_id": "string",
      "code": "003186",
      "name": "UP Częstochowa 1",
      "original_name": "Częstochowa 1",
      "active": true,
      "opening_hours": {
        "monday": {
          "start_hour": "08:00",
          "end_hour": "16:00"
        },
        "tuesday": {
          "start_hour": "08:00",
          "end_hour": "16:00"
        },
        "wednesday": {
          "start_hour": "08:00",
          "end_hour": "16:00"
        },
        "thursday": {
          "start_hour": "08:00",
          "end_hour": "16:00"
        },
        "friday": {
          "start_hour": "08:00",
          "end_hour": "16:00"
        },
        "saturday": {
          "start_hour": "08:00",
          "end_hour": "16:00"
        },
        "sunday": {
          "start_hour": "08:00",
          "end_hour": "16:00"
        }
      },
      "max_supported_weight": 31.5,
      "cod": true,
      "type": "Punkt sieciowy",
      "service": "inpost",
      "is_send_point": true,
      "is_delivery_point": true,
      "description": "Przystanek komunikacji miejskiej",
      "coordinates": {
        "latitude": 52.229872,
        "longitude": 21.011789
      },
      "distance": 0.1,
      "address": {
        "postcode": "82-300",
        "street": "Elbląska 123/4",
        "city": "Elbląg",
        "country_code": "PL",
        "province": "warmińsko-mazurskie",
        "house_number": "123"
      },
      "phone": "string",
      "photos": [
        null
      ],
      "point_type_str": "string",
      "email": "string",
      "boxes_specification": [
        {
          "gauge": "A",
          "width": "20",
          "height": "20",
          "depth": "20"
        }
      ],
      "holiday": true,
      "service_type": "service_point",
      "holiday_period": {
        "start_date": "2022-08-18",
        "end_date": "2022-08-22"
      },
      "furgonetka_point": true,
      "facebook_url": "string",
      "google_url": "string",
      "digital_label": true,
      "food": true,
      "is_poczta_points_partner": true,
      "label": "string",
      "original_point_id": "string"
    }
  },
  "sender": {
    "name": "string",
    "company": "string",
    "street": "string",
    "postcode": "string",
    "city": "string",
    "country_code": "string",
    "county": "string",
    "email": "string",
    "phone": "string",
    "point_data": {
      "point_id": "string",
      "code": "003186",
      "name": "UP Częstochowa 1"
    }
  }
}
```

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

### GET /packages

Source: https://furgonetka.pl/api/rest

Pobiera listę przesyłek użytkownika na podstawie opcjonalnych parametrów filtrowania.

```APIDOC
## GET /packages

### Description
Metoda służy do pobierania listy przesyłek użytkownika.

### Method
GET

### Endpoint
https://api.furgonetka.pl/packages

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - Limit liczby zwracanych przesyłek.
- **last_package_id** (integer) - Optional - ID ostatniej przesyłki dla stronicowania.
- **list_type** (string) - Optional - Typ listy: "sent", "ordered", "waiting", "all", "storage", "tracking", "auction".
- **query** (string) - Optional - Wyszukiwanie po numerze przesyłki.
- **filters** (object) - Optional - Struktura filtrów pobieranej listy przesyłek.

### Response
#### Success Response (200)
- **packages** (array) - Lista obiektów przesyłek.

#### Response Example
{
  "packages": [
    {
      "package_id": "12345",
      "group_id": "123456"
    }
  ]
}
```

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

### PUT /account/register/{partner}/{uuid}

Source: https://furgonetka.pl/api/rest

Creates a new partner account.

```APIDOC
## PUT /account/register/{partner}/{uuid}

### Description
Metoda służy do tworzenia kont partnera.

### Method
PUT

### Endpoint
https://api.furgonetka.pl/account/register/{partner}/{uuid}

### Parameters
#### Path Parameters
- **partner** (string) - Required - Nazwa partnera
- **uuid** (string) - Required - Identyfikator operacji ustalany przez klienta

#### Request Body
- **email** (string) - Required - Adres email konta
- **identifier** (string) - Required - Identyfikator konta po stronie partnera

### Request Example
{
  "email": "jan.testowy@partner.pl",
  "identifier": "123abc78de"
}

### Response
#### Success Response (200)
- **uuid** (string) - Identyfikator operacji

#### Response Example
{
  "uuid": "string"
}
```

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

### GET /account/notifications

Source: https://furgonetka.pl/api/rest

Retrieves a list of notifications for the user.

```APIDOC
## GET /account/notifications

### Description
This method is used to retrieve the list of notifications.

### Method
GET

### Endpoint
https://api.furgonetka.pl/account/notifications

### Response
#### Success Response (200)
- **notifications** (array) - List of notification objects.

#### Response Example
{
  "notifications": [
    {
      "type": "notification",
      "message": "string",
      "url": "/konto/wiadomosci",
      "urlText": "Przejdź do wiadomości"
    }
  ]
}
```

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

### Process Package Return Response

Source: https://furgonetka.pl/api/rest

Successful response providing the operation UUID, payment URL, and summary URL.

```json
{
  * "uuid": "string",
  * "paymentUrl": "string",
  * "summaryUrl": "string"

}
```

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

### GET /pudo/inventory/point/contracts

Source: https://furgonetka.pl/api/rest

Retrieves a list of contracts associated with the point.

```APIDOC
## GET /pudo/inventory/point/contracts

### Description
Retrieves a list of contracts, including signed, available, and pending contracts.

### Method
GET

### Endpoint
/pudo/inventory/point/contracts

### Response
#### Success Response (200)
- **contracts** (array) - List of contracts.
- **signedContracts** (array) - List of signed contracts.
- **signedOwnContracts** (array) - List of signed own contracts.
- **availableContracts** (array) - List of available contracts.
- **availableSoon** (array) - List of contracts available soon.
- **inventoryLabels** (object) - Inventory labels configuration.
- **hasTermination** (boolean) - Termination status.
- **shortNames** (object) - Mapping of courier short names.
- **pendingContracts** (array) - List of pending contracts.

#### Response Example
{
  "contracts": [],
  "signedContracts": [],
  "signedOwnContracts": [],
  "availableContracts": [],
  "availableSoon": [],
  "inventoryLabels": {},
  "hasTermination": true,
  "shortNames": {},
  "pendingContracts": []
}
```

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

### PUT /pickup-commands/{uuid}

Source: https://furgonetka.pl/api/rest/packages-instruction

Zamawia podjazd kuriera w wybranym terminie dla listy przesyłek.

```APIDOC
## PUT /pickup-commands/{uuid}

### Description
Składa zamówienie na podjazd kuriera dla wybranych przesyłek w określonym terminie.

### Method
PUT

### Endpoint
/pickup-commands/{uuid}

### Parameters
#### Path Parameters
- **uuid** (string) - Required - Identyfikator zlecenia.

### Request Body
- **packages** (array) - Required - Lista przesyłek objętych podjazdem.
- **pickup_date** (object) - Required - Struktura zawierająca pola `date`, `min_time` oraz `max_time`.
```

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

### GET /account/settings/notification/webhook/logs

Source: https://furgonetka.pl/api/rest

Retrieves a list of webhook call logs.

```APIDOC
## GET /account/settings/notification/webhook/logs

### Description
Retrieves a list of logs for webhook calls.

### Method
GET

### Endpoint
https://api.furgonetka.pl/account/settings/notification/webhook/logs

### Parameters
#### Query Parameters
- **lastId** (integer) - Optional - ID of the last log, used for pagination.
- **lastDatetimeSend** (string) - Optional - Date of the last log (ISO 8601), used for pagination.

### Response
#### Success Response (200)
- **logs** (array) - List of webhook logs.
- **lastSuccess** (string) - Timestamp of the last successful call.
- **isNextPage** (boolean) - Indicates if there are more pages available.

#### Response Example
{
  "logs": [
    {
      "id": 0,
      "datetimeSend": "2022-08-25T08:10:00+02:00",
      "packageNo": "string",
      "httpCode": 0,
      "trackingState": "string",
      "trackingStateName": "string",
      "timeout": 0.1,
      "webhookResponse": "string"
    }
  ],
  "lastSuccess": "2022-08-25T08:10:00+02:00",
  "isNextPage": true
}
```

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

### Create a draft package

Source: https://furgonetka.pl/api/rest/gielda

Sends a POST request to create a new package draft. Requires a valid Bearer token and specific JSON payload structure.

```bash
curl -X "POST" "https://api.furgonetka.pl/packages" \
     -H "Authorization: Bearer {token}" \
     -H "Content-Type: application/vnd.furgonetka.v2+json" \
     -d '{
  "receiver": {
    "street": "Agrykola 2",
    "city": "Elbląg",
    "country_code": "PL",
    "postcode": "82-300",
    "county": ""
  },
  "pickup": {
    "street": "Elbląska 20",
    "city": "Braniewo",
    "country_code": "PL",
    "postcode": "14-500",
    "county": ""
  },
  "service_id": "{service_id}",
  "additional_services": {},
  "parcels": [
    {
      "height": 90,
      "width": 170,
      "depth": 80,
      "weight": 60,
      "description": "Sofa 2-osobowa",
      "quantity": 1,
      "type": "furniture"
    }
  ],
  "photos": [
    "a7dc4cd9-39cf-42c8-ac4a-5400206add4f"
  ],
  "user_reference_number": "",
  "auction": {
    "title": "sofa",
    "description": "Sofa 2-osobowa, wymagany transport z windą towarową",
    "ready_from": "2026-07-03",
    "due_date": "2026-07-06",
    "budget": {
      "price": 300,
      "currency": "PLN"
    },
    "total_weight": 60
  }
}'
```

```json
{
  "id": "90014858038",
  "auction": {
    "id": 12345,
    "title": "sofa",
    "description": "Sofa 2-osobowa, wymagany transport z windą towarową",
    "ready_from": "2026-07-03",
    "ready_to": null,
    "due_date": "2026-07-06",
    "budget": {
      "price": 300,
      "currency": "PLN"
    },
    "total_weight": 60,
    "unique_haulers": 0,
    "minimum_offer_price": null,
    "minimum_offer_currency": null,
    "accepted_offer_price": null,
    "accepted_offer_currency": null,
    "accepted_offer_date": null,
    "actions": {
      "extend_available": false,
      "delete_available": true,
      "edit_available": true,
      "post_auction_available": true,
      "post_again_available": false,
      "user_rate_available": false
    }
  }
}
```

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

### GET /account/members

Source: https://furgonetka.pl/api/rest

Retrieves a list of all users associated with the account.

```APIDOC
## GET /account/members

### Description
Returns information regarding the users associated with the account, including their status and ownership roles.

### Method
GET

### Endpoint
https://api.furgonetka.pl/account/members

### Response
#### Success Response (200)
- **owner** (boolean) - Indicates if the current user is the owner.
- **shouldCompleteAddress** (boolean) - Indicates if address completion is required.
- **members** (Array) - List of account members containing email, name, owner status, and invitation status.

#### Response Example
{
  "owner": true,
  "shouldCompleteAddress": true,
  "members": [
    {
      "email": "string",
      "name": "string",
      "owner": true,
      "status": "invited"
    }
  ]
}
```

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

### GET /account/printers

Source: https://furgonetka.pl/api/rest

Retrieves a list of printers associated with the user.

```APIDOC
## GET /account/printers

### Description
Retrieves a list of printers associated with the user.

### Method
GET

### Endpoint
https://api.furgonetka.pl/account/printers

### Response
#### Success Response (200)
- **printers** (array) - List of printer objects

#### Response Example
{
  "printers": [
    {
      "name": "string",
      "online": true,
      "pc_name": "string",
      "users_id": 0,
      "user_name": "string",
      "selected": true,
      "hash": "string"
    }
  ]
}
```

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

### POST /packages

Source: https://furgonetka.pl/api/rest/gielda

Creates a new package draft with auction details.

```APIDOC
## POST /packages

### Description
Creates a new package draft including pickup, receiver, and auction details.

### Method
POST

### Endpoint
https://api.furgonetka.pl/packages

### Request Body
- **receiver** (object) - Required - Receiver address details
- **pickup** (object) - Required - Pickup address details
- **service_id** (string) - Required - ID of the service
- **parcels** (array) - Required - List of parcels
- **auction** (object) - Required - Auction details including title, description, and budget

### Response
#### Success Response (200)
- **id** (string) - The created package ID
- **auction** (object) - Auction details and available actions
```

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

### GET /cancel-command/{uuid}

Source: https://furgonetka.pl/api/rest/packages-instruction

Checks the status of a cancellation command.

```APIDOC
## GET /cancel-command/{uuid}

### Description
Retrieves the status of a cancellation request.

### Method
GET

### Endpoint
/cancel-command/{uuid}

### Parameters
#### Path Parameters
- **uuid** (string) - Required - The unique identifier for the cancellation command.

### Response
#### Success Response (200)
- **cancel_command_details** (array) - List containing cancellation status for each package, including `package_id`, `cancel_success`, and `scheduled_cancel_date`.
```

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

### GET /packages/{package_id}

Source: https://furgonetka.pl/api/rest/packages-instruction

Retrieves the details of a specific shipment.

```APIDOC
## GET /packages/{package_id}

### Description
Fetches detailed information about a specific shipment.

### Method
GET

### Endpoint
/packages/{package_id}

### Parameters
#### Path Parameters
- **package_id** (string) - Required - The ID of the shipment

#### Query Parameters
- **original_services** (boolean) - Optional - Returns original shipment data before carrier adjustments
```

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

### GET /account/register/{partner}/{uuid}

Source: https://furgonetka.pl/api/rest

Checks the status of a partner account creation task.

```APIDOC
## GET /account/register/{partner}/{uuid}

### Description
Checks the status of a partner account creation task.

### Method
GET

### Endpoint
https://api.furgonetka.pl/account/register/{partner}/{uuid}

### Parameters
#### Path Parameters
- **partner** (string) - Required - Name of the partner
- **uuid** (string) - Required - Operation identifier set by the client

### Response
#### Success Response (200)
- **status** (string) - Current status of the task
- **datetime_change** (string) - Last change timestamp
- **errors** (array) - List of error objects if any
- **uuid** (string) - Operation identifier
- **email** (string) - Associated email
- **companyId** (string) - Associated company ID

#### Response Example
{
  "status": "queueing",
  "datetime_change": "2020-08-25T13:15:01+02:00",
  "errors": [],
  "uuid": null,
  "email": "string",
  "companyId": "string"
}
```

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

### GET /auctions/user-opinions/{company_id}

Source: https://furgonetka.pl/api/rest/gielda

Retrieves opinions for a specific company.

```APIDOC
## GET /auctions/user-opinions/{company_id}

### Description
Pobiera opinie o danej firmie.

### Method
GET

### Endpoint
/auctions/user-opinions/{company_id}

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - Ilość pobieranych rekordów
- **type** (string) - Optional - Typ komentarzy: 'order' lub 'transport'
- **last_id** (string) - Optional - Identyfikator ostatniej pobranej opinii
```

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

### PUT /box/point/packages/{uuid}

Source: https://furgonetka.pl/api/rest

Prepares a package for a warehouse point. Requires a bearer token for authorization.

```APIDOC
## PUT /box/point/packages/{uuid}

### Description
Prepares a package for a warehouse point.

### Method
PUT

### Endpoint
https://api.furgonetka.pl/box/point/packages/{uuid}

### Parameters
#### Path Parameters
- **uuid** (string) - Required - Identyfikator operacji ustalany przez klienta.

#### Request Body
- **package_no** (string) - Required - Numer paczki z etykiety.
- **relation** (string) - Required - Osoba, która aktualnie jest obsługiwana.
- **provider** (string) - Required - Dostawca paczki (przewoźnik, do którego należy przesyłka). Enum: "dhl", "dhlparcel", "fedex", "allegro", "gls", "orlen".
- **label_number** (string) - Optional - W przypadku nadania kodem Orlen, numer etykiety podawany jest przez pracownika magazynu.

### Request Example
{
  "package_no": "123456T001",
  "label_number": "123456T001",
  "relation": "client, courier",
  "provider": "dhl"
}

### Response
#### Success Response (200)
- **uuid** (string) - Identifier of the operation.

#### Response Example
{
  "uuid": "string"
}
```

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

### GET /auctions/{packages_id}

Source: https://furgonetka.pl/api/rest/gielda

Retrieves additional auction-specific information.

```APIDOC
## GET /auctions/{packages_id}

### Description
Retrieves additional information specific to the auction, such as route, distance, discussion list with carriers, reviews, and winning carrier data.

### Method
GET

### Endpoint
/auctions/{packages_id}
```

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

### PUT /packages/print-documents-using-application/{uuid}

Source: https://furgonetka.pl/api/rest

Prints documents for the specified packages using the application settings. The labels are returned in the format configured during the order process.

```APIDOC
## PUT /packages/print-documents-using-application/{uuid}

### Description
Prints documents for the specified packages using the application settings. The labels are returned in the format configured during the order process.

### Method
PUT

### Endpoint
https://api.furgonetka.pl/packages/print-documents-using-application/{uuid}

### Parameters
#### Path Parameters
- **uuid** (string) - Required - Identyfikator operacji ustalany przez klienta.

#### Request Body
- **packages_ids** (Array of int) - Required - Id paczek.
- **documents_type** (string) - Required - Typ dokumentu. Enum: "all", "labels", "protocol_others", "labels_and_pickup_confirmations", "pickup_confirmations".
- **documents_format** (string) - Required - Format dokumentu. Enum: "all", "zpl", "epl", "pdfa4", "pdfa6", "pdfdl".
- **printer** (string) - Required - Hash drukarki.
- **ignore_packages_without_documents** (boolean) - Required - Ignorowanie błędów gdy paczka nie ma dokumentów.

### Request Example
{
  "packages_ids": [1234, 56789, 9192934],
  "documents_format": "pdfa4",
  "documents_type": "all",
  "ignore_packages_without_documents": true,
  "printer": "nnmc40c22b8e7fbf144fqw5a88995zaq"
}

### Response
#### Success Response (200)
- **uuid** (string) - Operation identifier.

#### Response Example
{
  "uuid": "string"
}
```

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

### GET /packages/{package_id}

Source: https://furgonetka.pl/api/rest/gielda

Retrieves the details and status of an auction.

```APIDOC
## GET /packages/{package_id}

### Description
Retrieves the details of an auction, including the `auction` structure containing status and offer statistics.

### Method
GET

### Endpoint
/packages/{package_id}
```

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

### PUT /order-commands/{uuid}

Source: https://furgonetka.pl/api/rest/gielda

Publishes a listing by ordering the associated packages.

```APIDOC
## PUT /order-commands/{uuid}

### Description
Publishes an auction listing by processing the order command for a list of package identifiers.

### Method
PUT

### Endpoint
/order-commands/{uuid}

### Parameters
#### Path Parameters
- **uuid** (string) - Required - The unique identifier for the operation generated by the client.
```

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

### PUT /account/register-sso/wza/{uuid}

Source: https://furgonetka.pl/api/rest

Registers an account based on Allegro WzA OAuth SSO data.

```APIDOC
## PUT /account/register-sso/wza/{uuid}

### Description
Registers an account based on Allegro WzA OAuth SSO data.

### Method
PUT

### Endpoint
https://api.furgonetka.pl/account/register-sso/wza/{uuid}

### Parameters
#### Path Parameters
- **uuid** (string) - Required - Identyfikator operacji ustalany przez klienta.

#### Request Body
- **id** (integer) - Required - Identyfikator konta Allegro WzA
- **access_token** (string) - Required - Access Token JWT konta Allegro WzA
- **expires** (string) - Required - Data w formacie ISO8601 kiedy Access Token straci ważność
- **refresh_token** (string) - Required - Refresh Token JWT konta Allegro WzA

### Response
#### Success Response (200)
- **uuid** (string) - The operation identifier.
```

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

### GET /file-command

Source: https://furgonetka.pl/api/rest/gielda

Checks the status of a file upload operation.

```APIDOC
## GET /file-command

### Description
Checks the status of a previously initiated file upload.

### Method
GET

### Endpoint
/file-command

### Parameters
- **uuid[]** (array) - Required - List of operation UUIDs to check.

### Response
#### Success Response (200)
- **status** (string) - Status of the upload (e.g., 'successful').
- **file_uuid** (string) - Identifier to be used in the listing creation.
```

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

### GET /account/service/spx/{service_id}

Source: https://furgonetka.pl/api/rest

Retrieves information about an SPX service agreement.

```APIDOC
## GET /account/service/spx/{service_id}

### Description
Retrieves information about an SPX service agreement.

### Method
GET

### Endpoint
https://api.furgonetka.pl/account/service/spx/{service_id}

### Parameters
#### Path Parameters
- **service_id** (string) - Required - Identyfikator przewoźnika.

### Response
#### Success Response (200)
- **id** (integer) - Agreement ID
- **service** (string) - Service name
- **name** (string) - Agreement name
- **owner** (string) - Owner name
- **configuration** (object) - Service configuration details
- **credentials** (object) - SPX credentials
```

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

### PUT /pickup-commands/{uuid}

Source: https://furgonetka.pl/api/rest/packages-instruction

Schedules a pickup for packages using a specific command UUID.

```APIDOC
## PUT /pickup-commands/{uuid}

### Description
Schedules a pickup for the specified packages at a chosen date and time.

### Method
PUT

### Endpoint
https://api.furgonetka.pl/pickup-commands/{uuid}

### Request Body
- **packages** (array) - Required - List of packages.
- **pickup_date** (object) - Required - Contains 'date', 'min_time', and 'max_time'.
```

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

### GET /account/service/gls/{service_id}

Source: https://furgonetka.pl/api/rest

Retrieves information about a personal GLS contract.

```APIDOC
## GET /account/service/gls/{service_id}

### Description
Retrieves information about a personal contract with GLS.

### Method
GET

### Endpoint
https://api.furgonetka.pl/account/service/gls/{service_id}

### Parameters
#### Path Parameters
- **service_id** (string) - Required - Identyfikator przewoźnika.

### Response
#### Success Response (200)
- **id** (integer)
- **service** (string)
- **name** (string)
- **owner** (string)
- **configuration** (object)
- **credentials** (object)
```

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

### GET /account/service/fedex/{service_id}

Source: https://furgonetka.pl/api/rest

Retrieves information about a personal FedEx contract.

```APIDOC
## GET /account/service/fedex/{service_id}

### Description
Retrieves information about a personal contract with FedEx.

### Method
GET

### Endpoint
https://api.furgonetka.pl/account/service/fedex/{service_id}

### Parameters
#### Path Parameters
- **service_id** (string) - Required - Identyfikator przewoźnika.

### Response
#### Success Response (200)
- **id** (integer)
- **service** (string)
- **name** (string)
- **owner** (string)
- **configuration** (object)
- **credentials** (object)
- **credentials_international_rest** (object)
```

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

### POST /packages/calculate-price

Source: https://furgonetka.pl/api/rest

Oblicza cenę przesyłki na podstawie dostarczonych parametrów paczki i usług.

```APIDOC
## POST /packages/calculate-price

### Description
Metoda służy do obliczenia ceny przesyłki o podanych parametrach.

### Method
POST

### Endpoint
https://api.furgonetka.pl/packages/calculate-price

### Request Body
- **package** (object) - Required - Struktura zawierająca parametry przesyłki (PackageParamsV1).
- **services** (object) - Required - Struktura określa zakres przewoźników do wyceny (wymagany typ przewoźnika albo identyfikator przewoźnika).

### Response
#### Success Response (200)
- OK

#### Error Response (401)
- Unauthorized
```

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

### GET /zwrot-zakupow/{shopDomain}

Source: https://furgonetka.pl/api/rest

Redirects the user to the return form with pre-filled order and user data.

```APIDOC
## GET /zwrot-zakupow/{shopDomain}

### Description
Redirects the user to the return form with pre-filled data based on the provided shop domain and order details.

### Method
GET

### Endpoint
https://api.furgonetka.pl/zwrot-zakupow/{shopDomain}

### Parameters
#### Path Parameters
- **shopDomain** (string) - Required - The domain name of the shop (e.g., domena-sklepu.pl).

#### Query Parameters
- **userEmail** (string) - Optional - The user's email address.
- **orderNumber** (string) - Optional - The order number.
- **ref** (string) - Optional - The source identifier (reference).

### Response
#### Success Response (302)
- Redirects the user to the return form.
```

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

### GET /documents-command/{uuid}

Source: https://furgonetka.pl/api/rest

Checks the status of a document generation operation.

```APIDOC
## GET /documents-command/{uuid}

### Description
Checks the status of the document preparation process for shipments.

### Method
GET

### Endpoint
https://api.furgonetka.pl/documents-command/{uuid}

### Parameters
#### Path Parameters
- **uuid** (string) - Required - The operation identifier set by the client.

### Response
#### Success Response (200)
- **status** (string) - Current status of the operation.
- **datetime_change** (string) - Timestamp of the last status change.
- **errors** (array) - List of error objects if any occurred.
- **uuid** (string) - Operation identifier.
- **url** (string) - URL to download the documents.
```

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

### Update printing configuration request

Source: https://furgonetka.pl/api/rest

Example JSON payload for the PUT /account/settings/printing endpoint.

```json
{
  "page_format": "A4",
  "file_format": "pdf",
  "add_cutting_line": true
}
```
Tokens:
Raw