AffiliateBase · JSON-LD Context
Affiliatebase Io Context
JSON-LD context defining the semantic vocabulary for Affiliatebase Io from AffiliateBase.
30 Classes
120 Properties
4 Namespaces
Namespaces
schema:
https://schema.org/
xsd:
http://www.w3.org/2001/XMLSchema#
dcterms:
http://purl.org/dc/terms/
affiliatebase:
https://affiliatebase.io/schema#
Classes
Error
Pagination
ApiKey
CampaignWrite
AffiliateState
Affiliate
AffiliateBanReason
AffiliateBanRequest
AffiliateUnbanRequest
AffiliateBanImpact
AffiliateBanSubject
Campaign
Link
Referral
Commission
Payout
PayoutExport
PayoutRun
Invitation
Coupon
CouponWriteDryRun
PaginatedApiKeys
PaginatedAffiliates
PaginatedCampaigns
PaginatedLinks
PaginatedReferrals
PaginatedCommissions
PaginatedPayouts
PaginatedInvitations
AffiliatePromoCode
Properties
| Property | Type | Container |
|---|---|---|
| error | string | |
| code | string | |
| details | ||
| previous_page | ||
| current_page | integer | |
| next_page | ||
| count | integer | |
| limit | integer | |
| total_pages | integer | |
| total_count | integer | |
| id | string | |
| account_id | string | |
| key_prefix | string | |
| name | string | |
| permissions | ||
| last_used_at | ||
| expires_at | ||
| revoked_at | ||
| created_at | dateTime | |
| updated_at | dateTime | |
| slug | string | |
| url | string | |
| attribution_model | string | |
| private | boolean | |
| private_tokens | string | |
| reward_type | string | |
| commission_percent | decimal | |
| commission_amount_cents | integer | |
| commission_amount_currency | string | |
| minimum_payout_cents | integer | |
| minimum_payout_currency | string | |
| max_commission_period_months | integer | |
| reward_conditions | list | |
| introductory_commission_percent | decimal | |
| introductory_commission_months | integer | |
| max_commissions | integer | |
| days_before_referrals_expire | integer | |
| days_until_commissions_are_due | integer | |
| affiliate_dashboard_text | string | |
| custom_reward_description | string | |
| welcome_text | string | |
| customers_visible_to_affiliates | boolean | |
| sale_description_visible_to_affiliates | boolean | |
| parameter_type | string | |
| stripe_coupon_id | string | |
| promo_code_provisioning | string | |
| default | boolean | |
| string | ||
| first_name | string | |
| last_name | string | |
| state | reference | |
| banned_at | dateTime | |
| ban_reason | ||
| paypal_email | string | |
| wise_email | string | |
| reason | reference | |
| note | string | |
| dry_run | boolean | |
| idempotency_key | string | |
| requested_by | string | |
| voided_commissions | list | |
| voided_totals | ||
| payouts_resized | list | |
| payouts_removed | list | |
| untouched_payouts | list | |
| links_archived | integer | |
| codes_stopped | integer | |
| affiliates | list | |
| campaign_id | string | |
| archived | boolean | |
| token | string | |
| affiliate_id | string | |
| conversion_state | string | |
| attribution_method | string | |
| coupon_id | ||
| deactivated_at | ||
| amount | integer | |
| currency | string | |
| due_at | ||
| paid_at | ||
| payment_reference | ||
| format | string | |
| notes | ||
| metadata | ||
| payout_count | integer | |
| total_amount_cents | integer | |
| payout_ids | list | |
| status | string | |
| selection_hash | string | |
| result_payload | ||
| completed_at | ||
| kind | string | |
| role | string | |
| accepted_at | ||
| external_id | ||
| sync_status | string | |
| sync_attempted_at | ||
| synced_at | ||
| sync_error_code | ||
| sync_error_message | ||
| leads | integer | |
| conversions | integer | |
| deleted_at | ||
| notice | string | |
| context | ||
| impact | ||
| data | list | |
| pagination | reference | |
| tracking_token | string | |
| stripe_promotion_code_id | string | |
| stripe_account_id | string | |
| livemode | boolean | |
| management | string | |
| assigned_at | dateTime | |
| stopped_at | dateTime | |
| provider_status | string | |
| provider_checked_at | dateTime | |
| discount | ||
| restrictions | ||
| replayed | boolean |
JSON-LD Document
{
"@context": {
"@vocab": "https://affiliatebase.io/schema#",
"schema": "https://schema.org/",
"xsd": "http://www.w3.org/2001/XMLSchema#",
"dcterms": "http://purl.org/dc/terms/",
"affiliatebase": "https://affiliatebase.io/schema#",
"Error": "affiliatebase:Error",
"error": {
"@id": "affiliatebase:error",
"@type": "xsd:string"
},
"code": {
"@id": "affiliatebase:code",
"@type": "xsd:string"
},
"details": {
"@id": "affiliatebase:details"
},
"Pagination": "affiliatebase:Pagination",
"previous_page": {
"@id": "affiliatebase:previous_page"
},
"current_page": {
"@id": "affiliatebase:current_page",
"@type": "xsd:integer"
},
"next_page": {
"@id": "affiliatebase:next_page"
},
"count": {
"@id": "affiliatebase:count",
"@type": "xsd:integer"
},
"limit": {
"@id": "affiliatebase:limit",
"@type": "xsd:integer"
},
"total_pages": {
"@id": "affiliatebase:total_pages",
"@type": "xsd:integer"
},
"total_count": {
"@id": "affiliatebase:total_count",
"@type": "xsd:integer"
},
"ApiKey": "affiliatebase:ApiKey",
"id": {
"@id": "affiliatebase:id",
"@type": "xsd:string"
},
"account_id": {
"@id": "affiliatebase:account_id",
"@type": "xsd:string"
},
"key_prefix": {
"@id": "affiliatebase:key_prefix",
"@type": "xsd:string"
},
"name": {
"@id": "affiliatebase:name",
"@type": "xsd:string"
},
"permissions": {
"@id": "affiliatebase:permissions"
},
"last_used_at": {
"@id": "affiliatebase:last_used_at"
},
"expires_at": {
"@id": "affiliatebase:expires_at"
},
"revoked_at": {
"@id": "affiliatebase:revoked_at"
},
"created_at": {
"@id": "affiliatebase:created_at",
"@type": "xsd:dateTime"
},
"updated_at": {
"@id": "affiliatebase:updated_at",
"@type": "xsd:dateTime"
},
"CampaignWrite": "affiliatebase:CampaignWrite",
"slug": {
"@id": "affiliatebase:slug",
"@type": "xsd:string"
},
"url": {
"@id": "affiliatebase:url",
"@type": "xsd:string"
},
"attribution_model": {
"@id": "affiliatebase:attribution_model",
"@type": "xsd:string"
},
"private": {
"@id": "affiliatebase:private",
"@type": "xsd:boolean"
},
"private_tokens": {
"@id": "affiliatebase:private_tokens",
"@type": "xsd:string"
},
"reward_type": {
"@id": "affiliatebase:reward_type",
"@type": "xsd:string"
},
"commission_percent": {
"@id": "affiliatebase:commission_percent",
"@type": "xsd:decimal"
},
"commission_amount_cents": {
"@id": "affiliatebase:commission_amount_cents",
"@type": "xsd:integer"
},
"commission_amount_currency": {
"@id": "affiliatebase:commission_amount_currency",
"@type": "xsd:string"
},
"minimum_payout_cents": {
"@id": "affiliatebase:minimum_payout_cents",
"@type": "xsd:integer"
},
"minimum_payout_currency": {
"@id": "affiliatebase:minimum_payout_currency",
"@type": "xsd:string"
},
"max_commission_period_months": {
"@id": "affiliatebase:max_commission_period_months",
"@type": "xsd:integer"
},
"reward_conditions": {
"@id": "affiliatebase:reward_conditions",
"@container": "@list"
},
"introductory_commission_percent": {
"@id": "affiliatebase:introductory_commission_percent",
"@type": "xsd:decimal"
},
"introductory_commission_months": {
"@id": "affiliatebase:introductory_commission_months",
"@type": "xsd:integer"
},
"max_commissions": {
"@id": "affiliatebase:max_commissions",
"@type": "xsd:integer"
},
"days_before_referrals_expire": {
"@id": "affiliatebase:days_before_referrals_expire",
"@type": "xsd:integer"
},
"days_until_commissions_are_due": {
"@id": "affiliatebase:days_until_commissions_are_due",
"@type": "xsd:integer"
},
"affiliate_dashboard_text": {
"@id": "affiliatebase:affiliate_dashboard_text",
"@type": "xsd:string"
},
"custom_reward_description": {
"@id": "affiliatebase:custom_reward_description",
"@type": "xsd:string"
},
"welcome_text": {
"@id": "affiliatebase:welcome_text",
"@type": "xsd:string"
},
"customers_visible_to_affiliates": {
"@id": "affiliatebase:customers_visible_to_affiliates",
"@type": "xsd:boolean"
},
"sale_description_visible_to_affiliates": {
"@id": "affiliatebase:sale_description_visible_to_affiliates",
"@type": "xsd:boolean"
},
"parameter_type": {
"@id": "affiliatebase:parameter_type",
"@type": "xsd:string"
},
"stripe_coupon_id": {
"@id": "affiliatebase:stripe_coupon_id",
"@type": "xsd:string"
},
"promo_code_provisioning": {
"@id": "affiliatebase:promo_code_provisioning",
"@type": "xsd:string"
},
"default": {
"@id": "affiliatebase:default",
"@type": "xsd:boolean"
},
"AffiliateState": "affiliatebase:AffiliateState",
"Affiliate": "affiliatebase:Affiliate",
"email": {
"@id": "affiliatebase:email",
"@type": "xsd:string"
},
"first_name": {
"@id": "affiliatebase:first_name",
"@type": "xsd:string"
},
"last_name": {
"@id": "affiliatebase:last_name",
"@type": "xsd:string"
},
"state": {
"@id": "affiliatebase:state",
"@type": "@id"
},
"banned_at": {
"@id": "affiliatebase:banned_at",
"@type": "xsd:dateTime"
},
"ban_reason": {
"@id": "affiliatebase:ban_reason"
},
"paypal_email": {
"@id": "affiliatebase:paypal_email",
"@type": "xsd:string"
},
"wise_email": {
"@id": "affiliatebase:wise_email",
"@type": "xsd:string"
},
"AffiliateBanReason": "affiliatebase:AffiliateBanReason",
"AffiliateBanRequest": "affiliatebase:AffiliateBanRequest",
"reason": {
"@id": "affiliatebase:reason",
"@type": "@id"
},
"note": {
"@id": "affiliatebase:note",
"@type": "xsd:string"
},
"dry_run": {
"@id": "affiliatebase:dry_run",
"@type": "xsd:boolean"
},
"idempotency_key": {
"@id": "affiliatebase:idempotency_key",
"@type": "xsd:string"
},
"requested_by": {
"@id": "affiliatebase:requested_by",
"@type": "xsd:string"
},
"AffiliateUnbanRequest": "affiliatebase:AffiliateUnbanRequest",
"AffiliateBanImpact": "affiliatebase:AffiliateBanImpact",
"voided_commissions": {
"@id": "affiliatebase:voided_commissions",
"@container": "@list"
},
"voided_totals": {
"@id": "affiliatebase:voided_totals"
},
"payouts_resized": {
"@id": "affiliatebase:payouts_resized",
"@container": "@list"
},
"payouts_removed": {
"@id": "affiliatebase:payouts_removed",
"@container": "@list"
},
"untouched_payouts": {
"@id": "affiliatebase:untouched_payouts",
"@container": "@list"
},
"links_archived": {
"@id": "affiliatebase:links_archived",
"@type": "xsd:integer"
},
"codes_stopped": {
"@id": "affiliatebase:codes_stopped",
"@type": "xsd:integer"
},
"affiliates": {
"@id": "affiliatebase:affiliates",
"@container": "@list"
},
"AffiliateBanSubject": "affiliatebase:AffiliateBanSubject",
"campaign_id": {
"@id": "affiliatebase:campaign_id",
"@type": "xsd:string"
},
"archived": {
"@id": "affiliatebase:archived",
"@type": "xsd:boolean"
},
"Campaign": "affiliatebase:Campaign",
"Link": "affiliatebase:Link",
"token": {
"@id": "affiliatebase:token",
"@type": "xsd:string"
},
"affiliate_id": {
"@id": "affiliatebase:affiliate_id",
"@type": "xsd:string"
},
"Referral": "affiliatebase:Referral",
"conversion_state": {
"@id": "affiliatebase:conversion_state",
"@type": "xsd:string"
},
"attribution_method": {
"@id": "affiliatebase:attribution_method",
"@type": "xsd:string"
},
"coupon_id": {
"@id": "affiliatebase:coupon_id"
},
"deactivated_at": {
"@id": "affiliatebase:deactivated_at"
},
"Commission": "affiliatebase:Commission",
"amount": {
"@id": "affiliatebase:amount",
"@type": "xsd:integer"
},
"currency": {
"@id": "affiliatebase:currency",
"@type": "xsd:string"
},
"due_at": {
"@id": "affiliatebase:due_at"
},
"paid_at": {
"@id": "affiliatebase:paid_at"
},
"Payout": "affiliatebase:Payout",
"payment_reference": {
"@id": "affiliatebase:payment_reference"
},
"PayoutExport": "affiliatebase:PayoutExport",
"format": {
"@id": "affiliatebase:format",
"@type": "xsd:string"
},
"notes": {
"@id": "affiliatebase:notes"
},
"metadata": {
"@id": "affiliatebase:metadata"
},
"payout_count": {
"@id": "affiliatebase:payout_count",
"@type": "xsd:integer"
},
"total_amount_cents": {
"@id": "affiliatebase:total_amount_cents",
"@type": "xsd:integer"
},
"payout_ids": {
"@id": "affiliatebase:payout_ids",
"@container": "@list"
},
"PayoutRun": "affiliatebase:PayoutRun",
"status": {
"@id": "affiliatebase:status",
"@type": "xsd:string"
},
"selection_hash": {
"@id": "affiliatebase:selection_hash",
"@type": "xsd:string"
},
"result_payload": {
"@id": "affiliatebase:result_payload"
},
"completed_at": {
"@id": "affiliatebase:completed_at"
},
"Invitation": "affiliatebase:Invitation",
"kind": {
"@id": "affiliatebase:kind",
"@type": "xsd:string"
},
"role": {
"@id": "affiliatebase:role",
"@type": "xsd:string"
},
"accepted_at": {
"@id": "affiliatebase:accepted_at"
},
"Coupon": "affiliatebase:Coupon",
"external_id": {
"@id": "affiliatebase:external_id"
},
"sync_status": {
"@id": "affiliatebase:sync_status",
"@type": "xsd:string"
},
"sync_attempted_at": {
"@id": "affiliatebase:sync_attempted_at"
},
"synced_at": {
"@id": "affiliatebase:synced_at"
},
"sync_error_code": {
"@id": "affiliatebase:sync_error_code"
},
"sync_error_message": {
"@id": "affiliatebase:sync_error_message"
},
"leads": {
"@id": "affiliatebase:leads",
"@type": "xsd:integer"
},
"conversions": {
"@id": "affiliatebase:conversions",
"@type": "xsd:integer"
},
"deleted_at": {
"@id": "affiliatebase:deleted_at"
},
"CouponWriteDryRun": "affiliatebase:CouponWriteDryRun",
"notice": {
"@id": "affiliatebase:notice",
"@type": "xsd:string"
},
"context": {
"@id": "affiliatebase:context"
},
"impact": {
"@id": "affiliatebase:impact"
},
"PaginatedApiKeys": "affiliatebase:PaginatedApiKeys",
"data": {
"@id": "affiliatebase:data",
"@container": "@list"
},
"pagination": {
"@id": "affiliatebase:pagination",
"@type": "@id"
},
"PaginatedAffiliates": "affiliatebase:PaginatedAffiliates",
"PaginatedCampaigns": "affiliatebase:PaginatedCampaigns",
"PaginatedLinks": "affiliatebase:PaginatedLinks",
"PaginatedReferrals": "affiliatebase:PaginatedReferrals",
"PaginatedCommissions": "affiliatebase:PaginatedCommissions",
"PaginatedPayouts": "affiliatebase:PaginatedPayouts",
"PaginatedInvitations": "affiliatebase:PaginatedInvitations",
"AffiliatePromoCode": "affiliatebase:AffiliatePromoCode",
"tracking_token": {
"@id": "affiliatebase:tracking_token",
"@type": "xsd:string"
},
"stripe_promotion_code_id": {
"@id": "affiliatebase:stripe_promotion_code_id",
"@type": "xsd:string"
},
"stripe_account_id": {
"@id": "affiliatebase:stripe_account_id",
"@type": "xsd:string"
},
"livemode": {
"@id": "affiliatebase:livemode",
"@type": "xsd:boolean"
},
"management": {
"@id": "affiliatebase:management",
"@type": "xsd:string"
},
"assigned_at": {
"@id": "affiliatebase:assigned_at",
"@type": "xsd:dateTime"
},
"stopped_at": {
"@id": "affiliatebase:stopped_at",
"@type": "xsd:dateTime"
},
"provider_status": {
"@id": "affiliatebase:provider_status",
"@type": "xsd:string"
},
"provider_checked_at": {
"@id": "affiliatebase:provider_checked_at",
"@type": "xsd:dateTime"
},
"discount": {
"@id": "affiliatebase:discount"
},
"restrictions": {
"@id": "affiliatebase:restrictions"
},
"replayed": {
"@id": "affiliatebase:replayed",
"@type": "xsd:boolean"
}
},
"@type": "schema:Dataset",
"schema:name": "AffiliateBase API JSON-LD context",
"schema:description": "A JSON-LD @context for the objects AffiliateBase'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-11-01) from openapi/affiliatebase-io-openapi.yml.",
"dcterms:created": "2026-11-01",
"dcterms:source": [
"openapi/affiliatebase-io-openapi.yml"
]
}