{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-@l10n/fr/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Reference Data Guide","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"reference-data-guide","__idx":0},"children":["Reference Data Guide"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This guide explains how to use the Reference Data API to access standardized master data in the Trace One platform."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"-what-is-the-reference-data-api","__idx":1},"children":["❓ What is the Reference Data API?"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The Reference Data API provides access to master data used across Trace One applications, ensuring consistency in data such as allergens, nutrients, countries, packaging types, and more."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"-reference-lists-vs-functional-lists","__idx":2},"children":["🧭 Reference Lists vs. Functional Lists"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Trace One organizes reference data into two broad types: ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Reference Lists"]}," and ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Functional Lists"]},". Understanding the difference is key when integrating against the API."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"-reference-lists-generic-lists","__idx":3},"children":["🔹 Reference Lists (Generic Lists)"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Reference Lists are ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["generic, reusable sets of values"]}," that are often:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Configurable by retailer or customer"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Tied to specific specification templates"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Used for UI dropdowns, filters, and form fields"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["These lists are retrieved via the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/lists/{listName}"]}," endpoints."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Retailers may customize these lists"]}," to reflect their business rules, terminology, or data model."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"-functional-lists-domain-specific-lists","__idx":4},"children":["🔹 Functional Lists (Domain-Specific Lists)"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Functional Lists represent ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["business-critical master data"]}," with standardized semantics defined by Trace One. These are tightly coupled with the PLM domain and often relate to product formulation, labeling, compliance, or regulatory processes."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Examples include:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Nutrients (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/nutrients"]},")"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Allergen definitions (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/allergens"]},")"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Harmonized trade codes (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/harmonized-codes"]},")"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Markets and fishing zones"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["These lists are not typically configurable by the customer and reflect ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Trace One's domain model"]},"."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"-what-types-of-reference-data-are-available","__idx":5},"children":["🔹 What types of reference data are available?"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The API includes access to:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Reference Lists"]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"e.g., ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["preservation-method"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["storage-condition-temperature"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["trade-item-status"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["languages"]},", etc."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Allergens"]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"List of known allergens and their classifications."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Countries & Country Divisions"]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"ISO country data and regional breakdowns."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Fishing Zones"]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Official geographic zones for seafood sourcing."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Harmonized Codes"]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"HS codes used in trade and compliance."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Markets"]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Trace One-defined market definitions."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Nutrients & Nutrient Families"]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Structured nutrient definitions and their groupings."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Raw Materials"]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Classification items and parts used in formulations."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Substances & Substance Functions"]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Chemical or additive data used in product specifications."]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"-how-do-i-get-all-items-from-a-reference-list","__idx":6},"children":["🔹 How do I get all items from a reference list?"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use this endpoint to retrieve all items in a specific list:"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["\\",{"$$mdtype":"Tag","name":"code","attributes":{},"children":[" GET /api/v2/lists/{listName} \\\\"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example:"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["\\",{"$$mdtype":"Tag","name":"code","attributes":{},"children":[" GET /api/v2/lists/preservation-method?languageCode=en-US \\\\"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Optional query parameters:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["languageCode"]}," – ISO language code (e.g., ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["en-US"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fr-FR"]},")"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["companyId"]}," – If applicable, for company-specific values"]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"-how-do-i-get-a-specific-item-by-id","__idx":7},"children":["🔹 How do I get a specific item by ID?"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use this endpoint:"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["\\",{"$$mdtype":"Tag","name":"code","attributes":{},"children":[" GET /api/v2/lists/{listName}/{itemId} \\\\"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example:"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["\\",{"$$mdtype":"Tag","name":"code","attributes":{},"children":[" GET /api/v2/lists/languages/123e4567-e89b-12d3-a456-426614174000 \\\\"]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"-do-i-need-authentication","__idx":8},"children":["🔹 Do I need authentication?"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Yes, all Reference Data endpoints require a Bearer token. Include the token in your request headers:"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["\\",{"$$mdtype":"Tag","name":"code","attributes":{},"children":[" Authorization: Bearer your-access-token \\\\"]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"-what-response-should-i-expect-if-the-item-doesnt-exist","__idx":9},"children":["🔹 What response should I expect if the item doesn't exist?"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You will receive a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["404 Not Found"]}," response if:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["itemId"]}," does not exist in the list"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The item lacks a translation in the requested language"]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"-can-i-get-results-in-other-languages","__idx":10},"children":["🔹 Can I get results in other languages?"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Yes. Use the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["languageCode"]}," query parameter to get translated values."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example:"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["\\",{"$$mdtype":"Tag","name":"code","attributes":{},"children":[" GET /api/v2/lists/trade-item-status?languageCode=fr-FR \\\\"]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For more details, refer to the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/apis/"},"children":["API Reference"]}," or contact ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"mailto:devsupport@traceone.com"},"children":["devsupport@traceone.com"]},"."]}]},"headings":[{"value":"Reference Data Guide","id":"reference-data-guide","depth":1},{"value":"❓ What is the Reference Data API?","id":"-what-is-the-reference-data-api","depth":2},{"value":"🧭 Reference Lists vs. Functional Lists","id":"-reference-lists-vs-functional-lists","depth":2},{"value":"🔹 Reference Lists (Generic Lists)","id":"-reference-lists-generic-lists","depth":3},{"value":"🔹 Functional Lists (Domain-Specific Lists)","id":"-functional-lists-domain-specific-lists","depth":3},{"value":"🔹 What types of reference data are available?","id":"-what-types-of-reference-data-are-available","depth":2},{"value":"🔹 How do I get all items from a reference list?","id":"-how-do-i-get-all-items-from-a-reference-list","depth":2},{"value":"🔹 How do I get a specific item by ID?","id":"-how-do-i-get-a-specific-item-by-id","depth":2},{"value":"🔹 Do I need authentication?","id":"-do-i-need-authentication","depth":2},{"value":"🔹 What response should I expect if the item doesn't exist?","id":"-what-response-should-i-expect-if-the-item-doesnt-exist","depth":2},{"value":"🔹 Can I get results in other languages?","id":"-can-i-get-results-in-other-languages","depth":2}],"frontmatter":{"seo":{"title":"Reference Data Guide"}},"lastModified":"2026-06-19T11:16:46.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/fr/getting-started/using-reference-data","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}