The businesses that ship with the carrier on account.
List shipper accounts
Newest first, cursor paginated: pass next_cursor back as cursor to get the next page. Filters combine with AND. Allowed to carrier admins and dispatchers.
query Parameters
limitMaximum number of items in the page.
cursorThe next_cursor of the previous page, passed back as is. Omit it to get the first page.
statusComma-separated statuses to keep.
rate_card_id^([0-9a-fA-F]{8}-[0-…Keep the accounts billed with this rate card.
created_fromCreated at or after this instant, or from the start of this Noumea day.
created_toCreated before this instant, or up to the end of this Noumea day.
qAccount name, RIDET or contact name.
Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
List shipper accounts › Responses
One page of shipper accounts.
next_cursorPass it as cursor to get the next page. null on the last page.
Open a shipper account
A merchant who ships with the carrier and creates its own shipments. Numbered EXP-0001 onwards. Allowed to carrier admins.
Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Open a shipper account › Request Body
nameactivityridet^\d{7}\.\d{3}$The business identifier in New Caledonia.
rate_card_id^([0-9a-fA-F]{8}-[0-…The rate card billed to the account; the carrier default when null.
Open a shipper account › Responses
The new shipper account.
idaccount_numberSequential per carrier.
nameactivityridetstatusEach field is null only on an account created before contacts were recorded.
Null only on an account created before pickup addresses were recorded.
Null when the account is billed with the carrier default rate card.
How the account creates its shipments besides the back-office.
shipments_last_30_dayscreated_at^(?:(?:\d\d[2468][04… · requiredupdated_at^(?:(?:\d\d[2468][04… · requiredGet a shipper account
Allowed to carrier admins and dispatchers, and to the shipper users of the account itself.
path Parameters
idThe shipper account id.
Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Get a shipper account › Responses
The shipper account.
idaccount_numberSequential per carrier.
nameactivityridetstatusEach field is null only on an account created before contacts were recorded.
Null only on an account created before pickup addresses were recorded.
Null when the account is billed with the carrier default rate card.
How the account creates its shipments besides the back-office.
shipments_last_30_dayscreated_at^(?:(?:\d\d[2468][04… · requiredupdated_at^(?:(?:\d\d[2468][04… · requiredUpdate a shipper account
Changes only the fields sent. status: suspended stops the account from shipping; active restores it. Allowed to carrier admins.
path Parameters
idThe shipper account id.
Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Update a shipper account › Request Body
nameactivityridet^\d{7}\.\d{3}$The business identifier in New Caledonia.
rate_card_id^([0-9a-fA-F]{8}-[0-…The rate card billed to the account; the carrier default when null.
statusUpdate a shipper account › Responses
The updated shipper account.
idaccount_numberSequential per carrier.
nameactivityridetstatusEach field is null only on an account created before contacts were recorded.
Null only on an account created before pickup addresses were recorded.
Null when the account is billed with the carrier default rate card.
How the account creates its shipments besides the back-office.
shipments_last_30_dayscreated_at^(?:(?:\d\d[2468][04… · requiredupdated_at^(?:(?:\d\d[2468][04… · requiredGet the shipping activity of an account
Shipments per Noumea week (last 8) or month (last 12), the share delivered at the first attempt and the amount billed, TGC included. Allowed to carrier admins and dispatchers, and to the shipper users of the account.
path Parameters
idThe shipper account id.
query Parameters
periodThe last 8 ISO weeks or the last 12 months, the current one included.
Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Get the shipping activity of an account › Responses
The activity over the period.
periodOldest first, the current week or month last.
shipmentsdelivered_first_attempt_ratioDelivered without a failed attempt, among delivered shipments.
billed_xpfTotal of the shipments, TGC included.
Get the rate card of an account
Its own rate card, or the carrier rate card in force when it has none. Allowed to carrier admins and dispatchers, and to the shipper users of the account.
path Parameters
idThe shipper account id.
Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Get the rate card of an account › Responses
The rate card and its prices.
idnamevalid_from^(?:(?:\d\d[2468][04… · requiredis_carrier_defaultTrue when the account has no rate card of its own and is billed with the default one.
tgc_rate_basis_pointsTGC rate in basis points (100 = 1%).
One price per zone, service and weight bracket; a zone without rate is not served.
List the users of a shipper account
Its members and the invitations still pending, newest first, cursor paginated. Allowed to carrier admins.
path Parameters
idThe shipper account id.
query Parameters
limitMaximum number of items in the page.
cursorThe next_cursor of the previous page, passed back as is. Omit it to get the first page.
Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
List the users of a shipper account › Responses
One page of users.
next_cursorPass it as cursor to get the next page. null on the last page.
Invite a user to a shipper account
Emails an invitation with the shipper role. Returns 200 with the pending invitation when one already exists. Allowed to carrier admins.
path Parameters
idThe shipper account id.
Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Invite a user to a shipper account › Request Body
email^(?:[A-Za-z0-9_'+\-]… · requiredInvite a user to a shipper account › Responses
The pending invitation that already existed.
idemailroleshipper_account_idexpires_at^(?:(?:\d\d[2468][04… · requiredcreated_at^(?:(?:\d\d[2468][04… · requiredaccept_urlThe 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.
List the API keys of a shipper account
Newest first, revoked ones included, cursor paginated. Never returns a secret. Allowed to carrier admins and to the shipper users of the account.
path Parameters
idThe shipper account id.
query Parameters
limitMaximum number of items in the page.
cursorThe next_cursor of the previous page, passed back as is. Omit it to get the first page.
Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
List the API keys of a shipper account › Responses
One page of API keys.
next_cursorPass it as cursor to get the next page. null on the last page.
Create an API key
The response carries the secret once; only its SHA-256 hash is stored. An integration sends it as Authorization: Bearer <secret> and acts as a shipper user of the account. Allowed to carrier admins and to the shipper users of the account.
path Parameters
idThe shipper account id.
Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Create an API key › Responses
The new key, with its secret.
idnameprefixThe first characters of the key, to recognise it.
statuscreated_at^(?:(?:\d\d[2468][04… · requiredlast_used_at^(?:(?:\d\d[2468][04… · requiredrevoked_at^(?:(?:\d\d[2468][04… · requiredsecretThe full key, shown once: only its hash is stored. Send it as Authorization: Bearer <key>.
Revoke an API key
The key is refused from the next request on. Revoking again changes nothing. Allowed to carrier admins and to the shipper users of the account.
path Parameters
idThe shipper account id.
keyIdThe API key id.
Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Revoke an API key › Responses
The revoked key.
idnameprefixThe first characters of the key, to recognise it.
statuscreated_at^(?:(?:\d\d[2468][04… · requiredlast_used_at^(?:(?:\d\d[2468][04… · requiredrevoked_at^(?:(?:\d\d[2468][04… · required