/shippers/{shipperId}/addresses

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

Responses

Response body

object

string

required

tenantId

string

required

shipperId

string

required

shipperTeamId

string

companyName

string

required

street

string

required

houseNumber

string

zipCode

string

required

city

string

required

country

required

contacts

array of objects

contacts

object

string

required

shipperUserId

name

extraInfo

properties

object | null

Key-value pairs in the dictionary have property IDs as keys. Property keys and their values appear only when the property value is explicitly set. The dictionary doesn't have default values, so retrieved property values are always undefined by default. Note: Data is stored even if the property definition doesn't exist. If there's no property definition, values won't be displayed on the frontend but can still be present in the dictionary.

Has additional fields

channels

array of objects

required

channels*

object

type

string

required

phone mobile email fax

subtype

string

required

office home work group-mailbox personal

value

string

required

isPrimaryChannel

boolean

extraInfo

string

geocoded

object

required

title

string

politicalView

string

resultType

string

administrativeArea locality street intersection addressBlock houseNumber postalCodePoint place

houseNumberType

string

PA interpolated

addressBlockType

string

block subblock

localityType

string

postalCode subdistrict district city

administrativeAreaType

string

county state country

address

object

position

object

access

array of objects

access

object

lat

number

required

lng

number

required

distance

number

mapView

object

houseNumberFallback

boolean

timeZone

object

streetInfo

array of objects

streetInfo

object

baseName

string

streetType

string

streetTypePrecedes

boolean

streetTypeAttached

boolean

prefix

string

suffix

string

direction

string

language

string

countryInfo

object

properties

object

Has additional fields

createdAt

number

required

updatedAt

number

required

openingHours

array of objects

openingHours

object

action

string

Defaults to general

general pickup dropoff

monday

object

required

tuesday

object

required

wednesday

object

required

thursday

object

required

friday

object

required

saturday

object

required

sunday

object

required

dateOverrides

array of objects

Defaults to

dateOverrides

object

open

boolean

required

dateRange

string

required

times

array

required

times*

loadingPoints

array of objects

loadingPoints

object

string

required

shipperAddressId

string

name

string

required

description

string

longitude

number

latitude

number

openingHours

object

properties

object | null

Has additional fields

actions

array of strings

actions

source

contactName

string

contactPhone

string

contactEmail

string

401

unauthorized

Language

Credentials

Header

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api-dev.orbit.do/v5/shippers/shipperId/addresses \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

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

application/json

200created shipper address