shipping.nc API

Team

Server

The members of the carrier and the invitations still open.


List the invitations

GET
https://api.shipping.nc
/v1/auth/invitations

Carrier admins only. Invitations neither accepted nor revoked, newest first, cursor paginated.

List the invitations › query Parameters

limit
​integer · min: 1 · max: 100

Maximum number of items in the page.

Example: 25
Default: 25
cursor
​string

The next_cursor of the previous page, passed back as is. Omit it to get the first page.

Example: WyIyMDI2LTExLTExVDA4OjQyOjEwLjAwMFoiLCIwYjZmOWMxZS01ZDJhLTRjM2UtOWYxYS03ZTJkOGM0YjZhMTAiXQ
status
​string

Comma-separated statuses to keep. Accepted and revoked invitations are never listed.

Example: pending

List the invitations › Headers

x-correlation-id
​string · maxLength: 128

Your request identifier. Generated when absent, and always echoed in the response header.

List the invitations › Responses

One page of invitations.

Invitations not accepted nor revoked, newest first.
​object[] · required
next_cursor
​string | null · required

Pass it as cursor to get the next page. null on the last page.


List the team

GET
https://api.shipping.nc
/v1/auth/members

Carrier admins and dispatchers (who pair the phones of the drivers). Newest first, cursor paginated: pass next_cursor back as cursor to get the next page. counts covers the whole team, whatever the filter and the page.

List the team › query Parameters

limit
​integer · min: 1 · max: 100

Maximum number of items in the page.

Example: 25
Default: 25
cursor
​string

The next_cursor of the previous page, passed back as is. Omit it to get the first page.

Example: WyIyMDI2LTExLTExVDA4OjQyOjEwLjAwMFoiLCIwYjZmOWMxZS01ZDJhLTRjM2UtOWYxYS03ZTJkOGM0YjZhMTAiXQ
role
​string

Comma-separated roles to keep.

Example: dispatcher,driver

List the team › Headers

x-correlation-id
​string · maxLength: 128

Your request identifier. Generated when absent, and always echoed in the response header.

List the team › Responses

One page of members.

Members, newest first.
​object[] · required
next_cursor
​string | null · required

Pass it as cursor to get the next page. null on the last page.

​object · required

Totals of the whole team, whatever the filter and the page.


Change the role or the status of a member

PATCH
https://api.shipping.nc
/v1/auth/members/{membership_id}

Carrier admins only. An admin may not disable or demote their own membership (403), a shipper membership keeps its role (403), and a person cannot get a role they already hold (409).

Change the role or the status of a member › path Parameters

membership_id
​string · uuid · required

The membership_id of the member.

Change the role or the status of a member › Headers

x-correlation-id
​string · maxLength: 128

Your request identifier. Generated when absent, and always echoed in the response header.

Change the role or the status of a member › Request Body

A shipper membership keeps its role: invite the person again for another role.
role
​string · enum
Enum values:
carrier_admin
dispatcher
driver
status
​string · enum
Enum values:
active
disabled

Change the role or the status of a member › Responses

The updated member.

membership_id
​string · required
user_id
​string · required
full_name
​string · required
email
​string · required
role
​string · enum · required
Enum values:
carrier_admin
dispatcher
driver
shipper
​object | null · required

The account a shipper is limited to; null for the other roles.

status
​string · enum · required
Enum values:
active
disabled
second_factor
​string | null · enum · required

null while the identity provider does not report it.

Enum values:
app
sms
email
pairing_code
none
last_active_at
​string | null · date-time · pattern: ^(?:(?:\d\d[2468][04… · required

Last time the member was seen, when known.

Example: 2026-11-11T08:42:10.000Z
created_at
​string · date-time · pattern: ^(?:(?:\d\d[2468][04… · required

Send an invitation again

POST
https://api.shipping.nc
/v1/auth/invitations/{id}/resend

Carrier admins only. Emails a new link valid 7 days; the previous link stops working. An accepted or revoked invitation gives not_found.

Send an invitation again › path Parameters

id
​string · uuid · required

The invitation id.

Send an invitation again › Headers

x-correlation-id
​string · maxLength: 128

Your request identifier. Generated when absent, and always echoed in the response header.

Send an invitation again › Responses

The invitation with its new expiry.

id
​string · required
email
​string · required
role
​string · enum · required
Enum values:
carrier_admin
dispatcher
driver
shipper
shipper_account_id
​string | null · required
expires_at
​string · date-time · pattern: ^(?:(?:\d\d[2468][04… · required
created_at
​string · date-time · pattern: ^(?:(?:\d\d[2468][04… · required
accept_url
​string · uri

The accept link, only in the response that minted the token and only on a stage that sends no invitation email (demo). Elsewhere the email is the only copy.

Example: https://app.demo.shipping.nc/invite#token=8mA2pQ3rS4tU5vW6xY7zA8bC9dE0fG1hI2jK3lM4nO5

Revoke an invitation

DELETE
https://api.shipping.nc
/v1/auth/invitations/{id}

Carrier admins only. Its link stops working. An accepted or revoked invitation gives not_found.

Revoke an invitation › path Parameters

id
​string · uuid · required

The invitation id.

Revoke an invitation › Headers

x-correlation-id
​string · maxLength: 128

Your request identifier. Generated when absent, and always echoed in the response header.

Revoke an invitation › Responses

Done.

No data returned