Void Shipment Guidelines (XML)
See How To Use this Guide before interpreting the guidelines below.
Message Type: SOM_VOID_SHIPMENT
Info Exchange Display Name: Void Shipment
| Data Element | Occurs Length |
Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|
| som:SOMVoidShipment | 1...1 - |
- |
Required. Root element of message. |
||||||
| som:ControlFileHeader | 1...1 - |
- |
Required. XML file control header record. |
||||||
| cmn:FileSenderNumber | 1...1 1/20 |
String |
Required. File sender's company identifier.1 |
||||||
| cmn:FileReceiverNumber | 1...1 1/20 |
String |
Required. File recipient's company identifier.2 |
||||||
| cmn:FileControlNumber | 1...1 1/* |
String |
Required. Unique file control ID number.3 |
||||||
| cmn:FileDate | 1...1 1/* |
Date |
Required. Date file generated in XML YYYY-MM-DD format.4 |
||||||
| cmn:FileTime | 1...1 1/* |
Time |
Required. Time file generated in XML HH:MM:SSZ format.5 |
||||||
| som:MessageBody | 1...1 - |
- |
Required. Main body of message. |
||||||
| cmn:DeliveryLocation | 0...1 0/* |
String |
Specifies identifier of facility/warehouse to scope the Sales Shipment Status update for the serial numbers matching the specified item code and lot number only at the specified location. If the location is omitted, the Sales Shipment status update will be applied globally to all matching serial numbers in the system.6 |
||||||
| @type | 1...1 1/1 |
String |
Conditionally required if cmn:DeliveryLocation is populated. Location identifier type.7 See the BusinessAndLocationId enumeration list for valid values. |
||||||
| som:VoidShipment | 1...* - |
- |
Required. Looping data element group for void shipment fields. |
||||||
| cmn:DeliveryNumber | 1...1 1/* |
String |
Required. Delivery number that links the order information to the serialized pick information for this customer delivery. Identifies the delivery document that will be voided or corrected.8 |
||||||
| cmn:DeliveryDirection | 1...1 1/* |
String |
Required. Delivery direction describes whether the delivery was sent or received by the partner. Valid values:9
|
||||||
| cmn:PartnerId | 0...1 0/* |
String |
Conditionally required if delivery type = |
||||||
| @type | 1...1 1/* |
String |
Required. Partner identifier type.11 See the BusinessAndLocationId enumeration list for valid values. |
||||||
| cmn:SenderInfo | 0...1 - |
- | Captures information about the business and location of the Partner voiding the shipment. | ||||||
| cmn:FromBusinessPartyInfo | 0...1 - |
- | Captures the full business information associated with the sold from business entity. | ||||||
| cmn:BusinessId | 1...* 1/* |
String | Conditionally required if cmn:FromBusinessPartyInfo is populated. Indicates the identifier associated with the sold from business entity. | ||||||
| @type | 1...1 1/* |
String |
Conditionally required if cmn:BusinessId is populated. Indicates the the type of sold from business identifier. See the BusinessAndLocationId enumeration list for valid values. |
||||||
| cmn:ShipFromLocationInfo | 0...1 - |
- | Captures the full business information associated with the ship from location. | ||||||
| cmn:FacilityId | 1...* 1/* |
String | Indicates the identifier associated with the ship from location. | ||||||
| @type | 1...1 1/* |
String |
Conditionally required if cmn:FacilityId is populated. Indicates the the type of sold from business identifier. See the BusinessAndLocationId enumeration list for valid values. |
||||||
| cmn:TransactionDate | 1...1 1/* |
Date |
Required. Date of void transaction in partner's business system.12 |
||||||
| cmn:OrderCancelled | 0...1 0/* |
Boolean |
Tracks whether order is cancelled rather than the intent to correct, aligning better
with future government reporting and ERP functionality. Default value is
|
||||||
| cmn:ReasonCode | 1...1 1/* |
String |
Required. Code identifying reason for the void or correction.14 See the ReasonCode enumeration list for valid values. |
||||||
| cmn:ReasonText | 0...1 0/* |
String |
Text description of reason code.15 |
||||||
| cmn:ReceiverInfo | 0...1 - |
String |
Captures the information about the supply chain partner that is receiving the void shipment. |
||||||
| cmn:ToBusinessPartyInfo | 0...1 - |
String |
The full business information associated with the sold to business entity is provided. |
||||||
| cmn:BusinessId | 1...* 1/* |
String |
The identifier associated with the return to business entity. This value is required for regulatory reporting. |
||||||
| @type | 1...1 1/* |
String |
Required. Business ID identifier type.16 See the BusinessAndLocationId enumeration list for valid values. |
||||||
| cmn:ShipToLocationInfo | 0...1 - |
String |
The full business information associated with the ship to location is provided directly. |
||||||
| cmn:FacilityId | 0...1 - |
String |
The full business information associated with the ship to location is provided directly. |
||||||
| @type | 1...1 1/* |
String |
Required. Facility identifier type.17 See the BusinessAndLocationId enumeration list for valid values. |
||||||
| cmn:IsPartialVoid | 1...1 1/* |
Boolean |
Represents whether the void is full or partial. Default value is
|
||||||
| cmn:NumberList | 0...1 - |
String |
Contains the list of serial numbers commissioned |
||||||
| cmn:Serial | 1...* 1/* |
String |
Required. The serial number being voided. Serial number is expressed in the GS1 Application Identifier format without parentheses for the AI keys. AI(01)(21) formatted serial number for GTINs. Non-GS1 serial numbers (e.g., China) are expressed in native format. 19 |
||||||
| @companyPrefix | 0...1 1/* |
String | Company prefix for serial number | ||||||
| @format | 0...1 1/* |
String |
Identifies format of serial numbers. See the Format enumeration list for valid values. |
||||||