Creates a new address book entry

Request
Security:
Request Body schema: application/json
Array of objects (Accessorial)
required
object (Address)
company_name
string or null
created_at
string or null <date-time>
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 or null
id
string or null <uuid>
is_default_origin
required
boolean
object (LoadCapacitySchedule)

Information about the per day capacity available at this location

location_name
required
string
object (LocationType)
notes
string or null
Array of objects (PointOfContact)
updated_at
string or null <date-time>
Responses
201

Successfully created a new address book entry

Response Schema: application/json
Array of objects (Accessorial)
required
object (Address)
company_name
string or null
created_at
string or null <date-time>
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 or null
id
string or null <uuid>
is_default_origin
required
boolean
object (LoadCapacitySchedule)

Information about the per day capacity available at this location

location_name
required
string
object (LocationType)
notes
string or null
Array of objects (PointOfContact)
updated_at
string or null <date-time>
default

Default error response

post/address-book/
Request samples
application/json
{
  • "accessorials": [
    ],
  • "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",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "is_default_origin": true,
  • "load_capacity_schedule": {
    },
  • "location_name": "string",
  • "location_type": {
    },
  • "notes": "string",
  • "point_of_contacts": [
    ],
  • "updated_at": "2019-08-24T14:15:22Z"
}
Response samples
application/json
{
  • "accessorials": [
    ],
  • "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",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "is_default_origin": true,
  • "load_capacity_schedule": {
    },
  • "location_name": "string",
  • "location_type": {
    },
  • "notes": "string",
  • "point_of_contacts": [
    ],
  • "updated_at": "2019-08-24T14:15:22Z"
}
Copyright © Shipwell 2022. All right reserved.