Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

« Previous Version 4 Next »

This endpoint is used to create new office by passing JSON request payload. This endpoint can only be accessed by user with company admin or warehouse admin role.

Resource URL

https://api.bbamastro.com.au/auth 🔗

Parameters

Type

Name

Description

Schema

Body

officeDetails

optional

Office request payload

OfficePayload

Responses

HTTP Code

Description

Schema

200

OK

PublicOfficeProjection

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Definitions

mykey

Type: apiKey

Name: Authorization

In: HEADER

OfficePayload

Name

Description

Schema

active

Office activation status

Example : false

boolean

addressLine1

Office address line 1

string

addressLine2

Office address line 2

string

code

Office code

string

companyId

Office company identifier

integer (int64)

currency

Office currency

string

defaultDimensions

optional

Office default dimension

DefaultDimensions

description

Office description

string

driverDirectSetting

optional

${swagger.model.office.driver_direct_setting}

DriverDirectSetting

email

Office email address

string

firstName

Office first name

string

lastName

Office last name

string

location

Office location identifier

integer (int64)

locationProfile

Office location profile

LocationProfile

measureUnit

Office measure unit

enum (cm, in, m, ft, mm)

name

Office name

string

notificationPreferences

Office notification preferences

NotificationPreferences

officeConfiguration

Office configuration

OfficeConfiguration

officeType

Office type (Warehouse/Crossdock/ThirdPartyLogistics)

enum (crossdock, warehouse, thirdpartylogistics)

parentId

Office parent identifier

integer (int64)

phone1

Office primary phone number

string

phone2

Office secondary phone number

string

receiverCode

Office receiver code

string

scheduledPickupTimeList

${swagger.model.office.scheduled_pickup_time_list}

< ScheduledPickupTime > array

senderCode

Office sender code

string

website

Office website

string

weightUnit

Office weight unit

enum (grams, kilograms, ounces, pounds)

PublicOfficeProjection

Name

Description

Schema

active

Office activation status

Example : false

boolean

addressLine1

Office address line 1

string

addressLine2

Office address line 2

string

code

Office code

string

company

Office company

PublicCompanyProjection

currency

Office currency

string

defaultDimensions

optional

Office default dimension

DefaultDimensions

description

Office description

string

driverDirectSetting

optional

${swagger.model.office.driver_direct_setting}

DriverDirectSetting

email

Office email address

string

firstName

Office first name

string

geoLocation

${swagger.model.office.geo_location}

GeoLocation

id

optional

read-only

Office identifier

integer (int64)

lastName

Office last name

string

location

Office location

Location

locationProfile

${swagger.model.office.locationProfile}

LocationProfileProjection

measureUnit

Office measure unit

enum (cm, in, m, ft, mm)

name

Office name

string

notificationPreferences

Office notification preferences

NotificationPreferences

officeConfiguration

Office configuration

OfficeConfiguration

officeType

Office type (Warehouse/Crossdock/ThirdPartyLogistics)

string

parent

Office parent identifier

integer (int64)

phone1

Office primary phone number

string

phone2

Office secondary phone number

string

receiverCode

Office receiver code

string

scheduledPickupTimeList

${swagger.model.office.scheduled_pickup_time_list}

< ScheduledPickupTime > array

senderCode

Office sender code

string

website

Office website

string

weightUnit

Office weight unit

enum (grams, kilograms, ounces, pounds)

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

  • No labels