Get a paginated list of manifests. It can be filtered by specific fields.
Resource URL
https://api.bbamastro.com.au/shipment🔗
Parameters
Type | Name | Description | Schema |
|---|---|---|---|
Query | carrierId | Carrier identifier | string |
Query | carrierProfileName | Carrier profile name | string |
Query | companyName | Company Name | string |
Query | manifestNum | ${swagger.param.manifest.manifest_num} | string |
Query | officeName optional | Office name | string |
Query | serviceId | Service identifier | string |
Query | serviceProfileName | Service profile name | string |
Body | endDate | Manifest end date | string (date-time) |
Body | startDate | Manifest start date | string (date-time) |
Responses
HTTP Code | Description | Schema |
|---|---|---|
200 | OK | Page<<PublicManifestProjection>> |
401 | Unauthorized | No Content |
403 | Forbidden | No Content |
404 | Not Found | No Content |
...
Definitions
mykey
Type: apiKey
Name: Authorization
In: HEADER
PublicManifestProjection
Name | Description | Schema |
|---|---|---|
approved optional | Indicate manifest already approved Example : false | boolean |
carrier optional | Manifest carrier | CarrierInformation |
carrierProfile optional | Manifest carrier profile | CarrierProfile |
createdBy optional | User who created the manifest | string |
createdDate optional | Date when manifest was created | string (date-time) |
id optional | Manifest identifier | string |
lastModifiedBy optional | Last user who modified the manifest | string |
lastModifiedDate optional | Last date when manifest was modified | string (date-time) |
minPickupFees optional | Margin pickup fee | < MinPickupFeeByServiceProfile > array |
office optional | ${swagger.model.manifest.office} | Office |
pickupFeeEnabled optional | Margin pickup fee enabled status Example : false | boolean |
serviceProfile optional | Manifest service profile | ServiceProfile |
shipmentsToCrossdock optional | < ShipmentPublicProjection > array | |
totalShipments optional | Manifest total shipment | integer (int32) |
| Info |
|---|
Please refer to the Additional Reference section for more information on BBA Integration API objects. |