Skip to content
Last updated

Start here

Quiqup has two APIs. They are different products, on different hosts, and most integrations only need one.

Fulfilment APILast-mile API
What it doesQuiqup holds your stock, picks it, packs it, ships itQuiqup collects a parcel you packed and delivers it
You sendProducts, inbound stock, orders against stock we holdOrders with a pickup address and a dropoff address
Hostplatform-api.quiqup.comapi-ae.quiqup.com
ReferenceFulfilment APILast-mile API

Not sure which one you are on? Which API do I need.

One credential works on both APIs. The same OAuth2 client credentials, and the same Quiqdash Bearer key, authenticate against the Fulfilment and the Last-mile host of an environment. There is nothing extra to request if you end up using both. Staging and production are a different question, answered in Environments.

One order state machine. A fulfilment order becomes a last-mile shipment once it is picked. Both APIs report the same values, in a field called state on last-mile and status on fulfilment, and both emit the same order.* webhooks, which carry it as payload.state. Order lifecycle is written once and applies to both.

What every account needs

Whichever product you are on:

  1. A business Quiqup account. Individual accounts cannot be integrated.
  2. A commercial agreement. Talk to your Business Development Manager before you build. Credentials follow the agreement, not the other way round.
  3. Account activation. Trade licence, bank card and finance details.
  4. The services you need enabled. Same Day, Next Day, 4-hour and international export are each switched on per account, by your account manager. Only Same Day is checked when an order is created, so do not rely on the API to tell you a service is off. Service types

Then pick your section

Fulfilment if Quiqup stores your stock. You will load products, book stock in, and create orders against what we hold.

Last-mile if you hold your own stock. You will create orders that name a pickup address and a dropoff address. This is also where the Shopify and WooCommerce connectors live.

Shared across both

Getting help

apisupport@quiqup.com is the technical channel. Support runs on email. See Getting help.

Before you email, read what to send in the first message. Getting those seven things right saves a round trip.