Cancel Shipment Service

Use the cancel shipment to cancel a pending shipment, that is not yet part of a closed job.

Request Message

XML Request
XSD

<xml>
  <cancelshipment tracknbr="1234567890" />
</xml>

XSD / Schema - cancelshipment.xsd Download cancelshipment.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="cancelshipment" minOccurs="1" maxOccurs="1">
          <xs:complexType>
            <xs:attribute name="tracknbr" use="required">
              <xs:simpleType>
                <xs:restriction base="xs:string">
                  <xs:maxLength value="50" />
                  <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>

cancelshipment

Identifies a shipment to cancel, shipments must be cancelled before closing the manifest job.

Name	Description	Type	Optional	Sample Value
tracknbr	Tracking number, assigned to the shipment	Text (50)		1234567890

Successful response cancelshipmentresponse.xml

<xml>
  <cancelshipmentresponse tracknbr="1234567890" status="Success" />
</xml>

Error response cancelshipmentresponseerr.xml

<xml>
  <cancelshipmentresponse>
    <error code="102" description="Not found" context="Shipment 1234567890 cannot be found." />
  </cancelshipmentresponse>
</xml>

XSD / Schema - cancelshipmentresponse.xsd Download cancelshipmentresponse.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="cancelshipmentresponse" 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="tracknbr" use="required">
              <xs:simpleType>
                <xs:restriction base="xs:string">
                  <xs:maxLength value="50" />
                  <xs:minLength value="1" />
                </xs:restriction>
              </xs:simpleType>
            </xs:attribute>
            <xs:attribute name="status" use="required">
              <xs:simpleType>
                <xs:restriction base="xs:string">
                  <xs:maxLength value="10" />
                  <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>

cancelshipmentresponse

Indicates the status of the cancelled shipment.

Name	Description	Type	Optional	Sample Value
tracknbr	Tracking number assigned to the shipment	Text (50)		1234567890
status	"Success", if the cancellation was successful, otherwise see the error element.	Text (10)		Success

error

Any errors cancelling the shipment will appear in this element.

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