Australia

https://api-demo.bbamastro.com/shipment/shipment

US

https://api-us.bbamastro.com/shipment/shipment

Query

bookingStatus

optional

Filter by booking statuses

enum (NEW, UNPROCESSED, INPROGRESS, PENDING, PROCESSED)

Query

carrierName

optional

Filter by shipment carrier name

< string > array (multi)

Query

carrierProfileName

optional

Filter by shipment carrier profile name

string

Query

companyName

optional

Filter by company name where the shipment created

string

Query

consignmentId

optional

Filter by consignment identifier

string

Query

customerName

optional

Filter by shipment customer name

string

Query

customerReferences

optional

${swagger.filter.shipment.customer_references}

string

Query

difotSummary

optional

Filter shipment by DIFOT summary

boolean

Query

endDate

optional

Filter by shipment created date end to

string (date-time)

Query

eta

optional

Filter by shipment ETA

string

Query

inTime

optional

Filter by shipment that delivered in time

boolean

Query

itemQty

optional

Filter by shipment total item quantity

integer (int32)

Query

job.id

optional

${swagger.filter.shipment.job}

string

Query

locationName

optional

Filter by shipment location name

string

Query

manifested

optional

Filter by shipment manifested status

boolean

Query

marketplace

optional

Filter by shipment marketplace

boolean

Query

marketplaceType

optional

Filter by shipment marketplace type

< enum (magento, magentov2, woocommerce, shopify, csv, cart3d, aceshop, amazon, aspdotnetstorefront, bigcommerce, loadedcommerce, cscart, cubecart, demandware, ebay, ecwid, etsy, gambio, interspire, joocart, mijoshop, neto, opencart, oscmax, oscommerce, oxid, pinnacle, prestashop, sspremium, shopware, tomatocart, ubercart, virtuemart, volusion, wpecommerce, webasyst, xcart, xtcommerce, xtcommerceveyton, zencart) > array (multi)

Query

officeName

optional

Filter by office name where the shipment created

string

Query

outOfTime

optional

Filter by shipment that delivered out of time

boolean

Query

pickupDateTime

optional

Filter by ETA

string (date-time)

Query

qtyBySku

optional

Filter by any SKU quantity in shipment

< string > array(multi)

Query

removeDelivered

optional

Remove delivered shipment

boolean

Query

resellerId

optional

Company reseller identifier

integer (int64)

Query

returns

optional

Filter by shipment return status

boolean

Query

serviceName

optional

Filter by shipment carrier service name

< string > array(multi)

Query

serviceProfileName

optional

Filter by shipment service profile name

string

Query

shipmentPerDay

optional

Filter by shipment per day

boolean

Query

skuQty

optional

Filter by shipment contains SKU quantity

integer (int32)

Query

split

optional

Filter by split shipment status

boolean

Query

startDate

optional

Filter by shipment created date start from

string (date-time)

Query

trackingNumber

optional

Filter by tracking number

string

Query

user.active

optional

boolean

Query

userEmail

optional

Filter by shipment user email

string

200

OK

Page <<ShipmentPublicProjection>>

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

content

optional

< ShipmentPublicProjection> array

first

optional

boolean

last

optional

boolean

number

optional

integer (int32)

numberOfElements

optional

integer (int32)

size

optional

integer (int32)

sort

optional

Sort

totalElements

optional

integer (int64)

totalPages

optional

integer (int32)

accompanied Delivery

optional

Indicate if the delivery will be accompanied by another person

Example : false

boolean

active

optional

Shipment activation status

Example : false

boolean

amount

optional

Shipment amount

number

appliedShippingRule

optional

Shipping rules that are applied to shipment

ShippingRule

bbaReferenceNumber

optional

Shipment BBA Reference number

string

billed

optional

boolean

bookingDate

optional

The date when shipment booked

string (date-time)

bookingStatus

optional

Shipment booking status

enum (new, unprocessed, inprogress, pending, processed)

breakBulkDetails

optional

${swagger.model.shipment.break_bulk_details}

BreakBulkDetails

carrierBookingOptions

optional

${swagger.model.shipment.carrier_booking_options}

< string, string > map

carrierConfiguration

optional

${swagger.model.shipment.job}

CarrierConfiguratio nProjection

carrierOrderId

optional

${swagger.model.shipment.carrierOrderId}

string

clientPresent

optional

Indicate if client will be present to assist the receiving of shipment

Example: false

boolean

company

optional

Shipment company

Company

consignmentId

optional

Shipment consignment identifier

string

consolidation

optional

Shipment consolidation

ShipmentConsolidation

containerId

optional

Shipment crossdock container identifier

string

containerName

optional

Shipment crossdock container name

string

containerType

optional

Shipment crossdock container type

enum (bag, box, carton, case, crate, envelope, pallet, rack, sack, tray)

createdDate

optional

The date when shipment created

string (date-time)

currency

optional

Shipment currency

string

customerReferences

optional

Shipment customer references

< string > array

dangerousGoods

optional

Indicate if shipment contains dangerous goods

Example : false

boolean

deliveredDate

optional

The date when shipment delivered

string (date-time)

description

optional

Shipment description

string

destinationAddress

optional

Shipment destination address

AddressPublicProjection

id

Shipment identifier

string

items

optional

Items contained in shipment

< ItemPublicProjection > array

job

optional

${swagger.model.shipment.job}

Job

lastDocumentPrintedTime

optional

The time when shipment document printed

string (date-time)

lastModifiedDate

optional

Date when the last time shipment data modified

string (date-time)

manifestId

optional

Shipment manifest identifier

string

manifesteNo

optional

Shipment manifest number

integer (int64)

manifestedDate

optional

${swagger.model.shipment.manifest_date}

string (date-time)

marketplaceId

optional

Shipment marketplace identifier

string

maxDeliveryDate

optional

string (date-time)

notifyReceiver

optional

Notify receiver for any update of this shipment

Example : false

boolean

notifySender

optional

Notify sender for any update of this shipment

Example : false

boolean

office

optional

Shipment office

OfficeProjection

officeTransitionHistory

optional

Shipment office transition history

< string > array

originalConsignmentId

optional

Shipment original consignment identifier (for return shipment)

string

originalShipmentId

optional

Original shipment id (for return shipment)

string

packDescAutoPopulate

optional

Indicate if shipment package is auto populate

Example : false

boolean

packages

optional

Shipment packages

< PackagePublicProjection > array

packaging

optional

Shipment packaging

string

pickupDetails

optional

Shipment pickup details

PickupDetails

poBox

optional

Indicate if shipment has PO BOX

Example : false

boolean

previousTrackingStatus

optional

Shipment previous tracking status

enum (documentationprepared, bookingarranged, collected, intransit, arrivedatdestination , outfordelivery, delivered, instore, missing)

purchasedDate

optional

The date when shipment purchased

string (date-time)

readyForProcess

optional

Indicate if shipment ready for process

Example : false

boolean

reasonForShipping

optional

Shipment reason for shipping

enum (purchase, gift)

returnAuthorityNumber

optional

Shipment return authority number

string

serviceDetails

optional

Shipment carrier service details

ServiceDetails

serviceProfile

optional

${swagger.model.shipment.service_profile}

ServiceProfile

shippingCost

optional

Shipment shipping cost

ShippingCost

sourceAddress

optional

Shipment source address

AddressPublicProjection

specialInstructions

optional

Shipment special instructions

string

sscc

optional

Shipment SSCC number

string

surcharge

optional

Shipment surcharge

Surcharge

tailGate

optional

Indicate if shipment tail gate status

Example : false

boolean

taxStatus

optional

Shipment tax status

enum (private)

timeBasedRateDetail

optional

Time base rate detail

TimeBasedRateDetail

trackingNumber

optional

Shipment tracking number

string

trackingStatus

optional

Shipment tracking status

enum (documentationprep ared, bookingarranged, collected, intransit, arrivedatdestination , outfordelivery, delivered, instore, missing)

trolleyRequired

optional

Indicate if a trolley will be required for shipping

Example : false

boolean

unattendedDelivery

optional

Indicate if shipment can be delivered unattended

Example : false

boolean

user

optional

Shipment user

string

validationResults

optional

Indicate if shipment data is valid

ValidationResult

withheld

optional

Indicates that the shipment in on hold

Example : false

boolean