Connect another platform through the API

For BigCommerce, Lightspeed and Squarespace, the platform chooser under Store Integration tells you to use the Dropday API. Any system that can forward orders, such as your own script, an order management system or a connector tool, can create orders in Dropday this way. It takes technical work on your side.

This is the Dropday API, through which orders come into Dropday. It isn't the API Call delivery method, which sends orders from Dropday to a supplier.

The Dropday API documentation is the technical reference. Its pages Authentication and POST orders cover the connection and the order request in full.

What you need

Your API key and your Account ID. To find them, go to Store Integration and choose the DropdayAPI tile on the screen Choose your e-commerce platform. Under Developers information, that page lists API-key and Account-ID, each with a Copy button.

Send an order

You create an order with a POST request to https://dropday.io/api/v1/orders. Every request needs the headers api-key with your API key and account-id with your Account ID, and the header Content-Type: application/json. Every product in the request becomes an order line of the new order.

The optional fields are in POST orders in the API documentation.

Example: an order request

This example is illustrative: the order data is made up. Replace YOUR_API_KEY and YOUR_ACCOUNT_ID with your own values, and the order data with your order's.

The request line and headers:

POST https://dropday.io/api/v1/orders
api-key: YOUR_API_KEY
account-id: YOUR_ACCOUNT_ID
Content-Type: application/json

The body below holds the fields Dropday checks on every order: external_id, source, total, a shipping_address with first_name, last_name, address1, postcode and city, and at least one product with external_id, name, quantity and price.

{
  "external_id": "1001",
  "source": "manual",
  "total": 49.90,
  "shipping_address": {
    "first_name": "Alex",
    "last_name": "Example",
    "address1": "Sample Street 1",
    "postcode": "1000 AA",
    "city": "Sampletown",
    "country_iso": "NL"
  },
  "products": [
    {
      "external_id": "SKU-001",
      "name": "Sample product",
      "quantity": 2,
      "price": 24.95
    }
  ]
}

The example also gives the shipping country as country_iso, a valid two-letter code in capitals such as NL; Dropday then fills in the country name. You can send country with the country name instead. Dropday accepts an order without a country too, but a shipping address normally needs one.

external_id is your order's own number, and source can be any value, for example manual. When Dropday accepts the request, it creates the order, here with one order line, and the order follows your rules and is sent to the supplier like any other order.

Example: add a delivery date

A delivery date goes in shipping.delivery_date, in the format DD-MM-YYYY. Add it to the body of the first example, with your own date:

{
  "shipping": {
    "delivery_date": "24-10-2026"
  }
}

Example: the same order twice

If you send an order with an external_id that already exists in your account, Dropday rejects it with HTTP status 422 and doesn't create a second order.

Orders and products can also carry your own fields with simple values, and products can carry labels. You can use the custom fields in supplier emails and files.

Test before going live

When an order comes in, your rules choose the supplier for each order line, and Dropday sends the lines through that supplier's active delivery methods. An order line was not sent to a supplier explains when a line isn't sent, for example because the supplier holds orders for review.

For a trial on real orders, send them as test orders through the API rather than through your webshop.

To send a test order, add "test": true to the order body, at the top level next to external_id and source. Without it, the order isn't a test order. Add it to the body of the first example:

{
  "external_id": "1001",
  "source": "manual",
  "test": true
}

Test orders are still emailed to suppliers, with "TEST EMAIL:" at the start of the subject. FTP Upload and API Call don't place test orders at the supplier. Orders are also processed as test orders while your account's billing details are incomplete.

Check that orders come in

After sending an order, open Orders in Dropday and check that it's in the list.

Bring in existing orders

A developer or script can add existing orders through the API, one at a time. This is the route for existing orders on Magento and Wix, and for large batches on any platform.

Good to know

• The Dropday API allows 60 requests per minute. The limit counts per IP address, not per account.

• For Laravel, the official package dropday-io/laravel has a client whose createOrder call sends an order to the order API.

Next, add a supplier.