Void Shipment Request Guidelines

See How To Use this Guide before interpreting the guidelines below.

When sending an element in Date or DateTime format, a valid date must be given. "00" is not a valid day or month value and "0000" is not a valid year value.

The following data is sent in the request to TraceLink:

Data Element Occurs
Length		 Type Description
soapenv:Envelope [1...1]
[–]		 -

Required. SOAP Envelope root element.
  soapenv:Header [1...1]
[–]		 -

Not used.
  soapenv:Body [1...1]
[–]		 -

Required. SOAP Message Body.
    urn:VoidShipment [1...1]
[–]		 -

Required. Create void shipment request message. Communicates the location, delivery number, order cancel status, transaction date, and reason of a void shipment message. The system validates the delivery in order to ensure that it is a valid shipment and that the serial numbers are in a Shipped status.

The Order Cancel status determines whether the delivery is voided and canceled such that the delivery may not be corrected or whether the delivery is voided and not corrected such that the delivery may be updated at a later time.
      LocationId [0…1]
[–]		 -

Optional location associated with the original delivery.

 
        @identifiervalue [1...1]
[0/*]		 String

Specifies identifier of facility/warehouse to scope the void shipment. This is intended to provide access control for the void message. When the transaction is updated, the location of the original delivery will be used to return the serial numbers to an available state.  *1
        @identifiertype [1...1]
[1/1]		 String

Required. Location identifier type. *2

See the LocationId enumeration list for valid values.

      DeliveryNumber [1...1]
[1/*]		 String

Required. Delivery number that refers to a previously submitted delivery (Serialized Operations Manager Sales Shipment). The system will validate that: *3

  • This original delivery is a sales shipment and not a transfer order.
  • The original delivery is in a submitted state.
  • The serial numbers for the original delivery are in a shipped status.
      DeliveryDirection [1...1]
[1/*]		 String

Required. Indicates whether the delivery is sent or received by the Partner which determines if the message is for voiding shipment or receipt. Valid values:

  • Sent

  • Received

      PartnerId [0…1]
[–]		 -

Optional Partner ID associated with the original delivery.
      SenderInfo [0...1]
[-]		 - Conditionally required if the same DeliveryNumber is used for multiple shipments. Captures information about the business entity and location that is sending the shipment.
        FromBusinessPartyInfo [0...1]
[-]		 - Captures the identifiers associated with the business entity that is sending the shipment.
          BusinessId [0...*]
[-]		 - Captures the identifiers associated with the business entity that is sending the shipment.
            @type [1...1]
[1/*]		 String

Conditionally required if the same BusinessId is present. Captures the sold from business identifier value. See the BusinessAndLocationId enumeration list for valid values.
        ShipFromLocationInfo [0...1]
[-]		 - Captures the identifiers associated with the location that is sending the shipment.
          FacilityId [0...*]
[-]		 - Indicates the identifiers associated with the business location that is sending the shipment.
            @type [1...1]
[1/*]		 String

Conditionally required if the FacilityId is present. Indicates the ship from location identifier value. See the BusinessAndLocationId enumeration list for valid values.
      TransactionDate [1...1]
[1/*]		 Date

Date of void transaction in partner's business system. *4
      OrderCancelled [1...1]
[1/*]		 Boolean

Required. Represents the status of the order/delivery in the ERP system. *5

  • If the order/delivery is canceled ( true), the original order is voided and canceled. Cannot be corrected.
  • If the order/delivery is not canceled ( false), the original order is voided and can be corrected a later time.
      ReasonCode [1...1]
[1/*]		 String

Required. Code identifying reason for the void or correction. *6

See the ReasonCodes enumeration list for valid values.
      ReasonText [0…1]
[0/*]		 String

Text description of reason code. *7