List Clients

Get the list of logistics clients with registered shipments

GET /api/v1/logistics/clients

List Clients

JavaScript

const options = {
  method: 'GET',
  headers: {
    'x-api-key': '<x-api-key>',
    'x-organization-id': '<x-organization-id>',
    'x-user-id': '<x-user-id>'
  }
};

fetch('https://api.dcycle.io/api/v1/logistics/clients', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

200

{
  "clients": [
    {}
  ]
}

List Logistics Clients

Legacy API. This page documents the previous version of the API. For new integrations use List Clients instead. Mind the response shape: this endpoint returns {"clients": [...]} and the current one returns a plain array.

Get the list of all unique clients that have registered shipments in the system. Useful for populating selectors or verifying that your uploads were processed correctly.

Request

Headers

x-api-key · string · required

Your API key for authentication

Example: sk_live_1234567890abcdef

x-organization-id · string · required

Your organization UUID

Example: ff4adcc7-8172-45fe-9cf1-e90a6de53aa9

x-user-id · string · required

Your user UUID

Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890

This endpoint requires no query parameters. It returns all unique clients for your organization.

Response

clients · array

Array of unique client names

Example: ["Correos Express", "DHL", "SEUR"]

Example

cURL

curl -X GET "https://api.dcycle.io/api/v1/logistics/clients" \
  -H "Authorization: Bearer ${DCYCLE_API_KEY}" \
  -H "x-organization-id: ${DCYCLE_ORG_ID}" \
  -H "x-user-id: ${DCYCLE_USER_ID}"

Successful Response

[
  "Correos Express",
  "DHL",
  "SEUR",
  "MRW"
]

Use Cases

Verify Upload

After uploading a CSV, verify that the client appears in the list:

# Upload CSV
upload_csv("correos_shipments.csv")

# Wait for processing
time.sleep(30)

# Verify
clients = get_clients()
if "Correos Express" in clients:
    print("✅ Upload processed successfully")
else:
    print("⚠️ Client not available yet, wait longer")

Populate UI Selector

// Get clients for a dropdown
const clients = await getClients();

const selectElement = document.getElementById('client-selector');
clients.forEach(client => {
  const option = document.createElement('option');
  option.value = client;
  option.text = client;
  selectElement.add(option);
});

Validate Client Name

Before generating a report, verify that the client exists:

def generate_report(client_name, start_date, end_date):
    # Validate that the client exists
    available_clients = get_clients()

    if client_name not in available_clients:
        raise ValueError(
            f"Client '{client_name}' not found. "
            f"Available: {', '.join(available_clients)}"
        )

    # Generate report
    return get_report(client_name, start_date, end_date)

Notes

The client list is dynamically generated based on the shipments you’ve uploaded. If you just completed an upload, wait a few seconds for processing to finish.

Client names are case-sensitive. "Correos Express" and "correos express" are considered different.

Related Endpoints

Get Report

Generate report for a client

Upload CSV

Upload bulk shipments