On this page:
7.1 Publish Manifest Request
Requires Authentication
A valid access Key must be provided in access_key request header.
POST v2/publishmanifestv4
This function allows your system to manifest particular connotes that are ready for manifesting.
Once these consignments are manifested, a summary manifest report is returned as a PDF.
7.2 Parameters
The body of the message should be sent as a JSON array.
A JSON list of consignment numbers.
This method will accept consignment numbers as an array (this is the value you receive in the “Connote” parameter in the Consignment Creation API response)
7.3 Return Format
JSON object array per manifest generated. This is in a key/value pair collection, with the manifest number being the key and value is the base64 encoded byte stream of the PDF.
7.4 Example Request
Endpoints
Live: https://api.omniparcel.com/v2/publishmanifestv4
Staging/Test: https://staging.omniparcel.com/v2/publishmanifestv4
Request
Header
access_key: [access_key_for_site_account] Content-Type: application/json; charset=utf-8
Body
[
"01593505840002135198",
"01593505840002135181"
]
Response Example 1: All parcels manifested successfully
A JSON object array of order and save status.
{
"OutboundManifest": [
{
"ManifestNumber": "OHG00288",
"ManifestedConnotes": [
"01593505840002135181",
"01593505840002135198"
],
"ManifestContent": "JVBERi0xLjcgCiXi48/TIAoxIDAgb2JqIAo8PCAKL1R5cGUgL0NhdGFsb2cgCi9QYWdlcyAyIDAgUiAKL1BhZ2VNb2RlIC9Vc2VOb25lIAovVmlld2VyUH...."
}
],
"InboundManifest": null,
"Error": null,
"StatusCode": 200,
"UnManifestedConnotes": []
}
*Base64 pdf data has been trimmed for presentation.
Response Example 2: All parcels failed
{
"OutboundManifest": null,
"InboundManifest": null,
"Error": null,
"StatusCode": 200,
"UnManifestedConnotes": [
"01593505840002135181- Already Manifested/not match with our database",
"01593505840002135198- Already Manifested/not match with our database",
]
}
*Base64 pdf data has been trimmed for presentation.
Response Example 3: Some parcels manifested successfully, some parcels failed
{
"OutboundManifest": [
{
"ManifestNumber": "EMN1234",
"ManifestedConnotes": [
"01593505840002135181"
],
"ManifestContent": "JVBERi0xLjcgCiXi48/TIAoxIDAgb2JqIAo8PCAKL1R5cGUgL0NhdGFsb2cgCi9QYWdlcyAyIDAgUiAKL1BhZ2VNb2RlIC9Vc2VOb25lIAovVmlld2VyUH...."
}
],
"InboundManifest": null,
"Error": null,
"StatusCode": 200,
"UnManifestedConnotes": [
"01593505840002135198- Already Manifested/not match with our database",
]
}
*Base64 pdf data has been trimmed for presentation.
Once you get a success response from OmniParcel, it’s important that those consignments are updated as “manifested” in your system, to ensure that you are only sending unmanifested parcels to be manifested.
7.5 Response Data Definition
Parameter | Description |
|---|---|
OutboundManifest | List of OutboundManifestResponse |
InboundManifest | InboundManifestResponse |
Error | Error details (String Object) |
StatusCode | HTTP status error code |
UnManifestedConnotes | UnManifested Consignment Numbers |
7.6 Outbound Manifest Response Data Definition
Parameter | Description |
|---|---|
ManifestNumber | Returns Manifest Number |
ManifestedConnotes | Manifested Consignment Numbers |
ManifestContent | Base64 Data |
7.7 Inbound Manifest Response Data Definition
Parameter | Description |
|---|---|
InboundManifestNumber | Returns Manifest Number for Inbound Parcels (Dynamic Parcels) |
InboundManifestedConnotes | Inbound Manifested Consignment Numbers |
Error
HTTP 400. Bad request – when no consignment numbers supplied or when invalid consignment numbers supplied.