The manifest service is called at the end of day, or whenever mail processing is complete. Call with the manifest job number provided with each shipment request to bundle all shipments together into a single job manifest.
Sample manifest, closes all shipments created with job number 12345 manifest_jobnbronly.xml
<xml> <manifest jobnumber="12345" datetime="2020-07-18T13:04:53.295Z" /> </xml>
Sample manifest, created job number 12345, and assigned shipments T1, T2, T3 to job number 12345. manifest_job_and_shipments.xml
<xml>
<manifest jobnumber="12345" datetime="2020-07-18T13:04:53.295Z">
<shipment tracknbr="T1" />
<shipment tracknbr="T2" />
<shipment tracknbr="T3" />
</manifest>
</xml>XSD / Schema - manifest.xsd Download manifest.xsd
<xs:schema elementFormDefault="qualified" attributeFormDefault="unqualified" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="xml">
<xs:complexType>
<xs:sequence>
<xs:element name="manifest" minOccurs="1" maxOccurs="1">
<xs:complexType>
<xs:sequence>
<xs:element name="shipment" minOccurs="0" maxOccurs="unbounded">
<xs:complexType>
<xs:attribute name="tracknbr">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="50" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
</xs:complexType>
</xs:element>
</xs:sequence>
<xs:attribute name="jobnumber" use="required">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="30" />
<xs:minLength value="1" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="datetime" use="required">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="30" />
<xs:minLength value="1" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="mawbnbr">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="30" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="jobtype">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="premium">
<!--Premium-->
</xs:enumeration>
<xs:enumeration value="select">
<!--Select-->
</xs:enumeration>
<xs:enumeration value="standard">
<!--Standard-->
</xs:enumeration>
<xs:maxLength value="20" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="mawbdestination">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="10" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="length">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="30" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="width">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="30" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="height">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="30" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="etd">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="30" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="eta">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="30" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="uom">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="5" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="unittype">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="20" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="physicalweight">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="20" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="airline">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="50" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="flightnumber">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="20" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
</xs:complexType>
</xs:element>
<xs:sequence>
<xs:element name="error" minOccurs="0" maxOccurs="unbounded">
<xs:complexType>
<xs:attribute name="code" use="required" type="xs:string" />
<xs:attribute name="description" use="required">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="500" />
<xs:minLength value="1" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="context">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="50" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:sequence>
<xs:anyAttribute />
</xs:complexType>
</xs:element>
</xs:schema>Used to close a manifest job, and retrieve the manifest PDF document. The service can be called in two ways. 1) With just a jobnumber. Include the job number provided with all of the individual create shipment requests. This approach works best if you know in advance what you'll be shipping before you make the create shipment calls. 2) With a new job number and all shipment tracking number. This approach allows you to call the manifest service after bundling shipments together at the end of day.
| Name | Description | Type | Optional | Sample Value |
|---|---|---|---|---|
| jobnumber | The job number to be closed. | Text (30) | 12345 | |
| datetime | Local Date Time | datetime | 2017-07-18T13:04:53.295Z | |
| mawbnbr | MAWB # | Text (30) | Optional | |
| jobtype | "premium", "select" or "standard" See reference values for "jobtype" | Text (20) | Optional | |
| mawbdestination | MAWB Destination Terminal | Text (10) | Optional | |
| length | Length must be a positive decimal number. | Decimal (2) | Optional | 30.00 |
| width | Width must be a positive decimal number. | Decimal (2) | Optional | 30.00 |
| height | Height must be a positive decimal number. | Decimal (2) | Optional | 30.00 |
| etd | Estimate Time of Departed must be earlier than ETA, and both must be in valid ISO 8601 datetime format. | datetime | Optional | 2017-07-18T13:04:53.295Z |
| eta | Estimate Time of Arrived must not be in the past relative to the manifest creation time. | datetime | Optional | 2017-07-18T13:04:53.295Z |
| uom | Unit of Measurement (cm or inch) | Text (5) | Optional | cm |
| unittype | Unit Type must be selected from allowed cargo types (AKE, PMC, Loose). | Text (20) | Optional | AKE |
| physicalweight | Physical Weight must be a positive decimal number. | Decimal (2) | Optional | 150.00 |
| airline | Airline Name | Text (50) | Optional | Cathay Pacific |
| flightnumber | Airline Flight Number | Text (20) | Optional | MH6119 |
Optional. Specifies the shipments in the manifest. Use this for end of day processing when the job is not known at the time the create shipment call was made.
| Name | Description | Type | Optional | Sample Value |
|---|---|---|---|---|
| tracknbr | Tracking # of the parcel to be manifested | Text (50) | Optional | 1234567890 |
Sample manifest response with Base 64 encoded PDF manifestresponse.xml
<xml> <manifestresponse jobnumber="12345" manifestpdf="JVBERi0xLjUNJeLjz9MNCjcgMCBvYmoNPDwvTGluZWFyaXplZC...Value Truncated" /> </xml>
Sample manifest with an error manifestresponseerror.xml
<xml>
<manifestresponse>
<error code="102" description="No unassigned shipments" context="No shipments are available for assignment to job 12345" />
</manifestresponse>
</xml>XSD / Schema - manifestresponse.xsd Download manifestresponse.xsd
<xs:schema elementFormDefault="qualified" attributeFormDefault="unqualified" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="xml">
<xs:complexType>
<xs:sequence>
<xs:element name="manifestresponse" minOccurs="1" maxOccurs="unbounded">
<xs:complexType>
<xs:sequence>
<xs:element name="error" minOccurs="0" maxOccurs="unbounded">
<xs:complexType>
<xs:attribute name="code" use="required" type="xs:string" />
<xs:attribute name="description" use="required">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="500" />
<xs:minLength value="1" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="context">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="50" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
</xs:complexType>
</xs:element>
</xs:sequence>
<xs:attribute name="jobnumber" use="required">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="30" />
<xs:minLength value="1" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="manifestpdf" use="required" type="xs:string" />
</xs:complexType>
</xs:element>
<xs:sequence>
<xs:element name="error" minOccurs="0" maxOccurs="unbounded">
<xs:complexType>
<xs:attribute name="code" use="required" type="xs:string" />
<xs:attribute name="description" use="required">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="500" />
<xs:minLength value="1" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="context">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="50" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:sequence>
<xs:anyAttribute />
</xs:complexType>
</xs:element>
</xs:schema>Contains the manifest PDF for the requested manifest job.
| Name | Description | Type | Optional | Sample Value |
|---|---|---|---|---|
| jobnumber | The manifest job number provided in the request. | Text (30) | 12345 | |
| manifestpdf | Base 64 encoded PDF document describing the job, includes customer account information, total weight and shipment count. | base64 | base 64 PDF content here...Base 64 File Content |
| Name | Description | Type | Optional | Sample Value |
|---|---|---|---|---|
| code | Code value of the error | int | 100 | |
| description | Text description of the error message | Text (500) | Invalid XML | |
| context | Error context information | Text (50) | Optional | Error on line 1 |