shipping.nc API

Rate cards

Server

List rate cards

GET
https://api.shipping.nc
/v1/settings/rate-cards

Newest first, cursor paginated, with the state of each card today in Noumea. Allowed to carrier admins only.

List rate cards › 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

List rate cards › Headers

x-correlation-id
​string · maxLength: 128

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

List rate cards › Responses

One page of rate cards.

​object[] · required
next_cursor
​string | null · required

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


Create a draft rate card

POST
https://api.shipping.nc
/v1/settings/rate-cards

From common starter prices, empty, or as a copy of another card. Allowed to carrier admins only.

Create a draft rate card › Headers

x-correlation-id
​string · maxLength: 128

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

Create a draft rate card › Request Body

oneOf
Exactly one variant must match.

Decision Table

VariantMatching Criteria
type = object · requires: source, name
type = object · requires: source, name
type = object · requires: source, name, copy_of
Properties for Variant 1:
source
​string · const · required
Const value: starter
name
​string · minLength: 1 · maxLength: 80 · required

Create a draft rate card › Responses

The new draft.

id
​string · required
name
​string · required
status
​string · enum · required
Enum values:
draft
published
state
​string · enum · required
Enum values:
draft
in_effect
scheduled
superseded
valid_from
​string · date · pattern: ^(?:(?:\d\d[2468][04… · required
valid_to
​string | null · date · pattern: ^(?:(?:\d\d[2468][04… · required
price_count
​integer · min: -9007199254740991 · max: 9007199254740991 · required
updated_at
​string · date-time · pattern: ^(?:(?:\d\d[2468][04… · required
updated_by_name
​string | null · required
published_at
​string | null · date-time · pattern: ^(?:(?:\d\d[2468][04… · required
tgc_rate_basis_points
​integer | null · min: 0 · max: 10000 · required
prices_include_tgc
​boolean · required
​object[] · required
​object[] · required
​object · required

Get a rate card

GET
https://api.shipping.nc
/v1/settings/rate-cards/{id}

With its brackets, prices in whole XPF and options. Allowed to carrier admins only.

Get a rate card › path Parameters

id
​string · required

The rate card id.

Get a rate card › Headers

x-correlation-id
​string · maxLength: 128

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

Get a rate card › Responses

The rate card.

id
​string · required
name
​string · required
status
​string · enum · required
Enum values:
draft
published
state
​string · enum · required
Enum values:
draft
in_effect
scheduled
superseded
valid_from
​string · date · pattern: ^(?:(?:\d\d[2468][04… · required
valid_to
​string | null · date · pattern: ^(?:(?:\d\d[2468][04… · required
price_count
​integer · min: -9007199254740991 · max: 9007199254740991 · required
updated_at
​string · date-time · pattern: ^(?:(?:\d\d[2468][04… · required
updated_by_name
​string | null · required
published_at
​string | null · date-time · pattern: ^(?:(?:\d\d[2468][04… · required
tgc_rate_basis_points
​integer | null · min: 0 · max: 10000 · required
prices_include_tgc
​boolean · required
​object[] · required
​object[] · required
​object · required

Save a draft rate card

PUT
https://api.shipping.nc
/v1/settings/rate-cards/{id}

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.

Save a draft rate card › path Parameters

id
​string · required

The rate card id.

Save a draft rate card › Headers

x-correlation-id
​string · maxLength: 128

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

Save a draft rate card › Request Body

name
​string · minLength: 1 · maxLength: 80 · required
valid_from
​string · date · pattern: ^(?:(?:\d\d[2468][04… · required
valid_to
​string | null · date · pattern: ^(?:(?:\d\d[2468][04… · required
tgc_rate_basis_points
​integer | null · min: 0 · max: 10000 · required
prices_include_tgc
​boolean · required
​object[] · minItems: 1 · maxItems: 20 · required
​object[] · maxItems: 300 · required
​object · required

Save a draft rate card › Responses

The saved draft.

id
​string · required
name
​string · required
status
​string · enum · required
Enum values:
draft
published
state
​string · enum · required
Enum values:
draft
in_effect
scheduled
superseded
valid_from
​string · date · pattern: ^(?:(?:\d\d[2468][04… · required
valid_to
​string | null · date · pattern: ^(?:(?:\d\d[2468][04… · required
price_count
​integer · min: -9007199254740991 · max: 9007199254740991 · required
updated_at
​string · date-time · pattern: ^(?:(?:\d\d[2468][04… · required
updated_by_name
​string | null · required
published_at
​string | null · date-time · pattern: ^(?:(?:\d\d[2468][04… · required
tgc_rate_basis_points
​integer | null · min: 0 · max: 10000 · required
prices_include_tgc
​boolean · required
​object[] · required
​object[] · required
​object · required

Delete a draft rate card

DELETE
https://api.shipping.nc
/v1/settings/rate-cards/{id}

A published card is kept for the shipments it priced. Allowed to carrier admins only.

Delete a draft rate card › path Parameters

id
​string · required

The rate card id.

Delete a draft rate card › Headers

x-correlation-id
​string · maxLength: 128

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

Delete a draft rate card › Responses

The draft is deleted.

No data returned

Publish a draft rate card

POST
https://api.shipping.nc
/v1/settings/rate-cards/{id}/publish

Freezes the draft. It prices shipments from its valid_from day, Noumea time. Needs a TGC rate. Allowed to carrier admins only.

Publish a draft rate card › path Parameters

id
​string · required

The rate card id.

Publish a draft rate card › Headers

x-correlation-id
​string · maxLength: 128

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

Publish a draft rate card › Responses

The published card.

id
​string · required
name
​string · required
status
​string · enum · required
Enum values:
draft
published
state
​string · enum · required
Enum values:
draft
in_effect
scheduled
superseded
valid_from
​string · date · pattern: ^(?:(?:\d\d[2468][04… · required
valid_to
​string | null · date · pattern: ^(?:(?:\d\d[2468][04… · required
price_count
​integer · min: -9007199254740991 · max: 9007199254740991 · required
updated_at
​string · date-time · pattern: ^(?:(?:\d\d[2468][04… · required
updated_by_name
​string | null · required
published_at
​string | null · date-time · pattern: ^(?:(?:\d\d[2468][04… · required
tgc_rate_basis_points
​integer | null · min: 0 · max: 10000 · required
prices_include_tgc
​boolean · required
​object[] · required
​object[] · required
​object · required