Disaggregate serial number APIs

Disaggregation messages allow manufacturing locations to manage exceptions (e.g. a damaged item inside a parent container) throughout production. Disaggregation removes child items from their parent container.

Disaggregation

Pharmaceutical Manufacturers or CMOs use this message to disaggregate serial numbers which were previously aggregated through a Disposition Assigned message or the Web UI.

Guidelines

  • Message Type: SNX_DISAGGREGATED
  • Info Exchange Display Name: Serial Number Disaggregation
  • Map Version: TL_XML_SNX_Disaggregation_1_0_IB_V1_0

Element Occurs
Length		 Type Description
snx:SNXDisaggregatedMessage [1...1]
[-]		 - Required. The XML message root element.
  snx:ControlFileHeader [1...1]
[-]		 - Required. The XML file control header.
    cmn:FileSenderNumber [1...1]
[1/20]		 String Required. The unique identifier for the company sending the message (e.g. 7777776067344).
    cmn:FileReceiverNumber [1...1]
[1/20]		 String Required. The unique identifier for the company receiving the message (e.g. 8888884043588).
    cmn:FileControlNumber [1...1]
[1/20]		 String Required. The unique identifier for the company sending the message (e.g. 7777776067344).
    cmn:FileDate [1...1]
[10/10]		 Date Required. The date the file was generated in YYYY-MM-DD format (e.g. 2023-06-30).
    cmn:FileTime [1...1]
[8/8]		 Time Required. The time the file was generated in HH:MM:SSZ format (e.g. 06:30:32Z).
  snx:MessageBody [1...1]
[-]		 -

Required. The body of the XML message.

    snx:DisaggregatedEvent [1...1]
[-]		 - Required. The data identifying the disaggregation event.
      cmn:EventDateTime [1...1]
[1/*]		 DateTime Required. The date and time the serial numbers were disaggregated in YYYY-MM-DDTHH:MM:SSZ format (e.g. 2023-03-31T12:40:21.140Z). Milliseconds default to zero for efficiency and smaller file sizes because serial numbers can be grouped together when the event times are the same.
      cmn:EventTimeZoneOffset [1...1]
[6/6]		 String Required. The time zone offset in effect at the time and place where the event occurred (e.g. -05:00).
      cmn:EventLocation [1...1]
[1/34]		 String Required. The SGLN of the location where disaggregation occurred, with the urn prefix omitted (e.g. 8888882.02867.0 instead of urn:epc:id:sgln:8888882.02867.0).
      cmn:ParentSerialNumber [1...1]
[1/*]		 AnyURI

Required. The serial number of the parent container. Express values in the GS1 Application Identifier format without parentheses for the AI keys.

Examples:

  • AI(01)(21): 010030069422066221100000127801
  • AI(00): 00003006910000010006
  • CN-EDMC: 88102321100002005943
      cmn:SerialNumberList [1...1]
[-]		 - Required. The list of child serial numbers.
        @isRandom [0...1]
[-]		 Boolean

Indicates that the list of serial numbers is not sequential. Valid value is true.
        cmn:SerialNumber [1...*]
[1/*]		 AnyURI

Required. The child serial number aggregated to the parent containe (e.g. for an each-to-case aggregation, the serial numbers of the eaches). Express values in the GS1 Application Identifier format without parentheses for the AI keys.

Examples:

  • AI(01)(21): 010030069422066221100000127801
  • AI(00): 00003006910000010006
  • CN-EDMC: 88102321100002005943

Example

Copy 
<?xml version="1.0" encoding="UTF-8"?>
<snx:SNXDisaggregatedMessage xmlns:snx="urn:tracelink:mapper:sl:serial_number_exchange" xmlns:cmn="urn:tracelink:mapper:sl:commontypes">
    <snx:ControlFileHeader>
        <cmn:FileSenderNumber>8887771013655</cmn:FileSenderNumber>
        <cmn:FileReceiverNumber>6667771013655</cmn:FileReceiverNumber>
        <cmn:FileControlNumber>0000000004</cmn:FileControlNumber>
        <cmn:FileDate>2020-08-17</cmn:FileDate>
        <cmn:FileTime>06:30:32Z</cmn:FileTime>
    </snx:ControlFileHeader>
    <snx:MessageBody>
        <snx:DisaggregatedEvent>
            <cmn:EventDateTime>2020-08-17T06:30:32.00Z</cmn:EventDateTime>
            <cmn:EventTimeZoneOffset>-05:00</cmn:EventTimeZoneOffset>
            <cmn:EventLocation>8887777.01384.0</cmn:EventLocation>
            <cmn:ParentSerialNumber>010088202501033821100000880051</cmn:ParentSerialNumber>
            <cmn:SerialNumberList isRandom="true">
                <cmn:SerialNumber>010088202501033821100000880037</cmn:SerialNumber>
                <cmn:SerialNumber>010088202501033821100000880051</cmn:SerialNumber>
            </cmn:SerialNumberList>
        </snx:DisaggregatedEvent>
    </snx:MessageBody>
</snx:SNXDisaggregatedMessage>

Errors

Element Error message Description
Class 2
cmn:FileControlNumber File [input file name] is a potential duplicate match with file [existing file name] sent from [file sender] received on [existing file date], based on both files having the same File Control Number [file control number]. The file might be a duplicate, as the file control number matches that of a previous message.
cmn:FileSenderNumber No integration user set for company [company name]. An integration user does not exist for the company.
No API Key exists for the owner company of service [service name].

An API key does not exist for the company in Serial Number Exchange.

cmn:FileSenderNumber or cmn:FileReceiverNumber

 Unable to find profile for serviceId [app ID] and subscriber company [Partner company ID]. The sender or receiver identifier, or the alternate identifier configured on the Link between them, does not have a Serial Number Exchange profile associated with it.
Unable to find product pool for serviceId [app identifier] and pool [pool identifier].

TraceLink cannot find the pool of serial numbers at this company for the packaging code entered.
Unable to find product pool for serviceId [app identifier] and pool [pool identifier]. TraceLink cannot find the pool of serial numbers at this company for the packaging code of the parent serial number entered.
cmn:EventDateTime Event timestamp is earlier than the aggregation date for serial number [serial number]. A disaggregation event can only occur after the serial number is aggregated.
cmn:EventTimeZoneOffset Data Error: EventTimeZoneOffset occurs fewer times than its minimum number of occurrences. This element must have a value specified.
cmn:EventLocation EventLocation occurs fewer times than its minimum number of occurrences. This element must have a value specified.
cmn:ParentSerialNumber ERROR This element must be specified in one of the valid formats.
ParentSerialNumber occurs fewer times than its minimum number of occurrences. This element must have a value specified.
Serial Number [serial number] status cannot be updated because no associated Serial Number Format could be found in [Owner]’s Serial Number Manager or Serial Number Exchange Profile. The format of this serial number is not configured in either the Serial Number Manager template or Serial Number Exchange profile.
Serial number [parent serial number] can not be found. The serial number is not configured in Product Master Data or Serial Number Exchange.
cmn:SerialNumber Invalid EPC format !!! This element must be specified in one of the valid formats.
BADSERIALNUMBERSTATE. The parent and child serial numbers must all exist with the serial number status commissioned and the item status available or blocked.
Serial Number [serial number] cannot be disaggregated because it was not previously aggregated to [parent serial number]. The serial number must be aggregated to the parent serial number to be disaggregated from that container.
Serial Number [serial number] status cannot be updated because no associated Serial Number Format could be found in [Owner]’s Serial Number Manager or Serial Number Exchange Profile. The format of this serial number is not configured in either the Serial Number Manager template or Serial Number Exchange profile.
Serial number [serial number] can not be found. The serial number is not configured in Product Master Data or Serial Number Exchange.
N/A Retries exceeded the maximum wait time [maximum wait time] seconds. The maximum wait time for park and retry was exceeded for this message.
Class 3
The following is thrown for all Class 3 errors: “INTERNALERROR=Internal error from server [server details].” Please contact Support if this error is encountered.

Guidelines

  • Message Type: SNX_DISAGGREGATED
  • Info Exchange Display Name: Serial Number Disaggregation
  • Map Version: TL_EPCIS_SNX_Disaggregated_1_2_IB_V1_1

Element Occurs
Length		 Type Description
epcis:EPCISDocument [1...1]
[-]		 - Required. The EPCIS message root element.
  @schemaVersion [1...1]
[1/*]		 Decimal Required. The version of the EPCIS schema used to populate the EPCIS document elements. Valid value is 1.2.
  @creationDate [1...1]
[1/*]		 DateTime Required. The date and time the EPCIS message was created in YYYY-MM-DDTHH:MM:SSZ format (e.g. 2023-03-25T22:08:02Z).
  EPCISHeader [1...1]
[-]		 -

Required. The XML file control header record providing message identification and routing information. This message supports the following use cases:

  • Aggregation events only (to disaggregate containers).
    sbdh:StandardBusinessDocumentHeader [1...1]
[-]		 - Required. The business header information, including the EPCIS header version, sender and receiver information, and the document identification.
      sbdh:HeaderVersion [1...1]
[1/*]		 String Required. The version number of the Standard Business Document Header. Valid value is 1.0.
      sbdh:Sender [1...1]
[-]		 - Required. The unique identification key for the organization that created the standard business document.
        sbdh:Identifier [1...1]
[1/*]		 String Required. The GLN, SGLN, or any other supported company identifier (e.g. 1100001014507). All identifier types except GLNs must have a GS1-conformant uri prefix (e.g. urn:epc:id:sgln:088202.867701.0).
          @Authority [1...1]
[1/*]		 String

Required. The sender identifier type.

  • AR_CUIT – 11-character Argentina Tax ID. Format is 00-00000000-0 (e.g. 33-56899856-8). Cannot be set as the Primary Identifier.
  • AM_TIN – 8-character Armenia Taxpayer Identification Number (e.g. 53663456). Cannot be set as the Primary Identifier.
  • BR_CNES – Brazil National Registry of Health Facilities Number (e.g. 3868249).
  • BR_CNPJ – 14-character Brazil Tax/Legal Entity ID. Format is 00.000.000/0001-00 (e.g. 71.116.165/0001-71).
  • BR_CPF – 11-character Brazil Individual Taxpayer Registration Number. Format is 000.000.000-00 (e.g. 605.085.153-00). The first 8 digits identify the company, the next 4 digits identify the branch or subsidiary ("0001" designates the headquarters), and the last 2 are check digits.
  • BR_PROF_REG – Brazil Professional Registration Number (e.g. CRODFCD9952).
  • BY_TIN – 9-character Belarus Taxpayer Identification Number (e.g. 004893223). Cannot be set as the Primary Identifier.
  • CN_CHINA_ID – Alphanumeric China identifier (e.g. 352J685B548N).
  • CN_FOREIGN_MAH – China Foreign MAH ID (e.g. 0678645).
  • CN_FOREIGN_MFR – China Foreign Manufacturer ID (e.g. 665S55D).
  • CN_USCID – China Unified Social Credit Identifier (e.g. 9771221453).
  • COMPANYID – Alphanumeric internal company identifier (e.g. KENDALL).
  • COMPANYSITEID – Alphanumeric internal location, plant, or site identifier (e.g. 465MEMPHIS).
  • DE_IFA_REG_NUM – 6-character Informationsstelle für Arzneispezialitäten (IFA) Registration Number (e.g. 548726). Cannot be set as the Primary Identifier.
  • DEA – 9-character US Drug Enforcement Agency Number (e.g. F92547851).
  • DUNS – 9-character Dunn and Bradstreet Number (e.g. 82-759-6961).
  • DUNS_PLUS_FOUR – 13-character Dunn and Bradstreet Number, which includes a 4 digit extension (e.g. 82-759-6961-KP89).
  • GCP – 6- to 12-character GS1 Global Company Prefix (e.g. 8856277).
  • GLN – 13-character Global Location Number (e.g. 8856277233311). To send and receive EPCIS messages, companies and locations need a GLN.
  • HIN – Maximum 9-alphanumeric character Health Industry Number assigned by HIBCC (e.g. 214Z65H00).
  • ID_BPOM_FACILITYID – Indonesia Facility ID (e.g. 45764574).
  • IN_COMPANY_ID – India Company ID (e.g. 5423695784236).
  • IN_GSTN – India Goods and Services Tax ID (e.g. 55876215).
  • IN_IEC – 10-character India Importer Exporter Code (e.g. 0255411222). Cannot be set as the Primary Identifier.
  • IN_LOCATION_ID – India Location ID (e.g. 65874532).
  • IN_MFR – India Manufacturing Code (e.g. 00552101).
  • IN_MRCH – India Merchant Exporter Code (e.g. 601227644).
  • IN_PAN – 10-character India Permanent Account Number. The first five characters are letters, next four numbers, last character is a letter (e.g. AFZPK7190K). Cannot be set as the Primary Identifier.
  • IN_TIN – 11-character India Taxpayer Identification Number (e.g. 95684444523). Cannot be set as the Primary Identifier.
  • KG_TIN – 14-character Kyrgyzstan Taxpayer Identification Number (e.g. 56200044505998). Cannot be set as the Primary Identifier.
  • KR_BUS_REG_NUMBER – 10-character South Korea Corporate Registration Number. Format is xxx-xx-xxxxx (e.g. 324-84-22451).
  • KR_PROVIDER_CODE – 8-character South Korea Provider Code (e.g. 45632196).
  • KZ_BIN – 12-character Kazakhstan Business Identification Number (e.g. 220110668755). Cannot be set as the Primary Identifier.
  • RU_ACCOUNT_NUMBER – 14- to 36-character Russia Account Number (e.g. 19527400000001 or 19406412-0001-000a-0000-000000000022). Cannot be set as the Primary Identifier.
  • RU_INN_FOREIGN_ENTITY – 10-character Russia Foreign Business Taxpayer Identification Number (e.g. 7744000912). Cannot be set as the Primary Identifier. Only one of the following identifier types can be assigned to an entity: RU - INN Local, RU - IN Foreign, and RU - INN Individual.
  • RU_INN_INDIV – 12-character Russia Individual Taxpayer Identification Number (e.g. 123456789001). Cannot be set as the Primary Identifier. Only one of the following identifier types can be assigned to an entity: RU - INN Local, RU - IN Foreign, and RU - INN Individual.
  • RU_INN_KPP_TAX_CODE – 9-character Russia KPP Registration Code (e.g. 771301001). Cannot be set as the Primary Identifier.
  • RU_INN_LOCAL_ENTITY – 10-character Russia Local Business Taxpayer Identification Number (e.g. 7728640746). Cannot be set as the Primary Identifier. Only one of the following identifier types can be assigned to an entity: RU - INN Local, RU - IN Foreign, and RU - INN Individual.
  • SGLN – 15-character SGLN format representation of Global Location Number:
    • Format for company entities is [CompanyPrefix].[LocationRef].0 or [CompanyPrefix]..0. The LocationRef segment is optional. If the LocationRef is included, the first two segments contain only digits separated by the dot, and must be 13 characters in total. If the LocationRef is not included, then the first segment must be 12 digits, followed by two dot seperators. The third segment should always be the digit 0. For example, 539885451928..0 or urn:epc:id:sgln:0614141.12345.0.
    • Format for location entities is [CompanyPrefix].[LocationRef].[sub-location identifier] or [CompanyPrefix]..[sub-location identifier].The LocationRef segment is optional. If the LocationRef is included, the first two segments contain only digits separated by the dot, and must be 13 characters in total. If the LocationRef is not included, then the first segment must be 12 digits, followed by two dot seperators. The third segment is always alphanumeric and can be any length, with at least one character in it preceded by the dot separator. For example, 8856277.23331.6 or 539885451928..11.
  • TRACELINK_ID – TraceLink Identification Number (e.g. KENDALLPHARM).
  • UZ_TIN – 9-character Uzbekistan Taxpayer Identification Number (e.g. 000181244). Cannot be set as the Primary Identifier.
      sbdh:Receiver [1...1]
[-]		 - Required. The unique identification key for the organization that created the standard business document.
        sbdh:Identifier [1...1]
[1/*]		 String Required. The GLN, SGLN, or any other supported company identifier (e.g. 1100001014507). All identifier types except GLNs must have a GS1-conformant uri prefix (e.g. urn:epc:id:sgln:088202.867701.0).
          @Authority [1...1]
[1/*]		 String

Required. The sender identifier type.

  • AR_CUIT – 11-character Argentina Tax ID. Format is 00-00000000-0 (e.g. 33-56899856-8). Cannot be set as the Primary Identifier.
  • AM_TIN – 8-character Armenia Taxpayer Identification Number (e.g. 53663456). Cannot be set as the Primary Identifier.
  • BR_CNES – Brazil National Registry of Health Facilities Number (e.g. 3868249).
  • BR_CNPJ – 14-character Brazil Tax/Legal Entity ID. Format is 00.000.000/0001-00 (e.g. 71.116.165/0001-71).
  • BR_CPF – 11-character Brazil Individual Taxpayer Registration Number. Format is 000.000.000-00 (e.g. 605.085.153-00). The first 8 digits identify the company, the next 4 digits identify the branch or subsidiary ("0001" designates the headquarters), and the last 2 are check digits.
  • BR_PROF_REG – Brazil Professional Registration Number (e.g. CRODFCD9952).
  • BY_TIN – 9-character Belarus Taxpayer Identification Number (e.g. 004893223). Cannot be set as the Primary Identifier.
  • CN_CHINA_ID – Alphanumeric China identifier (e.g. 352J685B548N).
  • CN_FOREIGN_MAH – China Foreign MAH ID (e.g. 0678645).
  • CN_FOREIGN_MFR – China Foreign Manufacturer ID (e.g. 665S55D).
  • CN_USCID – China Unified Social Credit Identifier (e.g. 9771221453).
  • COMPANYID – Alphanumeric internal company identifier (e.g. KENDALL).
  • COMPANYSITEID – Alphanumeric internal location, plant, or site identifier (e.g. 465MEMPHIS).
  • DE_IFA_REG_NUM – 6-character Informationsstelle für Arzneispezialitäten (IFA) Registration Number (e.g. 548726). Cannot be set as the Primary Identifier.
  • DEA – 9-character US Drug Enforcement Agency Number (e.g. F92547851).
  • DUNS – 9-character Dunn and Bradstreet Number (e.g. 82-759-6961).
  • DUNS_PLUS_FOUR – 13-character Dunn and Bradstreet Number, which includes a 4 digit extension (e.g. 82-759-6961-KP89).
  • GCP – 6- to 12-character GS1 Global Company Prefix (e.g. 8856277).
  • GLN – 13-character Global Location Number (e.g. 8856277233311). To send and receive EPCIS messages, companies and locations need a GLN.
  • HIN – Maximum 9-alphanumeric character Health Industry Number assigned by HIBCC (e.g. 214Z65H00).
  • ID_BPOM_FACILITYID – Indonesia Facility ID (e.g. 45764574).
  • IN_COMPANY_ID – India Company ID (e.g. 5423695784236).
  • IN_GSTN – India Goods and Services Tax ID (e.g. 55876215).
  • IN_IEC – 10-character India Importer Exporter Code (e.g. 0255411222). Cannot be set as the Primary Identifier.
  • IN_LOCATION_ID – India Location ID (e.g. 65874532).
  • IN_MFR – India Manufacturing Code (e.g. 00552101).
  • IN_MRCH – India Merchant Exporter Code (e.g. 601227644).
  • IN_PAN – 10-character India Permanent Account Number. The first five characters are letters, next four numbers, last character is a letter (e.g. AFZPK7190K). Cannot be set as the Primary Identifier.
  • IN_TIN – 11-character India Taxpayer Identification Number (e.g. 95684444523). Cannot be set as the Primary Identifier.
  • KG_TIN – 14-character Kyrgyzstan Taxpayer Identification Number (e.g. 56200044505998). Cannot be set as the Primary Identifier.
  • KR_BUS_REG_NUMBER – 10-character South Korea Corporate Registration Number. Format is xxx-xx-xxxxx (e.g. 324-84-22451).
  • KR_PROVIDER_CODE – 8-character South Korea Provider Code (e.g. 45632196).
  • KZ_BIN – 12-character Kazakhstan Business Identification Number (e.g. 220110668755). Cannot be set as the Primary Identifier.
  • RU_ACCOUNT_NUMBER – 14- to 36-character Russia Account Number (e.g. 19527400000001 or 19406412-0001-000a-0000-000000000022). Cannot be set as the Primary Identifier.
  • RU_INN_FOREIGN_ENTITY – 10-character Russia Foreign Business Taxpayer Identification Number (e.g. 7744000912). Cannot be set as the Primary Identifier. Only one of the following identifier types can be assigned to an entity: RU - INN Local, RU - IN Foreign, and RU - INN Individual.
  • RU_INN_INDIV – 12-character Russia Individual Taxpayer Identification Number (e.g. 123456789001). Cannot be set as the Primary Identifier. Only one of the following identifier types can be assigned to an entity: RU - INN Local, RU - IN Foreign, and RU - INN Individual.
  • RU_INN_KPP_TAX_CODE – 9-character Russia KPP Registration Code (e.g. 771301001). Cannot be set as the Primary Identifier.
  • RU_INN_LOCAL_ENTITY – 10-character Russia Local Business Taxpayer Identification Number (e.g. 7728640746). Cannot be set as the Primary Identifier. Only one of the following identifier types can be assigned to an entity: RU - INN Local, RU - IN Foreign, and RU - INN Individual.
  • SGLN – 15-character SGLN format representation of Global Location Number:
    • Format for company entities is [CompanyPrefix].[LocationRef].0 or [CompanyPrefix]..0. The LocationRef segment is optional. If the LocationRef is included, the first two segments contain only digits separated by the dot, and must be 13 characters in total. If the LocationRef is not included, then the first segment must be 12 digits, followed by two dot seperators. The third segment should always be the digit 0. For example, 539885451928..0 or urn:epc:id:sgln:0614141.12345.0.
    • Format for location entities is [CompanyPrefix].[LocationRef].[sub-location identifier] or [CompanyPrefix]..[sub-location identifier].The LocationRef segment is optional. If the LocationRef is included, the first two segments contain only digits separated by the dot, and must be 13 characters in total. If the LocationRef is not included, then the first segment must be 12 digits, followed by two dot seperators. The third segment is always alphanumeric and can be any length, with at least one character in it preceded by the dot separator. For example, 8856277.23331.6 or 539885451928..11.
  • TRACELINK_ID – TraceLink Identification Number (e.g. KENDALLPHARM).
  • UZ_TIN – 9-character Uzbekistan Taxpayer Identification Number (e.g. 000181244). Cannot be set as the Primary Identifier.
      sbdh:DocumentIdentification [1...1]
[-]		 - Required. The document identification and standard.
        sbdh:Standard [1...1]
[1/*]		 String Required. The document standard. Valid value is EPCglobal.
        sbdh:TypeVersion [1...1]
[1/*]		 String Required. The version of the document included in the payload. This is the complete version and is different than the sbdh:HeaderVersion. Valid value is 1.0.
        sbdh:InstanceIdentifier [1...1]
[1/*]		 String Required. The reference identifier that uniquely identifies this instance of the Standard Business Document between the sender and the receiver.
        sbdh:Type [1...1]
[1/*]		 String Required. The type of document. Valid value is EPCglobal.
        sbdh:CreationDateAndTime [1...1]
[1/*]		 DateTime Required. The date and time the file was created in YYYY-MM-DDTHH:MM:SS.ssZ format (e.g. 2023-03-25T22:08:02Z). Milliseconds default to zero.
  EPCISBody [1...1]
[-]		 -

Required. The body of the message with the EPCIS event.
    EventList [1...1]
[-]		 - Required. The EventList has the following structure:
  • AggregationEvent (1 or more for disaggregation events)
      choice [1...1]
[-]		 - Required. Only AggregationEvent can be used in any one loop of EPCISBody | EventList.
      AggregationEvent [1...*]
[-]		 -

Required. The disaggregation event.

Set the following values to indicate that that the ObjectEvent is for disaggregation:

  • action is DELETE.
  • bizStep is urn:epcglobal:cbv:bizstep:unpacking.
  • disposition is urn:epcglobal:cbv:disp:in_progress.
        eventTime [1...1]
[1/*]		 DateTime Required. The date and time the serial numbers were disaggregated in YYYY-MM-DDTHH:MM:SSZ format (e.g. 2023-03-31T12:40:21.140Z). Milliseconds default to zero for efficiency and smaller file sizes because serial numbers can be grouped together when the event times are the same.
        eventTimeZoneOffset [1...1]
[1/*]		 String Required. The time zone offset in effect at the time and place where the event occurred (e.g. -05:00).
        parentID [1...1]
[1/*]		 AnyURI

Required. The serial number of the parent container in EPC Pure Identity URI format (e.g. urn:epc:id:sgtin:088202.5503022.100000000670).

  • SGTIN
    • Format: urn:epc:id:sgtin:[company prefix].[indicator digit + item reference].[serial number]
    • Example: urn:epc:id:sgtin:068202.0401034.11220207026272
  • SSCC
    • Format: urn:epc:id:sscc:[company prefix].[extension digit + serial number]
    • Example: urn:epc:id:sscc:030944.10105363280
  • CN-EDMC
    • Format: http://epcis.tracelink.com/hc/cn-edmc/obj/[serial number]
    • Example: http://epcis.tracelink.com/hc/cn-edmc/obj88102321100002005943
        childEPCs [1...1]
[-]		 - Required. The list of child serial numbers disaggregated from the parent container (e.g. for an each-to-case aggregation, the serial numbers of the eaches).
          epc [1...*]
[1/*]		 AnyURI

Required. The EPC identifier for the child serial number in EPC Pure Identity URI format.

  • SGTIN
    • Format: urn:epc:id:sgtin:[company prefix].[indicator digit + item reference].[serial number]
    • Example: urn:epc:id:sgtin:068202.0401034.11220207026272
  • SSCC
    • Format: urn:epc:id:sscc:[company prefix].[extension digit + serial number]
    • Example: urn:epc:id:sscc:030944.10105363280
  • CN-EDMC
    • Format: http://epcis.tracelink.com/hc/cn-edmc/obj/[serial number]
    • Example: http://epcis.tracelink.com/hc/cn-edmc/obj88102321100002005943
        action [1...1]
[1/*]		 String Required. The standard GS1 action for the event. Valid value is DELETE.
        bizStep [1...1]
[1/*]		 AnyURI Required. The standard GS1 business step for the event. Valid value is urn:epcglobal:cbv:bizstep:unpacking.
        disposition [1...1]
[1/*]		 AnyURI Required. The standard GS1 disposition for the event. Valid value is urn:epcglobal:cbv:disp:in_progress.
        readPoint [0...1]
[-]		 - The location where disaggregation occurred, specifically where the barcode was scanned, if applicable.
          id [1...1]
[1/*]		 AnyURI

Required. The SGLN EPC of the location where disaggregation occurred (e.g. urn:epc:id:sgln:0614141.12345.RP1). This SGLN can be at the location level or a more specific storage space (e.g. a specific shelf within the warehouse).

This ID must use the following structure: urn:epc:id:sgln:[GS1 company prefix].[location ID].[sublocation ID]. The sublocation ID must be 0 if not applicable.
        bizLocation [1...1]
[-]		 - Required. The business location where disaggregation occurred.
          id [1...1]
[1/*]		 AnyURI

Required. The SGLN EPC of the location where disaggregation occurred (e.g. urn:epc:id:sgln:0614141.12345.RP1). This SGLN can be at the location level or a more specific storage space (e.g. a specific shelf within the warehouse).

This ID must use the following structure: urn:epc:id:sgln:[GS1 company prefix].[location ID].[sublocation ID]. The sublocation ID must be 0 if not applicable.

Example

Copy 
<?xml version="1.0" encoding="UTF-8"?>
<epcis:EPCISDocument xmlns:epcis="urn:epcglobal:epcis:xsd:1" xmlns:sbdh="http://www.unece.org/cefact/namespaces/StandardBusinessDocumentHeader" xmlns:cbvmda="urn:epcglobal:cbv:mda" xmlns:tl="http://epcis.tracelink.com/ns" creationDate="2017-04-11T07:15:00Z" schemaVersion="1.2">
    <EPCISHeader>
        <sbdh:StandardBusinessDocumentHeader>
            <sbdh:HeaderVersion>1.0</sbdh:HeaderVersion>
            <sbdh:Sender>
                <sbdh:Identifier Authority="GLN">8887771013655</sbdh:Identifier>
            </sbdh:Sender>
            <sbdh:Receiver>
                <sbdh:Identifier Authority="GLN">6667771013655</sbdh:Identifier>
            </sbdh:Receiver>
            <sbdh:DocumentIdentification>
                <sbdh:Standard>EPCglobal</sbdh:Standard>
                <sbdh:TypeVersion>1.0</sbdh:TypeVersion>
                <sbdh:InstanceIdentifier>00699999999990000000283944908</sbdh:InstanceIdentifier>
                <sbdh:Type>Events</sbdh:Type>
                <sbdh:CreationDateAndTime>2020-08-17T07:15:00Z</sbdh:CreationDateAndTime>
            </sbdh:DocumentIdentification>
        </sbdh:StandardBusinessDocumentHeader>
    </EPCISHeader>
    <EPCISBody>
        <EventList>
            <AggregationEvent>
                <eventTime>2020-08-17T00:12:23.83Z</eventTime>
                <eventTimeZoneOffset>-05:00</eventTimeZoneOffset>
                <parentID>urn:epc:id:sscc:088202.0401034.00200000034</parentID>
                <childEPCs>
                    <epc>urn:epc:id:sgtin:005434.40000000019</epc>
                </childEPCs>
                <action>DELETE</action>
                <bizStep>urn:epcglobal:cbv:bizstep:unpacking</bizStep>
                <disposition>urn:epcglobal:cbv:disp:in_progress</disposition>
                <readPoint>
                    <id>urn:epc:id:sgln:8887777.01384.0</id>
                </readPoint>
                <bizLocation>
                    <id>urn:epc:id:sgln:8887777.01384.0</id>
                </bizLocation>
            </AggregationEvent>
        </EventList>
    </EPCISBody>
</epcis:EPCISDocument>

Errors

Data Element Error message Description
Class 1
AggregationEvent At least one AggregationEvent is required for disaggregation !!! This element must have a value specified.
parentID Invalid EPC format !!! This element must be specified in one of the valid formats.
This element must have a value specified.
childEPCs | epc Invalid EPC format !!! This element must be specified in one of the valid formats.
This element must have a value specified.
action Action DELETE is required for disaggregation !!! This element must be specified as DELETE.
bizStep bizStep urn:epcglobal:cbv:bizstep:unpacking is required for disaggregation !!! This element must be specified as urn:epcglobal:cbv:bizstep:unpacking.
disposition Dispositio​n urn:epcglobal:cbv:di​sp:in_progress is required for disaggregation !!! This element must be specified as urn:epcglobal:cbv:di​sp:in_progress.
bizLocation | id Business location is required for disaggregation !!! This element must have a value specified.
Class 3
The following is thrown for all Class 3 errors: “INTERNALERROR=Internal error from server [server details].” Please contact Support if this error is encountered.