shipping.nc API

Error

​object · required

WebhookEvent

id
​string · required

Unique per event. Retries and replays send the same id: use it to skip duplicates.

type
​string · enum · required
Enum values:
shipment.created
shipment.status_changed
shipment.delivered
shipment.delivery_failed
incident.opened
incident.resolved
webhook.test
created_at
​string · date-time · pattern: ^(?:(?:\d\d[2468][04… · required

When the event happened.

carrier_id
​string · required
​object · required

MerchantWebhookEvent

What a merchant endpoint receives (ADR 0012).
id
​string · required

Unique per event. Retries and replays send the same id: use it to skip duplicates.

type
​string · enum · required
Enum values:
shipment.created
shipment.status_changed
shipment.delivered
shipment.delivery_failed
webhook.test
created_at
​string · date-time · pattern: ^(?:(?:\d\d[2468][04… · required

When the event happened.

mode
​string · enum · required

The mode of the shipment, and of the endpoint.

Enum values:
test
live
​object · required