Skip to content

List all ship-tos

GET
/ship-tos

Retrieve a paginated list of delivery destinations

page
integer
default: 1
page_size
integer
default: 50
customer_id
string
archived
boolean
organization_id
string
unit_id
string
service_area_id
string

List of ship-tos

object
data
Array
total
integer
page
integer
page_size
integer
has_more
boolean
data
Array<object>
object
id
string
company_id
string | null
external_id
string | null
customer_id
string | null
location_id
string | null
organization_id
string | null
unit_id
string | null
name
string | null
archived
boolean
area
string | null
preferences
object | null
primary_terminal_id
string | null
secondary_terminal_id
string | null
open_time
string | null
close_time
string | null
metadata
object | null
note
string | null
service_area_id
string | null
preferred_start_time
string | null
preferred_end_time
string | null
sales_rep_id
string | null
has_tanks
boolean
fuel_ship_to
boolean | null
fuel_transport
boolean | null
freight_id
string | null
billing_profile_id
string | null
tmw_id
string | null
units
array | null
last_modified_date
string | null format: date-time

Unauthorized

object
success
required
boolean
error
required
string
Example
An error occurred