POST /apiv2/manifests/manifest
Servers
- /
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
[] |
Array | Yes | |
[].consignmentIds[] |
Array | Yes |
All the consignment Ids that should be manifested together |
[].customValues[] |
Array | No | |
[].customValues[].propertyName |
String | No | |
[].customValues[].value |
String | No | |
[].pickupClosingTime |
String | No |
What is the closing time for this pickup location? |
[].companyId |
Integer | Yes |
The company's id in MachShip which is manifesting these consignments |
[].dgsDeclaration |
Boolean | No |
Must be true if manifesting DG consignments. Setting this to true means you Agree this Manifest is Compatible and in accordance with the Australian Dangerous Goods (ADG) Code Edition 7.9 |
[].pickupDateTime |
String | No |
Pickup Date of this manifest. Should be in the format 'YYYY-MM-DD HH:SS' |
[].palletSpaces |
Integer | No |
How many pallet spaces are required for this manifest? |
[].pickupSpecialInstructions |
String | No |
Pickup special instructions for the driver (Optional) |
[].pickupAlreadyBooked |
Boolean | No |
Has a pickup already been booked? If a pickup has not been booked, MachShip will book it for you |
[].carrierName |
String | No |
The carrier that the manifest is for |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.