shipping.nc API

Onboarding

Server

Get the onboarding progress

GET
https://api.shipping.nc
/v1/settings/onboarding

The steps done or skipped, the test shipment and the live mode. Allowed to carrier admins only.

Get the onboarding progress › Headers

x-correlation-id
​string · maxLength: 128

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

Get the onboarding progress › Responses

The progress.

completed_steps
​string[] · required
Enum values:
welcome
company
branding
zones
rates
notifications
team
driver_phone
skipped_steps
​string[] · required
Enum values:
welcome
company
branding
zones
rates
notifications
team
driver_phone
test_shipment_id
​string | null · required
is_live
​boolean · required
live_since
​string | null · date-time · pattern: ^(?:(?:\d\d[2468][04… · required
saved_at
​string | null · date-time · pattern: ^(?:(?:\d\d[2468][04… · required

Record a step as done or skipped

PUT
https://api.shipping.nc
/v1/settings/onboarding/steps/{step}

Idempotent. The first shipment step also records the test shipment. Allowed to carrier admins only.

Record a step as done or skipped › path Parameters

step
​string · required

The wizard step.

Record a step as done or skipped › Headers

x-correlation-id
​string · maxLength: 128

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

Record a step as done or skipped › Request Body

outcome
​string · enum · required
Enum values:
completed
skipped
test_shipment_id
​string · minLength: 1

Record a step as done or skipped › Responses

The progress.

completed_steps
​string[] · required
Enum values:
welcome
company
branding
zones
rates
notifications
team
driver_phone
skipped_steps
​string[] · required
Enum values:
welcome
company
branding
zones
rates
notifications
team
driver_phone
test_shipment_id
​string | null · required
is_live
​boolean · required
live_since
​string | null · date-time · pattern: ^(?:(?:\d\d[2468][04… · required
saved_at
​string | null · date-time · pattern: ^(?:(?:\d\d[2468][04… · required

Switch between test and live mode

PUT
https://api.shipping.nc
/v1/settings/onboarding/live

Going live needs a served zone and a rate card: the latest draft is published when none is in effect, and the test shipment is cancelled. Allowed to carrier admins only.

Switch between test and live mode › Headers

x-correlation-id
​string · maxLength: 128

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

Switch between test and live mode › Request Body

live
​boolean · required

Switch between test and live mode › Responses

The new mode.

completed_steps
​string[] · required
Enum values:
welcome
company
branding
zones
rates
notifications
team
driver_phone
skipped_steps
​string[] · required
Enum values:
welcome
company
branding
zones
rates
notifications
team
driver_phone
test_shipment_id
​string | null · required
is_live
​boolean · required
live_since
​string | null · date-time · pattern: ^(?:(?:\d\d[2468][04… · required
saved_at
​string | null · date-time · pattern: ^(?:(?:\d\d[2468][04… · required
published_rate_card_id
​string | null · required
cancelled_test_shipment
​boolean · required