List rate cards
Newest first, cursor paginated, with the state of each card today in Noumea. Allowed to carrier admins only.
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 rate cards › Responses
One page of rate cards.
next_cursorPass it as cursor to get the next page. null on the last page.
Create a draft rate card
From common starter prices, empty, or as a copy of another card. Allowed to carrier admins only.
Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Create a draft rate card › Request Body
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object · requires: source, name | |
| type = object · requires: source, name | |
| type = object · requires: source, name, copy_of |
sourcenameCreate a draft rate card › Responses
The new draft.
idnamestatusstatevalid_from^(?:(?:\d\d[2468][04… · requiredvalid_to^(?:(?:\d\d[2468][04… · requiredprice_countupdated_at^(?:(?:\d\d[2468][04… · requiredupdated_by_namepublished_at^(?:(?:\d\d[2468][04… · requiredtgc_rate_basis_pointsprices_include_tgcGet a rate card
With its brackets, prices in whole XPF and options. Allowed to carrier admins only.
path Parameters
idThe rate card id.
Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Get a rate card › Responses
The rate card.
idnamestatusstatevalid_from^(?:(?:\d\d[2468][04… · requiredvalid_to^(?:(?:\d\d[2468][04… · requiredprice_countupdated_at^(?:(?:\d\d[2468][04… · requiredupdated_by_namepublished_at^(?:(?:\d\d[2468][04… · requiredtgc_rate_basis_pointsprices_include_tgcSave a draft rate card
Replaces the whole draft. Brackets may not overlap nor go past 30 kg, and each price sits in one bracket. A published card cannot change: create a copy instead. Allowed to carrier admins only.
path Parameters
idThe rate card id.
Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Save a draft rate card › Request Body
namevalid_from^(?:(?:\d\d[2468][04… · requiredvalid_to^(?:(?:\d\d[2468][04… · requiredtgc_rate_basis_pointsprices_include_tgcSave a draft rate card › Responses
The saved draft.
idnamestatusstatevalid_from^(?:(?:\d\d[2468][04… · requiredvalid_to^(?:(?:\d\d[2468][04… · requiredprice_countupdated_at^(?:(?:\d\d[2468][04… · requiredupdated_by_namepublished_at^(?:(?:\d\d[2468][04… · requiredtgc_rate_basis_pointsprices_include_tgcDelete a draft rate card
A published card is kept for the shipments it priced. Allowed to carrier admins only.
path Parameters
idThe rate card id.
Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Delete a draft rate card › Responses
The draft is deleted.
Publish a draft rate card
Freezes the draft. It prices shipments from its valid_from day, Noumea time. Needs a TGC rate. Allowed to carrier admins only.
path Parameters
idThe rate card id.
Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Publish a draft rate card › Responses
The published card.
idnamestatusstatevalid_from^(?:(?:\d\d[2468][04… · requiredvalid_to^(?:(?:\d\d[2468][04… · requiredprice_countupdated_at^(?:(?:\d\d[2468][04… · requiredupdated_by_namepublished_at^(?:(?:\d\d[2468][04… · requiredtgc_rate_basis_pointsprices_include_tgc