/shippers/{shipperId}/addresses

post

https://api.dev.orbit.do/v5/shippers/{shipperId}/addresses

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

shipperId

string

required

Body Params

shipper address to create

shipperTeamId

string

Optional ShipperTeam id to scope the address to one team of the shipper.

address

object

required

The postal address (company name, street, zip code, city, country). Country accepts ISO 3166-1 alpha-2, alpha-3, and recognized localized country names; recognized values are normalized and stored as alpha-3, unrecognized values are stored as sent.

geocoded

object

contacts

array of objects

Contact persons reachable at this address.

contacts

openingHours

array of objects

Weekly opening hours, per stop action (general/pickup/dropoff).

openingHours

loadingPoints

array of objects

Loading points (docks/gates) at this address, each with optional own coordinates and opening hours.

loadingPoints

defaultLoadingPointId

string

Id of the loading point in this request's loadingPoints that becomes the address's default loading point. The referenced entry must carry this id in the same request; an id that matches no supplied entry is rejected.

defaultContactId

string

Id of the contact in this request's contacts that becomes the address's default contact. The referenced entry must carry this id in the same request; an id that matches no supplied entry is rejected.

Responses

401

unauthorized

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200created shipper address