Skip to content

Designed
Get template structure (chapters, sections, flags)

Request

Design-time discovery of the retailer template: which chapters exist, which sections each carries, which sections the retailer disabled (absent from reads, rejected on writes), which payload property carries each section, and where custom fields sit. Field-level rules (types, mandatory fields) come from the custom-fields schema and the chapter write schemas. Fetched once per template at integration time — not per call.

Security
oauth2(Required scopes: t1_api)
Path
templateIdstring, (uuid)required

The template identifier (communicated at onboarding)

Query
languageCodestring

Language of chapter and section names. Defaults to English; a name missing in the requested language falls back to English (en-US).

curl -i -X GET \
  'https://apis.traceone.com/spec/v2/templates/{templateId}/structure?languageCode=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Returns the template structure

Bodyapplication/json
templateIdstring, (uuid)read-only
namestring or null
templateTypestring
Enum:"Food""PetFood""Packaging""FruitsAndVegetable""Formula""BabyFood""FoodSupplement"
chaptersArray of objects(TemplateStructureChapter)
Response
{
  "templateId": "196100ac-4eec-4fb6-a7f7-86c8b584771d",
  "name": "string",
  "templateType": "Food",
  "chapters": [
    { … }
  ]
}