Angler Fulfilment API
Connect your own system (ERP, OMS or custom shop) to our warehouse. Send orders, read them back, keep products and stock in sync, announce returns, and get told by webhook as every order moves.
Talk to us about an integration Client login- REST and JSONHTTPS, one versioned base URL
- API keys with scopesOrders, stock and products, separately
- Signed webhooksHMAC-SHA256, retried for about two days
- Same system as our floorBuilt on Angler's own warehouse software
Overview
The Angler Fulfilment API lets your system work with our warehouse without anyone signing in. With it you can:
- send orders, read them back and cancel them before picking starts;
- read live stock levels for every product;
- add and change products (SKUs, barcodes, weights and sizes);
- announce returns and read them back.
Separately, we can push order events to your system by webhook: picked, packed, despatched with tracking, delivered, and more.
| Item | Value |
|---|---|
| Base URL | https://portal.anglerfulfilment.co.uk/api/v1 |
| Format | HTTPS, JSON request and response bodies (Content-Type: application/json) |
| Authentication | X-Api-Key header |
| Timestamps | ISO 8601 in UTC, for example 2026-11-18T09:41:07.512Z |
| Countries | ISO 3166-1 alpha-2, for example GB, IE, FR |
| Money | Decimal strings, for example "14.99". API orders are recorded in GBP |
| Weights and sizes | Grams (weight_g) and millimetres (length_mm, width_mm, height_mm) |
The API is available to Angler clients once their account is verified and the warehouse system is switched on for it. If you sell on Shopify, WooCommerce, eBay or TikTok Shop you may not need the API at all: see our platform integrations.
Quick start
KEY="afk_3f9a1c2e_..."
BASE="https://portal.anglerfulfilment.co.uk/api/v1"
# Read stock
curl -s "$BASE/inventory?limit=50" -H "X-Api-Key: $KEY"
# Create an order (safe to retry with the same external_ref)
curl -s -X POST "$BASE/orders" -H "X-Api-Key: $KEY" -H "Content-Type: application/json" -d '{
"external_ref": "WEB-10023",
"ship_to": { "name": "Alex Example", "line1": "10 Example Street", "city": "Manchester", "postcode": "M1 1AA", "country": "GB" },
"lines": [ { "sku": "TSHIRT-BLK-M", "quantity": 2 } ]
}'
# Find it again by your own reference
curl -s "$BASE/orders?search=WEB-10023&exact=true" -H "X-Api-Key: $KEY"
Authentication
Creating a key
A Client Admin creates keys in the client portal under Warehouse > Connect your store > Your own system (API keys). Give the key a name and tick the scopes it needs. Our team can also create one for you.
The full key is shown once, when it is created. We store only a hash of it, so a lost key cannot be recovered: revoke it and make a new one. Keys look like this:
afk_3f9a1c2e_Qm9vS2V5RXhhbXBsZU9ubHlOb3RSZWFsMTIz
The afk_xxxxxxxx part is the key's prefix, shown in the portal so you can tell keys apart, along with when each key was last used. Revoking a key takes effect on the next request.
Sending the key
Send the key in the X-Api-Key header on every request. The Authorization: Bearer header is not used for API keys.
GET /api/v1/orders HTTP/1.1
Host: portal.anglerfulfilment.co.uk
X-Api-Key: afk_3f9a1c2e_Qm9vS2V5RXhhbXBsZU9ubHlOb3RSZWFsMTIz
Scopes
| Scope | Portal label | Lets the key |
|---|---|---|
orders | Send orders and read them back | Create, read and cancel orders; announce and read returns |
stock | Read stock levels | Read stock and products |
products | Add and change products | Read, create and update products |
A key only ever sees your own company's data and never has Angler staff rights. It works only on the endpoints on this page; any other part of the portal (invoices, documents, messages, key and webhook management) refuses it.
Authentication errors
| HTTP | error.code | When |
|---|---|---|
| 401 | AUTH_REQUIRED | No key was sent |
| 401 | API_KEY_INVALID | The key is unknown or revoked |
| 401 | API_KEY_NOT_ALLOWED | That endpoint needs a person signed in; a key cannot use it |
| 403 | FORBIDDEN | The key does not have the scope the endpoint needs |
| 403 | WMS_NOT_ENABLED | The warehouse system is not yet switched on for your account |
| 403 | ACCOUNT_SUSPENDED | Your account is suspended or closed |
Responses and errors
Success
Every successful response has the same envelope. The request_id is also sent in the X-Request-Id header; quote it when you contact us about a request.
{
"success": true,
"data": { },
"message": null,
"request_id": "6b1f3c0e-2d7a-4f43-9a1e-5c2b8d9e0f11"
}
Errors
{
"success": false,
"error": { "code": "NOT_FOUND", "message": "Record not found." },
"request_id": "6b1f3c0e-2d7a-4f43-9a1e-5c2b8d9e0f11"
}
- Branch on the HTTP status and
error.code.error.messageis plain English and its wording may change. - A request that breaks a field rule answers
400 BAD_REQUESTwith the first problem found, for exampleship_to.country must match /^[A-Za-z]{2}$/ regular expression. - A record that does not exist, or belongs to someone else, answers
404 NOT_FOUND. - Fields that are not documented here are ignored, not rejected.
- An unexpected fault answers
500 INTERNAL_ERROR. Retry later, and tell us therequest_idif it repeats.
Pagination
List endpoints take page (from 1) and limit (default 25, at most 50 for an API key) and return:
{ "items": [ ], "pagination": { "page": 1, "limit": 25, "total": 312, "total_pages": 13 } }
Responses can include fields that are not described on this page. They are for our own use and may change, so please build only on the fields documented here.
Orders
Order statuses
| Status | Meaning |
|---|---|
ALLOCATED | Checked and stock reserved: ready to pick |
ON_HOLD | Stopped by one or more holds (see below) |
PICKING | On a pick list, being picked |
PICKED | All items picked, at the pack bench |
PACKED | Packed and checked |
DESPATCHED | Left the warehouse, with a tracking number on the shipment |
DELIVERED | Delivered, from courier tracking or confirmed by our team |
CANCELLED | Cancelled |
What happens when you send an order
- It gets an Angler order number, for example
SO-001042, and a despatch deadline from our cut-off times. - It is checked in the same request: each line's
skuis matched to one of your products, the address is checked, and stock is reserved for every line (all or nothing). - It comes back
ALLOCATED, ready for our team to pick, orON_HOLDwith the reason inholds.
| Hold code | Meaning | Clears by itself? |
|---|---|---|
INSUFFICIENT_STOCK | Not enough stock | Yes, when stock arrives |
UNMAPPED_SKU | A line matches none of your products | Yes, once you add the product |
ADDRESS_INVALID | The address is incomplete or the postcode is not valid | Yes, once the address is fixed in the portal |
MISSING_PRODUCT_DATA | A product has no weight or size, so a label cannot be bought | Yes, once the product is updated |
CREDIT_HOLD | The account is on hold | Yes |
CLIENT_QUERY, MANUAL, SHORT_PICK, LABEL_FAILED | A question, a hold by hand, a short pick or a label problem | No, a person deals with it |
Each hold also has a detail (for example Short: TSHIRT-BLK-M (2)) and a plain-English help line.
SKU matching: exact SKU first, then SKU ignoring case, then a product barcode. A case or inner barcode multiplies the line quantity by the units it holds.
Address rules: name, line1 and city are needed; UK postcodes must be valid and are tidied (m11aa becomes M1 1AA); other countries need a postcode except IE, HK and AE. A bad address does not reject the request: the order is created and held.
POST/orders
Create an order. Scope orders. Answers 201 with the full order.
| Field | Type | Required | Rules |
|---|---|---|---|
external_ref | string | Yes | Your order reference, 1 to 64 characters. Also the de-duplication key (below) |
ship_to.name | string | Yes | 1 to 120 |
ship_to.company | string | No | Up to 120 |
ship_to.email | string | No | Up to 200 |
ship_to.phone | string | No | Up to 40 |
ship_to.line1 | string | Yes | 1 to 200 |
ship_to.line2 | string | No | Up to 200 |
ship_to.city | string | Yes | 1 to 100 |
ship_to.region | string | No | Up to 100 |
ship_to.postcode | string | Yes | Up to 12 (may be empty for IE, HK, AE) |
ship_to.country | string | Yes | Two letters |
lines | array | Yes | 1 to 200 lines |
lines[].sku | string | Yes | 1 to 64 |
lines[].quantity | integer | Yes | 1 to 100000 |
lines[].unit_price | string | No | Decimal, for example "14.99" |
lines[].name | string | No | Up to 200, shown to the warehouse |
urgent | boolean | No | Default false |
requested_service | string | No | Up to 80. The delivery service you would like |
gift_message | string | No | Up to 500 |
packing_instructions | string | No | Up to 500 |
order_value | string | No | Decimal, recorded in GBP |
Safe retries. external_ref is the de-duplication key. Sending the same external_ref again returns the original order (still 201) and changes nothing, even if the body is different. So you can retry after a timeout, and should use a new reference for a genuinely new order.
POST /api/v1/orders
X-Api-Key: afk_3f9a1c2e_...
Content-Type: application/json
{
"external_ref": "WEB-10023",
"ship_to": {
"name": "Alex Example",
"email": "[email protected]",
"phone": "+447700900123",
"line1": "10 Example Street",
"line2": "Flat 2",
"city": "Manchester",
"postcode": "m1 1aa",
"country": "GB"
},
"lines": [
{ "sku": "TSHIRT-BLK-M", "quantity": 2, "unit_price": "14.99", "name": "T-shirt, black, M" },
{ "sku": "CAP-NAVY", "quantity": 1, "unit_price": "14.99", "name": "Cap, navy" }
],
"requested_service": "Tracked 48",
"packing_instructions": "Please include the returns slip.",
"order_value": "44.97"
}
Response (shortened):
{
"success": true,
"data": {
"order_id": "2d4f8a9e-6b1c-4e7a-9f0d-3c5b7a1e2f40",
"number": "SO-001042",
"channel": "API",
"external_ref": "WEB-10023",
"status": "ALLOCATED",
"urgent": false,
"ordered_at": "2026-11-18T09:41:07.512Z",
"ship_by": "2026-11-18T15:00:00.000Z",
"order_value": "44.97",
"currency": "GBP",
"ship_to": { "name": "Alex Example", "line1": "10 Example Street", "city": "Manchester", "postcode": "M1 1AA", "country": "GB" },
"lines": [
{ "channel_sku": "TSHIRT-BLK-M", "quantity": 2, "qty_allocated": 2, "qty_picked": 0, "qty_packed": 0,
"product": { "sku": "TSHIRT-BLK-M", "name": "Organic T-shirt, black, medium" } }
],
"holds": [],
"events": [
{ "type": "order.created", "message": "Order received.", "created_at": "2026-11-18T09:41:07.530Z" },
{ "type": "order.allocated", "message": "Checked and stock reserved. Ready to pick.", "created_at": "2026-11-18T09:41:07.700Z" }
],
"shipments": [],
"despatched_at": null,
"delivered_at": null,
"cancelled_at": null
},
"message": null,
"request_id": "9e8d7c6b-5a4f-4e3d-8c2b-1a0f9e8d7c6b"
}
| HTTP | error.code | When |
|---|---|---|
| 400 | BAD_REQUEST or VALIDATION | A field breaks a rule above |
| 409 | CLIENT_NOT_VERIFIED | Your account is not verified yet |
GET/orders
List orders, newest first. Scope orders.
| Query | Description |
|---|---|
status | One of the statuses above |
search | Matches the Angler number, your external_ref, a store order number, or an exact tracking number |
exact=true | With search: whole-reference match only. Use this to look up one order by your reference |
held_only=true | Only orders on hold |
page, limit | See pagination |
Each item has the order fields plus units, customer, the open holds and shipments (status, tracking_number, carrier).
GET /api/v1/orders?search=WEB-10023&exact=true
GET/orders/{order_id}
One order by its order_id (a UUID, not the order number). Scope orders. Returns the same object as the create response, with every hold the order has had, its timeline in events, and one entry in shipments per parcel: parcel_no, status, carrier, service_code, tracking_number, tracking_url, despatched_at, tracking_state (IN_TRANSIT, DELIVERED, PROBLEM or UNKNOWN) and delivered_at.
POST/orders/{order_id}/cancel
Cancel an order before picking starts. Scope orders. Body: { "reason": "Customer cancelled on our website" } (1 to 500 characters). Reserved stock is released. Answers 201 with the cancelled order.
| HTTP | error.code | When |
|---|---|---|
| 409 | CANCEL_NEEDS_ANGLER | Picking has started. Send us a message and we will stop it |
| 409 | INVALID_TRANSITION | The order has already gone, or was already cancelled |
Changing an address, holding or releasing an order are done in the client portal.
Products
GET/products
Your active products, sorted by SKU, each with its barcodes and stock (on_hand, allocated, available). Scope products or stock. Query: search (SKU, name, barcode or FNSKU), include_inactive=true, missing_data=true (products with no weight or size), page, limit.
GET/products/{product_id}
One product. Scope products or stock.
POST/products
Add a product. Scope products. Answers 201.
| Field | Type | Required | Rules |
|---|---|---|---|
sku | string | Yes | 1 to 64, no spaces at either end, unique for you |
name | string | Yes | 1 to 200 |
description | string | No | Up to 2000 |
weight_g | integer | No | 0 to 1000000. Needed before a courier label can be bought |
length_mm, width_mm, height_mm | integer | No | 0 to 10000 |
declared_value | string | No | Decimal. Value of one unit, for customs |
hs_code | string | No | 6 to 10 digits |
country_of_origin | string | No | Two letters |
kind | string | No | SIMPLE (default), VIRTUAL_BUNDLE or KIT |
fnsku | string | No | 10 letters or digits (Amazon FBA) |
batch_tracked, expiry_tracked, serial_tracked, fragile, dangerous_goods | boolean | No | Default false |
reorder_level | integer | No | You are alerted when available stock falls to this level |
tags | string[] | No | Up to 20, each up to 40 characters |
barcodes | array | No | Up to 20: { "barcode", "uom", "quantity" }. uom is EACH (default), INNER, CASE or PALLET; quantity is needed for anything but EACH |
{
"sku": "TSHIRT-BLK-M",
"name": "Organic T-shirt, black, medium",
"weight_g": 180,
"length_mm": 300, "width_mm": 250, "height_mm": 20,
"declared_value": "14.99",
"hs_code": "610910",
"country_of_origin": "PT",
"reorder_level": 50,
"barcodes": [
{ "barcode": "5012345678900" },
{ "barcode": "15012345678907", "uom": "CASE", "quantity": 24 }
]
}
A repeated SKU or a barcode already on another of your products answers 409 DUPLICATE. Adding a product re-checks any orders held for that SKU.
PATCH/products/{product_id}
Change a product. Scope products. Send only the fields that change; null clears a field. barcodes and tags, when sent, replace the whole list. "active": false retires a product. The SKU cannot change once the product has stock history (409 SKU_IN_USE), and a product with stock in the warehouse cannot be made inactive (409 PRODUCT_HAS_STOCK).
Stock
GET/inventory
Live stock for each active product, sorted by SKU. Scope stock. Query: search, in_stock_only=true, low_only=true, page, limit.
| Field | Meaning |
|---|---|
on_hand | All units in the warehouse |
allocated | Units reserved for orders |
available | Sellable units not reserved. For a virtual bundle, the number of whole sets its scarcest part allows |
receiving | Received but not yet put away |
quarantined, damaged, suspect | Units held back, damaged, or waiting for a recount |
low | true when available is at or below your reorder_level |
{
"product_id": "c3d4e5f6-a7b8-4c9d-8e0f-1a2b3c4d5e6f",
"sku": "TSHIRT-BLK-M",
"name": "Organic T-shirt, black, medium",
"reorder_level": 50,
"on_hand": 140,
"allocated": 12,
"available": 128,
"quarantined": 0,
"damaged": 0,
"receiving": 0,
"suspect": 0,
"low": false
}
Returns
GET/returns
Your returns, newest first. Scope orders. Query: status (EXPECTED, RECEIVED, CLOSED, CANCELLED), search (return number, tracking or order number), page, limit.
POST/returns
Tell us a return is on its way. Scope orders. Answers 201 with the return, for example RT-000318, status EXPECTED.
| Field | Type | Rules |
|---|---|---|
order_id | UUID | The Angler order it came from (optional) |
store_order_ref | string | Up to 60. Your order number, if we did not send the order |
reason | string | Up to 500 |
tracking_number | string | Up to 64. The return parcel's tracking |
client_note | string | Up to 1000, for example "Restock if unopened" |
lines | array | Up to 200: { "product_id", "quantity" } |
exchange | object | Optional: { "lines": [...], "ship_to": {...} } to send a replacement once the return is booked in. ship_to is needed only without order_id |
This endpoint does not de-duplicate. Before retrying after a timeout, check GET /returns?search=<tracking or order number>.
Webhooks
Webhooks tell your system when an order moves, so you do not have to poll.
Setting one up
A Client Admin adds a webhook in the client portal under Warehouse > Connect your store > Tell your system as orders move (webhooks): an https:// URL on a public host, and the events you want (or all of them). The signing secret (whsec_...) is shown once. In the portal you can also switch a webhook off and on, change it, rotate the secret, send a test, and see the delivery log for the last 30 days with a button to send any failed message again. A webhook receives events that happen after it was created.
Events
| Event | Sent when |
|---|---|
order.created | An order arrived |
order.allocated | Checked and stock reserved: ready to pick. Also sent when a held order goes ahead by itself, for example when stock arrives |
order.picking | Picking started |
order.picked | All items picked |
order.packed | Packed |
order.despatched | Despatched, with the tracking number |
order.delivered | Delivered (courier tracking, or confirmed by our team) |
order.cancelled | Cancelled |
order.held | An order was held: not enough stock, an unknown SKU, a bad address, a label problem, or held by our team |
order.released | A held order was released by our team or once its problem was fixed |
order.address_changed | The delivery address was changed |
order.short_pick | Fewer items were found than ordered |
order.claim_opened | A claim was opened with the courier |
ping | Only from "Send a test" in the portal |
An order held straight away when it is checked sends order.held, and its holds are also in the POST /orders response itself. When the problem clears (stock arrives, the product is added) it sends order.allocated.
What we send
Each message is a POST to your URL with these headers:
| Header | Value |
|---|---|
Angler-Event | The event, for example order.despatched |
Angler-Delivery | An id for this message, the same on every retry |
Angler-Signature | t=<unix seconds>,v1=<hex HMAC-SHA256> |
User-Agent | AnglerFulfilment-Webhooks/1 |
{
"id": "evt_884301",
"type": "order.despatched",
"created_at": "2026-11-18T16:05:41.207Z",
"data": {
"message": "Despatched with Royal Mail, tracking RM987654321GB.",
"details": {},
"order": {
"order_id": "2d4f8a9e-6b1c-4e7a-9f0d-3c5b7a1e2f40",
"number": "SO-001042",
"channel": "API",
"channel_order_number": null,
"external_ref": "WEB-10023",
"status": "DESPATCHED",
"shipments": [
{
"parcel_no": 1,
"carrier": "Royal Mail",
"service_code": "TPS48",
"tracking_number": "RM987654321GB",
"tracking_url": "https://www.royalmail.com/track-your-item#/tracking-results/RM987654321GB",
"despatched_at": "2026-11-18T16:05:40.950Z"
}
]
}
}
}
data.order is a snapshot of the order when the message was queued. Carrier names, service codes and tracking links depend on the courier.
Delivery and retries
- Messages go out within about a minute of the event.
- Success is any
2xxanswer within 10 seconds. Redirects are not followed and count as a failure. - A failed message is retried after 1, 5, 15, 60, 180, 360, 720 and 1440 minutes: 9 attempts over about two days.
- Delivery is at least once and order is not guaranteed. De-duplicate on
id, and usecreated_atand the order'sstatusto decide what is current. - After 50 failed attempts in a row a webhook switches itself off, with the reason shown in the portal. Events that happen while it is off are not queued.
Verifying the signature
The signature is the lowercase hex HMAC-SHA256 of <t>.<raw request body>, keyed with your whole signing secret including the whsec_ prefix. Each retry is signed again with a new t. Verify against the raw body bytes, before parsing the JSON, compare in constant time, and reject messages whose t is more than five minutes from your clock. Rotating the secret retires the old one at once.
Node.js (Express)
const crypto = require('crypto');
const express = require('express');
function verifyAnglerSignature(rawBody, header, secret, toleranceSeconds = 300) {
if (!header) return false;
const parts = {};
for (const piece of header.split(',')) {
const i = piece.indexOf('=');
if (i > 0) parts[piece.slice(0, i).trim()] = piece.slice(i + 1).trim();
}
const { t, v1 } = parts;
if (!t || !v1 || !/^\d+$/.test(t) || !/^[0-9a-f]{64}$/.test(v1)) return false;
if (Math.abs(Math.floor(Date.now() / 1000) - Number(t)) > toleranceSeconds) return false;
const expected = crypto
.createHmac('sha256', secret) // the whole "whsec_..." string
.update(`${t}.`, 'utf8')
.update(rawBody) // the exact bytes received
.digest();
const given = Buffer.from(v1, 'hex');
return given.length === expected.length && crypto.timingSafeEqual(given, expected);
}
const app = express();
app.post('/angler-webhook', express.raw({ type: 'application/json' }), (req, res) => {
if (!verifyAnglerSignature(req.body, req.get('Angler-Signature'), process.env.ANGLER_WEBHOOK_SECRET)) {
return res.status(400).send('bad signature');
}
const event = JSON.parse(req.body.toString('utf8'));
res.sendStatus(204); // answer first, then do the work
// handle event.type and event.data.order, de-duplicating on event.id
});
app.listen(3000);
Python (Flask)
import hashlib
import hmac
import os
import time
from flask import Flask, request, abort
def verify_angler_signature(raw_body: bytes, header: str, secret: str, tolerance_seconds: int = 300) -> bool:
if not header:
return False
parts = {}
for piece in header.split(","):
key, sep, value = piece.partition("=")
if sep:
parts[key.strip()] = value.strip()
t, v1 = parts.get("t"), parts.get("v1")
if not t or not v1 or not t.isdigit():
return False
if abs(int(time.time()) - int(t)) > tolerance_seconds:
return False
expected = hmac.new(
secret.encode("utf-8"), # the whole "whsec_..." string
t.encode("ascii") + b"." + raw_body,
hashlib.sha256,
).hexdigest()
return hmac.compare_digest(expected, v1)
app = Flask(__name__)
@app.post("/angler-webhook")
def angler_webhook():
raw = request.get_data() # exact bytes, before JSON parsing
if not verify_angler_signature(raw, request.headers.get("Angler-Signature", ""), os.environ["ANGLER_WEBHOOK_SECRET"]):
abort(400)
event = request.get_json()
# handle event["type"], de-duplicating on event["id"]
return "", 204
Rate limits
Each endpoint allows 100 requests per minute from one IP address. Every response carries X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset. Over the limit you get HTTP 429 with a Retry-After header in seconds: wait that long, then try again. Please check the HTTP status for this case rather than the error code.
For stock, one paged read of /inventory every few minutes is plenty; webhooks tell you about orders as they happen.
Testing and sandbox
We can give your team a sandbox account to build and test against. It uses the same base URL, API keys and webhooks as a live account, but its orders are never worked by the warehouse:
- no stock is reserved and no courier label is bought;
- orders never reach our warehouse floor and are never charged;
- SKU matching, address checks and holds work exactly as they do live, so you can test those too;
- you move a test order through the warehouse steps yourself, and every step sends the normal webhook.
Ask us for a sandbox account. Add your test products with POST /products, create a key, then send orders as you would live.
POST/orders/{order_id}/sandbox/advance
Sandbox accounts only. Moves a test order to its next step, or through every step up to to. Scope orders. Answers 201.
| Field | Type | Required | Rules |
|---|---|---|---|
to | string | No | PICKING, PICKED, PACKED, DESPATCHED or DELIVERED. Left out, the next step |
POST /api/v1/orders/2d4f8a9e-6b1c-4e7a-9f0d-3c5b7a1e2f40/sandbox/advance
X-Api-Key: afk_3f9a1c2e_...
Content-Type: application/json
{ "to": "DELIVERED" }
{
"success": true,
"data": {
"order_id": "2d4f8a9e-6b1c-4e7a-9f0d-3c5b7a1e2f40",
"number": "SO-001042",
"status": "DELIVERED",
"steps": ["PICKING", "PICKED", "PACKED", "DESPATCHED", "DELIVERED"]
},
"message": null,
"request_id": "..."
}
Each step writes the same event a live order does (order.picking, order.picked, order.packed, order.despatched, order.delivered), with "sandbox": true in data.details. At despatch the order gets a parcel with carrier Sandbox and a made-up tracking number starting ANGLERTEST.
| HTTP | error.code | When |
|---|---|---|
| 403 | SANDBOX_ONLY | The order is in a live account |
| 409 | ORDER_ON_HOLD | The order is on hold. Fix what holds it first |
| 409 | INVALID_TRANSITION | The order is already at or past that step, or cancelled |
Testing on a live account
On a live account everything is real: an order created through the API is checked, has stock reserved and goes to our warehouse floor. Use the read endpoints and the portal's "Send a test" webhook button freely, agree a plan with us before sending test orders, and cancel them straight away with POST /orders/{order_id}/cancel. During onboarding we set up your account and keys with you.
All endpoints
All paths are relative to https://portal.anglerfulfilment.co.uk/api/v1.
| Method | Path | Scope | Success |
|---|---|---|---|
| GET | /orders | orders | 200 |
| POST | /orders | orders | 201 |
| GET | /orders/{order_id} | orders | 200 |
| POST | /orders/{order_id}/cancel | orders | 201 |
| POST | /orders/{order_id}/sandbox/advance | orders (sandbox accounts) | 201 |
| GET | /products | products or stock | 200 |
| POST | /products | products | 201 |
| GET | /products/{product_id} | products or stock | 200 |
| PATCH | /products/{product_id} | products | 200 |
| GET | /inventory | stock | 200 |
| GET | /returns | orders | 200 |
| POST | /returns | orders | 201 |
Planning an integration?
Tell us about your system and order volumes. We are happy to set up a call with your integration lead.
Contact us support@anglerfulfilment.co.uk