Creates a new address book entry

SecurityAuthToken
Request
Request Body schema: application/json
required
Array of objects (Accessorial)
account_reps
Array of strings or null
required
object (Address)
company_name
string or null
created_at
string or null <date-time>

Ignored in request bodies

object (LocationCustomData)

Custom data for Location

object (AppointmentType)
dock_external_id
string or null
dock_hours_end
string or null <time>
dock_hours_start
string or null <time>
external_reference
string
facility_id
string or null
friday_close_time
string or null <time>
friday_open_time
string or null <time>
id
string or null <uuid>

Ignored in request bodies

is_default_origin
required
boolean
object (LoadCapacitySchedule)

Information about the per day capacity available at this location

location_name
required
string
object (LocationType)
monday_close_time
string or null <time>
monday_open_time
string or null <time>
notes
string or null
open_friday
boolean
open_monday
boolean
open_saturday
boolean
open_sunday
boolean
open_thursday
boolean
open_tuesday
boolean
open_wednesday
boolean
Array of objects (PointOfContact)
saturday_close_time
string or null <time>
saturday_open_time
string or null <time>
sunday_close_time
string or null <time>
sunday_open_time
string or null <time>
thursday_close_time
string or null <time>
thursday_open_time
string or null <time>
tuesday_close_time
string or null <time>
tuesday_open_time
string or null <time>
updated_at
string or null <date-time>

Ignored in request bodies

wednesday_close_time
string or null <time>
wednesday_open_time
string or null <time>
Responses
201

Successfully created a new address book entry

Response Schema: application/json
Array of objects (Accessorial)
account_reps
Array of strings or null
required
object (Address)
company_name
string or null
created_at
string or null <date-time>

Ignored in request bodies

object (LocationCustomData)

Custom data for Location

object (AppointmentType)
dock_external_id
string or null
dock_hours_end
string or null <time>
dock_hours_start
string or null <time>
external_reference
string
facility_id
string or null
friday_close_time
string or null <time>
friday_open_time
string or null <time>
id
string or null <uuid>

Ignored in request bodies

is_default_origin
required
boolean
object (LoadCapacitySchedule)

Information about the per day capacity available at this location

location_name
required
string
object (LocationType)
monday_close_time
string or null <time>
monday_open_time
string or null <time>
notes
string or null
open_friday
boolean
open_monday
boolean
open_saturday
boolean
open_sunday
boolean
open_thursday
boolean
open_tuesday
boolean
open_wednesday
boolean
Array of objects (PointOfContact)
saturday_close_time
string or null <time>
saturday_open_time
string or null <time>
sunday_close_time
string or null <time>
sunday_open_time
string or null <time>
thursday_close_time
string or null <time>
thursday_open_time
string or null <time>
tuesday_close_time
string or null <time>
tuesday_open_time
string or null <time>
updated_at
string or null <date-time>

Ignored in request bodies

wednesday_close_time
string or null <time>
wednesday_open_time
string or null <time>
default

Default error response

post/address-book/
Request samples
application/json
{
  • "accessorials": [
    ],
  • "account_reps": [
    ],
  • "address": {
    },
  • "company_name": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "custom_data": { },
  • "default_appointment_type": {
    },
  • "dock_external_id": "string",
  • "dock_hours_end": "14:15:22Z",
  • "dock_hours_start": "14:15:22Z",
  • "external_reference": "string",
  • "facility_id": "string",
  • "friday_close_time": "14:15:22Z",
  • "friday_open_time": "14:15:22Z",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "is_default_origin": true,
  • "load_capacity_schedule": {
    },
  • "location_name": "string",
  • "location_type": {
    },
  • "monday_close_time": "14:15:22Z",
  • "monday_open_time": "14:15:22Z",
  • "notes": "string",
  • "open_friday": true,
  • "open_monday": true,
  • "open_saturday": true,
  • "open_sunday": true,
  • "open_thursday": true,
  • "open_tuesday": true,
  • "open_wednesday": true,
  • "point_of_contacts": [
    ],
  • "saturday_close_time": "14:15:22Z",
  • "saturday_open_time": "14:15:22Z",
  • "sunday_close_time": "14:15:22Z",
  • "sunday_open_time": "14:15:22Z",
  • "thursday_close_time": "14:15:22Z",
  • "thursday_open_time": "14:15:22Z",
  • "tuesday_close_time": "14:15:22Z",
  • "tuesday_open_time": "14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "wednesday_close_time": "14:15:22Z",
  • "wednesday_open_time": "14:15:22Z"
}
Response samples
application/json
{
  • "accessorials": [
    ],
  • "account_reps": [
    ],
  • "address": {
    },
  • "company_name": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "custom_data": { },
  • "default_appointment_type": {
    },
  • "dock_external_id": "string",
  • "dock_hours_end": "14:15:22Z",
  • "dock_hours_start": "14:15:22Z",
  • "external_reference": "string",
  • "facility_id": "string",
  • "friday_close_time": "14:15:22Z",
  • "friday_open_time": "14:15:22Z",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "is_default_origin": true,
  • "load_capacity_schedule": {
    },
  • "location_name": "string",
  • "location_type": {
    },
  • "monday_close_time": "14:15:22Z",
  • "monday_open_time": "14:15:22Z",
  • "notes": "string",
  • "open_friday": true,
  • "open_monday": true,
  • "open_saturday": true,
  • "open_sunday": true,
  • "open_thursday": true,
  • "open_tuesday": true,
  • "open_wednesday": true,
  • "point_of_contacts": [
    ],
  • "saturday_close_time": "14:15:22Z",
  • "saturday_open_time": "14:15:22Z",
  • "sunday_close_time": "14:15:22Z",
  • "sunday_open_time": "14:15:22Z",
  • "thursday_close_time": "14:15:22Z",
  • "thursday_open_time": "14:15:22Z",
  • "tuesday_close_time": "14:15:22Z",
  • "tuesday_open_time": "14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "wednesday_close_time": "14:15:22Z",
  • "wednesday_open_time": "14:15:22Z"
}
Copyright © Shipwell 2024. All right reserved.