Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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

contentWeight

optional

number

cubicWeight

optional

number

height

optional

number

index

optional

integer (int32)

items

optional

< Item > array

labelEndPage

optional

integer (int32)

labelStartPage

optional

integer (int32)

length

optional

number

measureUnit

optional

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

packagingID

optional

string

quantity

optional

integer (int32)

type

optional

string

weight

optional

number

weightUnit

optional

enum (grams, kilograms, ounces, pounds)

width

optional

number

PickupDetails

Name

Schema

asap

optional

boolean

pickupDate

optional

string (date-time)

pickupEarliestTime

optional

string

pickupLatestTime

optional

string

pickupTimeZone

optional

string

...

Name

Schema

approved

optional

boolean

carrierId

optional

string

carrierProfileId

optional

string

companyId

optional

string

createdBy

optional

string

createdDate

optional

string (date-time)

documentData

optional

string (byte)

id

optional

string

lastModifiedBy

optional

string

lastModifiedDate

optional

string (date-time)

manifestNumber

optional

integer (int64)

officeId

optional

string

orderId

optional

string

serviceProfileId

optional

string

shipments

optional

< Shipment> array

shipmentsToCrossdock

optional

< Shipment> array

Package

Name

Description

Schema

contentWeight

optional

Package content weight

number

cubicMeter

optional

Package cubic meter

number

cubicWeight

optional

${swagger.model.package.cubic_weight}

number

height

optional

Package height

number

index

optional

Package index

integer (int32)

labelEndPage

optional

Package end page in label

integer (int32)

labelStartPage

optional

Package start page in label

integer (int32)

length

optional

Package length

number

measureUnit

optional

Package measure unit

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

packagingId

optional

Package packaging identifier

integer (int64)

quantity

optional

Package quantity

integer (in32)

weight

optional

Package weight

number

weightUnit

optional

Package weight unit

enum (grams, kilograms, ounces, pounds)

width

optional

Package width

number

...