Warehouses API v1

Use the legacy Merchant API v1 warehouse endpoints to list the pickup addresses configured for the authenticated merchant or retrieve one of them by its pickup address ID.

Table of Contents

1. Variables
2. List Warehouses
3. Retrieve a Warehouse
4. Warehouse Fields
5. Use a Warehouse for Voucher Creation

Variables

• merchantAPIEndpoint: /api
• idPickupAddress: 42

Both endpoints require Merchant API authentication. See Authentication for request setup.

1. List Warehouses

GET {merchantAPIEndpoint}/warehouses?page=1&itemsPerPage=5

Query Parameters

Response

Content-Type: application/json

{
  "warehouses": [
    {
      "id_pickup_address": 42,
      "address": "10 Kifisias Avenue",
      "city": "Athens",
      "courier_account_id": "CC-12345",
      "is_default": true,
      "label": "Main warehouse",
      "postal_code": "11526"
    }
  ],
  "params": {
    "page": 1,
    "items_per_page": 5,
    "total_items": 1
  }
}

An authenticated merchant only receives warehouses associated with its own merchant profile.

2. Retrieve a Warehouse

GET {merchantAPIEndpoint}/warehouses/{idPickupAddress}

Path Parameters

Response

{
  "id_pickup_address": 42,
  "address": "10 Kifisias Avenue",
  "city": "Athens",
  "courier_account_id": "CC-12345",
  "is_default": true,
  "label": "Main warehouse",
  "postal_code": "11526"
}

If the warehouse does not exist or does not belong to the authenticated merchant, the endpoint returns:

{
  "message": "The warehouse with id 42 was not found"
}

Warehouse Fields

Use a Warehouse for Voucher Creation

Pass the warehouse's id_pickup_address as the id_pickup_address query parameter when you create a v1 shipment voucher. If it is omitted, the Merchant API uses the merchant's default warehouse.