shipping.nc API
​string · maxLength: 128​string[] · required​string[] · required​string | null · required​boolean · required​string | null · date-time · pattern: ​string | null · date-time · pattern:
​string · required​string · maxLength: 128​string · enum · required​string · minLength: 1​string[] · required​string[] · required​string | null · required​boolean · required​string | null · date-time · pattern: ​string | null · date-time · pattern:
​string · maxLength: 128​string[] · required​string[] · required​string | null · required​boolean · required​string | null · date-time · pattern: ​string | null · date-time · pattern: ​string | null · required​boolean · required
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.
Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Get the onboarding progress › Responses
The progress.
completed_stepsEnum values:
welcome
company
branding
zones
rates
notifications
team
driver_phone
skipped_stepsEnum values:
welcome
company
branding
zones
rates
notifications
team
driver_phone
test_shipment_idis_livelive_since^(?:(?:\d\d[2468][04… · requiredsaved_at^(?:(?:\d\d[2468][04… · requiredRecord 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.
path Parameters
stepThe wizard step.
Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Record a step as done or skipped › Request Body
outcomeEnum values:
completed
skipped
test_shipment_idRecord a step as done or skipped › Responses
The progress.
completed_stepsEnum values:
welcome
company
branding
zones
rates
notifications
team
driver_phone
skipped_stepsEnum values:
welcome
company
branding
zones
rates
notifications
team
driver_phone
test_shipment_idis_livelive_since^(?:(?:\d\d[2468][04… · requiredsaved_at^(?:(?:\d\d[2468][04… · requiredSwitch 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.
Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Switch between test and live mode › Responses
The new mode.
completed_stepsEnum values:
welcome
company
branding
zones
rates
notifications
team
driver_phone
skipped_stepsEnum values:
welcome
company
branding
zones
rates
notifications
team
driver_phone
test_shipment_idis_livelive_since^(?:(?:\d\d[2468][04… · requiredsaved_at^(?:(?:\d\d[2468][04… · requiredpublished_rate_card_idcancelled_test_shipment