GET orders¶

Retrieve a paginated list of orders with optional filtering.

Endpoint¶

GET https://dropday.io/api/v1/orders

Query parameters¶

Parameter	Type	Description
external_id `optional`	String	Filter by external order ID. Supports partial match.
date_from `optional`	String	Filter orders created on or after this date. ISO 8601 format (e.g., `2025-09-22T10:30:00`).
date_to `optional`	String	Filter orders created on or before this date. ISO 8601 format (e.g., `2025-09-22T23:59:59`).
completed_since `optional`	String	Filter orders completed after this timestamp. ISO 8601 format (e.g., `2025-09-22T10:30:00`). Compares against the order's `completed_at` field.
statuses `optional`	String	Comma-separated list of statuses to filter. Values: `completed`, `partially_completed`, `failed`, `pending`, `ruled`, `declined`, `skipped`.
supplier_ids `optional`	String	Comma-separated list of supplier IDs to filter orders by supplier.
total_min `optional`	Number	Filter orders with a total amount greater than or equal to this value.
total_max `optional`	Number	Filter orders with a total amount less than or equal to this value.
blocked `optional`	Boolean	Filter by blocked status. Set to `true` to show only blocked orders, `false` for non-blocked orders.
include_test `optional`	Boolean	Set to `true` to include test orders in the results. Test orders are excluded by default.
per_page `optional`	Number	Number of results per page. Maximum `100`, default `50`.

See Orders for the response field reference.

Request¶

curl -X GET "https://dropday.io/api/v1/orders?statuses=pending,completed&date_from=2025-09-01T00:00:00&per_page=25" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "api-key: tdh7nNUp3DZAHsMtw3dQYhDsm3wf593hMGbyXP6Y5R8DTF2Rwy4QCvkWFYQb" \
  -H "account-id: 101"

Response¶

200401500

{
    "current_page": 1,
    "data": [
        {
            "id": 1542,
            "external_id": "ORD-2025-00142",
            "reference": "123",
            "source": "Example Shop",
            "test": false,
            "blocked": false,
            "total": 156.45,
            "shipping_address": {
                "email": "[email protected]",
                "first_name": "Jane",
                "last_name": "Smith",
                "company_name": null,
                "phone": "+1 555 123 4567",
                "address1": "123 Main Street",
                "address2": "Apt 4B",
                "city": "New York",
                "postcode": "10001",
                "state": "NY",
                "country": "US"
            },
            "shipping": {
                "cost": 5.95,
                "name": "DHL Express",
                "description": "Next day delivery",
                "note": "Leave at front door",
                "delivery_date": "2025-09-25"
            },
            "custom": {
                "gift_wrap": true,
                "gift_message": "Happy Birthday!"
            },
            "order_lines": [
                {
                    "id": 3201,
                    "external_id": "PROD-001",
                    "name": "Wireless Headphones",
                    "ean13": "8712345678901",
                    "reference": "WH-PRO-BLK",
                    "quantity": 1,
                    "stock_quantity": 150,
                    "price": 89.99,
                    "purchase_price": 45.00,
                    "height": 8.5,
                    "width": 18,
                    "length": 20,
                    "weight": 0.25,
                    "brand": "AudioTech",
                    "category": "Electronics",
                    "image_url": "https://example.org/images/headphones.jpg",
                    "custom": {
                        "color": "Black",
                        "warranty": "2 years"
                    },
                    "labels": ["fragile", "gift"],
                    "current_status": "completed",
                    "supplier": "AudioTech Wholesale",
                    "matched_supplier": {
                        "id": 5,
                        "name": "TechSupply Co."
                    }
                },
                {
                    "id": 3202,
                    "external_id": "PROD-002",
                    "name": "Phone Case",
                    "ean13": "8712345678902",
                    "reference": "PC-IP15-CLR",
                    "quantity": 2,
                    "stock_quantity": 500,
                    "price": 29.99,
                    "purchase_price": 12.50,
                    "height": 1.2,
                    "width": 8,
                    "length": 16,
                    "weight": 0.04,
                    "brand": "CaseMaster",
                    "category": "Accessories",
                    "image_url": "https://example.org/images/phonecase.jpg",
                    "custom": null,
                    "labels": [],
                    "current_status": "completed",
                    "supplier": "CaseMaster Direct",
                    "matched_supplier": {
                        "id": 12,
                        "name": "AccessoryWorld"
                    }
                }
            ],
            "suppliers": [
                {
                    "id": 5,
                    "name": "TechSupply Co."
                },
                {
                    "id": 12,
                    "name": "AccessoryWorld"
                }
            ],
            "created_at": "2025-09-22T14:30:00.000000Z",
            "updated_at": "2025-09-23T09:15:22.000000Z",
            "completed_at": "2025-09-23T09:15:22.000000Z"
        },
        {
            "id": 1541,
            "external_id": "ORD-2025-00141",
            "reference": "DD-98541",
            "source": "Example Shop",
            "test": false,
            "blocked": false,
            "total": 67.50,
            "shipping_address": {
                "email": "[email protected]",
                "first_name": "John",
                "last_name": "Doe",
                "company_name": "Doe Enterprises",
                "phone": "+1 555 987 6543",
                "address1": "456 Oak Avenue",
                "address2": null,
                "city": "Los Angeles",
                "postcode": "90001",
                "state": "CA",
                "country": "US"
            },
            "shipping": {
                "cost": 3.50,
                "name": "Standard Shipping",
                "description": "3-5 business days",
                "note": null,
                "delivery_date": null
            },
            "custom": null,
            "order_lines": [
                {
                    "id": 3200,
                    "external_id": "PROD-003",
                    "name": "USB-C Cable 2m",
                    "ean13": "8712345678903",
                    "reference": "USBC-2M",
                    "quantity": 3,
                    "stock_quantity": 1000,
                    "price": 12.99,
                    "purchase_price": 5.00,
                    "height": 1,
                    "width": 8,
                    "length": 12,
                    "weight": 0.08,
                    "brand": "CablePro",
                    "category": "Cables",
                    "image_url": "https://example.org/images/cable.jpg",
                    "custom": null,
                    "labels": [],
                    "current_status": "pending",
                    "supplier": "CablePro",
                    "matched_supplier": {
                        "id": 5,
                        "name": "TechSupply Co."
                    }
                }
            ],
            "suppliers": [
                {
                    "id": 5,
                    "name": "TechSupply Co."
                }
            ],
            "created_at": "2025-09-22T10:15:00.000000Z",
            "updated_at": "2025-09-22T10:15:00.000000Z",
            "completed_at": null
        }
    ],
    "links": {
        "first": "https://dropday.io/api/v1/orders?page=1",
        "last": "https://dropday.io/api/v1/orders?page=5",
        "prev": null,
        "next": "https://dropday.io/api/v1/orders?page=2"
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 5,
        "path": "https://dropday.io/api/v1/orders",
        "per_page": 50,
        "to": 50,
        "total": 234
    }
}

{
    "message": "Unauthorized",
    "error": "Invalid or missing api-key or account-id header"
}

{
    "message": "Internal Server Error",
    "error": "An unexpected error occurred. Please try again later."
}