Here is a list of additional object references for BBA Integration APIs.
...
Name | Schema |
|---|---|
addressLine1 optional | string |
addressLine2 optional | string |
city optional | string |
country optional | string |
postcode optional | string |
...
Package
Name | Schema | |
|---|---|---|
categoriescontentWeight optional | < string > array | codenumber |
cubicWeight optional | stringnumber | |
countryheight optional | stringnumber | |
currencyindex optional | string | descriptioninteger (int32) |
items optional | string | height< Item > array |
labelEndPage optional | number | idinteger (int32) |
labelStartPage optional | string | |
itemType optional | string | |
integer (int32) | ||
length optional | numbermanufacturer optional | string |
measureUnit optional | enum (cm, in, m, ft, mm) | |
namepackagingID optional | string | |
quantity optional | integer (int32) | |
remoteID optional | string | |
returnredQuantity optional | integer (int32) | |
sku type optional | string taxes optional | string |
value optional | number | |
weight optional | number | |
weightUnit optional | enum (grams, kiogramskilograms, ounces, pounds) | |
width optional | number |
...
PickupDetails
Name | Schema | ||
|---|---|---|---|
contentWeightasap optional | numberboolean | ||
cubicWeightpickupDate optional | number | heightstring (date-time) | |
pickupEarliestTime optional | numberstring | ||
indexpickupLatestTime optional | integer (int32) | itemsstring | |
pickupTimeZone optional | < Item > array | labelEndPage | string |
BreakBulkDetails
Name | Schema | |
|---|---|---|
firstMile optional | integer (int32) | labelStartPageBreakBulkStepSummary |
id optional | integer interger (int32) | |
lengthlastMile optional | numberBreakBulkStepSummary | |
measureUnitlineHaul optional | enum (cm, in, m, ft, mm) | packagingIDBreakBulkStepSummary |
name optional | stringquantity |
CarrierBookingOption
integer (int32) | typeName | Schema |
|---|---|---|
defaultValue optional | string | |
weightlistValues optional | number | weightUnit< string > array |
name optional | enum (grams, kilograms, ounces, pounds) | widthstring |
type optional | numberstring |
...
Operation
Name | Schema |
|---|---|
asapcarrierProfileId optional | booleanstring |
pickupDatechannel optional | string (date-time) |
pickupEarliestTimeclickandCollect optional | string |
pickupLatestTimecurrency optional | string |
pickupTimeZonedangerousGoods optional | stringboolean |
...
displayPriceOverride | Nameoptional | Schemastring |
firstMiledisplayRuleName optional | BreakBulkStepSummarystring | |
idfixValue optional | interger integer (int32) | |
lastMilegiftWrapping optional | BreakBulkStepSummaryboolean | |
lineHaulid optional | BreakBulkStepSummarystring | |
namemaxHeight optional | stringnumber |
...
maxLength | Nameoptional | Schemanumber |
defaultValuemaxPrice optional | stringnumber | |
listValuesmaxWeight optional | < string > array | namenumber |
MaxWidth optional | stringnumber | |
Name | Schema | |
|---|---|---|
carrierProfileId optional | string | |
channel optional | string | |
clickandCollect optional | string | |
currency optional | string | |
dangerousGoods optional | boolean | |
typemeasureUnit optional | string |
Operation
displayPriceOverrideenum (cm, in, m, ft, mm) | |||
minHeight optional | number | ||
minLength optional | number | ||
minPrice optional | number | ||
minWeight optional | number | ||
minWidth optional | number | ||
name optional | string | ||
displayRuleNameoffice optional | string | ||
fixValuepercentageValue optional | integer (int32) | ||
giftWrappingpoBox optional | boolean | ||
idpriority optional | string | maxHeightinteger (int32) | |
regions optional | number | maxLength< Regions> array | |
serviceProfileID optional | numberstring | ||
maxPriceunattendedDelivery optional | numberboolean | ||
maxWeightuser optional | numberstring | ||
MaxWidthweightUnit optional | number | measureUnit optional | enum (cmgrams, inkilograms, mounces, ft, mmpounds)minHeight |
Original
Name | optionalDescription | numberSchema |
|---|---|---|
minLengthamount optional | Quote original amount | number |
minPricecurrency optional | Quote original currency | numberstring |
minWeightrate optional | Quote original rate | number |
ServiceProfileProjection
Name | optionalDescription | numberSchema | |
|---|---|---|---|
nameactive optional | string | ||
office optional | string | ||
percentageValue optionalService profile activation status Example : false | boolean | ||
bbaProfileId optional | Associated BBA profile identifier | integer (int32int64) | |
poBoxcarrierAccountCode optional | boolean | priorityService profile carrier account code | string |
carrierProfile optional | integer (int32) | regions optional | < Regions> array|
serviceProfileID optional | string | ||
unattendedDelivery optional | boolean | ||
user optional | string | ||
weightUnit optional | enum (grams, kilograms, ounces, pounds) |
Original
...
Name
...
Description
...
Schema
...
amount
optional
...
Quote original amount
number
...
currency
optional
...
Quote original currency
...
string
...
rate
optional
...
Quote original rate
...
number
ServiceProfileProjection
...
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
TimeRateDetailProjection
...
Name
...
Description
...
Schema
...
hourlyRate
optional
...
Time based rate hourly rate
number
...
maxAmount
optional
...
Time based rate maximum amount
...
number
...
maxDuration
optional
...
Time based rate maximum duration
...
number
...
maxTax
optional
...
Time based rate maximum tax
...
number
...
maxVariance
optional
...
Time based rate maximum variance
...
number
...
minAmount
optional
...
Time based rate minimum amount
...
number
...
minDuration
optional
...
Time based rate minimum duration
...
number
...
minTax
optional
...
Time based rate minimum tax
...
number
...
minVariance
optional
...
Time based rate minimum variance
...
number
Items
Name | Schema | categories optional |
|---|---|---|
code optional | string | |
country optional | string | |
currency optional | string | |
description optional | string | |
height optional | number | |
id optional | string | |
itemType optional | string | |
length optional | number | |
manufacturer optional | string | |
measureUnit optional | enum (cm, in, m, ft, mm) | |
name optional | string | |
quantity optional | integer (int32) | |
remodeId optional | string | |
returnedQuantity optional | integer (int32) | |
sku optional | string | |
taxes optional | string | |
value optional | number | |
weight optional | number | |
weightUnit optional | enum (grams, kilograms, ounces, pounds | |
width optionalService 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 |
TimeRateDetailProjection
Name | Description | Schema |
|---|---|---|
hourlyRate optional | Time based rate hourly rate | number |
maxAmount optional | Time based rate maximum amount | number |
maxDuration optional | Time based rate maximum duration | number |
maxTax optional | Time based rate maximum tax | number |
maxVariance optional | Time based rate maximum variance | number |
minAmount optional | Time based rate minimum amount | number |
minDuration optional | Time based rate minimum duration | number |
minTax optional | Time based rate minimum tax | number |
minVariance optional | Time based rate minimum variance | number |
BreakBulkStepSummary
...
Name | Description | Schema |
|---|---|---|
account optional | ${swagger.model.accounting.invoice.account} | string |
actualMargin optional | ${swagger.model.accounting.invoice.actual_margin} | number |
actualMarginPercentage optional | ${swagger.model.accounting.invoice.actual_margin_percen tage} | number |
ada optional | ${swagger.model.accounting.invoice.ada} | number |
additionalCharges optional | ${swagger.model.accounting.invoice.additional_charges} | number |
chargebleWeight optional | ${swagger.model.accounting.invoice.chargeable_weight} | number |
ddp optional | ${swagger.model.accounting.invoice.ddp} | number |
exTaxCharge optional | ${swagger.model.accounting.invoice.ex_tax_charge} | number |
exTaxTotal optional | ${swagger.model.accounting.invoice.ex_tax_total} | number |
forProcessing optional | ${swagger.model.accounting.invoice.for_processing} | string |
fuel optional | ${swagger.model.accounting.invoice.fuel} | number |
internalNotes optional | ${swagger.model.accounting.invoice.internal_notes} | < string > array |
invoiceDate optional | ${swagger.model.accounting.invoice.invoice_date} | string (date-time) |
invoiceNotes optional | ${swagger.model.accounting.invoice.invoice_notes} | string |
rdl optional | ${swagger.model.accounting.invoice.rdl} | number |
tax optional | ${swagger.model.accounting.invoice.tax} | number |
tgl optional | ${swagger.model.accounting.invoice.tgl} | number |
weightUnit optional | ${swagger.model.accounting.invoice.weight_unit} | enum (grams, kilograms, ounces, pounds) |
Item
Name | Description | Schema |
|---|---|---|
categories optional | Item categories | < string > array |
code optional | Item code | string |
country optional | Item country | string |
currency optional | Item currency | string |
description optional | Item description | string |
height optional | Item height | number |
id optional | Item identifier | string |
itemType optional | Item type | string |
length optional | Item length | number |
manufacturer optional | Item manufacturer | string |
measureUnit optional | Item measure unit | enum (cm, in, m, ft, mm) |
name optional | Item name | string |
quantity optional | Item quantity | integer (int32) |
remoteId optional | Marketplace item’s identifier | string |
returnedQuantity optional | Item returned quantity | integer (int32) |
sku optional | Item SKU | string |
taxes optional | Item taxes | string |
value optional | Item value | number |
weight optional | Item weight | number |
weightUnit optional | Item weight unit | enum (grams, kilograms, ounces, pounds) |
width optional | Item width | number |
...