Receiving links

A link a shop posts its orders to (WooCommerce's webhooks, Zapier, Make, Wix Automations, a Google Sheet's script): each order becomes a delivery under your automation rules. Post to the link's url (/v1/in/<token>), no key: the token and the signature are the key. Format generic: the body below, signed X-NWays-Signature: sha256=<hex HMAC-SHA256 of the body with the secret> (or Authorization: Bearer <secret> where the sender can't sign). Format woocommerce: WooCommerce's order webhook as it comes (X-WC-Webhook-Signature). The delivery's id is <idPrefix or format>-<order id>; a repeat does nothing new. At most 120 calls a minute per link, 256 KB each. Every call is in the link's log for 30 days.

On this page

Your receiving links (no secrets) and the formats a link takes
Make a receiving link (its secret is shown now, once)
One receiving link
Change a link (pickupPlaceId "" and dispatch null clear them)
Delete a link and its log (its address stops at once)
A new address and secret (shown once); the old ones stop at once
The link's log, newest first (30 days)
Run a logged call again as it came (409 NOT_RETRYABLE when it wasn't kept)

Note:

Send your key as key=YOUR_API_KEY on the address, or in the X-NWays-Api-Key header. API keys

Base address: https://nways.ng/maps/v1/fleet

Your receiving links (no secrets) and the formats a link takes

GET https://nways.ng/maps/v1/fleet/inbound

cURL

curl "https://nways.ng/maps/v1/fleet/inbound" \
  -H "X-NWays-Api-Key: YOUR_API_KEY"

JavaScript

const res = await fetch('https://nways.ng/maps/v1/fleet/inbound', {
  headers: { 'X-NWays-Api-Key': process.env.NWAYS_API_KEY },
})
const data = await res.json()

Python

import os
import requests

res = requests.get(
    "https://nways.ng/maps/v1/fleet/inbound",
    headers={"X-NWays-Api-Key": os.environ["NWAYS_API_KEY"]},
    timeout=10,
)
data = res.json()

Response

Links

Field	Type	Description
`links`	`InboundLink[]`
`links[].id`	`string`
`links[].name`	`string`
`links[].format`	`string`	One of: `generic`, `woocommerce`.
`links[].url`	`string`
`links[].secret`	`string`	Only when made or rotated.
`links[].pickupPlaceId`	`string \| null`
`links[].dispatch`	`string \| object \| null`
`links[].idPrefix`	`string`
`links[].readyStatus`	`string`
`links[].test`	`boolean`
`links[].active`	`boolean`
`links[].createdAt`	`string (date-time)`
`links[].updatedAt`	`string (date-time)`
`links[].lastAt`	`string (date-time) \| null`
`links[].counts`	`object`	Calls logged (30 days) by state.
`links[].made`	`integer`	Deliveries its calls made (30 days), those held for their address too.
`links[].open`	`integer`	What still needs you: deliveries still held for their address, and failed calls with nothing taken from that order since.
`formats`	`object[]`
`formats[].id`	`string`
`formats[].name`	`string`
`formats[].signature`	`string`
`formats[].platforms`	`string[]`

200 OK

{
  "links": [
    {
      "id": "inl_4fQ9xLm2Za",
      "name": "string",
      "format": "generic",
      "url": "https://map.nways.ng/v1/in/in_…",
      "secret": "string",
      "pickupPlaceId": "string",
      "dispatch": "auto",
      "idPrefix": "string",
      "readyStatus": "string",
      "test": true,
      "active": true,
      "createdAt": "2026-10-15T09:00:00+01:00",
      "updatedAt": "2026-10-15T09:00:00+01:00",
      "lastAt": "2026-10-15T09:00:00+01:00",
      "counts": {},
      "made": 0,
      "open": 0
    }
  ],
  "formats": [
    {
      "id": "string",
      "name": "string",
      "signature": "string",
      "platforms": [
        "string"
      ]
    }
  ]
}

Errors

default Error

Make a receiving link (its secret is shown now, once)

POST https://nways.ng/maps/v1/fleet/inbound

Request body

Field	Type	Description
`name`	`string`	Required when making one. Up to 80 characters.
`format`	`string`	One of: `generic`, `woocommerce`. Default: `generic`.
`pickupPlaceId`	`string`	One of your pickup places: the orders' pickup.
`dispatch`	`string \| object`	An order's own dispatch: `auto`, `hold` or `manual`, or an object; what it leaves out comes from your automation rules.
`idPrefix`	`string`	Delivery ids are <idPrefix>-<order id> (default: the format).
`readyStatus`	`string`	WooCommerce: the order status that means ready for pickup (e.g. ready-for-pickup).
`test`	`boolean`	Its orders are test deliveries, never given to a rider or driver.
`active`	`boolean`	Default: `true`.

cURL

curl -X POST "https://nways.ng/maps/v1/fleet/inbound" \
  -H "X-NWays-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"My shop","format":"woocommerce","pickupPlaceId":"plc_4fQ9xLm2Za","readyStatus":"ready-for-pickup"}'

JavaScript

const res = await fetch('https://nways.ng/maps/v1/fleet/inbound', {
  method: 'POST',
  headers: { 'X-NWays-Api-Key': process.env.NWAYS_API_KEY, 'Content-Type': 'application/json' },
  body: JSON.stringify({
    "name": "My shop",
    "format": "woocommerce",
    "pickupPlaceId": "plc_4fQ9xLm2Za",
    "readyStatus": "ready-for-pickup"
  }),
})
const data = await res.json()

Python

import os
import requests

res = requests.post(
    "https://nways.ng/maps/v1/fleet/inbound",
    headers={"X-NWays-Api-Key": os.environ["NWAYS_API_KEY"]},
    json={"name": "My shop", "format": "woocommerce", "pickupPlaceId": "plc_4fQ9xLm2Za", "readyStatus": "ready-for-pickup"},
    timeout=10,
)
data = res.json()

Response

Link with secret

Field	Type	Description
`id`	`string`
`name`	`string`
`format`	`string`	One of: `generic`, `woocommerce`.
`url`	`string`
`secret`	`string`	Only when made or rotated.
`pickupPlaceId`	`string \| null`
`dispatch`	`string \| object \| null`
`idPrefix`	`string`
`readyStatus`	`string`
`test`	`boolean`
`active`	`boolean`
`createdAt`	`string (date-time)`
`updatedAt`	`string (date-time)`
`lastAt`	`string (date-time) \| null`
`counts`	`object`	Calls logged (30 days) by state.
`made`	`integer`	Deliveries its calls made (30 days), those held for their address too.
`open`	`integer`	What still needs you: deliveries still held for their address, and failed calls with nothing taken from that order since.

201 OK

{
  "id": "inl_4fQ9xLm2Za",
  "name": "string",
  "format": "generic",
  "url": "https://map.nways.ng/v1/in/in_…",
  "secret": "string",
  "pickupPlaceId": "string",
  "dispatch": "auto",
  "idPrefix": "string",
  "readyStatus": "string",
  "test": true,
  "active": true,
  "createdAt": "2026-10-15T09:00:00+01:00",
  "updatedAt": "2026-10-15T09:00:00+01:00",
  "lastAt": "2026-10-15T09:00:00+01:00",
  "counts": {},
  "made": 0,
  "open": 0
}

Errors

default Error

One receiving link

GET https://nways.ng/maps/v1/fleet/inbound/{id}

Parameters

Name	In	Type	Description
`id`	path	`string`	Required.

cURL

curl "https://nways.ng/maps/v1/fleet/inbound/string" \
  -H "X-NWays-Api-Key: YOUR_API_KEY"

JavaScript

const res = await fetch('https://nways.ng/maps/v1/fleet/inbound/string', {
  headers: { 'X-NWays-Api-Key': process.env.NWAYS_API_KEY },
})
const data = await res.json()

Python

import os
import requests

res = requests.get(
    "https://nways.ng/maps/v1/fleet/inbound/string",
    headers={"X-NWays-Api-Key": os.environ["NWAYS_API_KEY"]},
    timeout=10,
)
data = res.json()

Response

Link

Field	Type	Description
`id`	`string`
`name`	`string`
`format`	`string`	One of: `generic`, `woocommerce`.
`url`	`string`
`secret`	`string`	Only when made or rotated.
`pickupPlaceId`	`string \| null`
`dispatch`	`string \| object \| null`
`idPrefix`	`string`
`readyStatus`	`string`
`test`	`boolean`
`active`	`boolean`
`createdAt`	`string (date-time)`
`updatedAt`	`string (date-time)`
`lastAt`	`string (date-time) \| null`
`counts`	`object`	Calls logged (30 days) by state.
`made`	`integer`	Deliveries its calls made (30 days), those held for their address too.
`open`	`integer`	What still needs you: deliveries still held for their address, and failed calls with nothing taken from that order since.

200 OK

{
  "id": "inl_4fQ9xLm2Za",
  "name": "string",
  "format": "generic",
  "url": "https://map.nways.ng/v1/in/in_…",
  "secret": "string",
  "pickupPlaceId": "string",
  "dispatch": "auto",
  "idPrefix": "string",
  "readyStatus": "string",
  "test": true,
  "active": true,
  "createdAt": "2026-10-15T09:00:00+01:00",
  "updatedAt": "2026-10-15T09:00:00+01:00",
  "lastAt": "2026-10-15T09:00:00+01:00",
  "counts": {},
  "made": 0,
  "open": 0
}

Errors

default Error

Change a link (pickupPlaceId "" and dispatch null clear them)

PATCH https://nways.ng/maps/v1/fleet/inbound/{id}

Parameters

Name	In	Type	Description
`id`	path	`string`	Required.

Request body

Field	Type	Description
`name`	`string`	Required when making one. Up to 80 characters.
`format`	`string`	One of: `generic`, `woocommerce`. Default: `generic`.
`pickupPlaceId`	`string`	One of your pickup places: the orders' pickup.
`dispatch`	`string \| object`	An order's own dispatch: `auto`, `hold` or `manual`, or an object; what it leaves out comes from your automation rules.
`idPrefix`	`string`	Delivery ids are <idPrefix>-<order id> (default: the format).
`readyStatus`	`string`	WooCommerce: the order status that means ready for pickup (e.g. ready-for-pickup).
`test`	`boolean`	Its orders are test deliveries, never given to a rider or driver.
`active`	`boolean`	Default: `true`.

cURL

curl -X PATCH "https://nways.ng/maps/v1/fleet/inbound/string" \
  -H "X-NWays-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","format":"generic","pickupPlaceId":"string","dispatch":"auto","idPrefix":"string","readyStatus":"string","test":true,"active":true}'

JavaScript

const res = await fetch('https://nways.ng/maps/v1/fleet/inbound/string', {
  method: 'PATCH',
  headers: { 'X-NWays-Api-Key': process.env.NWAYS_API_KEY, 'Content-Type': 'application/json' },
  body: JSON.stringify({
    "name": "string",
    "format": "generic",
    "pickupPlaceId": "string",
    "dispatch": "auto",
    "idPrefix": "string",
    "readyStatus": "string",
    "test": true,
    "active": true
  }),
})
const data = await res.json()

Python

import os
import requests

res = requests.patch(
    "https://nways.ng/maps/v1/fleet/inbound/string",
    headers={"X-NWays-Api-Key": os.environ["NWAYS_API_KEY"]},
    json={"name": "string", "format": "generic", "pickupPlaceId": "string", "dispatch": "auto", "idPrefix": "string", "readyStatus": "string", "test": True, "active": True},
    timeout=10,
)
data = res.json()

Response

Link

Field	Type	Description
`id`	`string`
`name`	`string`
`format`	`string`	One of: `generic`, `woocommerce`.
`url`	`string`
`secret`	`string`	Only when made or rotated.
`pickupPlaceId`	`string \| null`
`dispatch`	`string \| object \| null`
`idPrefix`	`string`
`readyStatus`	`string`
`test`	`boolean`
`active`	`boolean`
`createdAt`	`string (date-time)`
`updatedAt`	`string (date-time)`
`lastAt`	`string (date-time) \| null`
`counts`	`object`	Calls logged (30 days) by state.
`made`	`integer`	Deliveries its calls made (30 days), those held for their address too.
`open`	`integer`	What still needs you: deliveries still held for their address, and failed calls with nothing taken from that order since.

200 OK

{
  "id": "inl_4fQ9xLm2Za",
  "name": "string",
  "format": "generic",
  "url": "https://map.nways.ng/v1/in/in_…",
  "secret": "string",
  "pickupPlaceId": "string",
  "dispatch": "auto",
  "idPrefix": "string",
  "readyStatus": "string",
  "test": true,
  "active": true,
  "createdAt": "2026-10-15T09:00:00+01:00",
  "updatedAt": "2026-10-15T09:00:00+01:00",
  "lastAt": "2026-10-15T09:00:00+01:00",
  "counts": {},
  "made": 0,
  "open": 0
}

Errors

default Error

Delete a link and its log (its address stops at once)

DELETE https://nways.ng/maps/v1/fleet/inbound/{id}

Parameters

Name	In	Type	Description
`id`	path	`string`	Required.

cURL

curl -X DELETE "https://nways.ng/maps/v1/fleet/inbound/string" \
  -H "X-NWays-Api-Key: YOUR_API_KEY"

JavaScript

const res = await fetch('https://nways.ng/maps/v1/fleet/inbound/string', {
  method: 'DELETE',
  headers: { 'X-NWays-Api-Key': process.env.NWAYS_API_KEY },
})
const data = await res.json()

Python

import os
import requests

res = requests.delete(
    "https://nways.ng/maps/v1/fleet/inbound/string",
    headers={"X-NWays-Api-Key": os.environ["NWAYS_API_KEY"]},
    timeout=10,
)
data = res.json()

Response

Deleted

No content.

Errors

default Error

A new address and secret (shown once); the old ones stop at once

POST https://nways.ng/maps/v1/fleet/inbound/{id}/rotate

Parameters

Name	In	Type	Description
`id`	path	`string`	Required.

cURL

curl -X POST "https://nways.ng/maps/v1/fleet/inbound/string/rotate" \
  -H "X-NWays-Api-Key: YOUR_API_KEY"

JavaScript

const res = await fetch('https://nways.ng/maps/v1/fleet/inbound/string/rotate', {
  method: 'POST',
  headers: { 'X-NWays-Api-Key': process.env.NWAYS_API_KEY },
})
const data = await res.json()

Python

import os
import requests

res = requests.post(
    "https://nways.ng/maps/v1/fleet/inbound/string/rotate",
    headers={"X-NWays-Api-Key": os.environ["NWAYS_API_KEY"]},
    timeout=10,
)
data = res.json()

Response

Link with secret

Field	Type	Description
`id`	`string`
`name`	`string`
`format`	`string`	One of: `generic`, `woocommerce`.
`url`	`string`
`secret`	`string`	Only when made or rotated.
`pickupPlaceId`	`string \| null`
`dispatch`	`string \| object \| null`
`idPrefix`	`string`
`readyStatus`	`string`
`test`	`boolean`
`active`	`boolean`
`createdAt`	`string (date-time)`
`updatedAt`	`string (date-time)`
`lastAt`	`string (date-time) \| null`
`counts`	`object`	Calls logged (30 days) by state.
`made`	`integer`	Deliveries its calls made (30 days), those held for their address too.
`open`	`integer`	What still needs you: deliveries still held for their address, and failed calls with nothing taken from that order since.

200 OK

{
  "id": "inl_4fQ9xLm2Za",
  "name": "string",
  "format": "generic",
  "url": "https://map.nways.ng/v1/in/in_…",
  "secret": "string",
  "pickupPlaceId": "string",
  "dispatch": "auto",
  "idPrefix": "string",
  "readyStatus": "string",
  "test": true,
  "active": true,
  "createdAt": "2026-10-15T09:00:00+01:00",
  "updatedAt": "2026-10-15T09:00:00+01:00",
  "lastAt": "2026-10-15T09:00:00+01:00",
  "counts": {},
  "made": 0,
  "open": 0
}

Errors

default Error

The link's log, newest first (30 days)

GET https://nways.ng/maps/v1/fleet/inbound/{id}/events

Parameters

Name	In	Type	Description
`id`	path	`string`	Required.
`state`	query	`string`	One of: `created`, `updated`, `duplicate`, `ignored`, `needs_address`, `failed`.
`limit`	query	`integer`	Default: `50`. ≥ 1, ≤ 200.
`pageToken`	query	`string`

cURL

curl "https://nways.ng/maps/v1/fleet/inbound/string/events" \
  -H "X-NWays-Api-Key: YOUR_API_KEY"

JavaScript

const res = await fetch('https://nways.ng/maps/v1/fleet/inbound/string/events', {
  headers: { 'X-NWays-Api-Key': process.env.NWAYS_API_KEY },
})
const data = await res.json()

Python

import os
import requests

res = requests.get(
    "https://nways.ng/maps/v1/fleet/inbound/string/events",
    headers={"X-NWays-Api-Key": os.environ["NWAYS_API_KEY"]},
    timeout=10,
)
data = res.json()

Response

Log

Field	Type	Description
`events`	`InboundEvent[]`
`events[].id`	`string`
`events[].event`	`string`
`events[].orderId`	`string`
`events[].taskId`	`string`	The delivery made or changed ("" when none).
`events[].state`	`string`	One of: `created`, `updated`, `duplicate`, `ignored`, `needs_address`, `failed`.
`events[].reason`	`string`
`events[].attempts`	`integer`
`events[].retryable`	`boolean`
`events[].payload`	`any`	The call as it came (null when not kept).
`events[].createdAt`	`string (date-time)`
`events[].updatedAt`	`string (date-time)`
`total`	`integer`
`counts`	`object`
`nextPageToken`	`string \| null`

200 OK

{
  "events": [
    {
      "id": "ine_Qa71ZcR0mX",
      "event": "order.created",
      "orderId": "string",
      "taskId": "string",
      "state": "created",
      "reason": "Delivery #1042 made.",
      "attempts": 0,
      "retryable": true,
      "payload": "string",
      "createdAt": "2026-10-15T09:00:00+01:00",
      "updatedAt": "2026-10-15T09:00:00+01:00"
    }
  ],
  "total": 0,
  "counts": {},
  "nextPageToken": "string"
}

Errors

default Error

Run a logged call again as it came (409 NOT_RETRYABLE when it wasn't kept)

POST https://nways.ng/maps/v1/fleet/inbound/{id}/events/{eid}/retry

Parameters

Name	In	Type	Description
`id`	path	`string`	Required.
`eid`	path	`string`	Required.

cURL

curl -X POST "https://nways.ng/maps/v1/fleet/inbound/string/events/string/retry" \
  -H "X-NWays-Api-Key: YOUR_API_KEY"

JavaScript

const res = await fetch('https://nways.ng/maps/v1/fleet/inbound/string/events/string/retry', {
  method: 'POST',
  headers: { 'X-NWays-Api-Key': process.env.NWAYS_API_KEY },
})
const data = await res.json()

Python

import os
import requests

res = requests.post(
    "https://nways.ng/maps/v1/fleet/inbound/string/events/string/retry",
    headers={"X-NWays-Api-Key": os.environ["NWAYS_API_KEY"]},
    timeout=10,
)
data = res.json()

Response

The entry with its new outcome

Field	Type	Description
`id`	`string`
`event`	`string`
`orderId`	`string`
`taskId`	`string`	The delivery made or changed ("" when none).
`state`	`string`	One of: `created`, `updated`, `duplicate`, `ignored`, `needs_address`, `failed`.
`reason`	`string`
`attempts`	`integer`
`retryable`	`boolean`
`payload`	`any`	The call as it came (null when not kept).
`createdAt`	`string (date-time)`
`updatedAt`	`string (date-time)`

200 OK

{
  "id": "ine_Qa71ZcR0mX",
  "event": "order.created",
  "orderId": "string",
  "taskId": "string",
  "state": "created",
  "reason": "Delivery #1042 made.",
  "attempts": 0,
  "retryable": true,
  "payload": "string",
  "createdAt": "2026-10-15T09:00:00+01:00",
  "updatedAt": "2026-10-15T09:00:00+01:00"
}

Errors

default Error