Thanks.io · JSON-LD Context

Thanks Io Context

JSON-LD context defining the semantic vocabulary for Thanks Io from Thanks.io.

26 Classes 174 Properties 4 Namespaces
View Context View on GitHub

Namespaces

schema: https://schema.org/
xsd: http://www.w3.org/2001/XMLSchema#
dcterms: http://purl.org/dc/terms/
thanks: https://thanks.io/schema#

Classes

webhook-type webhook-data-flat webhook-order-status-update-payload scan-board-status order order-item giftcard-group giftcard-group-list mailing-list image-template creative message-template message-template-create message-template-update recipient-no-mailinglist recipient-create recipient-create-no-mailinglist sub-account sub-account-create links meta paginated estimate-response send-mailer-base send-mailer-order-response send-mailer-preview-response

Properties

Property Type Container
order_item.id integer
order_item.scans integer
order_item.failure string
recipient.name string
recipient.company string
recipient.address string
recipient.address2 string
recipient.absentee_address string
recipient.city string
recipient.province string
recipient.postal_code string
recipient.country string
recipient.email string
recipient.phone string
recipient.custom_1 string
recipient.custom_2 string
recipient.custom_3 string
recipient.custom_4 string
recipient.custom_5 string
recipient.custom_6 string
recipient.custom_7 string
recipient.custom_8 string
recipient.custom_9 string
recipient.custom_10 string
order.id integer
order.sub_account_id integer
order.status string
order_item.delivery_date string
order_item.previous_status string
order_item.current_status string
qrcode.url reference
order.metadata
order.previous_status string
order.current_status string
id integer
message string
size string
sub_account_id integer
type string
display_type string
style integer
front_image string
high_quality_preview string
authorization_total integer
grand_total integer
order_total integer
total_estimated_recipients integer
total_recipients integer
recipient_count integer
status string
method string
cancellable boolean
total_scans integer
metadata
created_at dateTime
updated_at dateTime
delivery_date date
scans integer
failure string
recipient
giftcard
preview
title string
brands list
user_id integer
description string
qrcode_url string
processed boolean
is_suppression_list boolean
unique_scans integer
last_scan string
total_sends integer
last_send string
api_key string
created_at_diff string
name string
image string
canva_id string
mailer_type string
postcard_size string
source string
hidden boolean
default boolean
preview_image_url string
thumbnail_url string
share_url string
is_complete boolean
needs list
image_template
message_template
back_background
handwriting_style_id integer
font_size integer
font_color string
handwriting_realism boolean
content string
additional_pages reference
skip_creative_generation integer
custom_background_url string
cc_emails list
giftcard_brand_code string
giftcard_brand_image string
giftcard_amount integer
landing_page_url reference
share_uuid string
pdf_only_url reference
company string
address string
address2 string
city string
province string
postal_code string
country string
dob string
anniversary string
email string
phone string
custom1 string
custom2 string
custom3 string
custom4 string
custom5 string
custom6 string
custom7 string
custom8 string
custom9 string
custom10 string
absentee_address string
mailing_list_id integer
absentee_city reference
absentee_province reference
absentee_postal_code reference
return_name string
return_address string
return_address2 string
return_city string
return_state string
return_postal_code string
first string
last string
prev string
next string
current_page integer
from integer
last_page integer
path string
per_page integer
to integer
total integer
first_page_url string
last_page_url string
next_page_url string
prev_page_url string
data
mailing_list_ids list
recipients list
radius_search
handwriting_color string
sub_account integer
notification_emails string
email_lookup boolean
postage_class string
leads_fee integer
mailing_list_ids_used string
image_template_id integer
message_template_id integer
append_or_current_resident boolean
return_province string
display_status string
display_trigger string
addons
giftcard_brand string
giftcard_image string
giftcard_brand_longname string

JSON-LD Document

Raw ↑
{
  "@context": {
    "@vocab": "https://thanks.io/schema#",
    "schema": "https://schema.org/",
    "xsd": "http://www.w3.org/2001/XMLSchema#",
    "dcterms": "http://purl.org/dc/terms/",
    "thanks": "https://thanks.io/schema#",
    "webhook-type": "thanks:webhook-type",
    "webhook-data-flat": "thanks:webhook-data-flat",
    "order_item.id": {
      "@id": "thanks:order_item.id",
      "@type": "xsd:integer"
    },
    "order_item.scans": {
      "@id": "thanks:order_item.scans",
      "@type": "xsd:integer"
    },
    "order_item.failure": {
      "@id": "thanks:order_item.failure",
      "@type": "xsd:string"
    },
    "recipient.name": {
      "@id": "thanks:recipient.name",
      "@type": "xsd:string"
    },
    "recipient.company": {
      "@id": "thanks:recipient.company",
      "@type": "xsd:string"
    },
    "recipient.address": {
      "@id": "thanks:recipient.address",
      "@type": "xsd:string"
    },
    "recipient.address2": {
      "@id": "thanks:recipient.address2",
      "@type": "xsd:string"
    },
    "recipient.absentee_address": {
      "@id": "thanks:recipient.absentee_address",
      "@type": "xsd:string"
    },
    "recipient.city": {
      "@id": "thanks:recipient.city",
      "@type": "xsd:string"
    },
    "recipient.province": {
      "@id": "thanks:recipient.province",
      "@type": "xsd:string"
    },
    "recipient.postal_code": {
      "@id": "thanks:recipient.postal_code",
      "@type": "xsd:string"
    },
    "recipient.country": {
      "@id": "thanks:recipient.country",
      "@type": "xsd:string"
    },
    "recipient.email": {
      "@id": "thanks:recipient.email",
      "@type": "xsd:string"
    },
    "recipient.phone": {
      "@id": "thanks:recipient.phone",
      "@type": "xsd:string"
    },
    "recipient.custom_1": {
      "@id": "thanks:recipient.custom_1",
      "@type": "xsd:string"
    },
    "recipient.custom_2": {
      "@id": "thanks:recipient.custom_2",
      "@type": "xsd:string"
    },
    "recipient.custom_3": {
      "@id": "thanks:recipient.custom_3",
      "@type": "xsd:string"
    },
    "recipient.custom_4": {
      "@id": "thanks:recipient.custom_4",
      "@type": "xsd:string"
    },
    "recipient.custom_5": {
      "@id": "thanks:recipient.custom_5",
      "@type": "xsd:string"
    },
    "recipient.custom_6": {
      "@id": "thanks:recipient.custom_6",
      "@type": "xsd:string"
    },
    "recipient.custom_7": {
      "@id": "thanks:recipient.custom_7",
      "@type": "xsd:string"
    },
    "recipient.custom_8": {
      "@id": "thanks:recipient.custom_8",
      "@type": "xsd:string"
    },
    "recipient.custom_9": {
      "@id": "thanks:recipient.custom_9",
      "@type": "xsd:string"
    },
    "recipient.custom_10": {
      "@id": "thanks:recipient.custom_10",
      "@type": "xsd:string"
    },
    "order.id": {
      "@id": "thanks:order.id",
      "@type": "xsd:integer"
    },
    "order.sub_account_id": {
      "@id": "thanks:order.sub_account_id",
      "@type": "xsd:integer"
    },
    "order.status": {
      "@id": "thanks:order.status",
      "@type": "xsd:string"
    },
    "order_item.delivery_date": {
      "@id": "thanks:order_item.delivery_date",
      "@type": "xsd:string"
    },
    "order_item.previous_status": {
      "@id": "thanks:order_item.previous_status",
      "@type": "xsd:string"
    },
    "order_item.current_status": {
      "@id": "thanks:order_item.current_status",
      "@type": "xsd:string"
    },
    "qrcode.url": {
      "@id": "thanks:qrcode.url",
      "@type": "@id"
    },
    "order.metadata": {
      "@id": "thanks:order.metadata"
    },
    "webhook-order-status-update-payload": "thanks:webhook-order-status-update-payload",
    "order.previous_status": {
      "@id": "thanks:order.previous_status",
      "@type": "xsd:string"
    },
    "order.current_status": {
      "@id": "thanks:order.current_status",
      "@type": "xsd:string"
    },
    "scan-board-status": "thanks:scan-board-status",
    "order": "thanks:order",
    "id": {
      "@id": "thanks:id",
      "@type": "xsd:integer"
    },
    "message": {
      "@id": "thanks:message",
      "@type": "xsd:string"
    },
    "size": {
      "@id": "thanks:size",
      "@type": "xsd:string"
    },
    "sub_account_id": {
      "@id": "thanks:sub_account_id",
      "@type": "xsd:integer"
    },
    "type": {
      "@id": "thanks:type",
      "@type": "xsd:string"
    },
    "display_type": {
      "@id": "thanks:display_type",
      "@type": "xsd:string"
    },
    "style": {
      "@id": "thanks:style",
      "@type": "xsd:integer"
    },
    "front_image": {
      "@id": "thanks:front_image",
      "@type": "xsd:string"
    },
    "high_quality_preview": {
      "@id": "thanks:high_quality_preview",
      "@type": "xsd:string"
    },
    "authorization_total": {
      "@id": "thanks:authorization_total",
      "@type": "xsd:integer"
    },
    "grand_total": {
      "@id": "thanks:grand_total",
      "@type": "xsd:integer"
    },
    "order_total": {
      "@id": "thanks:order_total",
      "@type": "xsd:integer"
    },
    "total_estimated_recipients": {
      "@id": "thanks:total_estimated_recipients",
      "@type": "xsd:integer"
    },
    "total_recipients": {
      "@id": "thanks:total_recipients",
      "@type": "xsd:integer"
    },
    "recipient_count": {
      "@id": "thanks:recipient_count",
      "@type": "xsd:integer"
    },
    "status": {
      "@id": "thanks:status",
      "@type": "xsd:string"
    },
    "method": {
      "@id": "thanks:method",
      "@type": "xsd:string"
    },
    "cancellable": {
      "@id": "thanks:cancellable",
      "@type": "xsd:boolean"
    },
    "total_scans": {
      "@id": "thanks:total_scans",
      "@type": "xsd:integer"
    },
    "metadata": {
      "@id": "thanks:metadata"
    },
    "created_at": {
      "@id": "thanks:created_at",
      "@type": "xsd:dateTime"
    },
    "updated_at": {
      "@id": "thanks:updated_at",
      "@type": "xsd:dateTime"
    },
    "order-item": "thanks:order-item",
    "delivery_date": {
      "@id": "thanks:delivery_date",
      "@type": "xsd:date"
    },
    "scans": {
      "@id": "thanks:scans",
      "@type": "xsd:integer"
    },
    "failure": {
      "@id": "thanks:failure",
      "@type": "xsd:string"
    },
    "recipient": {
      "@id": "thanks:recipient"
    },
    "giftcard": {
      "@id": "thanks:giftcard"
    },
    "preview": {
      "@id": "thanks:preview"
    },
    "giftcard-group": "thanks:giftcard-group",
    "title": {
      "@id": "thanks:title",
      "@type": "xsd:string"
    },
    "brands": {
      "@id": "thanks:brands",
      "@container": "@list"
    },
    "giftcard-group-list": "thanks:giftcard-group-list",
    "mailing-list": "thanks:mailing-list",
    "user_id": {
      "@id": "thanks:user_id",
      "@type": "xsd:integer"
    },
    "description": {
      "@id": "thanks:description",
      "@type": "xsd:string"
    },
    "qrcode_url": {
      "@id": "thanks:qrcode_url",
      "@type": "xsd:string"
    },
    "processed": {
      "@id": "thanks:processed",
      "@type": "xsd:boolean"
    },
    "is_suppression_list": {
      "@id": "thanks:is_suppression_list",
      "@type": "xsd:boolean"
    },
    "unique_scans": {
      "@id": "thanks:unique_scans",
      "@type": "xsd:integer"
    },
    "last_scan": {
      "@id": "thanks:last_scan",
      "@type": "xsd:string"
    },
    "total_sends": {
      "@id": "thanks:total_sends",
      "@type": "xsd:integer"
    },
    "last_send": {
      "@id": "thanks:last_send",
      "@type": "xsd:string"
    },
    "api_key": {
      "@id": "thanks:api_key",
      "@type": "xsd:string"
    },
    "created_at_diff": {
      "@id": "thanks:created_at_diff",
      "@type": "xsd:string"
    },
    "image-template": "thanks:image-template",
    "name": {
      "@id": "thanks:name",
      "@type": "xsd:string"
    },
    "image": {
      "@id": "thanks:image",
      "@type": "xsd:string"
    },
    "canva_id": {
      "@id": "thanks:canva_id",
      "@type": "xsd:string"
    },
    "creative": "thanks:creative",
    "mailer_type": {
      "@id": "thanks:mailer_type",
      "@type": "xsd:string"
    },
    "postcard_size": {
      "@id": "thanks:postcard_size",
      "@type": "xsd:string"
    },
    "source": {
      "@id": "thanks:source",
      "@type": "xsd:string"
    },
    "hidden": {
      "@id": "thanks:hidden",
      "@type": "xsd:boolean"
    },
    "default": {
      "@id": "thanks:default",
      "@type": "xsd:boolean"
    },
    "preview_image_url": {
      "@id": "thanks:preview_image_url",
      "@type": "xsd:string"
    },
    "thumbnail_url": {
      "@id": "thanks:thumbnail_url",
      "@type": "xsd:string"
    },
    "share_url": {
      "@id": "thanks:share_url",
      "@type": "xsd:string"
    },
    "is_complete": {
      "@id": "thanks:is_complete",
      "@type": "xsd:boolean"
    },
    "needs": {
      "@id": "thanks:needs",
      "@container": "@list"
    },
    "image_template": {
      "@id": "thanks:image_template"
    },
    "message_template": {
      "@id": "thanks:message_template"
    },
    "back_background": {
      "@id": "thanks:back_background"
    },
    "message-template": "thanks:message-template",
    "handwriting_style_id": {
      "@id": "thanks:handwriting_style_id",
      "@type": "xsd:integer"
    },
    "font_size": {
      "@id": "thanks:font_size",
      "@type": "xsd:integer"
    },
    "font_color": {
      "@id": "thanks:font_color",
      "@type": "xsd:string"
    },
    "handwriting_realism": {
      "@id": "thanks:handwriting_realism",
      "@type": "xsd:boolean"
    },
    "content": {
      "@id": "thanks:content",
      "@type": "xsd:string"
    },
    "additional_pages": {
      "@id": "thanks:additional_pages",
      "@type": "@id"
    },
    "skip_creative_generation": {
      "@id": "thanks:skip_creative_generation",
      "@type": "xsd:integer"
    },
    "custom_background_url": {
      "@id": "thanks:custom_background_url",
      "@type": "xsd:string"
    },
    "cc_emails": {
      "@id": "thanks:cc_emails",
      "@container": "@list"
    },
    "giftcard_brand_code": {
      "@id": "thanks:giftcard_brand_code",
      "@type": "xsd:string"
    },
    "giftcard_brand_image": {
      "@id": "thanks:giftcard_brand_image",
      "@type": "xsd:string"
    },
    "giftcard_amount": {
      "@id": "thanks:giftcard_amount",
      "@type": "xsd:integer"
    },
    "landing_page_url": {
      "@id": "thanks:landing_page_url",
      "@type": "@id"
    },
    "share_uuid": {
      "@id": "thanks:share_uuid",
      "@type": "xsd:string"
    },
    "message-template-create": "thanks:message-template-create",
    "pdf_only_url": {
      "@id": "thanks:pdf_only_url",
      "@type": "@id"
    },
    "message-template-update": "thanks:message-template-update",
    "recipient-no-mailinglist": "thanks:recipient-no-mailinglist",
    "company": {
      "@id": "thanks:company",
      "@type": "xsd:string"
    },
    "address": {
      "@id": "thanks:address",
      "@type": "xsd:string"
    },
    "address2": {
      "@id": "thanks:address2",
      "@type": "xsd:string"
    },
    "city": {
      "@id": "thanks:city",
      "@type": "xsd:string"
    },
    "province": {
      "@id": "thanks:province",
      "@type": "xsd:string"
    },
    "postal_code": {
      "@id": "thanks:postal_code",
      "@type": "xsd:string"
    },
    "country": {
      "@id": "thanks:country",
      "@type": "xsd:string"
    },
    "dob": {
      "@id": "thanks:dob",
      "@type": "xsd:string"
    },
    "anniversary": {
      "@id": "thanks:anniversary",
      "@type": "xsd:string"
    },
    "email": {
      "@id": "thanks:email",
      "@type": "xsd:string"
    },
    "phone": {
      "@id": "thanks:phone",
      "@type": "xsd:string"
    },
    "custom1": {
      "@id": "thanks:custom1",
      "@type": "xsd:string"
    },
    "custom2": {
      "@id": "thanks:custom2",
      "@type": "xsd:string"
    },
    "custom3": {
      "@id": "thanks:custom3",
      "@type": "xsd:string"
    },
    "custom4": {
      "@id": "thanks:custom4",
      "@type": "xsd:string"
    },
    "custom5": {
      "@id": "thanks:custom5",
      "@type": "xsd:string"
    },
    "custom6": {
      "@id": "thanks:custom6",
      "@type": "xsd:string"
    },
    "custom7": {
      "@id": "thanks:custom7",
      "@type": "xsd:string"
    },
    "custom8": {
      "@id": "thanks:custom8",
      "@type": "xsd:string"
    },
    "custom9": {
      "@id": "thanks:custom9",
      "@type": "xsd:string"
    },
    "custom10": {
      "@id": "thanks:custom10",
      "@type": "xsd:string"
    },
    "absentee_address": {
      "@id": "thanks:absentee_address",
      "@type": "xsd:string"
    },
    "recipient-create": "thanks:recipient-create",
    "mailing_list_id": {
      "@id": "thanks:mailing_list_id",
      "@type": "xsd:integer"
    },
    "absentee_city": {
      "@id": "thanks:absentee_city",
      "@type": "@id"
    },
    "absentee_province": {
      "@id": "thanks:absentee_province",
      "@type": "@id"
    },
    "absentee_postal_code": {
      "@id": "thanks:absentee_postal_code",
      "@type": "@id"
    },
    "recipient-create-no-mailinglist": "thanks:recipient-create-no-mailinglist",
    "sub-account": "thanks:sub-account",
    "return_name": {
      "@id": "thanks:return_name",
      "@type": "xsd:string"
    },
    "return_address": {
      "@id": "thanks:return_address",
      "@type": "xsd:string"
    },
    "return_address2": {
      "@id": "thanks:return_address2",
      "@type": "xsd:string"
    },
    "return_city": {
      "@id": "thanks:return_city",
      "@type": "xsd:string"
    },
    "return_state": {
      "@id": "thanks:return_state",
      "@type": "xsd:string"
    },
    "return_postal_code": {
      "@id": "thanks:return_postal_code",
      "@type": "xsd:string"
    },
    "sub-account-create": "thanks:sub-account-create",
    "links": "thanks:links",
    "first": {
      "@id": "thanks:first",
      "@type": "xsd:string"
    },
    "last": {
      "@id": "thanks:last",
      "@type": "xsd:string"
    },
    "prev": {
      "@id": "thanks:prev",
      "@type": "xsd:string"
    },
    "next": {
      "@id": "thanks:next",
      "@type": "xsd:string"
    },
    "meta": "thanks:meta",
    "current_page": {
      "@id": "thanks:current_page",
      "@type": "xsd:integer"
    },
    "from": {
      "@id": "thanks:from",
      "@type": "xsd:integer"
    },
    "last_page": {
      "@id": "thanks:last_page",
      "@type": "xsd:integer"
    },
    "path": {
      "@id": "thanks:path",
      "@type": "xsd:string"
    },
    "per_page": {
      "@id": "thanks:per_page",
      "@type": "xsd:integer"
    },
    "to": {
      "@id": "thanks:to",
      "@type": "xsd:integer"
    },
    "total": {
      "@id": "thanks:total",
      "@type": "xsd:integer"
    },
    "paginated": "thanks:paginated",
    "first_page_url": {
      "@id": "thanks:first_page_url",
      "@type": "xsd:string"
    },
    "last_page_url": {
      "@id": "thanks:last_page_url",
      "@type": "xsd:string"
    },
    "next_page_url": {
      "@id": "thanks:next_page_url",
      "@type": "xsd:string"
    },
    "prev_page_url": {
      "@id": "thanks:prev_page_url",
      "@type": "xsd:string"
    },
    "estimate-response": "thanks:estimate-response",
    "data": {
      "@id": "thanks:data"
    },
    "send-mailer-base": "thanks:send-mailer-base",
    "mailing_list_ids": {
      "@id": "thanks:mailing_list_ids",
      "@container": "@list"
    },
    "recipients": {
      "@id": "thanks:recipients",
      "@container": "@list"
    },
    "radius_search": {
      "@id": "thanks:radius_search"
    },
    "handwriting_color": {
      "@id": "thanks:handwriting_color",
      "@type": "xsd:string"
    },
    "sub_account": {
      "@id": "thanks:sub_account",
      "@type": "xsd:integer"
    },
    "notification_emails": {
      "@id": "thanks:notification_emails",
      "@type": "xsd:string"
    },
    "email_lookup": {
      "@id": "thanks:email_lookup",
      "@type": "xsd:boolean"
    },
    "postage_class": {
      "@id": "thanks:postage_class",
      "@type": "xsd:string"
    },
    "send-mailer-order-response": "thanks:send-mailer-order-response",
    "leads_fee": {
      "@id": "thanks:leads_fee",
      "@type": "xsd:integer"
    },
    "mailing_list_ids_used": {
      "@id": "thanks:mailing_list_ids_used",
      "@type": "xsd:string"
    },
    "image_template_id": {
      "@id": "thanks:image_template_id",
      "@type": "xsd:integer"
    },
    "message_template_id": {
      "@id": "thanks:message_template_id",
      "@type": "xsd:integer"
    },
    "append_or_current_resident": {
      "@id": "thanks:append_or_current_resident",
      "@type": "xsd:boolean"
    },
    "return_province": {
      "@id": "thanks:return_province",
      "@type": "xsd:string"
    },
    "display_status": {
      "@id": "thanks:display_status",
      "@type": "xsd:string"
    },
    "display_trigger": {
      "@id": "thanks:display_trigger",
      "@type": "xsd:string"
    },
    "addons": {
      "@id": "thanks:addons"
    },
    "giftcard_brand": {
      "@id": "thanks:giftcard_brand",
      "@type": "xsd:string"
    },
    "giftcard_image": {
      "@id": "thanks:giftcard_image",
      "@type": "xsd:string"
    },
    "giftcard_brand_longname": {
      "@id": "thanks:giftcard_brand_longname",
      "@type": "xsd:string"
    },
    "send-mailer-preview-response": "thanks:send-mailer-preview-response"
  },
  "@type": "schema:Dataset",
  "schema:name": "Thanks.io API JSON-LD context",
  "schema:description": "A JSON-LD @context for the objects Thanks.io's own API contract declares: one class per component schema, one property per declared field, typed from the contract. Derived by script (derive-json-ld.py, 2026-10-28) from openapi/thanks-io-openapi.json.",
  "dcterms:created": "2026-10-28",
  "dcterms:source": [
    "openapi/thanks-io-openapi.json"
  ]
}