Get a paginated list of offices. It can be filtered by specific fields.

Resource URL

Cluster	URL

Cluster	URL
Australia	https://api.bbamastro.com/auth/office
US	https://api-us.bbamastro.com/auth/office

Parameters

Type	Name	Description	Schema

Type	Name	Description	Schema
Query	crossDockManifesting optional	Called in Cross Dock Manifesting page	boolean
Query	enabled optional		boolean
Query	firstName optional	Office first name	string
Query	fullName optional	Full name	string
Query	location.code optional		string
Query	location.country.code optional		string
Query	location.country.enabled optional		boolean
Query	location.country.name optional		string
Query	location.enabled optional		boolean
Query	location.id optional		integer (int64)
Query	location.name optional		string
Query	location.state.code optional		string
Query	location.state.enabled optional		boolean
Query	location.state.name optional		string
Query	phone optional	Phone	string
Query	reseller_id optional	Reseller Id	integer (int64)

Responses

HTTP Code	Description	Schema

HTTP Code	Description	Schema
200	OK	Page<<PublicOfficeProjection>>
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

Definitions

mykey

Type: apiKey

Name: Authorization

In: HEADER

Page<<PublicOfficeProjection>>

Name	Schema

Name	Schema
content optional	< PublicOfficeProjection > array
first optional	boolean
last optional	boolean
number optional	integer (int32)
numberOfElements optional	integer (int32)
size optional	integer (int32)
sort optional	Sort
totalElements optional	integer (int64)
totalPages optional	integer (int32)

PublicOfficeProjection

Name	Description	Schema

Name	Description	Schema
active optional	Office activation status Example : false	boolean
addressLine1 optional	Office address line 1	string
addressLine2 optional	Office address line 2	string
code optional	Office code	string
company optional	Office company	PublicCompanyProjection
currency optional	Office currency	string
defaultDimensions optional	Office default dimension	DefaultDimensions
description optional	Office description	string
driverDirectSetting optional	${swagger.model.office.driver_direct_setting}	DriverDirectSetting
email optional	Office email address	string
firstName optional	Office first name	string
geoLocation optional	${swagger.model.office.geo_location}	GeoLocation
id optional read-only	Office identifier	integer (int64)
lastName optional	Office last name	string
location optional	Office location	Location
locationProfile optional	${swagger.model.office.locationProfile}	LocationProfileProjection
measureUnit optional	Office measure unit	enum (cm, in, m, ft, mm)
name optional	Office name	string
notificationPreferences optional	Office notification preferences	NotificationPreferences
officeConfiguration optional	Office configuration	OfficeConfiguration
officeType optional	Office type (Warehouse/Crossdock/ThirdPartyLogistics)	string
parent optional	Office parent identifier	integer (int64)
phone1 optional	Office primary phone number	string
phone2 optional	Office secondary phone number	string
receiverCode optional	Office receiver code	string
scheduledPickupTimeList optional	${swagger.model.office.scheduled_pickup_time_list}	< ScheduledPickupTime > array
senderCode optional	Office sender code	string
website optional	Office website	string
weightUnit optional	Office weight unit	enum (grams, kilograms, ounces, pounds)
goodsCheck	Goods check	GoodsCheck

Please refer to the Additional Reference section for more information on BBA Integration API objects.

API Integration

GET /office

Analytics