Expedico API

https://expedico.eu/api-docs
Admin
Expedico API is a shipping and logistics management API that provides functionality for managing...
Tokens:3,321
Snippets:10
Trust Score:7.3
Update:7 months ago
Show doc for...
Tokens:
Raw
### Returns API

Source: https://expedico.eu/api-docs

Endpoints for managing shelved returns.

```APIDOC
## GET /api/v2/returns_shelved

### Description
Retrieves a list of shelved returns.

### Method
GET

### Endpoint
/api/v2/returns_shelved

### Response
#### Success Response (200)
- **returns** (ReturnsShelvedResponse) - A list of shelved returns.

#### Response Example
```json
{
  "returns": [
    {
      "id": "r1",
      "status": "received"
    }
  ]
}
```
```

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

### Currency API

Source: https://expedico.eu/api-docs

Endpoints for retrieving currency information.

```APIDOC
## GET /api/v2/currencies

### Description
Retrieves a list of available currencies.

### Method
GET

### Endpoint
/api/v2/currencies

### Response
#### Success Response (200)
- **currencies** (CurrenciesResponse) - A list of currencies.

#### Response Example
```json
{
  "currencies": [
    {
      "code": "USD",
      "name": "United States Dollar"
    },
    {
      "code": "EUR",
      "name": "Euro"
    }
  ]
}
```
```

```APIDOC
## GET /api/v2/currencies/{id}

### Description
Retrieves a specific currency by its ID.

### Method
GET

### Endpoint
/api/v2/currencies/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the currency.

### Response
#### Success Response (200)
- **currency** (CurrencyResponse) - Details of the requested currency.

#### Response Example
```json
{
  "currency": {
    "code": "USD",
    "name": "United States Dollar"
  }
}
```
```

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

### Pickup Point API

Source: https://expedico.eu/api-docs

Endpoints for retrieving pickup point information.

```APIDOC
## GET /api/v2/pickup_points

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

### Method
GET

### Endpoint
/api/v2/pickup_points

### Parameters
#### Query Parameters
- **countryCode** (string) - Optional - Filter by country code.
- **city** (string) - Optional - Filter by city.

### Response
#### Success Response (200)
- **pickupPoints** (PickupPointsResponse) - A list of pickup points.

#### Response Example
```json
{
  "pickupPoints": [
    {
      "id": "pp1",
      "name": "Main Street Pickup",
      "address": "456 Oak Ave, Anytown, 12345"
    }
  ]
}
```
```

```APIDOC
## GET /api/v2/pickup_points/{id}

### Description
Retrieves a specific pickup point by its ID.

### Method
GET

### Endpoint
/api/v2/pickup_points/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the pickup point.

### Response
#### Success Response (200)
- **pickupPoint** (PickupPointResponse) - Details of the requested pickup point.

#### Response Example
```json
{
  "pickupPoint": {
    "id": "pp1",
    "name": "Main Street Pickup",
    "address": "456 Oak Ave, Anytown, 12345"
  }
}
```
```

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

### Box API

Source: https://expedico.eu/api-docs

Endpoints for managing boxes and assigning them to parcels.

```APIDOC
## POST /api/v2/boxes_assign

### Description
Assigns boxes to parcels.

### Method
POST

### Endpoint
/api/v2/boxes_assign

### Parameters
#### Request Body
- **request** (AssignBoxesRequest) - Required - Details for assigning boxes.

### Request Example
```json
{
  "request": {
    "parcelId": "p12345",
    "boxId": "b1"
  }
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.

#### Response Example
```json
{
  "message": "Box assigned to parcel successfully."
}
```
```

```APIDOC
## GET /api/v2/boxes

### Description
Retrieves a list of boxes.

### Method
GET

### Endpoint
/api/v2/boxes

### Response
#### Success Response (200)
- **boxes** (BoxesResponse) - A list of boxes.

#### Response Example
```json
{
  "boxes": [
    {
      "id": "b1",
      "name": "Small Box"
    }
  ]
}
```
```

```APIDOC
## POST /api/v2/boxes

### Description
Creates a new box.

### Method
POST

### Endpoint
/api/v2/boxes

### Parameters
#### Request Body
- **box** (BoxRequest) - Required - Details of the box to create.

### Request Example
```json
{
  "box": {
    "name": "Medium Box",
    "dimensions": {
      "width": 30,
      "height": 20,
      "depth": 10,
      "unit": "cm"
    }
  }
}
```

### Response
#### Success Response (200)
- **box** (BoxResponse) - Details of the created box.

#### Response Example
```json
{
  "box": {
    "id": "b2",
    "name": "Medium Box"
  }
}
```
```

```APIDOC
## GET /api/v2/boxes/{id}

### Description
Retrieves a specific box by its ID.

### Method
GET

### Endpoint
/api/v2/boxes/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the box.

### Response
#### Success Response (200)
- **box** (BoxResponse) - Details of the requested box.

#### Response Example
```json
{
  "box": {
    "id": "b1",
    "name": "Small Box"
  }
}
```
```

```APIDOC
## GET /api/v2/boxes/{boxes_id}/label

### Description
Retrieves the label for a specific box.

### Method
GET

### Endpoint
/api/v2/boxes/{boxes_id}/label

### Parameters
#### Path Parameters
- **boxes_id** (string) - Required - The ID of the box.

### Response
#### Success Response (200)
- **label** (LabelResponse) - The label data for the box.

#### Response Example
```json
{
  "label": {
    "format": "PNG",
    "data": "iVBORw0KGgoAAAANSUhEUgAA..."
  }
}
```
```

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

### Label Collection API

Source: https://expedico.eu/api-docs

Endpoints for managing label collections.

```APIDOC
## POST /api/v2/label_collections

### Description
Creates a new label collection.

### Method
POST

### Endpoint
/api/v2/label_collections

### Parameters
#### Request Body
- **request** (LabelCollectionRequest) - Required - Details for the label collection.

### Request Example
```json
{
  "request": {
    "parcelIds": ["p12345", "p67890"]
  }
}
```

### Response
#### Success Response (200)
- **labelCollection** (LabelCollectionResponse) - Details of the created label collection.

#### Response Example
```json
{
  "labelCollection": {
    "id": "lc1",
    "status": "processing"
  }
}
```
```

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

### Tracking API

Source: https://expedico.eu/api-docs

Endpoints for managing and retrieving parcel tracking information.

```APIDOC
## GET /api/v2/parcels_tracking

### Description
Retrieves tracking information for multiple parcels.

### Method
GET

### Endpoint
/api/v2/parcels_tracking

### Parameters
#### Query Parameters
- **parcelIds** (Array<string>) - Required - A list of parcel IDs to track.

### Response
#### Success Response (200)
- **trackingInfo** (Array<ParcelsTrackingResponse>) - Tracking information for the specified parcels.

#### Response Example
```json
{
  "trackingInfo": [
    {
      "parcelId": "p12345",
      "trackingNumber": "TRK123456789",
      "status": "in_transit"
    }
  ]
}
```
```

```APIDOC
## POST /api/v2/parcels_tracking

### Description
Creates tracking for parcels.

### Method
POST

### Endpoint
/api/v2/parcels_tracking

### Parameters
#### Request Body
- **parcelIds** (ParcelIdsRequest) - Required - The IDs of the parcels to create tracking for.

### Request Example
```json
{
  "parcelIds": ["p12345", "p67890"]
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.

#### Response Example
```json
{
  "message": "Tracking created for specified parcels."
}
```
```

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

### Country API

Source: https://expedico.eu/api-docs

Endpoints for retrieving country information.

```APIDOC
## GET /api/v2/countries

### Description
Retrieves a list of available countries.

### Method
GET

### Endpoint
/api/v2/countries

### Response
#### Success Response (200)
- **countries** (CountriesResponse) - A list of countries.

#### Response Example
```json
{
  "countries": [
    {
      "code": "US",
      "name": "United States"
    },
    {
      "code": "DE",
      "name": "Germany"
    }
  ]
}
```
```

```APIDOC
## GET /api/v2/countries/{id}

### Description
Retrieves a specific country by its ID.

### Method
GET

### Endpoint
/api/v2/countries/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the country.

### Response
#### Success Response (200)
- **country** (CountryResponse) - Details of the requested country.

#### Response Example
```json
{
  "country": {
    "code": "US",
    "name": "United States"
  }
}
```
```

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

### Carrier API

Source: https://expedico.eu/api-docs

Endpoints for retrieving carrier information.

```APIDOC
## GET /api/v2/carriers

### Description
Retrieves a list of available carriers.

### Method
GET

### Endpoint
/api/v2/carriers

### Response
#### Success Response (200)
- **carriers** (CarriersResponse) - A list of carriers.

#### Response Example
```json
{
  "carriers": [
    {
      "id": "c1",
      "name": "Expedico Express"
    }
  ]
}
```
```

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

### Parcel Management API

Source: https://expedico.eu/api-docs

Endpoints for creating, retrieving, and managing parcels. Includes tracking and label generation functionalities.

```APIDOC
## POST /api/v2/parcels

### Description
Creates a new parcel.

### Method
POST

### Endpoint
/api/v2/parcels

### Parameters
#### Request Body
- **parcel** (ParcelRequest) - Required - Details of the parcel to be created.

### Request Example
```json
{
  "parcel": {
    "recipient": {
      "name": "John Doe",
      "street": "123 Main St",
      "city": "Anytown",
      "postalCode": "12345",
      "countryCode": "US"
    },
    "weight": {
      "value": 1.5,
      "unit": "kg"
    }
  }
}
```

### Response
#### Success Response (200)
- **parcel** (ParcelResponse) - Details of the created parcel.

#### Response Example
```json
{
  "parcel": {
    "id": "p12345",
    "status": "created"
  }
}
```
```

```APIDOC
## GET /api/v2/parcels

### Description
Retrieves a list of parcels.

### Method
GET

### Endpoint
/api/v2/parcels

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - Maximum number of parcels to return.
- **offset** (integer) - Optional - Number of parcels to skip.

### Response
#### Success Response (200)
- **parcels** (Array<ParcelResponse>) - A list of parcels.

#### Response Example
```json
{
  "parcels": [
    {
      "id": "p12345",
      "status": "created"
    },
    {
      "id": "p67890",
      "status": "shipped"
    }
  ]
}
```
```

```APIDOC
## GET /api/v2/parcels/{id}

### Description
Retrieves a specific parcel by its ID.

### Method
GET

### Endpoint
/api/v2/parcels/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the parcel to retrieve.

### Response
#### Success Response (200)
- **parcel** (ParcelResponse) - Details of the requested parcel.

#### Response Example
```json
{
  "parcel": {
    "id": "p12345",
    "status": "created",
    "recipient": {
      "name": "John Doe",
      "street": "123 Main St",
      "city": "Anytown",
      "postalCode": "12345",
      "countryCode": "US"
    }
  }
}
```
```

```APIDOC
## GET /api/v2/parcels/{parcel_id}/tracking

### Description
Retrieves tracking information for a specific parcel.

### Method
GET

### Endpoint
/api/v2/parcels/{parcel_id}/tracking

### Parameters
#### Path Parameters
- **parcel_id** (string) - Required - The ID of the parcel.

### Response
#### Success Response (200)
- **tracking** (TrackingResponse) - The tracking details for the parcel.

#### Response Example
```json
{
  "tracking": {
    "carrier": "Expedico Express",
    "trackingNumber": "TRK123456789",
    "status": "in_transit",
    "events": [
      {
        "timestamp": "2023-10-27T10:00:00Z",
        "location": "Warehouse A",
        "description": "Package received"
      }
    ]
  }
}
```
```

```APIDOC
## GET /api/v2/parcels/{parcel_id}/label

### Description
Retrieves the shipping label for a specific parcel.

### Method
GET

### Endpoint
/api/v2/parcels/{parcel_id}/label

### Parameters
#### Path Parameters
- **parcel_id** (string) - Required - The ID of the parcel.

### Response
#### Success Response (200)
- **label** (LabelResponse) - The shipping label data.

#### Response Example
```json
{
  "label": {
    "format": "PDF",
    "data": "JVBERi0xLjQKJc..."
  }
}
```
```
Tokens:
Raw