Canonical, legacy, and UI glossary
Translate canonical API values to legacy spellings and current merchant-admin labels.
API v3 uses lowercase snake_case values. Earlier API responses, internal records, and parts of the merchant admin use older uppercase spellings or human labels. Use this table only at a migration boundary; new integrations should store and send the canonical value.
The canonical and legacy columns are machine values. The UI label is display text and may be translated or clarified independently, so never parse it back into a machine value.
Two similar names need special care:
legacy_fixed_heightis a read-only v3 description of the retiredFIXED_HEIGHTpricing model. It is not accepted on writes.fixed_heightis a supported sizing strategy for asimple_lettercustomiser. Its legacy spellings areHEIGHTandFIXED.
Finish kind
Field: finish_kind
| Canonical API value | Legacy spelling | Current UI label | Notes |
|---|---|---|---|
colour | COLOUR | Colour | |
texture | TEXTURE | Texture |
Height measurement mode
Field: height_measurement_mode
| Canonical API value | Legacy spelling | Current UI label | Notes |
|---|---|---|---|
line_height | LINE_HEIGHT | Line height | |
letter_height | LETTER_HEIGHT | Letter height |
Pricing model
Field: pricing_model
| Canonical API value | Legacy spelling | Current UI label | Notes |
|---|---|---|---|
simple_letter | FIXED_WIDTH | Simple Letter | |
advanced_letter | MATERIAL_LENGTH | Advanced Letter | |
frame_fit | FRAME_FIT | Frame Fit | |
legacy_fixed_height | FIXED_HEIGHT | Fixed Height (legacy) | Read-only legacy value. Read-only migration metadata. It is not accepted on writes. |
Product family
Field: product_family
| Canonical API value | Legacy spelling | Current UI label | Notes |
|---|---|---|---|
neon | NEON | Neon | |
channel_letter | CHANNEL | Channel Letter | |
metal_cut_out | CUTOUT_METAL | Metal Cut-Out |
Selection mode
Field: selection_mode
| Canonical API value | Legacy spelling | Current UI label | Notes |
|---|---|---|---|
single_style | SINGLE | Single | |
per_word | MULTI | Multiple |
Sign category
Field: sign_category
| Canonical API value | Legacy spelling | Current UI label | Notes |
|---|---|---|---|
neon | NEON | Neon | |
acrylic_channel_letter | ACRYLIC | Channel Letter | |
metal_channel_letter | METAL | Metal Channel Letter | |
metal_cut_out | CUTOUT_METAL | Metal Cut-Out | |
stencil | STENCIL | Stencil | |
lightbox | LIGHTBOX | Lightbox | |
wood_letter | WOOD | Wood Letter | |
aluminium_plate | ALUMINIUM | Aluminium Plate | |
braille_sign | BRAILLE | Braille Sign | |
wood_frame | WOOD_FRAME | Wood Frame |
Sizing strategy
Field: sizing_strategy
| Canonical API value | Legacy spelling | Current UI label | Notes |
|---|---|---|---|
fixed_width | WIDTH, DYNAMIC | Fixed Width - Height scales dynamically | |
fixed_height | HEIGHT, FIXED | Fixed Height - Width scales dynamically | Supported sizing strategy; this is not the retired FIXED_HEIGHT pricing model. |