### User Permissions Management Request Sample

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

Example JSON payload for managing user permissions within a multi-account setup. It specifies the target user emails and the type of operation (add or block).

```json
{
  "emails": [
    "string"
  ],
  "operationType": "add"
}
```

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

### Get Package List (GET)

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

Retrieves a list of packages with various filtering and sorting options. Requires a user bearer token for authorization. Supports parameters like limit, last_package_id, list_type, query, and filters.

```HTTP
GET https://api.furgonetka.pl/packages?limit=10&last_package_id=12345&list_type=sent&query=90014858038
Authorization: Bearer <your_token>
```

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

### GET /account/package-templates

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

Retrieves a list of user's package templates. Supports pagination and searching.

```APIDOC
## GET /account/package-templates

### Description
Retrieves a list of user's package templates. Supports pagination and searching.

### Method
GET

### Endpoint
/account/package-templates

### Query Parameters
- **page** (number) - Optional - Page number for the list of package templates (limit 100 entries per page).
- **search** (string) - Optional - Search phrase for templates.
- **templates_ids** (Array of integers) - Optional - Filters results to specified template IDs.

### Responses
#### Success Response (200)
OK. Returns a list of package templates.
- **package_templates** (Array) - List of package template objects.
  - **id** (integer) - Template ID.
  - **override_pickup** (integer) - Pickup point override.
  - **override_sender** (integer) - Sender details override.
  - **name** (string) - Template name.
  - **service** (string) - Shipping carrier.
  - **service_id** (integer) - Carrier service ID.
  - **shipment_type** (string) - Shipment type (e.g., "door").
  - **delivery_type** (string) - Delivery type (e.g., "door").
  - **additional_services** (object) - Additional services configuration.
  - **default** (boolean) - Whether this is the default template.
  - **type** (string) - Template type.
  - **weight** (number) - Package weight.
  - **width** (number) - Package width.
  - **height** (number) - Package height.
  - **depth** (number) - Package depth.
  - **value** (number) - Declared value.
  - **description** (string) - Template description.

#### Error Response (400)
Bad Request.

#### Error Response (401)
Unauthorized.

### Response Example (200)
```json
{
  "package_templates": [
    {
      "id": 0,
      "override_pickup": 0,
      "override_sender": 0,
      "name": "string",
      "service": "string",
      "service_id": 0,
      "shipment_type": "door",
      "delivery_type": "door",
      "additional_services": {},
      "default": true,
      "type": "string",
      "weight": 0.1,
      "width": 0,
      "height": 0,
      "depth": 0,
      "value": 0.1,
      "description": "string"
    }
  ]
}
```
```

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

### Get Partner Account Registration Status (GET)

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

Checks the status of a partner account creation task. Requires bearer token authorization for the application. Accepts path parameters for partner name and a UUID identifying the operation. Returns a 200 OK status with task details or 400/401 for errors.

```json
{
  "status": "queueing",
  "datetime_change": "2020-08-25T13:15:01+02:00",
  "errors": [
    {
      "path": "string",
      "message": "string",
      "details": "string",
      "code": "string"
    }
  ],
  "uuid": null,
  "email": "string",
  "companyId": "string"
}
```

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

### GET /packages

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

Retrieves a list of packages. This endpoint supports filtering and pagination to fetch specific sets of packages.

```APIDOC
## GET /packages

### Description
Retrieves a list of packages. This endpoint supports filtering and pagination to fetch specific sets of packages.

### Method
GET

### Endpoint
`/packages`

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - Specifies the maximum number of packages to return. Example: `limit=10`
- **last_package_id** (integer) - Optional - Returns packages after the specified package ID. Example: `last_package_id=12345`
- **list_type** (string) - Optional - Filters the list by type. Allowed values: "sent", "ordered", "waiting", "all", "storage", "tracking".
- **query** (string) - Optional - A search query string to filter packages. Example: `query=90014858038`
- **filters** (object) - Optional - A structure for applying advanced filters to the package list.

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

#### Error Responses
- **400** Bad Request
- **401** Unauthorized
```

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

### POST /packages/return/{uuid}

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

Initiates the return process for a package.

```APIDOC
## POST /packages/return/{uuid}

### Description
This method is used to initiate the return of a package to the sender. It requires a unique operation identifier and the package details, including acceptance of regulations.

### Method
POST

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

### Parameters
#### Path Parameters
- **uuid** (string) - Required - A client-defined identifier for the operation. Example: `a8bc8db0-8d8b-4f16-ac32-f69be9e40855`

#### Request Body
- **packageId** (string) - Required - The ID of the package to be returned.
- **regulationsAccept** (string or null) - Optional - The timestamp indicating acceptance of regulations.

### Response
(No specific success response details provided in the source text, typically would include confirmation or status.)

#### Error Responses
- **400** Bad Request
- **401** Unauthorized
```

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

### GET /configuration/statements

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

Retrieves general statements. This endpoint is used to get messages, potentially including malfunction reports and informational statements from carriers.

```APIDOC
## GET /configuration/statements

### Description
Retrieves general statements. This endpoint is used to get messages, potentially including malfunction reports and informational statements from carriers.

### Method
GET

### Endpoint
/configuration/statements

### Parameters
#### Query Parameters
- **place** (string) - Enum: "contact" "contact_gielda" "dashboard" "messages" "order_summary" - Specifies the location or context for the statements to be retrieved.

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **statementsMalfunctions** (array) - An array of malfunction statement objects.
  - **header** (string) - The header of the malfunction statement.
  - **statement** (string) - The content of the malfunction statement.
  - **type** (string) - The type of statement (e.g., "automatic").
  - **url** (string) - A URL related to the statement.
  - **service** (array) - Array of services associated with the malfunction.
- **statementsInformation** (array) - An array of informational statement objects.
  - **header** (string) - The header of the informational statement.
  - **statement** (string) - The content of the informational statement.
  - **type** (string) - The type of statement (e.g., "automatic").
  - **url** (string) - A URL related to the statement.
  - **service** (array) - Array of services associated with the information.

#### Response Example
```json
{
  "statementsMalfunctions": [
    {
      "header": "string",
      "statement": "string",
      "type": "automatic",
      "url": "string",
      "service": [
        "dpd",
        "ups"
      ]
    }
  ],
  "statementsInformation": [
    {
      "header": "string",
      "statement": "string",
      "type": "automatic",
      "url": "string",
      "service": [
        "dpd",
        "ups"
      ]
    }
  ]
}
```
```

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

### Response Sample for Adding Contracts

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

Sample response for the 'Add Contracts' endpoint, indicating success and listing the added contracts with their IDs and names.

```json
{
  "success": true,
  "added_contracts": [
    {
      "id": "123",
      "name": "dpd"
    }
  ]
}
```

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

### GET /configuration/services-statements

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

Retrieves carrier service statements. This endpoint is used to get messages related to carrier services, potentially including rules and conditions.

```APIDOC
## GET /configuration/services-statements

### Description
Retrieves carrier service statements. This endpoint is used to get messages related to carrier services, potentially including rules and conditions.

### Method
GET

### Endpoint
/configuration/services-statements

### Parameters
#### Query Parameters
- **filters** (object) - Optional - Filters for service statements. Expected to be of type `ServicesStatementFilters`.

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **servicesStatements** (array) - An array of service statement objects.
  - **rules** (object) - Rules associated with the statement.
    - **courier** (string) - The courier name.
    - **country_from** (string) - The origin country code.
    - **country_to** (string) - The destination country code.
    - **package_type** (array) - Array of package types (e.g., "package", "dox", "pallet").
    - **country_relation** (array) - Array of country relation types (e.g., "national", "import", "export").
    - **service_contract** (array) - Array of service contract types (e.g., "client", "provided").
    - **is_furgonetka_point_partner** (boolean) - Indicates if it's a Furgonetka point partner.
    - **datetime_start** (string) - The start date and time for the rule.
    - **datetime_end** (string) - The end date and time for the rule.
  - **content_pl** (string) - The statement content in Polish.
  - **content_en** (string) - The statement content in English.

#### Response Example
```json
{
  "servicesStatements": [
    {
      "rules": {
        "courier": "gls",
        "country_from": "PL",
        "country_to": "DE",
        "package_type": [
          "package",
          "dox",
          "pallet"
        ],
        "country_relation": [
          "national",
          "import",
          "export"
        ],
        "service_contract": [
          "client",
          "provided"
        ],
        "is_furgonetka_point_partner": true,
        "datetime_start": "2021-07-01 00:00:00",
        "datetime_end": "2021-07-01 23:59:59"
      },
      "content_pl": "string",
      "content_en": "string"
    }
  ]
}
```
```

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

### Prepare Package for Warehouse

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

This method is used to prepare a package for the warehouse of a point. It requires user authentication via a bearer token.

```APIDOC
## POST /websites/furgonetka_pl_api_rest

### Description
This method is used to prepare a package for the warehouse of a point.

### Method
POST

### Endpoint
/websites/furgonetka_pl_api_rest

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
This endpoint does not explicitly define a request body in the provided text, but typically would include package details.

### Request Example
```json
{
  "package_data": {
    "tracking_state_description": "string",
    "sending_code": "string",
    "uuid": "string",
    "package_no": "string",
    "tracking_state": "string",
    "external_parcel_number": "string",
    "provider": "allegro",
    "service": "ups",
    "service_type": "string",
    "source": "external",
    "point_code": "string",
    "datetime": "string",
    "datetime_change": "string",
    "packages_id": 0,
    "sender_name": "string",
    "sender_surname": "string",
    "inventory_uuid": "string",
    "dispatch_init_datetime": "string",
    "dispatch_expired": true,
    "collection_datetime": "string",
    "locked": true,
    "width": 0,
    "height": 0,
    "depth": 0,
    "weight": 0.1,
    "external_id": "string",
    "receiver_name": "string",
    "receiver_surname": "string",
    "receiver_company": "string",
    "receiver_phone": "string",
    "return_new_package_no": "string",
    "return_package_no": "string",
    "relation": "courier,client",
    "documents": {
      "documents": [
        {
          "uuid": "string",
          "datetime_add": "string",
          "type": "string",
          "page_format": "string",
          "file_format": "string",
          "content": "string"
        }
      ]
    },
    "actions": {
      "machine_command_available": {
        "type": "collection",
        "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"
        }
      },
      "point_command_available": [
        {
          "activity": "collection",
          "description": "collectionFromClient",
          "accessCodeRequired": true,
          "accessCodeResendAvailable": true,
          "courierNumberRequired": true,
          "collectToTimestamp": 0,
          "minutesToCollect": 0
        }
      ]
    },
    "display_package_number": "string",
    "display_external_number": "string"
  }
}
```

### Response
#### Success Response (200)
- **status** (string) - The current status of the package.
- **datetime_change** (string) - The timestamp of the last status change.
- **errors** (array) - A list of errors, if any occurred.
  - **path** (string) - The path related to the error.
  - **message** (string) - The error message.
  - **details** (string) - Additional details about the error.
  - **code** (string) - The error code.
- **uuid** (string or null) - The unique identifier for the package.
- **package_id** (integer) - The internal ID of the package.
- **collected** (boolean) - Indicates if the package has been collected.
- **provider** (string) - The shipping provider.
- **service** (string) - The specific service used.
- **package_uuid** (string) - The UUID of the package.
- **package_no** (string) - The package number.
- **package_data** (object) - Detailed information about the package.

#### Response Example
```json
{
  "status": "queueing",
  "datetime_change": "2020-08-25T13:15:01+02:00",
  "errors": [],
  "uuid": null,
  "package_id": 0,
  "collected": true,
  "provider": "string",
  "service": "string",
  "package_uuid": "string",
  "package_no": "string",
  "package_data": {
    "tracking_state_description": "string",
    "sending_code": "string",
    "uuid": "string",
    "package_no": "string",
    "tracking_state": "string",
    "external_parcel_number": "string",
    "provider": "allegro",
    "service": "ups",
    "service_type": "string",
    "source": "external",
    "point_code": "string",
    "datetime": "string",
    "datetime_change": "string",
    "packages_id": 0,
    "sender_name": "string",
    "sender_surname": "string",
    "inventory_uuid": "string",
    "dispatch_init_datetime": "string",
    "dispatch_expired": true,
    "collection_datetime": "string",
    "locked": true,
    "width": 0,
    "height": 0,
    "depth": 0,
    "weight": 0.1,
    "external_id": "string",
    "receiver_name": "string",
    "receiver_surname": "string",
    "receiver_company": "string",
    "receiver_phone": "string",
    "return_new_package_no": "string",
    "return_package_no": "string",
    "relation": "courier,client",
    "documents": {
      "documents": [
        {
          "uuid": "string",
          "datetime_add": "string",
          "type": "string",
          "page_format": "string",
          "file_format": "string",
          "content": "string"
        }
      ]
    },
    "actions": {
      "machine_command_available": {
        "type": "collection",
        "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"
        }
      },
      "point_command_available": [
        {
          "activity": "collection",
          "description": "collectionFromClient",
          "accessCodeRequired": true,
          "accessCodeResendAvailable": true,
          "courierNumberRequired": true,
          "collectToTimestamp": 0,
          "minutesToCollect": 0
        }
      ]
    },
    "display_package_number": "string",
    "display_external_number": "string"
  }
}
```

#### Error Responses
- **400 Bad Request**: The request was malformed or invalid.
- **401 Unauthorized**: Authentication credentials were not provided or were invalid.

```

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

### GET /account/services-agreements/inpost/dispatch-points-sync/{uuid}

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

Checks the status of the InPost dispatch points synchronization task. Use GET /account/services-agreements/inpost/{agreement_id}/dispatch-points to retrieve dispatch point data.

```APIDOC
## GET /account/services-agreements/inpost/dispatch-points-sync/{uuid}

### Description
Checks the status of the InPost dispatch points synchronization task. Use GET /account/services-agreements/inpost/{agreement_id}/dispatch-points to retrieve dispatch point data.

### Method
GET

### Endpoint
`/account/services-agreements/inpost/dispatch-points-sync/{uuid}`

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

### Response
#### Success Response (200)
- **status** (string) - The current status of the synchronization task (e.g., "queueing").
- **datetime_change** (string) - The date and time of the last status change.
- **errors** (array) - An array of error objects if the synchronization failed.
  - **path** (string) - The path to the field with the error.
  - **message** (string) - The error message.
  - **details** (string) - Additional error details.
  - **code** (string) - The error code.
- **uuid** (string) - The identifier of the operation.

#### Response Example
```json
{
  "status": "queueing",
  "datetime_change": "2020-08-25T13:15:01+02:00",
  "errors": [
    {
      "path": "string",
      "message": "string",
      "details": "string",
      "code": "string"
    }
  ],
  "uuid": "string"
}
```
```

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

### Prepare Package for Warehouse - Furgonetka API

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

This section describes the method for preparing a package for a warehouse point within the Furgonetka system. It requires bearer token authorization for the user. The specific API endpoint and request/response bodies are not detailed here, but the purpose is to initiate the package preparation process.

```markdown
## Przygotowanie paczki dla magazynu w systemie 
Metoda służy do przygotowania paczki dla magazynu punktu.
##### Authorizations:
_bearer-token-for-user_
```

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

### Get Cancellation Summary (GET)

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

Retrieves a summary of package cancellation statuses, identified by a UUID. Requires bearer token authorization. Returns cancellation details on success, or Bad Request/Unauthorized on failure.

```HTTP
GET /cancel-command/{uuid} HTTP/1.1
Host: api.furgonetka.pl
Authorization: Bearer <your_token>
```

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

### Get Account Data Endpoint (HTTP)

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

This describes the HTTP GET request to retrieve account data. It specifies the production and sandbox server URLs. Authorization is required using a bearer token.

```http
GET /pudo/account

Production server:
https://api.furgonetka.pl/pudo/account

Sandbox server:
https://api.sandbox.furgonetka.pl/pudo/account

Authorization: Bearer <your_token>
```

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

### Get Package Templates List - Response Sample (200 OK)

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

This is a sample JSON response for a successful request to retrieve package templates. It contains an array of 'package_templates' objects, each detailing a specific template with its ID, name, service, dimensions, and additional services.

```json
{
  "package_templates": [
    {
      "id": 0,
      "override_pickup": 0,
      "override_sender": 0,
      "name": "string",
      "service": "string",
      "service_id": 0,
      "shipment_type": "door",
      "delivery_type": "door",
      "additional_services": {
        "additional_handling": true,
        "additional_insurance": true,
        "guarantee_0930": 0,
        "guarantee_1200": 0,
        "saturday_delivery": 0,
        "guarantee_next_day": 0,
        "rod": 0,
        "cod": 0,
        "quick_transfer": 0,
        "iban": "string",
        "iban_name": "string",
        "swift": "string",
        "sms_predelivery_information": 0,
        "ups_saver": 0,
        "fedex_priority": 0,
        "documents_supply": 0,
        "saturday_sunday_delivery": 0,
        "declaredvalue": 0,
        "cud": 0,
        "personal_delivery": 0,
        "poczta_ekspres24": 0,
        "pocztex": 0,
        "delivery_on_time": 0,
        "delivery_on_time_value": "string",
        "delivery_confirmation": 0,
        "registered_company_letter": 0,
        "receiver_sms_notification": 0,
        "deligoo_express": 0,
        "pickup_from_door": 0,
        "delivery_to_door": 0,
        "digital_label": 0
      },
      "default": true,
      "type": "string",
      "weight": 0.1,
      "width": 0,
      "height": 0,
      "depth": 0,
      "value": 0.1,
      "description": "string"
    }
  ]
}
```

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

### POST /account/package-templates

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

Adds a new package template for the user. Requires a bearer token for authorization.

```APIDOC
## POST /account/package-templates

### Description
Adds a new package template for the user. Requires a bearer token for authorization.

### Method
POST

### Endpoint
/account/package-templates

### Request Body schema
application/vnd.furgonetka.v2+json

### Request Body
- **name** (string) - Required - Name of the template.
- **parcels** (Array of objects) - Required - Array containing parcel information. Max parcels per carrier varies (e.g., 15 for DHL, DPD, GLS, InPost Kurier, UPS; 1 for DPD envelope, DHL Express, InPost, Poczta, Orlen Paczka, UPS; 5 for DHL pallet).
- **override_pickup** (integer) - Optional - Sender ID from the address book.
- **override_sender** (integer) - Optional - Other label data ID from the address book.
- **service** (string) - Optional - Shipping carrier.
- **service_id** (integer) - Optional - Carrier service ID configured in the system.
- **shipment_type** (string) - Optional - Enum: "door", "point", "point_apm". Pickup point information will be taken from sender data. For InPost, DPD, DHL, FedEx, and UPS, you can drop off at any point if no point is selected in sender data.
- **delivery_type** (string) - Optional - Enum: "door", "point", "point_apm", "any". If creating shipments imported from a sales platform, the system will automatically determine the delivery point/machine information from your order, regardless of the template's point setting.
- **additional_services** (object) - Optional - Structure containing additional services configuration for package templates.
- **default** (boolean) - Optional - Whether this is the default template.

### Responses
#### Success Response (200)
OK.

#### Error Response (400)
Bad Request.

#### Error Response (401)
Unauthorized.

### Request Example
```json
{
  "name": "My Package Template",
  "parcels": [
    {
      "weight": 1.5,
      "width": 20,
      "height": 30,
      "depth": 10,
      "value": 50.0,
      "description": "Example parcel"
    }
  ],
  "service": "DPD",
  "shipment_type": "door",
  "delivery_type": "door",
  "default": true
}
```
```

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

### Get Account Printers (GET)

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

Retrieves a list of printers associated with the authenticated user's account. Requires bearer token authorization. Returns a JSON object containing an array of printer details.

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

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

### Propose Pickup Dates for Packages (JSON)

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

This endpoint allows users to propose pickup dates for packages. It requires an array of package IDs, a ready date, and optionally a flag for repickup and the number of days ahead for proposals. The response includes proposed dates and times for each package.

```json
{
  "packages": [
    {
      "id": "string"
    }
  ],
  "ready_date": "2020-05-01",
  "only_repickup": "true",
  "days_ahead": 1
}
```

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

### Get Parcel Creation Command Status (GET)

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

Retrieves the status of a parcel creation request. This endpoint is useful for tracking the progress of adding a parcel to the cart. It requires a UUID to identify the command and returns the current status, timestamps, and potential errors.

```json
{
  "status": "queueing",
  "datetime_change": "2020-08-25T13:15:01+02:00",
  "errors": [
    {
      "path": "string",
      "message": "string",
      "details": "string",
      "code": "string"
    }
  ],
  "uuid": null,
  "package_id": 12345,
  "redirect_url": "https://furgonetka.pl/potwierdzenie/logowania/{hash}"
}
```

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

### POST /packages/pickup-date-proposals

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

Proposes pickup dates for packages based on readiness and desired pickup window.

```APIDOC
## POST /packages/pickup-date-proposals

### Description
This endpoint proposes pickup dates for packages. You can specify the packages, the date they will be ready, and the desired number of days ahead for courier pickup proposals. It also supports a flag for re-pickup scenarios.

### Method
POST

### Endpoint
https://api.furgonetka.pl/packages/pickup-date-proposals

### Parameters
#### Request Body
- **packages** (Array of objects) - Required - An array containing package objects, each with an 'id' (string).
- **ready_date** (string) - Optional - The date when the package will be ready for pickup (format: YYYY-MM-DD).
- **only_repickup** (boolean) - Optional - A flag indicating if this is solely a re-pickup request.
- **days_ahead** (integer) - Optional - The number of days in advance to suggest courier pickup dates (1-7). If 'ready_date' is provided, days are counted from that date.

### Request Example
```json
{
  "packages": [
    {
      "id": "string"
    }
  ],
  "ready_date": "2020-05-01",
  "only_repickup": true,
  "days_ahead": 1
}
```

### Response
#### Success Response (200)
- **packages** (Array of objects) - Contains package details and pickup proposals.
  - **package_id** (string) - The ID of the package.
  - **proposals** (Array of objects) - A list of proposed pickup dates and times.
    - **date** (string) - The proposed date.
    - **min_time** (string) - The earliest pickup time.
    - **max_time** (string) - The latest pickup time.
    - **available** (boolean) - Indicates if the proposal is available.
    - **hash** (string) - A unique hash for the proposal.
    - **custom_description** (string) - A human-readable description of the proposal.

#### Response Example
```json
{
  "packages": [
    {
      "package_id": "string",
      "proposals": [
        {
          "date": "string",
          "min_time": "string",
          "max_time": "string",
          "available": true,
          "hash": "dfe1cc49bec1d942c1db625a8d710d45",
          "custom_description": "2024-07-30 13:00 15:00 (Aktualne do 2024-07-30 13:00)"
        }
      ]
    }
  ]
}
```
```

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

### POST /packages/return/calculate-price

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

Calculates the price for returning a package.

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

### Description
This method is used to calculate the price for a return shipment. It requires the ID of the package to be returned.

### Method
POST

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

### Parameters
#### Request Body
- **packageId** (integer) - Required - The ID of the package to be returned.

### Request Example
```json
{
  "packageId": 12345
}
```

### Response
#### Success Response (200)
- **price** (number) - The calculated price for the return shipment.

#### Response Example
```json
{
  "price": 20.76
}
```
```

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

### Get Advanced Account Settings (GET)

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

Retrieves advanced account settings for the Furgonetka API. This endpoint returns a JSON object containing various settings related to shipping, file formats, and API access. It supports multiple content types for responses.

```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",
  "windows_url": "string",
  "settings": {
    "pickup_address": true,
    "csv_export": true,
    "user_reference_number": true,
    "self_pickup": true,
    "description_field": true
  },
  "add_cutting_line": false
}
```

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

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

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

Creates a partner account. Requires path parameters for partner name and operation UUID, and a request body with email and identifier.

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

### Description
Creates a partner account. Requires path parameters for partner name and operation UUID, and a request body with email and identifier.

### Method
PUT

### Endpoint
- Production: https://api.furgonetka.pl/account/register/{partner}/{uuid}
- Sandbox: https://api.sandbox.furgonetka.pl/account/register/{partner}/{uuid}

### Parameters
#### Path Parameters
- **partner** (string) - Required - The name of the partner.
- **uuid** (string) - Required - The operation UUID (e.g., a8bc8db0-8d8b-4f16-ac32-f69be9e40855).

#### Request Body
- **email** (string) - Required - The email address for the account. For the test environment, append '+nodata' (e.g., jan.testowy+nodata@partner.pl).
- **identifier** (string) - Required - The partner's account identifier, can be the same as the email.

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

### Response
#### Success Response (200)
- **uuid** (string) - The UUID of the created account.

#### Error Response (400)
- Bad Request
#### Error Response (401)
- Unauthorized

#### Response Example (200)
```json
{
  "uuid": "string"
}
```
```

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

### Get Pickup/Delivery Points API

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

Retrieves a list of available pickup and delivery points.

```APIDOC
## GET /points

### Description
Retrieves a list of available pickup and delivery points.

### Method
GET

### Endpoint
/points

### Parameters
#### Query Parameters
- **city** (string) - Optional - Filters points by city.
- **postal_code** (string) - Optional - Filters points by postal code.

### Response
#### Success Response (200)
- **points** (array) - A list of pickup/delivery points.
  - **id** (string) - The unique identifier of the point.
  - **name** (string) - The name of the point.
  - **address** (string) - The address of the point.
  - **city** (string) - The city of the point.
  - **postal_code** (string) - The postal code of the point.

#### Response Example
```json
{
  "points": [
    {
      "id": "point001",
      "name": "Poczta Polska - Dworzec Główny",
      "address": "ul. Długa 1",
      "city": "Kraków",
      "postal_code": "30-001"
    },
    {
      "id": "point002",
      "name": "InPost Paczkomat",
      "address": "ul. Krótka 5",
      "city": "Kraków",
      "postal_code": "30-002"
    }
  ]
}
```
```

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

### Get Package Templates List - API Request

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

This snippet demonstrates how to make an API request to retrieve a list of user's package templates. It includes optional query parameters for pagination, searching, and filtering by template IDs. The response includes a list of package templates with their details.

```http
GET /account/package-templates?page=3&search=szablon1&templates_ids=[1, 2] 
Host: api.furgonetka.pl 
Authorization: Bearer <your_token>
```

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

### Get Poczta Polska Post Offices Command Status (GET)

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

Retrieves the status of a command to fetch Poczta Polska post offices. It requires a UUID to identify the operation and returns the status, timestamps, errors, and a list of post offices if available. Supports production and sandbox environments.

```json
{
  "status": "queueing",
  "datetime_change": "2020-08-25T13:15:01+02:00",
  "errors": [
    {
      "path": "string",
      "message": "string",
      "details": "string",
      "code": "string"
    }
  ],
  "uuid": null,
  "postOffices": [
    {
      "id": "123",
      "name": "PP Wrocław D101"
    }
  ]
}
```

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

### Furgonetka API v1/v2 Package Price Response Sample (JSON)

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

This JSON object represents a sample response for retrieving package service prices from the Furgonetka API. It includes details about services, pricing, and potential errors.

```json
{
  "services_prices": [
    {
      "service_id": 0,
      "service": "dpd",
      "agreement_owner": "furgonetka",
      "available": true,
      "access": null,
      "errors": [
        {
          "path": "string",
          "message": "string",
          "details": "string",
          "code": "string"
        }
      ],
      "lowest_price": {
        "price_gross": 20.76
      },
      "calculation_pending_in_background": true,
      "additional_fees": [
        {
          "type": "string",
          "amount": 0.1,
          "amount_net": 0.1,
          "description": "string",
          "charged_items": [
            "string"
          ]
        }
      ],
      "pricing": {
        "price_gross": 20.76,
        "price_net": 16.88,
        "price_base_net": 12.89,
        "price_org": 10.89,
        "adjusted_price": 16.49,
        "tax": 23,
        "price_info": "+ podjazd",
        "details": {
          "cod": 5.15,
          "additional_handling": 3.21,
          "usługa_3": 1.95,
          "...": 123
        }
      }
    }
  ]
}
```

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

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

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

Retrieves a list of webhook call logs.

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

### Description
Metoda służy do pobrania listy z logami wywołań Webhook'a.

### Method
GET

### Endpoint
/account/settings/notification/webhook/logs

### Parameters
#### Query Parameters
- **lastId** (integer) - Optional - ID ostatniego loga. Używane do pobierania kolejnych rekordów. Wymagane gdy podano `lastDatetimeSend`.
- **lastDatetimeSend** (string) - Optional - <ISO 8601> Example:  2022-08-25T08:10:00+02:00 Data ostatniego loga. Używane do pobierania kolejnych rekordów. Wymagane gdy podano `lastId`.

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

#### Error Response (400)
Bad Request

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

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

### Response Sample - Generic Account Service

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

A sample JSON response structure for account service details. This structure is common across different carriers but the `credentials` object will vary based on the specific carrier.

```JSON
{
  "id": 0,
  "service": "dpd",
  "name": "string",
  "owner": "furgonetka",
  "configuration": {
    "additional_services": {
      "cod_enabled": true,
      "insurance_set_default_override_enabled": true
    },
    "national_only": true
  },
  "credentials": {
    "login": "string",
    "password": "string",
    "master_fid": "string"
  },
  "credentials_import": {
    "login": "string",
    "password": "string",
    "master_fid": "string"
  }
}
```