POST /manifest
This endpoint is used to create new manifest by passing JSON request payload.
Resource URL
Cluster | URL |
|---|---|
Australia | |
US |
Header Request
Field | Data Type | Description |
|---|---|---|
Authorization | String | Bearer Access token |
Request Payload
Field | Data Type | Required | Description |
|---|---|---|---|
officeId | Long | Yes | Office id |
carrierId | String | Yes | Carrier id |
carrierProfileId | String | Yes | Carrier profile id |
serviceProfileId | String | No | Service profile id |
{
"officeId": 282,
"carrierId": "couriers-please",
"carrierProfileId": "5f607e186e304e0001e5fc57",
"serviceProfileId": "5f608642c33c8b00015a4aff"
}Responses
HTTP Code | Description | Schema |
|---|---|---|
200 | OK | |
201 | Created | No Content |
401 | Unauthorized | No Content |
403 | Forbidden | No Content |
404 | Not Found | No Content |
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.