GET /manifest
Get a paginated list of manifests. It can be filtered by specific fields.
Resource URL
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query | carrierId optional | Carrier identifier | string |
Query | carrierProfileName optional | Carrier profile name | string |
Query | companyName optional | Company Name | string |
Query | manifestNum optional | ${swagger.param.manifest.manifest_num} | string |
Query | officeName optional | Office name | string |
Query | serviceId optional | Service identifier | string |
Query | serviceProfileName optional | Service profile name | string |
Body | endDate optional | Manifest end date | string (date-time) |
Body | startDate optional | Manifest start date | string (date-time) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 | OK | |
401 | Unauthorized | No Content |
403 | Forbidden | No Content |
404 | Not Found | No Content |
Definitions
mykey
Type: apiKey
Name: Authorization
In: HEADER
Page<<PublicManifestProjection>>
Name | Schema |
---|---|
content optional | < PublicManifestProjection> 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) |
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) |
Please refer to the Additional Reference section for more information on BBA Integration API objects.