Here is a list of additional object references for BBA Integration APIs.
...
Name | Schema |
---|---|
carrierProfileId optional | string |
channel optional | string |
clickandCollect optional | string |
currency optional | string |
dangerousGoods optional | boolean |
displayPriceOverride optional | string |
displayRuleName optional | string |
fixValue optional | integer (int32) |
giftWrapping optional | boolean |
id optional | string |
maxHeight optional | number |
maxLength optional | number |
maxPrice optional | number |
maxWeight optional | number |
MaxWidth optional | number |
measureUnit optional | enum (cm, in, m, ft, mm) |
minHeight optional | number |
minLength optional | number |
minPrice optional | number |
minWeight optional | number |
minWidth optional | number |
name optional | string |
office optional | string |
percentageValue optional | integer (int32) |
poBox optional | boolean |
priority optional | integer (int32) |
regions optional | < Regions> array |
serviceProfileID optional | string |
unattendedDelivery optional | boolean |
user optional | string |
weightUnit optional | enum (grams, kilograms, ounces, pounds) |
...
Name | Description | Schema |
---|---|---|
active optional | Service profile activation status Example : false | boolean |
bbaProfileId optional | Associated BBA profile identifier | integer (int64) |
carrierAccountCode optional | Service profile carrier account code | string |
carrierProfile optional | Service profile carrier profile | |
currency optional | Service profile currency | string |
detailHidden optional | Service profile detail hidden Example : false | boolean |
driverDirectEnabled optional | boolean | |
fuelLevy optional | Service profile fuel levy | |
id optional | Service profile identifier | string |
marginEnabled optional | boolean | |
name optional | Service profile name | string |
networkEffect optional | Service profile network effect | |
owned optional | boolean | |
profileSettings optional | Service profile settings | < ProfileSettings > array |
readOnly optional | Boolean | |
received optional | boolean | |
service optional | Service profile service | |
serviceName optional | Service name that is displayed in label | string |
...
Name | Description | Schema |
---|---|---|
active optional | Carrier profile activation status Example : false | boolean |
address1 optional | Carrier profile address line 1 | string |
address2 optional | Carrier profile address line 2 | string |
carrier optional | ${swagger.model.carrier_profile.carrier} | |
driverDirectEnabled optional | boolean | |
optional | Carrier profile email | string |
id optional | Carrier profile identifier | string |
logoUrl optional | ${swagger.model.carrier_profile.url} | string |
marginEnabled optional | boolean | |
name optional | Carrier profile name | string |
networkEffect optional | Carrier profile network effect | |
owned optional | boolean | |
phone1 optional | Carrier profile primary phone | string |
phone2 optional | Carrier profile secondary phone | string |
profileSettings optional | Carrier profile profile settings | < ProfileSettings> array |
readOnly optional | boolean | |
received optional | boolean | |
settings optional | Carrier profile settings | < Settings> array |
website optional | Carrier profile website | string |
...
Name | Description | Schema |
---|---|---|
details optional | Fuel levy details | |
enabled optional | Fuel levy activation status Example : false | boolean |
...
Name | Description | Schema |
---|---|---|
addressValidationExternal optional | ${swagger.model.carrier_partial_information.external_address_validation} Example : false | boolean |
id optional | Carrier identifier | string |
logoUrl optional | Carrier logo URL | string |
name optional | Carrier name | string |
networkEffect optional | Carrier Network Effect | |
productSource optional | product Source | string |
quoteGenerat edByCarrierApi optional | ${swagger.model.carrier_partial_information.external_quo te} Example : false | boolean |
services optional | Carrier services | < ServicePartialInformation> array |
settings optional | Carrier settings | < Settings > array |
shipmentGeneratedByCarrierApi optional | ${swagger.model.carrier_partial_information.external_shipment} Example : false | boolean |
...
Name | Schema |
---|---|
active optional | boolean |
address1 optional | string |
address2 optional | string |
addressValidationExternal optional | boolean |
carrierId optional | string |
companyId optional | integer (int64) |
optional | string |
id optional | string |
locationId optional | integer (int64) |
logoUrl optional | string |
name optional | string |
networkEffect optional | |
phone1 optional | string |
phone2 optional | string |
primaryContact optional | |
productSource optional | string |
quoteGeneratedByCarrierApi optional | boolean |
settings optional | < Settings> array |
shipmentGeneratedByCarrierApi optional | boolean |
website optional | string |
...