Eurosender API

https://sandbox-api.eurosender.com/docs
Admin
Eurosender API is a REST-based logistics platform that enables businesses to create orders, get...
Tokens:53,550
Snippets:201
Trust Score:10
Update:6 months ago
Show doc for...
Tokens:
Raw
### Retrieve Order Details Response

Source: https://sandbox-api.eurosender.com/docs

Example JSON response body returned by the GET /v1/orders/{orderCode} endpoint containing comprehensive order information.

```json
{
  "orderCode": "674304-24",
  "status": "Deferred Payment",
  "serviceType": "regular_plus",
  "language": "en",
  "email": "user@example.com",
  "paymentMethod": "deferred",
  "currencyCode": "EUR",
  "vatRate": "17%",
  "parcels": {
    "envelopes": [],
    "packages": [
      {
        "parcelId": "A00001",
        "orderCode": "674304-24",
        "type": "package",
        "weight": 2.0,
        "length": 15,
        "width": 14,
        "height": 14,
        "content": "books",
        "value": 150,
        "price": {
          "original": {
            "currencyCode": "EUR",
            "gross": 32.92,
            "net": 28.14
          },
          "converted": null
        },
        "tracking": null
      }
    ],
    "pallets": [],
    "vans": [],
    "ltls": [],
    "ftls": [],
    "nonStandard": []
  },
  "courier": {
    "id": 66,
    "shortName": "UPS",
    "countryCode": "LU",
    "email": "support courier email",
    "phone": "+00 00 00 00 00"
  },
  "shipment": {
    "pickupAddress": {
      "street": "9 Rue du Laboratoire",
      "zip": "1911",
      "city": "Luxembourg",
      "region": null,
      "country": "LU"
    },
    "pickupContact": {
      "name": "Eurosender SARL",
      "phone": "+442031292884"
    },
    "deliveryAddress": {
      "street": "9 Rue du Laboratoire",
      "zip": "1911",
      "city": "Luxembourg",
      "region": null,
      "country": "LU"
    },
    "deliveryContact": {
      "name": "Eurosender SARL",
      "phone": "+442031292884"
    },
    "pickupDate": "2024-07-04T00:00:00+02:00",
    "pickupTimeFrom": "09:00",
    "pickupTimeTo": "13:00",
    "addOns": [],
    "routeDistance": 0.0
  },
  "estimatedDeliveryTime": "1-2",
  "price": {
    "original": {
      "currencyCode": "EUR",
      "gross": 32.92,
      "net": 28.14
    },
    "converted": null
  },
  "discount": null,
  "coupon": null,
  "insurance": {
    "id": 33,
    "text": "Insurance coverage of up to <strong>200€ (per package)</strong>",
    "price": {
      "original": {
        "currencyCode": "EUR",
        "gross": 0.0,
        "net": 0.0
      },
      "converted": null
    }
  },
  "isCallRequired": false,
  "isLabelRequired": true,
  "labelLink": "https://example-storage.com/label.pdf",
  "labelFormat": "pdf",
  "comment": "2nd floor",
  "documents": [
    {
      "id": "label_pdf_b11**************2b",
      "type": "label",
      "fileFormat": "pdf"
    }
  ],
  "created": "2024-06-10T13:13:26+02:00"
}
```

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

### OrderRequest 200 Response

Source: https://sandbox-api.eurosender.com/docs

Example response for a successful OrderRequest creation.

```json
null
```

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

### Successful Order Creation Response

Source: https://sandbox-api.eurosender.com/docs.json

Example of the response returned upon successful order creation.

```json
{
  "orderCode": "674304-24",
  "status": "Deferred Payment",
  "serviceType": "regular_plus",
  "language": "en",
  "email": "user@example.com",
  "paymentMethod": "deferred",
  "currencyCode": "EUR",
  "vatRate": "17%%",
  "parcels": {
    "envelopes": [],
    "packages": [
      {
        "parcelId": "A00001",
        "orderCode": "674304-24",
        "type": "package",
        "weight": 2.0,
        "length": 15,
        "width": 14,
        "height": 14,
        "content": "books",
        "value": 150,
        "price": {
          "original": {
            "currencyCode": "EUR",
            "gross": 32.92,
            "net": 28.14
          },
          "converted": null
        },
        "tracking": null
      }
```

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

### Available pickup times response

Source: https://sandbox-api.eurosender.com/docs

Example JSON response for available pickup time slots.

```json
[
  {
    "pickupDate": null,
    "timeFrom": [
      "09:00",
      "09:30",
      "10:00",
      "10:30",
      "11:00"
    ],
    "timeTo": [
      "13:00",
      "13:30",
      "14:00",
      "14:30"
    ]
  }
]
```

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

### GET /v1/countries API Response Example

Source: https://sandbox-api.eurosender.com/docs

This JSON response from the /v1/countries endpoint provides details for a specific country, including its ID, code, name, and whether regions or cities are required for order creation. It also lists supported service types and custom fields.

```json
[
  {
    "id": 35,
    "code": "BG",
    "name": "Bulgaria",
    "requiresRegion": false,
    "requiresCity": false,
    "active": true,
    "isEu": true,
    "countryCustomFields": {
      "supportedServiceTypeIds": [
        "selection",
        "flexi",
        "express",
        "regular_plus",
        "individual_offer"
      ],
      "customFields": [
        {
          "name": "local_phone_required",
          "type": "info",
          "length": null,
          "required": false,
          "options": [],
          "label": "Local phone is required",
          "additionalInfo": "The courier will call you before pick-up, a local phone number is mandatory",
          "placeholder": null
        }
      ]
    }
  }
]
```

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

### Webhook Request Headers Example

Source: https://sandbox-api.eurosender.com/docs

Headers to be included in webhook requests for most events. Ensure 'Webhook-Id' is unique for each webhook sent.

```text
Webhook-Id: unique_id_for_each_webhook_sent
Webhook-Event: code
Webhook-Signature: ...
```

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

### Order Response JSON Structure

Source: https://sandbox-api.eurosender.com/docs.json

Example of the JSON object returned when retrieving order details or creating an order.

```json
{
    "pallets": [],
    "vans": [],
    "ltls": [],
    "ftls": [],    
    "nonStandard": []
  },
  "courier": {
    "id": 66,
    "shortName": "UPS",
    "countryCode": "LU",
    "email": "test support email",
    "phone": "+00 00 00 00 00"
  },
  "shipment": {
    "pickupAddress": {
      "street": "9 Rue du Laboratoire",
      "zip": "1911",
      "city": "Luxembourg",
      "region": null,
      "country": "LU"
    },
    "pickupContact": {
      "name": "Eurosender SARL",
      "phone": "+442031292884"
    },
    "deliveryAddress": {
      "street": "9 Rue du Laboratoire",
      "zip": "1911",
      "city": "Luxembourg",
      "region": null,
      "country": "LU"
    },
    "deliveryContact": {
      "name": "Eurosender SARL",
      "phone": "+442031292884"
    },
    "pickupDate": "2024-07-04T00:00:00+02:00",
    "pickupTimeFrom": "09:00",
    "pickupTimeTo": "13:00",
    "addOns": [],
    "routeDistance": 0.0
  },
  "estimatedDeliveryTime": "1-2",
  "price": {
    "original": {
      "currencyCode": "EUR",
      "gross": 32.92,
      "net": 28.14
    },
    "converted": null
  },
  "discount": null,
  "coupon": null,
  "insurance": {
    "id": 33,
    "text": "Insurance coverage of up to <strong>200€ (per package)</strong>",
    "price": {
      "original": {
        "currencyCode": "EUR",
        "gross": 0.0,
        "net": 0.0
      },
      "converted": null
    }
  },
  "isCallRequired": false,
  "isLabelRequired": true,
  "labelLink": "",
  "labelFormat": "pdf",
  "comment": "2nd floor",
  "documents": [],
  "created": "2024-06-10T13:13:26+02:00"
}
```

```json
{
  "orderCode": "674304-24",
  "status": "Deferred Payment",
  "serviceType": "regular_plus",
  "language": "en",
  "email": "user@example.com",
  "paymentMethod": "deferred",
  "currencyCode": "EUR",
  "vatRate": "17%",
  "parcels": {
    "envelopes": [],
    "packages": [
```

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

### Order Response Structure

Source: https://sandbox-api.eurosender.com/docs.json

Example JSON response body for an order, containing shipment details, courier information, and document references.

```json
{
        "parcelId": "A00001",
        "orderCode": "674304-24",
        "type": "package",
        "weight": 2.0,
        "length": 15,
        "width": 14,
        "height": 14,
        "content": "books",
        "value": 150,
        "price": {
          "original": {
            "currencyCode": "EUR",
            "gross": 32.92,
            "net": 28.14
          },
          "converted": null
        },
        "tracking": null
      }
    ],
    "pallets": [],
    "vans": [],
    "ltls": [],
    "ftls": [],
    "nonStandard": []
  },
  "courier": {
    "id": 66,
    "shortName": "UPS",
    "countryCode": "LU",
    "email": "support courier email",
    "phone": "+00 00 00 00 00"
  },
  "shipment": {
    "pickupAddress": {
      "street": "9 Rue du Laboratoire",
      "zip": "1911",
      "city": "Luxembourg",
      "region": null,
      "country": "LU"
    },
    "pickupContact": {
      "name": "Eurosender SARL",
      "phone": "+442031292884"
    },
    "deliveryAddress": {
      "street": "9 Rue du Laboratoire",
      "zip": "1911",
      "city": "Luxembourg",
      "region": null,
      "country": "LU"
    },
    "deliveryContact": {
      "name": "Eurosender SARL",
      "phone": "+442031292884"
    },
    "pickupDate": "2024-07-04T00:00:00+02:00",
    "pickupTimeFrom": "09:00",
    "pickupTimeTo": "13:00",
    "addOns": [],
    "routeDistance": 0.0
  },
  "estimatedDeliveryTime": "1-2",
  "price": {
    "original": {
      "currencyCode": "EUR",
      "gross": 32.92,
      "net": 28.14
    },
    "converted": null
  },
  "discount": null,
  "coupon": null,
  "insurance": {
    "id": 33,
    "text": "Insurance coverage of up to <strong>200€ (per package)</strong>",
    "price": {
      "original": {
        "currencyCode": "EUR",
        "gross": 0.0,
        "net": 0.0
      },
      "converted": null
    }
  },
  "isCallRequired": false,
  "isLabelRequired": true,
  "labelLink": "https://example-storage.com/label.pdf",
  "labelFormat": "pdf",
  "comment": "2nd floor",
  "documents": [
    {
      "id": "label_pdf_b11**************2b",
      "type": "label",
      "fileFormat": "pdf"
    }
  ],
  "created": "2024-06-10T13:13:26+02:00"
}
```

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

### Tracking Response Structure

Source: https://sandbox-api.eurosender.com/docs.json

Example of the JSON structure returned for shipment tracking, including parcel details and event checkpoints.

```json
{
  "parcelId": "c8f25422-0078-511e-8cec-00011206943f",
  "orderCode": "120014-24",
  "trackingNumber": "00931017539",
  "currentStatus": "InTransit",
  "currentSubstatus": "InTransit_001",
  "updatedDate": "2024-06-10T13:11:27+02:00",
  "expectedDeliveryDate": null,
  "pickupDate": "2024-06-10T14:34:31+02:00",
  "deliveryDate": null,
  "signedBy": null,
  "checkpoints": [
    {
      "eventDate": "2024-06-10T14:34:31+02:00",
      "status": "InTransit",
      "substatus": "InTransit_001",
      "location": null,
      "countryCode": null,
      "message": "Data sent"
    }
  ]
}
```

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

### List of cities for country response

Source: https://sandbox-api.eurosender.com/docs

Example JSON response for the city list endpoint.

```json
[
  {
    "id": 1341,
    "name": "Dublin",
    "regionId": 6
  }
]
```

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

### GET /v1/orders/{orderCode}

Source: https://sandbox-api.eurosender.com/docs

Retrieves the details of a specific order, including status, label links, and required documentation.

```APIDOC
## GET /v1/orders/{orderCode}

### Description
Retrieves detailed information about an existing order, including current status, courier contact details, and label availability.

### Method
GET

### Endpoint
/v1/orders/{orderCode}

### Parameters
#### Path Parameters
- **orderCode** (string) - Required - The unique identifier for the order.

### Response
#### Success Response (200)
- **status** (string) - Current status of the order (e.g., Order Received, Confirmed, Tracking).
- **isLabelRequired** (boolean) - Indicates if labels must be printed.
- **labelLink** (string) - URL for retrieving labels when available.
- **documents** (array) - List of additional documents required for the order.
- **parcels.packages.tracking** (string) - URL for viewing tracking information on the courier's site.
```

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

### Retrieve PUDO List Response

Source: https://sandbox-api.eurosender.com/docs

Example JSON response structure for a successful PUDO list retrieval request.

```json
{
  * "orderCode": "string",
  * "parcels": [
    * {
      * "parcelId": null,
      * "orderCode": "string",
      * "trackingNumber": "string",
      * "currentStatus": "InfoReceived",
      * "currentSubstatus": "string",
      * "updatedDate": "2019-08-24T14:15:22Z",
      * "expectedDeliveryDate": null,
      * "pickupDate": null,
      * "deliveryDate": null,
      * "signedBy": null,
      * "checkpoints": [
        * {
          * "eventDate": "2019-08-24T14:15:22Z",
          * "status": "InfoReceived",
          * "substatus": "string",
          * "location": null,
          * "countryCode": null,
          * "message": null
}
]
}
]

}
```

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

### Example Order Tracking Response

Source: https://sandbox-api.eurosender.com/docs

This JSON structure represents the response from the order tracking endpoint, detailing parcel information and a history of checkpoints.

```json
{
  "parcels": [
    {
      "parcelId": "ecab2e6a-917e-49b4-99aa-3b4dc9b3ee9a",
      "orderCode": "740001-20",
      "trackingNumber": "91120016997",
      "currentStatus": "InTransit",
      "currentSubstatus": "InTransit_001",
      "updatedDate": "2024-06-10T13:11:27+02:00",
      "expectedDeliveryDate": null,
      "pickupDate": "2024-06-10T14:34:31+02:00",
      "deliveryDate": null,
      "signedBy": null,
      "checkpoints": [
        {
          "eventDate": "2024-06-10T14:34:31+02:00",
          "status": "InTransit",
          "substatus": "InTransit_001",
          "location": null,
          "countryCode": null,
          "message": "Data sent"
        }
      ]
    },
    {
      "parcelId": "c8f25422-0078-511e-8cec-00011206943f",
      "orderCode": "120014-24",
      "trackingNumber": "00931017539",
      "currentStatus": "InTransit",
      "currentSubstatus": "InTransit_001",
      "updatedDate": "2024-06-10T13:11:27+02:00",
      "expectedDeliveryDate": null,
      "pickupDate": "2024-06-10T14:34:31+02:00",
      "deliveryDate": null,
      "signedBy": null,
      "checkpoints": [
        {
          "eventDate": "2024-06-10T14:34:31+02:00",
          "status": "InTransit",
          "substatus": "InTransit_001",
          "location": null,
          "countryCode": null,
          "message": "Data sent"
        }
      ]
    }
  ]
}
```

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

### Order Creation Response

Source: https://sandbox-api.eurosender.com/docs

This is an example of a successful response after creating an order. It includes the order code, status, shipment details, pricing, and any additional fees like pickup date fees under `addOns`.

```APIDOC
## Order Creation Response

### Description
This response is returned upon successful order creation. It contains the `orderCode`, `status`, shipment details, pricing information, and any applicable additional charges.

### Method
POST

### Endpoint
/api/orders

### Response
#### Success Response (200)
- **orderCode** (string) - The unique code assigned to the order.
- **status** (string) - The current status of the order.
- **serviceType** (string) - The type of service provided.
- **language** (string) - The language code for the order.
- **email** (string) - The email address associated with the order.
- **paymentMethod** (string) - The payment method used.
- **currencyCode** (string) - The currency code for pricing.
- **vatRate** (string) - The VAT rate applied.
- **parcels** (object) - Details about the parcels in the order.
  - **ltls** (array) - List of LTL parcels with their details, including price.
- **courier** (object) - Information about the assigned courier.
- **shipment** (object) - Detailed shipment information.
  - **pickupAddress** (object) - Pickup address details.
  - **pickupContact** (object) - Pickup contact details.
  - **deliveryAddress** (object) - Delivery address details.
  - **deliveryContact** (object) - Delivery contact details.
  - **pickupDate** (string) - The confirmed pickup date.
  - **addOns** (array) - List of additional services or fees applied (e.g., "early_pickup_fee").
    - **code** (string) - The code for the add-on.
    - **price** (object) - The price details for the add-on.
- **estimatedDeliveryTime** (string) - Estimated delivery time frame.
- **price** (object) - The total price of the order.
- **discount** (object | null) - Discount information, if applicable.
- **coupon** (object | null) - Coupon information, if applicable.
- **insurance** (object | null) - Insurance details, if applicable.
- **isCallRequired** (boolean) - Indicates if a call is required.
- **isLabelRequired** (boolean) - Indicates if a label is required.
- **labelLink** (string) - Link to the generated label.
- **labelFormat** (string) - The format of the label.
- **comment** (string) - Any comments associated with the order.
- **customerInternalReference** (object | null) - Customer's internal reference.
- **customerBillingReference** (object | null) - Customer's billing reference.
- **documents** (array) - List of associated documents.
- **created** (string) - Timestamp when the order was created.

#### Response Example
```json
{
    "orderCode": "237548-25",
    "status": "Deferred Payment",
    "serviceType": "ftl",
    "language": "en",
    "email": "name@example.com",
    "paymentMethod": "deferred",
    "currencyCode": "EUR",
    "vatRate": "0%",
    "parcels": {
        "envelopes": [],
        "packages": [],
        "pallets": [],
        "vans": [],
        "ltls": [
            {
                "parcelId": "V00001",
                "orderCode": "237548-25",
                "euroPalletQuantity": 12,
                "loadingMeters": null,
                "weight": 3600.0,
                "price": {
                    "original": {
                        "currencyCode": "EUR",
                        "gross": 550.0,
                        "net": 550.0
                    },
                    "converted": null
                }
            }
        ],
        "ftls": [],
        "nonStandard": []
    },
    "courier": {
        "id": 49,
        "shortName": "Eurosender",
        "countryCode": "",
        "email": "",
        "phone": ""
    },
    "shipment": {
        "pickupAddress": {
            "street": "9 Rue du Laboratoire",
            "zip": "1911",
            "city": "Luxembourg",
            "region": null,
            "country": "LU"
        },
        "pickupContact": {
          "name": "Eurosender SARL",
          "phone": "+442031292884"
        },
        "deliveryAddress": {
            "street": "Bernhard-Grzimek-Allee 1",
            "zip": "60316",
            "city": "Frankfurt am Main",
            "region": null,
            "country": "DE"
        },
        "deliveryContact": {
            "name": "Eurosender SARL",
            "phone": "+442031292884"
        },
        "pickupDate": "2025-02-12T00:00:00+01:00",
        "addOns": [
            {
                "code": "early_pickup_fee",
                "price": {
                    "original": {
                        "currencyCode": "EUR",
                        "gross": 200.0,
                        "net": 200.0
                    },
                    "converted": null
                }
            }
        ],
        "pickupType": "new_pickup_request",
        "routeDistance": 232.0
    },
    "estimatedDeliveryTime": "2-5",
    "price": {
        "original": {
            "currencyCode": "EUR",
            "gross": 750.0,
            "net": 750.0
        },
        "converted": null
    },
    "discount": null,
    "coupon": null,
    "insurance": null,
    "isCallRequired": false,
    "isLabelRequired": false,
    "labelLink": "",
    "labelFormat": "pdf",
    "comment": "",
    "customerInternalReference": null,
    "customerBillingReference": null,
    "documents": [],
    "created": "2025-02-11T12:50:50+01:00"
}
```
```

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

### Order Creation Response and Order Info

Source: https://sandbox-api.eurosender.com/docs

This is an example of the response received after creating an order, which also serves as the structure for retrieving order information. It includes details like order code, status, service type, and shipment information, potentially including fees like `early_pickup_fee`.

```json
{
    "orderCode": "237548-25",
    "status": "Deferred Payment",
    "serviceType": "ftl",
    "language": "en",
    "email": "name@example.com",
    "paymentMethod": "deferred",
    "currencyCode": "EUR",
    "vatRate": "0%",
    "parcels": {
        "envelopes": [],
        "packages": [],
        "pallets": [],
        "vans": [],
        "ltls": [
            {
                "parcelId": "V00001",
                "orderCode": "237548-25",
                "euroPalletQuantity": 12,
                "loadingMeters": null,
                "weight": 3600.0,
                "price": {
                    "original": {
                        "currencyCode": "EUR",
                        "gross": 550.0,
                        "net": 550.0
                    },
                    "converted": null
                }
            }
        ],
        "ftls": [],
        "nonStandard": []
    },
    "courier": {
        "id": 49,
        "shortName": "Eurosender",
        "countryCode": "",
        "email": "",
        "phone": ""
    },
    "shipment": {
        "pickupAddress": {
            "street": "9 Rue du Laboratoire",
            "zip": "1911",
            "city": "Luxembourg",
            "region": null,
            "country": "LU"
        },
        "pickupContact": {
          "name": "Eurosender SARL",
          "phone": "+442031292884"
        },
        "deliveryAddress": {
            "street": "Bernhard-Grzimek-Allee 1",
            "zip": "60316",
            "city": "Frankfurt am Main",
            "region": null,
            "country": "DE"
        },
        "deliveryContact": {
            "name": "Eurosender SARL",
            "phone": "+442031292884"
        },
        "pickupDate": "2025-02-12T00:00:00+01:00",
        "addOns": [
            {
                "code": "early_pickup_fee",
                "price": {
                    "original": {
                        "currencyCode": "EUR",
                        "gross": 200.0,
                        "net": 200.0
                    },
                    "converted": null
                }
            }
        ],
        "pickupType": "new_pickup_request",
        "routeDistance": 232.0
    },
    "estimatedDeliveryTime": "2-5",
    "price": {
        "original": {
            "currencyCode": "EUR",
            "gross": 750.0,
            "net": 750.0
        },
        "converted": null
    },
    "discount": null,
    "coupon": null,
    "insurance": null,
    "isCallRequired": false,
    "isLabelRequired": false,
    "labelLink": "",
    "labelFormat": "pdf",
    "comment": "",
    "customerInternalReference": null,
    "customerBillingReference": null,
    "documents": [],
    "created": "2025-02-11T12:50:50+01:00"
}
```

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

### GET /v1/orders/{orderCode}/documents/{id}

Source: https://sandbox-api.eurosender.com/docs.json

Retrieves order-related documents such as invoices or labels. The document ID can be found in the 'documents' array of the POST /v1/orders or GET /v1/orders/{orderCode} responses. Specify 'application/pdf' or 'x-application/zpl' in the Accept header for desired document format.

```APIDOC
## GET /v1/orders/{orderCode}/documents/{id}

### Description
Retrieves order-related documents (e.g., Invoice, Label). The document ID is obtained from the `documents` array in the response of `POST /v1/orders` or `GET /v1/orders/{orderCode}`.

### Method
GET

### Endpoint
`/v1/orders/{orderCode}/documents/{id}`

### Parameters
#### Path Parameters
- **orderCode** (string) - Required - The unique code of the order.
- **id** (string) - Required - The unique identifier of the document.

#### Headers
- **x-api-key** (string) - Required - Your API key.
- **Accept** (string) - Required - Specifies the desired document format. Use `application/pdf` for PDF or `x-application/zpl` for ZPL format.
```

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

### GET /v1/countries

Source: https://sandbox-api.eurosender.com/docs.json

Retrieves the collection of countries supported by the API.

```APIDOC
## GET /v1/countries

### Description
Retrieves the collection of countries.

### Method
GET

### Endpoint
/v1/countries

### Response
#### Success Response (200)
- **CountryResponse** (array) - A collection of country objects.
```

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

### GET /v1/orders/{orderCode}/labels

Source: https://sandbox-api.eurosender.com/docs.json

Retrieves the shipping labels for a specific order.

```APIDOC
## GET /v1/orders/{orderCode}/labels

### Description
Retrieves labels document. For labels in PDF format use "application/pdf" Accept header, for labels in ZPL (Zebra) use "x-application/zpl" Accept header.

### Method
GET

### Endpoint
/v1/orders/{orderCode}/labels

### Parameters
#### Path Parameters
- **orderCode** (string) - Required - Order code of existing order

### Response
#### Success Response (200)
- **OrderLabelRequest** (object) - Label resource
```

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

### Order Information Response

Source: https://sandbox-api.eurosender.com/docs.json

Example of the API response for an order, containing status, pricing, shipment details, and potential add-on fees like pickup date charges.

```json
{
    "orderCode": "237548-25",
    "status": "Deferred Payment",
    "serviceType": "ftl",
    "language": "en",
    "email": "name@example.com",
    "paymentMethod": "deferred",
    "currencyCode": "EUR",
    "vatRate": "0%",
    "parcels": {
        "envelopes": [],
        "packages": [],
        "pallets": [],
        "vans": [],
        "ltls": [
            {
                "parcelId": "V00001",
                "orderCode": "237548-25",
                "euroPalletQuantity": 12,
                "loadingMeters": null,
                "weight": 3600.0,
                "price": {
                    "original": {
                        "currencyCode": "EUR",
                        "gross": 550.0,
                        "net": 550.0
                    },
                    "converted": null
                }
            }
        ],
        "ftls": [],
        "nonStandard": []
    },
    "courier": {
        "id": 49,
        "shortName": "Eurosender",
        "countryCode": "",
        "email": "",
        "phone": ""
    },
    "shipment": {
        "pickupAddress": {
            "street": "9 Rue du Laboratoire",
            "zip": "1911",
            "city": "Luxembourg",
            "region": null,
            "country": "LU"
        },
        "pickupContact": {
          "name": "Eurosender SARL",
          "phone": "+442031292884"
        },
        "deliveryAddress": {
            "street": "Bernhard-Grzimek-Allee 1",
            "zip": "60316",
            "city": "Frankfurt am Main",
            "region": null,
            "country": "DE"
        },
        "deliveryContact": {
            "name": "Eurosender SARL",
            "phone": "+442031292884"
        },
        "pickupDate": "2025-02-12T00:00:00+01:00",
        "addOns": [
            {
                "code": "early_pickup_fee",
                "price": {
                    "original": {
                        "currencyCode": "EUR",
                        "gross": 200.0,
                        "net": 200.0
                    },
                    "converted": null
                }
            }
        ],
        "pickupType": "new_pickup_request",
        "routeDistance": 232.0
    },
    "estimatedDeliveryTime": "2-5",
    "price": {
        "original": {
            "currencyCode": "EUR",
            "gross": 750.0,
            "net": 750.0
        },
        "converted": null
    }
```

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

### GET /v1/countries

Source: https://sandbox-api.eurosender.com/docs

Retrieves the collection of countries. Requires API key authorization.

```APIDOC
## GET /v1/countries

### Description
Retrieves the collection of countries.

### Method
GET

### Endpoint
/v1/countries

### Response
#### Success Response (200)
- **CountryResponse collection** - An array of country objects.
  - **id** (integer) - Unique identifier for the country.
  - **code** (string) - ISO 3166-1 alpha-2 country code.
  - **name** (string) - Name of the country.
  - **requiresRegion** (boolean) - Indicates if region is required for addresses in this country.
  - **requiresCity** (boolean) - Indicates if city is required for addresses in this country.
  - **active** (boolean) - Indicates if the country is active.
  - **isEu** (boolean) - Indicates if the country is part of the European Union.
  - **countryCustomFields** (object) - Custom fields specific to the country.
    - **supportedServiceTypeIds** (Array of integers) - List of supported service type IDs.
    - **customFields** (Array of objects) - Array of custom field definitions.
      - **name** (string) - Name of the custom field.
      - **type** (string) - Type of the custom field.
      - **length** (integer) - Maximum length of the field (if applicable).
      - **required** (boolean) - Whether the field is required.
      - **options** (Array of strings) - Possible options for the field (if applicable).
      - **label** (string) - Label for the custom field.
      - **additionalInfo** (string) - Additional information about the field.
      - **placeholder** (string) - Placeholder text for the field.

#### Response Example
```json
[
  {
    "id": 123,
    "code": "LU",
    "name": "Luxembourg",
    "requiresRegion": false,
    "requiresCity": false,
    "active": true,
    "isEu": true,
    "countryCustomFields": {
      "supportedServiceTypeIds": [
        0
      ],
      "customFields": [
        {
          "name": "string",
          "type": "string",
          "length": null,
          "required": true,
          "options": [
            "string"
          ],
          "label": "string",
          "additionalInfo": "string",
          "placeholder": null
        }
      ]
    }
  }
]
```
```

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

### GET /v1/orders/{orderCode}/tracking

Source: https://sandbox-api.eurosender.com/docs

Retrieves the delivery tracking status for an order.

```APIDOC
## GET /v1/orders/{orderCode}/tracking

### Description
Retrieves details about delivery status of an order. Please revert to us to enable the endpoint for you.

### Method
GET

### Endpoint
/v1/orders/{orderCode}/tracking

### Parameters
#### Path Parameters
- **orderCode** (string) - Required - Order code of existing order

### Response
#### Success Response (200)
- TrackingDetailsResponse resource

#### Error Response (404)
- Resource not found
```

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

### GET /v1/orders/{orderCode}/labels

Source: https://sandbox-api.eurosender.com/docs

Retrieves the labels document for a specific order.

```APIDOC
## GET /v1/orders/{orderCode}/labels

### Description
Retrieves labels document. For labels in PDF format use "application/pdf" Accept header, for labels in ZPL (Zebra) use "x-application/zpl" Accept header.

### Method
GET

### Endpoint
/v1/orders/{orderCode}/labels

### Parameters
#### Path Parameters
- **orderCode** (string) - Required - Order code of existing order

### Response
#### Success Response (200)
- OrderLabelRequest resource

#### Error Response (404)
- Resource not found
```

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

### POST /v1/orders/fast_label

Source: https://sandbox-api.eurosender.com/docs.json

Creates a new basic order with an associated shipping label.

```APIDOC
## POST /v1/orders/fast_label

### Description
Creates a new basic order with label.

### Method
POST

### Endpoint
/v1/orders/fast_label

### Request Body
- **OrderRequest** (object) - Required - The new OrderRequest resource

### Response
#### Success Response (201)
- **FastLabelOrderResponse** (object) - OrderRequest resource created
```

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

### GET /v1/orders/{orderCode}/labels

Source: https://sandbox-api.eurosender.com/docs

Retrieves the shipping label for a specific order.

```APIDOC
## GET /v1/orders/{orderCode}/labels

### Description
Retrieves the order label. Use 'application/pdf' or 'x-application/zpl' in the Accept header to specify the format.

### Method
GET

### Endpoint
/v1/orders/{orderCode}/labels

### Parameters
#### Path Parameters
- **orderCode** (string) - Required - The unique order code.

### Headers
- **Accept** (string) - Required - 'application/pdf' or 'x-application/zpl'
```

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

### GET /v1/orders/{orderCode}

Source: https://sandbox-api.eurosender.com/docs

Retrieves details about an existing order using its unique code.

```APIDOC
## GET /v1/orders/{orderCode}

### Description
Retrieves details about an existing order using its unique code.

### Method
GET

### Endpoint
https://api.eurosender.com/v1/orders/{orderCode}
https://sandbox-api.eurosender.com/v1/orders/{orderCode}

### Authorizations
_x_api_key_

### Path Parameters
- **orderCode** (string) - Required - OrderRequest identifier

### Responses
#### Success Response (200)
OrderRequest resource

#### Error Response (404)
Resource not found
```

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

### List of regions for country response

Source: https://sandbox-api.eurosender.com/docs

Example JSON response for the region list endpoint.

```json
[
  {
    "id": 6,
    "name": "County Dublin",
    "code": null
  }
]
```

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

### Order Creation Request Structure

Source: https://sandbox-api.eurosender.com/docs.json

Example of the JSON payload structure for creating a shipment order, including contact details, addresses, and parcel specifications.

```json
{
            "name": "Eurosender SARL",
            "email": "name@example.com",
            "phone": "+442031292884"
        },
        "pickupAddress": {
            "zip": "1911",
            "city": "Luxembourg",
            "street": "9 Rue du Laboratoire",
            "country": "LU"
        },
        "deliveryAddress": {
            "zip": "60316",
            "city": "Frankfurt am Main",
            "street": "Bernhard-Grzimek-Allee 1",
            "country": "DE"
        },
        "pickupDate": "2025-02-12"
    },
    "parcels": {
        "ltls": [
            {
                "parcelId": "V00001",
                "euroPalletQuantity": 12,
                "weight": 3600,
                "notes": "12x 120x80x220cm, 300kg/pallet, total weight: 3.600kg, not-stackable, boxes with a spare parts packed on pallets"
            }
        ]
    },
    "orderContact": {
        "email": "name@example.com"
    }
}
```

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

### POST /v1/pudo/list

Source: https://sandbox-api.eurosender.com/docs

Retrieves a list of PUDO (Pick-Up Drop-Off) points for creating orders with service types: door_to_shop, shop_to_door, and shop_to_shop.

```APIDOC
## POST /v1/pudo/list

### Description
Retrieves a list of PUDO (Pick-Up Drop-Off) points for creating orders with the following service types: door_to_shop, shop_to_door, and shop_to_shop.

### Method
POST

### Endpoint
/v1/pudo/list

### Parameters
#### Request Body
- **courierId** (integer) - Required - ID of the courier
- **country** (string) - Required - Country code
- **geolocation** (object) - Optional - Geolocation coordinates (mandatory if address is null)
- **address** (object) - Optional - Postal address (mandatory if geolocation is null)
- **pickupDate** (string) - Optional - Date-time of pickup
- **distanceFromLocation** (integer) - Required - Search radius
- **parcels** (object) - Required - Parcel details
- **resultsLimit** (integer) - Optional - Limit of results
- **filterBySide** (string) - Required - Enum: "pickupSide", "deliverySide"

### Request Example
{
  "courierId": 0,
  "country": "string",
  "geolocation": {
    "latitude": -90,
    "longitude": -180
  },
  "address": {
    "street": "9 Rue du Laboratoire",
    "city": "Luxembourg",
    "zip": "1911"
  },
  "distanceFromLocation": 0,
  "parcels": {},
  "filterBySide": "pickupSide"
}

### Response
#### Success Response (200)
- **list** (array) - List of PUDO points

#### Response Example
{
  "list": [
    {
      "pudoPointCode": "string",
      "locationName": "string",
      "street": "string",
      "zip": "string",
      "city": "string"
    }
  ]
}
```

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

### GET /v1/pickup/{orderCode}/availability

Source: https://sandbox-api.eurosender.com/docs

Provides available pickup times for an order with independent pickup.

```APIDOC
## GET /v1/pickup/{orderCode}/availability

### Description
Provides available pickup times for an order placed with independentPickup: true.

### Method
GET

### Endpoint
/v1/pickup/{orderCode}/availability

### Parameters
#### Path Parameters
- **orderCode** (string) - Required - Order code

### Response
#### Success Response (200)
- **pickupDate** (string|null) - Date of pickup
- **timeFrom** (array) - Available start times
- **timeTo** (array) - Available end times

#### Response Example
[
  {
    "pickupDate": null,
    "timeFrom": ["09:00", "09:30", "10:00", "10:30", "11:00"],
    "timeTo": ["13:00", "13:30", "14:00", "14:30"]
  }
]
```
Tokens:
Raw