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.

Name	Description	Schema
active optionalrequired	Office activation status Example : false	boolean
addressLine1 optionalrequired	Office address line 1	string
addressLine2 optional	Office address line 2	string
code optionalrequired	Office code	string
companyId optionalrequired	Office company identifier	integer (int64)
currency optionalrequired	Office currency	string
defaultDimensions optionalrequired	Office default dimension	DefaultDimensions
description optionalrequired	Office description	string
driverDirectSetting optional	${swagger.model.office.driver_direct_setting}	DriverDirectSetting
email optionalrequired	Office email address	string
firstName optionalrequired	Office first name	string
lastName optional	Office last name	string
location optionalrequired	Office location identifier	integer (int64)
locationProfile optional	Office location profile	LocationProfile
measureUnit optionalrequired	Office measure unit	enum (cm, in, m, ft, mm)
name optionalrequired	Office name	string
notificationPreferences optionalrequired	Office notification preferences	NotificationPreferences
officeConfiguration optional	Office configuration	OfficeConfiguration
officeType optionalrequired	Office type (Warehouse/Crossdock/ThirdPartyLogistics)	enum (crossdock, warehouse, thirdpartylogistics)
parentId optional	Office parent identifier	integer (int64)
phone1 optionalrequired	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}Office schedule pickup time list	< ScheduledPickupTime > array
senderCode optional	Office sender code	string
website optional	Office website	string
weightUnit optionalrequired	Office weight unit	enum (grams, kilograms, ounces, pounds)
goodsCheck required	Office goods check	GoodsCheck

PublicOfficeProjection

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

Request Payload Sample

Code Block

{
    "name": "Test office name",
    "active": true,
    "addressLine1": "stringTest address 1",
    "addressLine2": "string"null,
    "code": "stringTST",
    "companyId": 075,
    "currency": "stringAUD",
    "defaultDimensions": {
        "defaultHeight": 0,
        "defaultLength": 0,
        "defaultWeight": 0,
        "defaultWidth": 0,
        "enableDefaultDimension": false
true    },
    "description": "stringthis is test office",
    "driverDirectSetting": {
        "autoJobAssignationEnabled": truefalse,
        "callCustomer": truefalse,
        "customerSignature": truefalse,
        "driverCommissionFixed": 0,
        "driverCommissionPercentage": 0,
        "driverDirectEnabled": truefalse,
        "emailNotification": truefalse,
        "jobSplittingEnabled": truefalse,
        "keepPackageUntilRedelivery": truefalse,
        "maxCarryOnWeightPerPerson": 0,
        "maxJob": 0,
        "p2pEnabled": truefalse,
        "pickupFeeEnabled": truefalse,
        "requiredPackageScanning": truefalse,
        "returnPackageToDepot": truefalse,
        "shipmentTypes": [
            "regular"
        ],
        "smsNotification": truefalse,
        "unattendedPodPicture": truefalse
    },
    "email": "stringtest@mailinator.com",
    "enableUpdate": truefalse,
    "firstName": "John",
    "lastName": "stringDoe",
    "goodsCheck": {
        "accompaniedDelivery": truefalse,
        "clientPresent": truefalse,
        "dangerousGoods": truefalse,
        "fragile": truefalse,
        "handUnload": truefalse,
        "poBox": truefalse,
        "residentialDelivery": truefalse,
        "residentialPickup": truefalse,
        "tailGatetrolleyRequired": truefalse,
        "trolleyRequiredunattendedDelivery": truefalse,
        "unattendedDeliverytailGateDelivery": false,
 true    },   "lastNametailGatePickup": false,
        "string",perishableGood": false
    },    
    "location": 014415,
    "locationProfile": {
        "address1": "stringTest address 1",
        "address2": "string"null,
        "email": "stringtest@mailintor.com",
        "firstName": "stringJohn",
        "lastName": "stringDoe",
        "location": 014415,
        "phone1": "string+612394854",
        "phone2": "string"null
    },
    "measureUnit": "cm",
    "namenotificationPreferences": "string",{
  "notificationPreferences": {     "notifyPendingShipment": truefalse,
        "notifyQuoteAndBook": truefalse,
        "notifyReturns": truefalse
    },
    "officeConfiguration": {
        "breakBulkManifesting": truefalse,
        "containerizationEnabled": truefalse,
        "createPickupJob": truefalse,
        "creditLimit": "stringfalse",
        "crossDockManifestingEnabled": truefalse,
        "crossDockStraightThroughEnabled": truefalse,
        "ddp": truefalse,
        "defaultWarehouse": truefalse,
        "emailTrackingToReceiver": truefalse,
        "instructionsDocumentEnabled": truefalse,
        "jobDeliveredToScanCrossDockShipmentEnabled": truefalse,
        "manifesting": truefalse,
        "paperlessTradingEnabled": truefalse,
        "satchelOnlyInQuote": truefalse,
        "scheduledPickup": truefalse,
        "smsNotificationEnabled": truefalse,
        "thermal": truefalse,
        "timeZone": "stringaustralia/sydney"
    },
    "officeType": "crossdockwarehouse",
    "parentId": 0null,
    "phone1": "string+612394854",
    "phone2": "string"null,
    "receiverCode": "string"null,
    "senderCode": "string"null,
    "tax": 0,
    "website": "string"null,
    "weightUnit": "grams"
}

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

...

Version	Old Version 15	New Version Current
Changes made by	Zulfy Adi Harianto	Zulfy Adi Harianto
Saved on	Aug 19, 2024	Aug 19, 2024

Versions Compared

Key

PublicOfficeProjection

Request Payload Sample

Content Comparison

Versions Compared

Key

PublicOfficeProjection

Request Payload Sample