{"$schema":"http://json-schema.org/draft-07/schema#","$id":"https://api.orderful.com/v3/simplified-schemas/INVENTORY_ADVICE","title":"Simplified Inventory Advice","description":"A simplified version of the inventory inquiry/advice document","type":"object","properties":{"purpose":{"type":"string","enum":["full","incremental","change"],"description":"Purpose of the inventory report","orderful_x12_path":["846:beginningSegmentForInventoryInquiryAdvice.*.transactionSetPurposeCode"],"orderful_x12_codes":["00","04","05","25"]},"reportType":{"type":"string","enum":["sellerInventory"],"description":"Type of inventory report being sent","orderful_x12_path":["846:beginningSegmentForInventoryInquiryAdvice.*.reportTypeCode"],"orderful_x12_codes":["SI","DD","MB","TC"]},"reportNumber":{"type":"string","description":"Unique identifier for this inventory report","orderful_x12_path":["846:beginningSegmentForInventoryInquiryAdvice.*.referenceIdentification"]},"reportDate":{"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"}],"description":"Date the inventory report was created or snapshot was taken","orderful_x12_path":["846:beginningSegmentForInventoryInquiryAdvice.*.date","846:beginningSegmentForInventoryInquiryAdvice.*.time"]},"parties":{"description":"Parties involved in the inventory report","orderful_x12_path":["846:N1_loop"],"type":"object","properties":{"inventoryLocation":{"description":"Warehouse or distribution center reporting inventory","orderful_x12_path":["846:N1_loop.* | entityIdentifierCode=WH,RL,SF"],"orderful_x12_codes":["WH","RL","SF"],"type":"object","properties":{"name":{"description":"Party name or company name","type":"string"},"additionalName1":{"description":"Additional name line 1","type":"string"},"additionalName2":{"description":"Additional name line 2","type":"string"},"identificationCode":{"description":"Party identification code value","type":"string"},"identificationCodeType":{"type":"string","enum":["sendersId","receiversId","duns","plantCode","dunsPlus4","drugEnforcementAdmin","telephone","federalReserveRouting","standardAddressSAN","healthIndustryHIN","warehouse","schoolId","memberId","stateLicenseId","globalLocationId"],"description":"Type of identification code","orderful_x12_path":["856:HL_loop.*.N1_loop.*.partyIdentification.*.identificationCodeQualifier"],"orderful_enum_meta":{"sendersId":{"description":"Sender's identification code","orderful_x12_codes":["58","93","91","92"],"orderful_edifact_codes":["91"]},"receiversId":{"description":"Receiver's identification code","orderful_x12_codes":["59","94","91","92"],"orderful_edifact_codes":["92"]},"duns":{"description":"Dun & Bradstreet number","orderful_x12_codes":["1"],"orderful_edifact_codes":["16"]},"plantCode":{"description":"Plant code","orderful_x12_codes":["6"]},"dunsPlus4":{"description":"DUNS+4 identifier","orderful_x12_codes":["9"]},"drugEnforcementAdmin":{"description":"DEA (Drug Enforcement Administration) number","orderful_x12_codes":["11"]},"telephone":{"description":"Telephone number as identifier","orderful_x12_codes":["12"]},"federalReserveRouting":{"description":"Federal Reserve routing number","orderful_x12_codes":["13"]},"standardAddressSAN":{"description":"Standard Address Number (SAN)","orderful_x12_codes":["15"]},"healthIndustryHIN":{"description":"Health Industry Number (HIN)","orderful_x12_codes":["21"]},"warehouse":{"description":"Warehouse identifier","orderful_x12_codes":["54"]},"schoolId":{"description":"School identifier","orderful_x12_codes":["DS"]},"memberId":{"description":"Member identifier","orderful_x12_codes":["MI"]},"stateLicenseId":{"description":"State license identifier","orderful_x12_codes":["SL"]},"globalLocationId":{"description":"Global Location Number (GLN)","orderful_x12_codes":["UL"],"orderful_edifact_codes":["9"]}}},"addressLine1":{"description":"Street address line 1","type":"string"},"addressLine2":{"description":"Street address line 2","type":"string"},"addressLine3":{"description":"Street address line 3","type":"string"},"addressLine4":{"description":"Street address line 4","type":"string"},"city":{"description":"City name","type":"string"},"stateOrProvinceCode":{"description":"State or province code","type":"string"},"postalCode":{"description":"Postal or ZIP code","type":"string"},"countryCode":{"description":"Country code (ISO)","type":"string"},"zoneType":{"description":"Address zone type","type":"string","enum":["residential","commercial"]},"contacts":{"description":"Contact persons for this party","type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["primary","customerRelations","orderInquiry","department","shipping","receiving","hazmat"],"description":"Type of contact. Default to 'primary' for party-level (N1_loop) PER segments and context-routed header-level PER segments — the parent party's role provides the context. Use other types only to distinguish multiple contacts within a single party (e.g. 'hazmat' for HM, 'shipping' for SD).","orderful_x12_path":["856:HL_loop.*.N1_loop.*.administrativeCommunicationsContact.*.contactFunctionCode"],"orderful_enum_meta":{"primary":{"description":"General contact or party-level contact","orderful_x12_codes":["AJ","BD","IC"]},"customerRelations":{"description":"Customer relations contact","orderful_x12_codes":["CR"]},"orderInquiry":{"description":"Order or billing contact","orderful_x12_codes":["BI","OC"]},"department":{"description":"Sales representative or department contact","orderful_x12_codes":["SR"]},"shipping":{"description":"Shipping department contact","orderful_x12_codes":["SD"]},"receiving":{"description":"Receiving department contact","orderful_x12_codes":["RE"]},"hazmat":{"description":"Hazardous material contact","orderful_x12_codes":["HM"]}}},"name":{"description":"Contact person name","type":"string"},"phoneNumber":{"description":"Contact phone number. Default source is the comm-number paired with a TE qualifier (PER03/04, PER05/06, or PER07/08). If the partner guideline note on the comm-number element labels the value as a different comm type (e.g. \"Fax #\", \"Email\"), follow the note and route accordingly.","type":"string"},"faxNumber":{"description":"Contact fax number. Default source is the comm-number paired with an FX qualifier (PER03/04, PER05/06, or PER07/08). If the partner guideline note on a comm-number element labels its value as fax even when the qualifier is TE/EM, follow the note and route the value here.","type":"string"},"email":{"description":"Contact email address. Default source is the comm-number paired with an EM qualifier (PER03/04, PER05/06, or PER07/08). If the partner guideline note on the comm-number element labels the value as a different comm type, follow the note and route accordingly.","type":"string"}},"required":["type"],"additionalProperties":false}}},"additionalProperties":false},"buyer":{"description":"Buyer or retailer receiving the inventory report","orderful_x12_path":["846:N1_loop.* | entityIdentifierCode=BY,TO"],"orderful_x12_codes":["BY","TO"],"type":"object","properties":{"name":{"description":"Party name or company name","type":"string"},"additionalName1":{"description":"Additional name line 1","type":"string"},"additionalName2":{"description":"Additional name line 2","type":"string"},"identificationCode":{"description":"Party identification code value","type":"string"},"identificationCodeType":{"type":"string","enum":["sendersId","receiversId","duns","plantCode","dunsPlus4","drugEnforcementAdmin","telephone","federalReserveRouting","standardAddressSAN","healthIndustryHIN","warehouse","schoolId","memberId","stateLicenseId","globalLocationId"],"description":"Type of identification code","orderful_x12_path":["856:HL_loop.*.N1_loop.*.partyIdentification.*.identificationCodeQualifier"],"orderful_enum_meta":{"sendersId":{"description":"Sender's identification code","orderful_x12_codes":["58","93","91","92"],"orderful_edifact_codes":["91"]},"receiversId":{"description":"Receiver's identification code","orderful_x12_codes":["59","94","91","92"],"orderful_edifact_codes":["92"]},"duns":{"description":"Dun & Bradstreet number","orderful_x12_codes":["1"],"orderful_edifact_codes":["16"]},"plantCode":{"description":"Plant code","orderful_x12_codes":["6"]},"dunsPlus4":{"description":"DUNS+4 identifier","orderful_x12_codes":["9"]},"drugEnforcementAdmin":{"description":"DEA (Drug Enforcement Administration) number","orderful_x12_codes":["11"]},"telephone":{"description":"Telephone number as identifier","orderful_x12_codes":["12"]},"federalReserveRouting":{"description":"Federal Reserve routing number","orderful_x12_codes":["13"]},"standardAddressSAN":{"description":"Standard Address Number (SAN)","orderful_x12_codes":["15"]},"healthIndustryHIN":{"description":"Health Industry Number (HIN)","orderful_x12_codes":["21"]},"warehouse":{"description":"Warehouse identifier","orderful_x12_codes":["54"]},"schoolId":{"description":"School identifier","orderful_x12_codes":["DS"]},"memberId":{"description":"Member identifier","orderful_x12_codes":["MI"]},"stateLicenseId":{"description":"State license identifier","orderful_x12_codes":["SL"]},"globalLocationId":{"description":"Global Location Number (GLN)","orderful_x12_codes":["UL"],"orderful_edifact_codes":["9"]}}},"addressLine1":{"description":"Street address line 1","type":"string"},"addressLine2":{"description":"Street address line 2","type":"string"},"addressLine3":{"description":"Street address line 3","type":"string"},"addressLine4":{"description":"Street address line 4","type":"string"},"city":{"description":"City name","type":"string"},"stateOrProvinceCode":{"description":"State or province code","type":"string"},"postalCode":{"description":"Postal or ZIP code","type":"string"},"countryCode":{"description":"Country code (ISO)","type":"string"},"zoneType":{"description":"Address zone type","type":"string","enum":["residential","commercial"]},"contacts":{"description":"Contact persons for this party","type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["primary","customerRelations","orderInquiry","department","shipping","receiving","hazmat"],"description":"Type of contact. Default to 'primary' for party-level (N1_loop) PER segments and context-routed header-level PER segments — the parent party's role provides the context. Use other types only to distinguish multiple contacts within a single party (e.g. 'hazmat' for HM, 'shipping' for SD).","orderful_x12_path":["856:HL_loop.*.N1_loop.*.administrativeCommunicationsContact.*.contactFunctionCode"],"orderful_enum_meta":{"primary":{"description":"General contact or party-level contact","orderful_x12_codes":["AJ","BD","IC"]},"customerRelations":{"description":"Customer relations contact","orderful_x12_codes":["CR"]},"orderInquiry":{"description":"Order or billing contact","orderful_x12_codes":["BI","OC"]},"department":{"description":"Sales representative or department contact","orderful_x12_codes":["SR"]},"shipping":{"description":"Shipping department contact","orderful_x12_codes":["SD"]},"receiving":{"description":"Receiving department contact","orderful_x12_codes":["RE"]},"hazmat":{"description":"Hazardous material contact","orderful_x12_codes":["HM"]}}},"name":{"description":"Contact person name","type":"string"},"phoneNumber":{"description":"Contact phone number. Default source is the comm-number paired with a TE qualifier (PER03/04, PER05/06, or PER07/08). If the partner guideline note on the comm-number element labels the value as a different comm type (e.g. \"Fax #\", \"Email\"), follow the note and route accordingly.","type":"string"},"faxNumber":{"description":"Contact fax number. Default source is the comm-number paired with an FX qualifier (PER03/04, PER05/06, or PER07/08). If the partner guideline note on a comm-number element labels its value as fax even when the qualifier is TE/EM, follow the note and route the value here.","type":"string"},"email":{"description":"Contact email address. Default source is the comm-number paired with an EM qualifier (PER03/04, PER05/06, or PER07/08). If the partner guideline note on the comm-number element labels the value as a different comm type, follow the note and route accordingly.","type":"string"}},"required":["type"],"additionalProperties":false}}},"additionalProperties":false},"supplier":{"description":"Supplier or seller providing inventory information","orderful_x12_path":["846:N1_loop.* | entityIdentifierCode=SE,SU,VN"],"orderful_x12_codes":["SE","SU","VN"],"type":"object","properties":{"name":{"description":"Party name or company name","type":"string"},"additionalName1":{"description":"Additional name line 1","type":"string"},"additionalName2":{"description":"Additional name line 2","type":"string"},"identificationCode":{"description":"Party identification code value","type":"string"},"identificationCodeType":{"type":"string","enum":["sendersId","receiversId","duns","plantCode","dunsPlus4","drugEnforcementAdmin","telephone","federalReserveRouting","standardAddressSAN","healthIndustryHIN","warehouse","schoolId","memberId","stateLicenseId","globalLocationId"],"description":"Type of identification code","orderful_x12_path":["856:HL_loop.*.N1_loop.*.partyIdentification.*.identificationCodeQualifier"],"orderful_enum_meta":{"sendersId":{"description":"Sender's identification code","orderful_x12_codes":["58","93","91","92"],"orderful_edifact_codes":["91"]},"receiversId":{"description":"Receiver's identification code","orderful_x12_codes":["59","94","91","92"],"orderful_edifact_codes":["92"]},"duns":{"description":"Dun & Bradstreet number","orderful_x12_codes":["1"],"orderful_edifact_codes":["16"]},"plantCode":{"description":"Plant code","orderful_x12_codes":["6"]},"dunsPlus4":{"description":"DUNS+4 identifier","orderful_x12_codes":["9"]},"drugEnforcementAdmin":{"description":"DEA (Drug Enforcement Administration) number","orderful_x12_codes":["11"]},"telephone":{"description":"Telephone number as identifier","orderful_x12_codes":["12"]},"federalReserveRouting":{"description":"Federal Reserve routing number","orderful_x12_codes":["13"]},"standardAddressSAN":{"description":"Standard Address Number (SAN)","orderful_x12_codes":["15"]},"healthIndustryHIN":{"description":"Health Industry Number (HIN)","orderful_x12_codes":["21"]},"warehouse":{"description":"Warehouse identifier","orderful_x12_codes":["54"]},"schoolId":{"description":"School identifier","orderful_x12_codes":["DS"]},"memberId":{"description":"Member identifier","orderful_x12_codes":["MI"]},"stateLicenseId":{"description":"State license identifier","orderful_x12_codes":["SL"]},"globalLocationId":{"description":"Global Location Number (GLN)","orderful_x12_codes":["UL"],"orderful_edifact_codes":["9"]}}},"addressLine1":{"description":"Street address line 1","type":"string"},"addressLine2":{"description":"Street address line 2","type":"string"},"addressLine3":{"description":"Street address line 3","type":"string"},"addressLine4":{"description":"Street address line 4","type":"string"},"city":{"description":"City name","type":"string"},"stateOrProvinceCode":{"description":"State or province code","type":"string"},"postalCode":{"description":"Postal or ZIP code","type":"string"},"countryCode":{"description":"Country code (ISO)","type":"string"},"zoneType":{"description":"Address zone type","type":"string","enum":["residential","commercial"]},"contacts":{"description":"Contact persons for this party","type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["primary","customerRelations","orderInquiry","department","shipping","receiving","hazmat"],"description":"Type of contact. Default to 'primary' for party-level (N1_loop) PER segments and context-routed header-level PER segments — the parent party's role provides the context. Use other types only to distinguish multiple contacts within a single party (e.g. 'hazmat' for HM, 'shipping' for SD).","orderful_x12_path":["856:HL_loop.*.N1_loop.*.administrativeCommunicationsContact.*.contactFunctionCode"],"orderful_enum_meta":{"primary":{"description":"General contact or party-level contact","orderful_x12_codes":["AJ","BD","IC"]},"customerRelations":{"description":"Customer relations contact","orderful_x12_codes":["CR"]},"orderInquiry":{"description":"Order or billing contact","orderful_x12_codes":["BI","OC"]},"department":{"description":"Sales representative or department contact","orderful_x12_codes":["SR"]},"shipping":{"description":"Shipping department contact","orderful_x12_codes":["SD"]},"receiving":{"description":"Receiving department contact","orderful_x12_codes":["RE"]},"hazmat":{"description":"Hazardous material contact","orderful_x12_codes":["HM"]}}},"name":{"description":"Contact person name","type":"string"},"phoneNumber":{"description":"Contact phone number. Default source is the comm-number paired with a TE qualifier (PER03/04, PER05/06, or PER07/08). If the partner guideline note on the comm-number element labels the value as a different comm type (e.g. \"Fax #\", \"Email\"), follow the note and route accordingly.","type":"string"},"faxNumber":{"description":"Contact fax number. Default source is the comm-number paired with an FX qualifier (PER03/04, PER05/06, or PER07/08). If the partner guideline note on a comm-number element labels its value as fax even when the qualifier is TE/EM, follow the note and route the value here.","type":"string"},"email":{"description":"Contact email address. Default source is the comm-number paired with an EM qualifier (PER03/04, PER05/06, or PER07/08). If the partner guideline note on the comm-number element labels the value as a different comm type, follow the note and route accordingly.","type":"string"}},"required":["type"],"additionalProperties":false}}},"additionalProperties":false}},"additionalProperties":false},"references":{"description":"Reference numbers associated with the inventory report","orderful_x12_path":["846:referenceInformation.* | referenceIdentificationQualifier!=L1"],"type":"object","properties":{"vendorNumber":{"description":"Vendor or supplier identifier","orderful_x12_path":["846:referenceInformation.* | referenceIdentificationQualifier=VR,IA"],"orderful_x12_codes":["VR","IA"],"type":"object","properties":{"value":{"description":"The reference identifier value","type":"string"},"description":{"description":"Additional description or context for the reference","type":"string"}},"additionalProperties":false},"batchNumber":{"description":"Batch number for inventory report grouping","orderful_x12_path":["846:referenceInformation.* | referenceIdentificationQualifier=BT"],"orderful_x12_codes":["BT"],"type":"object","properties":{"value":{"description":"The reference identifier value","type":"string"},"description":{"description":"Additional description or context for the reference","type":"string"}},"additionalProperties":false},"departmentNumber":{"description":"Department number within the organization","orderful_x12_path":["846:referenceInformation.* | referenceIdentificationQualifier=DP"],"orderful_x12_codes":["DP"],"type":"object","properties":{"value":{"description":"The reference identifier value","type":"string"},"description":{"description":"Additional description or context for the reference","type":"string"}},"additionalProperties":false}},"additionalProperties":false},"dates":{"description":"Date ranges for the inventory reporting period","orderful_x12_path":["846:dateTimeReference"],"type":"object","properties":{"reportStartDate":{"description":"Date the inventory reporting period starts","orderful_x12_path":["846:dateTimeReference.* | dateTimeQualifier=090"],"orderful_x12_codes":["090"],"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"}]},"reportEndDate":{"description":"Date the inventory reporting period ends","orderful_x12_path":["846:dateTimeReference.* | dateTimeQualifier=091"],"orderful_x12_codes":["091"],"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"}]}},"additionalProperties":false},"sellersCurrency":{"description":"Currency used by the seller for pricing information","orderful_x12_path":["846:currency.* | entityIdentifierCode=SE"],"orderful_x12_codes":["SE"],"type":"object","properties":{"currencyCode":{"type":"string","description":"ISO currency code (e.g., USD, EUR)"},"exchangeRate":{"description":"Exchange rate for currency conversion","type":"string"}},"required":["currencyCode"],"additionalProperties":false},"notes":{"description":"Notes and comments for the inventory report","orderful_x12_path":["846:referenceInformation.* | referenceIdentificationQualifier=L1"],"orderful_x12_codes":["L1"],"type":"object","properties":{"general":{"description":"General notes or comments about the inventory report","orderful_x12_path":["846:referenceInformation.* | referenceIdentificationQualifier=L1"],"orderful_x12_codes":["L1"],"type":"object","properties":{"description":{"description":"Brief description or title of the note","type":"string"},"text":{"description":"Array of text lines for the note content","type":"array","items":{"type":"string"}}},"additionalProperties":false}},"additionalProperties":false},"lineItems":{"type":"array","items":{"type":"object","properties":{"lineNumber":{"description":"Sequential line item number for referencing specific items","orderful_x12_path":["846:LIN_loop.*.itemIdentification.*.assignedIdentification"],"type":"string"},"productIds":{"type":"object","properties":{"buyerItemNumber":{"description":"Buyer-assigned item number","orderful_x12_codes":["BP","IN","CB","SK","PI","IT","PN","ST"],"orderful_edifact_codes":["BP","IN","SK","IT"],"type":"string"},"vendorItemNumber":{"description":"Vendor-assigned item number (EDIFACT LIN/PIA supplier's item number)","orderful_x12_codes":["VA","VC","VN","VP","MG","MF","SA"],"orderful_edifact_codes":["SA","VN","VP","MF"],"type":"string"},"gtin12":{"description":"GTIN-12 (UPC-A) barcode","orderful_x12_codes":["UP"],"orderful_edifact_codes":["UP"],"type":"string"},"gtin13":{"description":"GTIN-13 (EAN) barcode","orderful_x12_codes":["EN"],"orderful_edifact_codes":["EN","SRV"],"type":"string"},"gtin14":{"description":"GTIN-14 (ITF-14) case code barcode","orderful_x12_codes":["UK"],"type":"string"},"caseCode":{"description":"Case code identifier","orderful_x12_codes":["UI","UN","UA","UB"],"type":"string"},"drugCode":{"description":"National Drug Code (NDC)","orderful_x12_codes":["N1","N2","N3","N4","ND"],"type":"string"},"standardBookNumber":{"description":"ISBN or standard book number","orderful_x12_codes":["IB"],"orderful_edifact_codes":["IB"],"type":"string"},"buyerItemIds":{"description":"Additional buyer product identifiers","orderful_x12_codes":["CB","SK","ST","IT"],"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["catalog","manufacturerPart","sku","style"],"description":"Type of product identifier","orderful_x12_path":["856:HL_loop.*.itemIdentification.*.productServiceIDQualifier","856:HL_loop.*.itemIdentification.*.productServiceIDQualifier1","856:HL_loop.*.itemIdentification.*.productServiceIDQualifier2","856:HL_loop.*.itemIdentification.*.productServiceIDQualifier3","856:HL_loop.*.itemIdentification.*.productServiceIDQualifier4","856:HL_loop.*.itemIdentification.*.productServiceIDQualifier5","856:HL_loop.*.itemIdentification.*.productServiceIDQualifier6","856:HL_loop.*.itemIdentification.*.productServiceIDQualifier7","856:HL_loop.*.itemIdentification.*.productServiceIDQualifier8","856:HL_loop.*.itemIdentification.*.productServiceIDQualifier9","856:HL_loop.*.itemIdentification.*.productServiceIDQualifier10","856:HL_loop.*.itemIdentification.*.productServiceIDQualifier11","856:HL_loop.*.itemIdentification.*.productServiceIDQualifier12","856:HL_loop.*.itemIdentification.*.productServiceIDQualifier13","856:HL_loop.*.itemIdentification.*.productServiceIDQualifier14"],"orderful_enum_meta":{"catalog":{"description":"Catalog number (buyer catalog reference)","orderful_x12_codes":["CB","VC"]},"manufacturerPart":{"description":"Manufacturer part number","orderful_x12_codes":["MG","MF"]},"sku":{"description":"Stock keeping unit identifier","orderful_x12_codes":["SK"]},"style":{"description":"Style number or code","orderful_x12_codes":["ST","IT","VA"]}}},"value":{"type":"string","description":"Product identifier value"}},"required":["type","value"],"additionalProperties":false}},"vendorItemIds":{"description":"Additional vendor product identifiers","orderful_x12_codes":["VC","MG","VA","MF"],"orderful_edifact_codes":["MF"],"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["catalog","manufacturerPart","sku","style"],"description":"Type of product identifier","orderful_x12_path":["856:HL_loop.*.itemIdentification.*.productServiceIDQualifier","856:HL_loop.*.itemIdentification.*.productServiceIDQualifier1","856:HL_loop.*.itemIdentification.*.productServiceIDQualifier2","856:HL_loop.*.itemIdentification.*.productServiceIDQualifier3","856:HL_loop.*.itemIdentification.*.productServiceIDQualifier4","856:HL_loop.*.itemIdentification.*.productServiceIDQualifier5","856:HL_loop.*.itemIdentification.*.productServiceIDQualifier6","856:HL_loop.*.itemIdentification.*.productServiceIDQualifier7","856:HL_loop.*.itemIdentification.*.productServiceIDQualifier8","856:HL_loop.*.itemIdentification.*.productServiceIDQualifier9","856:HL_loop.*.itemIdentification.*.productServiceIDQualifier10","856:HL_loop.*.itemIdentification.*.productServiceIDQualifier11","856:HL_loop.*.itemIdentification.*.productServiceIDQualifier12","856:HL_loop.*.itemIdentification.*.productServiceIDQualifier13","856:HL_loop.*.itemIdentification.*.productServiceIDQualifier14"],"orderful_enum_meta":{"catalog":{"description":"Catalog number (buyer catalog reference)","orderful_x12_codes":["CB","VC"]},"manufacturerPart":{"description":"Manufacturer part number","orderful_x12_codes":["MG","MF"]},"sku":{"description":"Stock keeping unit identifier","orderful_x12_codes":["SK"]},"style":{"description":"Style number or code","orderful_x12_codes":["ST","IT","VA"]}}},"value":{"type":"string","description":"Product identifier value"}},"required":["type","value"],"additionalProperties":false}}},"additionalProperties":false,"description":"Product identification codes such as UPC, SKU, or vendor item number","orderful_x12_notes":["Mapping rule when a guideline requires a code that this schema can supply from multiple fields:\n  1. Fill mandatory guideline positions before optional/conditional ones.\n  2. Prefer the more specific source. `*ItemIds` typed-array entries cover a tighter code set than `*ItemNumber` string fields; use the array entry when both could satisfy the same code.\n  3. Each simplified property maps to exactly one X12 qualifier across every line item in a transformation. Do not switch a property's qualifier line-by-line based on which sibling fields are populated. The position where the qualifier appears within a repeating element group can vary per line item depending on which other identifiers are present."],"orderful_x12_path":["846:LIN_loop.*.itemIdentification.*.productServiceIDQualifier","846:LIN_loop.*.itemIdentification.*.productServiceID"]},"productAttributes":{"description":"Product descriptions and attributes","orderful_x12_path":["846:LIN_loop.*.productItemDescription"],"type":"object","properties":{"description":{"description":"General product description. Sourced from X12 PID05 when PID02=\"08\" (Product Description, general) or when PID02 is absent. In EDIFACT, sourced from EVERY IMD composite for this line item where itemDescriptionCode=\"SP\" (Product) — there may be MULTIPLE matching IMD repetitions per line item, and ALL of them must be included. Within each matching IMD, concatenate itemDescription + itemDescription_1 (the continuation field) with a single space; then $join those per-IMD strings across ALL matching IMDs with a single space separator. Do NOT pick only the first matching IMD — partners commonly split a long description across multiple IMD segments because each itemDescription element is capped at 35 characters. The qualifier code \"SP\" (or X12 \"08\") is positional — it identifies which IMDs carry the product description, and must NOT be reported as a schema gap.","orderful_edifact_paths":["ORDERS:lineItem_group.*.itemDescription.*.itemDescription_composite | itemDescriptionCode=SP"],"orderful_edifact_codes":["SP"],"type":"string"},"shortDescription":{"description":"{\"description\":\"Short product description\"}","type":"string"},"brand":{"description":"Brand or label name for the product","orderful_x12_path":["850:PO1_loop.*.referenceInformation.* | referenceIdentificationQualifier=2N","850:PO1_loop.*.baselineItemData.*.productServiceID | productServiceIDQualifier=BL","850:PO1_loop.*.N1_loop.*.partyIdentification.*.name | entityIdentifierCode=BRN","860:POC_loop.*.referenceInformation.* | referenceIdentificationQualifier=2N","860:POC_loop.*.lineItemChange.*.productServiceID | productServiceIDQualifier=BL","860:POC_loop.*.N1_loop.*.partyIdentification.*.name | entityIdentifierCode=BRN"],"orderful_x12_codes":["2N","BL","BRN"],"orderful_x12_notes":["REF02 when REF01=2N; PO107/09.. when PO106/08..=BL; N102 when N101=BRN"],"type":"string"},"colorCode":{"description":"Color code identifier","orderful_x12_codes":["BO","CM","VE"],"type":"string"},"colorDescription":{"description":"Color description text","orderful_x12_codes":["73","75"],"orderful_x12_path":["943:W04_loop.*.lineItemDetail1.*.color"],"type":"string"},"sizeCode":{"description":"Size code identifier","orderful_x12_codes":["IZ","SM","SZ"],"type":"string"},"sizeDescription":{"description":"Size description text","orderful_x12_codes":["74","91"],"type":"string"},"materialCode":{"description":"Material code identifier","orderful_x12_codes":["KJ"],"type":"string"},"materialDescription":{"description":"Material description text","orderful_x12_codes":["78","92","AH"],"type":"string"},"materialAttributes":{"type":"object","properties":{"type":{"description":"Material type or classification","type":"string"},"grade":{"description":"Material grade or quality tier (e.g., prime, excessPrime, waste)","type":"string"},"annealMethod":{"description":"Annealing method applied to the material","type":"string"},"temper":{"description":"Heat treatment or mechanical processing state of the material","type":"string"},"finish":{"description":"Surface finish or texture applied to the material","type":"string"},"outerCoating":{"description":"Outer surface coating or plating","type":"string"},"innerCoating":{"description":"Inner surface coating or plating","type":"string"},"surfaceProtection":{"description":"Surface protection method or specification","type":"string"},"treatment":{"description":"Chemical or mechanical treatment applied to the material","type":"string"},"weld":{"description":"Welding specification or classification for the material","type":"string"}},"additionalProperties":false},"processCode":{"description":"Process code identifier","orderful_x12_codes":["PR"],"type":"string"},"processDescription":{"description":"Process description text","orderful_x12_codes":["12","PP","PR"],"type":"string"},"height":{"description":"Product height dimension","type":"string"},"length":{"description":"Product length dimension","type":"string"},"width":{"description":"Product width dimension","type":"string"},"dimensionUOM":{"type":"string","enum":["standardCubicFoot","boardFeet","hundredBoardFeet","cubicDecimeter","cubicCentimeter","cubicFeet","cubicInches","centimeter","cubicMeter","cubicYard","decimeter","foot","hundredFeet","hundredFeetLinear","hundredSquareFeet","hundredYards","inch","linearFoot","linearMeter","linearYard","millimeter","meter","squareFoot","squareInches","squareMeter","squareYard","thousandSquareInches","thousandFeetLinear","thousandFeetBoard","tenSquareFeet","thousandSquareFeet","yard"],"description":"Unit of measure for product dimensions","orderful_enum_meta":{"standardCubicFoot":{"description":"Standard cubic foot","orderful_x12_codes":["5I"]},"boardFeet":{"description":"Board feet measure","orderful_x12_codes":["BF"]},"hundredBoardFeet":{"description":"Hundred board feet measure","orderful_x12_codes":["BP"]},"cubicDecimeter":{"description":"Cubic decimeter","orderful_x12_codes":["C8"]},"cubicCentimeter":{"description":"Cubic centimeter","orderful_x12_codes":["CC"]},"cubicFeet":{"description":"Cubic feet","orderful_x12_codes":["CF"]},"cubicInches":{"description":"Cubic inches","orderful_x12_codes":["CI"]},"centimeter":{"description":"Centimeter length measure","orderful_x12_codes":["CM"]},"cubicMeter":{"description":"Cubic meter","orderful_x12_codes":["CR"]},"cubicYard":{"description":"Cubic yard","orderful_x12_codes":["CY"]},"decimeter":{"description":"Decimeter length measure","orderful_x12_codes":["DM"]},"foot":{"description":"Foot length measure","orderful_x12_codes":["FT"]},"hundredFeet":{"description":"Hundred feet measure","orderful_x12_codes":["HF"]},"hundredFeetLinear":{"description":"Hundred linear feet measure","orderful_x12_codes":["HL"]},"hundredSquareFeet":{"description":"Hundred square feet measure","orderful_x12_codes":["HS"]},"hundredYards":{"description":"Hundred yards measure","orderful_x12_codes":["HY"]},"inch":{"description":"Inch length measure","orderful_x12_codes":["IN"]},"linearFoot":{"description":"Linear foot measure","orderful_x12_codes":["LF"]},"linearMeter":{"description":"Linear meter measure","orderful_x12_codes":["LM"]},"linearYard":{"description":"Linear yard measure","orderful_x12_codes":["LY"]},"millimeter":{"description":"Millimeter length measure","orderful_x12_codes":["MM"]},"meter":{"description":"Meter length measure","orderful_x12_codes":["MR"]},"squareFoot":{"description":"Square foot area measure","orderful_x12_codes":["SF"]},"squareInches":{"description":"Square inches area measure","orderful_x12_codes":["SI"]},"squareMeter":{"description":"Square meter area measure","orderful_x12_codes":["SM"]},"squareYard":{"description":"Square yard area measure","orderful_x12_codes":["SY"]},"thousandSquareInches":{"description":"Thousand square inches area measure","orderful_x12_codes":["TI"]},"thousandFeetLinear":{"description":"Thousand linear feet measure","orderful_x12_codes":["TL"]},"thousandFeetBoard":{"description":"Thousand board feet measure","orderful_x12_codes":["TM"]},"tenSquareFeet":{"description":"Ten square feet area measure","orderful_x12_codes":["TR"]},"thousandSquareFeet":{"description":"Thousand square feet area measure","orderful_x12_codes":["TS"]},"yard":{"description":"Yard length measure","orderful_x12_codes":["YD"]}}}},"additionalProperties":false},"itemStatus":{"description":"Current status of the item in inventory","orderful_x12_path":["846:LIN_loop.*.itemIdentification.*.productServiceID | productServiceIDQualifier=DP"],"orderful_x12_codes":["DP"],"type":"string","enum":["inStock","outOfStock","discontinued","hidden"]},"discontinueDate":{"description":"Date after which the product is discontinued or expires","orderful_x12_path":["846:LIN_loop.*.dateTimeReference.* | dateTimeQualifier=036"],"orderful_x12_codes":["036"],"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"}]},"unlimitedAvailability":{"description":"Indicates supplier guarantees fulfillment regardless of stock levels","orderful_x12_path":["846:LIN_loop.*.QTY_loop.*.quantityInformation.* | quantityQualifier=TH"],"orderful_x12_codes":["TH"],"type":"boolean"},"unitOfMeasure":{"description":"Unit of measure for inventory quantities","orderful_x12_path":["846:LIN_loop.*.unitDetail","846:LIN_loop.*.QTY_loop.*.unitDetail"],"type":"string","enum":["assembly","assortment","bag","bale","ball","bar","barrel","belt","bin","block","boardFeet","bolt","book","bottle","box","bulk","bundle","bushel","cake","can","card","carton","cartridge","case","cassette","celsius","cell","centigram","centiliter","centimeter","coil","combo","cone","container","count","cover","display","dozen","drum","each","flakeTon","foot","gallon","gram","gramsPerLiter","inch","kilogram","kit","knots","linearFoot","liter","meter","milliliter","monetaryValue","ocularInsertSystem","order","ounce","packPAK","package","pad","pail","pair","pairInches","palletLift","palletUnitLoad","person","piece","pint","pound","poundEquivalent","poundGross","quart","reel","roll","section","set","sheet","sixPack","squareFoot","syringe","thousand","threePack","tote","tube","unit","vial"],"orderful_enum_meta":{"assembly":{"description":"Assembly — set of manufactured components combined into a functional unit","orderful_x12_codes":["AY"]},"assortment":{"description":"Assortment — mixed selection of multiple SKUs or item types in one unit","orderful_x12_codes":["AS"]},"bag":{"description":"Bag — flexible container; used for produce, grains, or loose items","orderful_x12_codes":["BG"]},"bale":{"description":"Bale — compressed bundle; used for textiles, paper, or agricultural products","orderful_x12_codes":["BA"]},"ball":{"description":"Ball — spherical wound unit; used for yarn, twine, or wire","orderful_x12_codes":["AA"]},"bar":{"description":"Bar — rigid elongated unit; used for metal stock, soap, or food products","orderful_x12_codes":["BI"]},"barrel":{"description":"Barrel — cylindrical container; standard 42-gallon oil barrel or general dry goods","orderful_x12_codes":["BR"]},"belt":{"description":"Belt — long continuous flat strip sold by unit; used for conveyor or drive belts","orderful_x12_codes":["BT"]},"bin":{"description":"Bin — open-top storage container for bulk loose items","orderful_x12_codes":["2W"]},"block":{"description":"Block — solid rectangular unit; used for cheese, ice, or masonry materials","orderful_x12_codes":["BL"]},"boardFeet":{"description":"Board feet — lumber volume unit; 1 ft × 1 ft × 1 in thick","orderful_x12_codes":["BF"]},"bolt":{"description":"Bolt — roll of fabric measured in linear yards","orderful_x12_codes":["BM"]},"book":{"description":"Book — bound or tabbed unit; used for matches, stamps, or checks","orderful_x12_codes":["BK"]},"bottle":{"description":"Bottle — rigid container with a narrow neck; used for liquids","orderful_x12_codes":["BO"]},"box":{"description":"Box — rigid rectangular container; standard retail or shipping unit","orderful_x12_codes":["BX"]},"bulk":{"description":"Bulk — unpackaged loose quantity; no individual container or wrapping","orderful_x12_codes":["BN"]},"bundle":{"description":"Bundle — group of items tied or strapped together; used for rebar, pipes, lumber","orderful_x12_codes":["BD"]},"bushel":{"description":"Bushel — dry volume; 64 US pints; used for grain and produce","orderful_x12_codes":["BU"]},"cake":{"description":"Cake — compressed solid block; used for yeast, soap, or wax","orderful_x12_codes":["KA"]},"can":{"description":"Can — metal sealed cylindrical container","orderful_x12_codes":["CN"]},"card":{"description":"Card — flat backing card; used for hanging retail blister packs","orderful_x12_codes":["CG"]},"carton":{"description":"Carton — paperboard box; typical inner or outer shipping container","orderful_x12_codes":["CT"]},"cartridge":{"description":"Cartridge — self-contained replaceable unit; used for ink, filters, or ammunition","orderful_x12_codes":["CQ"]},"case":{"description":"Case — outer shipping container holding multiple inner units; most common shipper UOM","orderful_x12_codes":["CA"]},"cassette":{"description":"Cassette — enclosed tape or cartridge format; used for media, ribbon, or film","orderful_x12_codes":["CS"]},"celsius":{"description":"Celsius — temperature unit; used when a quantity represents a temperature value","orderful_x12_codes":["CE"]},"cell":{"description":"Cell — individual battery cell or biological sample unit","orderful_x12_codes":["C6"]},"centigram":{"description":"Centigram — 0.01 gram; unit of mass for small precise quantities","orderful_x12_codes":["AF"]},"centiliter":{"description":"Centiliter — 0.01 liter; unit of liquid volume for small quantities","orderful_x12_codes":["C3"]},"centimeter":{"description":"Centimeter — 0.01 meter; unit of length","orderful_x12_codes":["CM"]},"coil":{"description":"Coil — wound continuous material; used for wire, steel strip, hose, or tubing","orderful_x12_codes":["CX"]},"combo":{"description":"Combo — bundled multi-component set sold as a single unit","orderful_x12_codes":["CZ"]},"cone":{"description":"Cone — conical spindle or spool; used for thread or yarn","orderful_x12_codes":["CJ"]},"container":{"description":"Container — generic shipping container; use when no more specific form applies","orderful_x12_codes":["CH"]},"count":{"description":"Count — generic numerical count of individual items; prefer each (EA) when count equals 1","orderful_x12_codes":["1N"]},"cover":{"description":"Cover — individual lid or covering unit","orderful_x12_codes":["CV"]},"display":{"description":"Display — shelf-ready PDQ or floor display holding multiple retail units","orderful_x12_codes":["DS"]},"dozen":{"description":"Dozen — 12 units; standard quantity for eggs, bottles, and similar items","orderful_x12_codes":["DZ"]},"drum":{"description":"Drum — large cylindrical container; typically 55 gallons; used for chemicals and liquids","orderful_x12_codes":["DR"]},"each":{"description":"Each — single individual unit; default UOM when no other code applies","orderful_x12_codes":["EA"]},"flakeTon":{"description":"Flake ton — ton measured in flake form; used for flaked or pelletized bulk material","orderful_x12_codes":["FL"]},"foot":{"description":"Foot — imperial length; 12 inches; used for lumber, pipe, and fabric","orderful_x12_codes":["FT"]},"gallon":{"description":"Gallon — US liquid volume; 128 fluid ounces; used for paint, chemicals, and beverages","orderful_x12_codes":["GA"]},"gram":{"description":"Gram — metric unit of mass; used for small weight quantities in food and pharma","orderful_x12_codes":["GR"]},"gramsPerLiter":{"description":"Grams per liter — solution concentration unit; used in chemical and food industries","orderful_x12_codes":["GL"]},"inch":{"description":"Inch — imperial length; 1/12 foot; used for dimensions and hardware","orderful_x12_codes":["IN"]},"kilogram":{"description":"Kilogram — 1,000 grams; standard metric weight UOM in international trade","orderful_x12_codes":["KG"]},"kit":{"description":"Kit — predefined set of parts packaged together for assembly or installation","orderful_x12_codes":["KT"]},"knots":{"description":"Knots — nautical speed (nm/hr); used in marine shipping contexts","orderful_x12_codes":["EH"]},"linearFoot":{"description":"Linear foot — length in feet regardless of width; used for trim, cable, and fabric","orderful_x12_codes":["LF"]},"liter":{"description":"Liter — metric liquid volume; ~1.057 US quarts; standard international liquid UOM","orderful_x12_codes":["LT"]},"meter":{"description":"Meter — base metric unit of length; ~39.37 inches","orderful_x12_codes":["MR"]},"milliliter":{"description":"Milliliter — 0.001 liter; used for small liquid quantities in pharma and beverages","orderful_x12_codes":["ML"]},"monetaryValue":{"description":"Monetary value — quantity expressed as a currency amount","orderful_x12_codes":["M4"]},"ocularInsertSystem":{"description":"Ocular insert system — pharmaceutical ophthalmic delivery unit placed in the eye","orderful_x12_codes":["AU"]},"order":{"description":"Order — entire purchase order treated as a single billable unit","orderful_x12_codes":["ET"]},"ounce":{"description":"Ounce — imperial weight; 1/16 pound; common in US food and retail","orderful_x12_codes":["OZ"]},"packPAK":{"description":"Pack (PAK) — sealed multi-unit retail pack; use instead of package (PK) when the pack form is specifically a PAK","orderful_x12_codes":["PH"]},"package":{"description":"Package — general-purpose shipping or retail package; use when the pack type is unspecified","orderful_x12_codes":["PK"]},"pad":{"description":"Pad — flat stacked unit; used for paper notepads or sticker sheets","orderful_x12_codes":["PD"]},"pail":{"description":"Pail — small open-top bucket, typically 1–5 gallons; used for paint and adhesives","orderful_x12_codes":["PA"]},"pair":{"description":"Pair — two matching items sold together (shoes, gloves, socks)","orderful_x12_codes":["PR"]},"pairInches":{"description":"Pair inches — pipe fitting measurement; a pair measured in inches","orderful_x12_codes":["PB"]},"palletLift":{"description":"Pallet lift (PF) — individual pallet; use when counting or billing by pallet. Distinct from palletUnitLoad (PL) which is the complete loaded pallet","orderful_x12_codes":["PF"]},"palletUnitLoad":{"description":"Pallet unit load (PL) — complete loaded pallet as shipped, including goods and pallet. Distinct from palletLift (PF) which counts the pallet itself","orderful_x12_codes":["PL"]},"person":{"description":"Person — individual person; used for labor, staffing, or capacity billing","orderful_x12_codes":["IE"]},"piece":{"description":"Piece — individual item not in a standard retail package; used for industrial and bulk parts","orderful_x12_codes":["PC"]},"pint":{"description":"Pint — liquid volume; 16 US fluid ounces","orderful_x12_codes":["PT"]},"pound":{"description":"Pound — imperial weight; most common weight UOM in US grocery and distribution","orderful_x12_codes":["LB","01","PN"]},"poundEquivalent":{"description":"Pound equivalent — standardized weight comparison unit; used in apparel and textile industries","orderful_x12_codes":["PE"]},"poundGross":{"description":"Pound gross — total weight including all packaging and the container itself","orderful_x12_codes":["PG"]},"quart":{"description":"Quart — US liquid volume unit; 0.946 liters; used for paint, motor oil, and liquids sold in quart containers","orderful_x12_codes":["QT"]},"reel":{"description":"Reel — cylindrical spool unit; used for wire, cable, film, or tape wound on a hub","orderful_x12_codes":["RE"]},"roll":{"description":"Roll — cylindrical wrapped unit; used for paper, fabric, or flexible material rolled without a rigid hub. Distinct from reel (RE) which has a hub","orderful_x12_codes":["RL"]},"section":{"description":"Section — subdivision of a larger structure sold as a distinct piece; used in furniture, shelving, or land measurement","orderful_x12_codes":["SE"]},"set":{"description":"Set — defined collection of matched or functionally related items sold together; use when items are inseparable as a set","orderful_x12_codes":["ST"]},"sheet":{"description":"Sheet — single flat panel unit; used for glass, metal, plywood, drywall, or paper sold in flat cut pieces","orderful_x12_codes":["SH"]},"sixPack":{"description":"Six-pack (6P) — fixed retail grouping of exactly 6 units; use for beverages or consumer goods sold as a pre-packaged six. Distinct from threePack (P3)","orderful_x12_codes":["P6"]},"squareFoot":{"description":"Square foot — area unit; 144 square inches; used for flooring, roofing, fabric, and surface-area pricing","orderful_x12_codes":["SF"]},"syringe":{"description":"Syringe — pre-filled or unit-dose injectable pharmaceutical unit","orderful_x12_codes":["SZ"]},"thousand":{"description":"Thousand (M) — quantity multiplier; used when pricing or ordering in increments of 1,000 (e.g., fasteners, bricks, sheets). Distinct from each (EA)","orderful_x12_codes":["TH"]},"threePack":{"description":"Three-pack (P3) — fixed retail grouping of exactly 3 units; use for consumer goods sold as a pre-packaged triple. Distinct from sixPack (6P)","orderful_x12_codes":["P3"]},"tote":{"description":"Tote — large reusable open-top container or bin; used in warehouse and bulk distribution settings","orderful_x12_codes":["TE"]},"tube":{"description":"Tube — cylindrical dispensing container; used for adhesives, ointments, toothpaste, or caulk sold in squeezable tubes","orderful_x12_codes":["TB"]},"unit":{"description":"Unit (UN) — generic count when no specific UOM code applies; use as a last resort when the item type does not match any other code","orderful_x12_codes":["UN"]},"vial":{"description":"Vial — small sealed glass or plastic container; used for injectable drugs, reagents, or laboratory specimens","orderful_x12_codes":["VI"]}}},"inventoryQuantities":{"type":"array","items":{"type":"object","properties":{"locationId":{"type":"string","description":"Location identifier for the warehouse, store, or distribution center","orderful_x12_path":["846:LIN_loop.*.destinationQuantity.*.identificationCode"]},"type":{"type":"string","enum":["available","unavailable","incoming","allocated","maxOrderQuantity"],"description":"Type of inventory quantity being reported","orderful_x12_path":["846:LIN_loop.*.QTY_loop.*.quantityInformation.*.quantityQualifier"],"orderful_x12_codes":["33","17","61","AT","V2","20","74","QH","15","37","78","29","63","IQ","27","70"]},"quantity":{"type":"string","description":"Inventory quantity value","orderful_x12_path":["846:LIN_loop.*.QTY_loop.*.quantityInformation.*.quantity","846:LIN_loop.*.destinationQuantity.*.quantity"]},"availableDate":{"description":"Date when this quantity is or will be available","orderful_x12_path":["846:LIN_loop.*.dateTimeReference.* | dateTimeQualifier=169,018"],"orderful_x12_codes":["169","018"],"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"}]}},"required":["locationId","type","quantity"],"additionalProperties":false},"description":"Inventory quantities by location and type","orderful_x12_path":["846:LIN_loop.*.QTY_loop.*.quantityInformation","846:LIN_loop.*.destinationQuantity"]},"unitCostPrice":{"description":"Default wholesale unit cost price for the item","orderful_x12_path":["846:LIN_loop.*.pricingInformation.*.unitPrice | priceIdentifierCode=CUP"],"orderful_x12_codes":["CUP"],"type":"string"},"additionalPricing":{"description":"Additional pricing information such as retail, list cost, or promotional pricing","orderful_x12_path":["846:LIN_loop.*.pricingInformation"],"type":"array","items":{"type":"object","properties":{"priceType":{"type":"string","enum":["discountAllowed","highValuePrice","listCost","retail","promotional","purchase"],"description":"Type of price","orderful_enum_meta":{"discountAllowed":{"description":"Discount allowed from list price","orderful_x12_codes":["DSC"]},"highValuePrice":{"description":"High value price","orderful_x12_codes":["GB"]},"listCost":{"description":"List cost price","orderful_x12_codes":["LPR","SLP"]},"retail":{"description":"Retail price","orderful_x12_codes":["RTL","RES"]},"promotional":{"description":"Promotional price","orderful_x12_codes":["PRP"]},"purchase":{"description":"Purchase price","orderful_x12_codes":["PUR"]}}},"unitPrice":{"description":"Unit price value","type":"string"},"unitPriceBasis":{"description":"Basis for the unit price","type":"string","enum":["advise","beforeDiscount","discount","net","noCharge","perHundred","perThousand","perDozen","perEach","perFoot","perGram","perKilogram","perTen","perOunce","perPound","perTenThousand","perUOM","promotion","standard","suggestedRetail","wholesale","wholesalePerEach"],"orderful_enum_meta":{"advise":{"description":"Price to be advised","orderful_x12_codes":["AP"]},"beforeDiscount":{"description":"Price before discount","orderful_x12_codes":["BD"]},"discount":{"description":"Discount price","orderful_x12_codes":["DS"]},"net":{"description":"Net price","orderful_x12_codes":["NT"]},"noCharge":{"description":"No charge","orderful_x12_codes":["NC"]},"perHundred":{"description":"Price per hundred units","orderful_x12_codes":["HP"]},"perThousand":{"description":"Price per thousand units","orderful_x12_codes":["HT"]},"perDozen":{"description":"Price per dozen (12 units)","orderful_x12_codes":["WD"]},"perEach":{"description":"Price per each unit","orderful_x12_codes":["LE","TE","PE","QE"]},"perFoot":{"description":"Price per foot","orderful_x12_codes":["PF"]},"perGram":{"description":"Price per gram","orderful_x12_codes":["PG"]},"perKilogram":{"description":"Price per kilogram","orderful_x12_codes":["PK"]},"perTen":{"description":"Price per ten units","orderful_x12_codes":["PN"]},"perOunce":{"description":"Price per ounce","orderful_x12_codes":["PO"]},"perPound":{"description":"Price per pound","orderful_x12_codes":["PP"]},"perTenThousand":{"description":"Price per ten thousand units","orderful_x12_codes":["TT"]},"perUOM":{"description":"Price per specified unit of measure","orderful_x12_codes":["UM","ST","AB"]},"promotion":{"description":"Promotional price","orderful_x12_codes":["PR"]},"standard":{"description":"Standard list price","orderful_x12_codes":["ST","QT","CT","CA","FX","DI","CP","AB"]},"suggestedRetail":{"description":"Suggested retail price (MSRP)","orderful_x12_codes":["SR"]},"wholesale":{"description":"Wholesale price","orderful_x12_codes":["WH","SW"]},"wholesalePerEach":{"description":"Wholesale price per each unit","orderful_x12_codes":["WE"]}}},"quantityPerUnitPrice":{"description":"Quantity per unit price","type":"string"}},"additionalProperties":false}},"references":{"description":"Reference numbers for this line item","orderful_x12_path":["846:LIN_loop.*.referenceInformation.* | referenceIdentificationQualifier!=L1"],"type":"object","properties":{"productType":{"description":"Product type classification for the trading partner","orderful_x12_path":["846:LIN_loop.*.referenceInformation.* | referenceIdentificationQualifier=PRT"],"orderful_x12_codes":["PRT"],"type":"object","properties":{"value":{"description":"The reference identifier value","type":"string"},"description":{"description":"Additional description or context for the reference","type":"string"}},"additionalProperties":false}},"additionalProperties":false},"notes":{"description":"Notes and comments for the line item","orderful_x12_path":["846:LIN_loop.*.referenceInformation.* | referenceIdentificationQualifier=L1"],"orderful_x12_codes":["L1"],"type":"object","properties":{"general":{"description":"General notes or comments about the item","orderful_x12_path":["846:LIN_loop.*.referenceInformation.* | referenceIdentificationQualifier=L1"],"orderful_x12_codes":["L1"],"type":"object","properties":{"description":{"description":"Brief description or title of the note","type":"string"},"text":{"description":"Array of text lines for the note content","type":"array","items":{"type":"string"}}},"additionalProperties":false}},"additionalProperties":false}},"required":["productIds","inventoryQuantities"],"additionalProperties":false},"description":"Inventory line items being reported","orderful_x12_path":["846:LIN_loop"]}},"required":["purpose","reportType","reportNumber","reportDate","lineItems"],"additionalProperties":false}