Open Parcel Group

The manifest service is used to group inbound shipments. The manifest helps terminal operations verify reciept of the entire order, before scanning indivdiual pieces. Typically manifests are completed at the end of the day. The service returns a bar-coded PDF document that the terminal can use to scan the shipments.

Request Message

manifest

Used to close a manifest job, and retreive the manifest PDF document. The manifest will include all shipments since the last manifest call.

Name	Description	Type	Optional	Sample Value
manifestnbr	The unique manifest number to be closed. Use a date/time CCYYMMDDHHMM if you don't have one.	Text (30)		12345

Sample manifest, closes all shipments created with job number 12345 manifest_jobnbronly.json

{
  "manifest": {
    "manifestnbr": "12345",
    "datetime": "2019-06-18T13:04:53.295Z"
  }
}

Sample manifest, creates job number 12345, and assigns shipments T1, T2, T3 to job number 12345. manifest_job_and_shipments.json

{
  "manifest": {
    "manifestnbr": "12345",
    "datetime": "2017-07-18T13:04:53.295Z",
    "shipment": [
      {
        "tracknbr": "T1"
      },
      {
        "tracknbr": "T2"
      },
      {
        "tracknbr": "T3"
      }
    ]
  }
}

Sample manifest, closes all shipments created with job number 12345 manifest_jobnbronly.xml

<xml>
  <manifest manifestnbr="12345" datetime="2019-06-18T13:04:53.295Z" />
</xml>

Sample manifest, creates job number 12345, and assigns shipments T1, T2, T3 to job number 12345. manifest_job_and_shipments.xml

<xml>
  <manifest manifestnbr="12345" datetime="2017-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:attribute name="manifestnbr" use="required">
              <xs:simpleType>
                <xs:restriction base="xs:string">
                  <xs:maxLength value="30" />
                  <xs:minLength value="1" />
                </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>

Response Message

manifestresponse

Contains the manifest PDF for the requested manifest job.

Name	Description	Type	Optional	Sample Value
manifestnbr	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

Sample manifest response with Base 64 encoded PDF manifestresponse.json

{
  "manifestresponse": {
    "manifestnbr": "12345",
    "manifestpdf": "JVBERi0xLjUNJeLjz9MNCjcgMCBvYmoNPDwvTGluZWFyaXplZC...Value Truncated"
  }
}

Sample manifest response with Base 64 encoded PDF manifestresponse.xml

<xml>
  <manifestresponse manifestnbr="12345" manifestpdf="JVBERi0xLjUNJeLjz9MNCjcgMCBvYmoNPDwvTGluZWFyaXplZC...Value Truncated" />
</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:element>
            </xs:sequence>
            <xs:attribute name="manifestnbr" 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>

ManifestAPI Documentation

Request Message

manifest

Response Message

manifestresponse