Reach · JSON-LD Context

Withreach Context

JSON-LD context defining the semantic vocabulary for Withreach from Reach.

22 Classes 83 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/
withreach: https://withreach.com/schema#

Classes

Session Item Discount Address Payment Ideal Paypal Expiry Action Times Error CaptureResultResource Refund Quote Tax TransactionDetailsModeA TransactionDetailsModeB LineItem ItemTax ErrorResponse FieldError AuthErrorResponse

Properties

Property Type Container
SessionId string
State string
MerchantReference string
Currency string
TotalAmount decimal
Items list
AutoCapture boolean
CompleteUrl string
CancelUrl string
ViaAgent boolean
BillingProfileId string
BillingProfileReference string
BillingProfile
ShippingDetails
TaxAmount decimal
Order
Discounts list
RateOfferId string
Meta reference
PaymentDate string
PaymentMethod string
AllowContract boolean
OpenContract boolean
TaxQuoteId string
Name string
Amount decimal
Quantity integer
Street string
City string
Region string
Country string
Postcode string
Type string
Method string
ReturnUrl string
Online
Card
Offline
IssuerId string
Email string
Month string
Year string
Redirect string
Challenge string
Display reference
Created string
Authorized string
Processed string
Code string
Message string
FieldErrors list
OrderState string
RefundId string
RefundReference string
Id string
Reference string
ShippingAddress reference
WarehouseAddress reference
BusinessIdentificationNumber string
PspTransactionId string
PspName string
ParentPspTransactionId string
ParentReference string
TaxProviderId string
TaxProviderReferenceId string
TaxDate string
Sku string
Description string
CountryOfOrigin string
ProviderTaxCode string
ProviderTaxCategory string
ProviderParentTaxCategory string
ItemTaxes list
JurisdictionName string
JurisdictionLevel string
JurisdictionCountryCode string
JurisdictionRegionCode string
TaxableAmount decimal
NonTaxableAmount decimal
TaxRate decimal
TransactionType integer
ServiceType integer
Field string

JSON-LD Document

Raw ↑
{
  "@context": {
    "@vocab": "https://withreach.com/schema#",
    "schema": "https://schema.org/",
    "xsd": "http://www.w3.org/2001/XMLSchema#",
    "dcterms": "http://purl.org/dc/terms/",
    "withreach": "https://withreach.com/schema#",
    "Session": "withreach:Session",
    "SessionId": {
      "@id": "withreach:SessionId",
      "@type": "xsd:string"
    },
    "State": {
      "@id": "withreach:State",
      "@type": "xsd:string"
    },
    "MerchantReference": {
      "@id": "withreach:MerchantReference",
      "@type": "xsd:string"
    },
    "Currency": {
      "@id": "withreach:Currency",
      "@type": "xsd:string"
    },
    "TotalAmount": {
      "@id": "withreach:TotalAmount",
      "@type": "xsd:decimal"
    },
    "Items": {
      "@id": "withreach:Items",
      "@container": "@list"
    },
    "AutoCapture": {
      "@id": "withreach:AutoCapture",
      "@type": "xsd:boolean"
    },
    "CompleteUrl": {
      "@id": "withreach:CompleteUrl",
      "@type": "xsd:string"
    },
    "CancelUrl": {
      "@id": "withreach:CancelUrl",
      "@type": "xsd:string"
    },
    "ViaAgent": {
      "@id": "withreach:ViaAgent",
      "@type": "xsd:boolean"
    },
    "BillingProfileId": {
      "@id": "withreach:BillingProfileId",
      "@type": "xsd:string"
    },
    "BillingProfileReference": {
      "@id": "withreach:BillingProfileReference",
      "@type": "xsd:string"
    },
    "BillingProfile": {
      "@id": "withreach:BillingProfile"
    },
    "ShippingDetails": {
      "@id": "withreach:ShippingDetails"
    },
    "TaxAmount": {
      "@id": "withreach:TaxAmount",
      "@type": "xsd:decimal"
    },
    "Order": {
      "@id": "withreach:Order"
    },
    "Discounts": {
      "@id": "withreach:Discounts",
      "@container": "@list"
    },
    "RateOfferId": {
      "@id": "withreach:RateOfferId",
      "@type": "xsd:string"
    },
    "Meta": {
      "@id": "withreach:Meta",
      "@type": "@id"
    },
    "PaymentDate": {
      "@id": "withreach:PaymentDate",
      "@type": "xsd:string"
    },
    "PaymentMethod": {
      "@id": "withreach:PaymentMethod",
      "@type": "xsd:string"
    },
    "AllowContract": {
      "@id": "withreach:AllowContract",
      "@type": "xsd:boolean"
    },
    "OpenContract": {
      "@id": "withreach:OpenContract",
      "@type": "xsd:boolean"
    },
    "TaxQuoteId": {
      "@id": "withreach:TaxQuoteId",
      "@type": "xsd:string"
    },
    "Item": "withreach:Item",
    "Name": {
      "@id": "withreach:Name",
      "@type": "xsd:string"
    },
    "Amount": {
      "@id": "withreach:Amount",
      "@type": "xsd:decimal"
    },
    "Quantity": {
      "@id": "withreach:Quantity",
      "@type": "xsd:integer"
    },
    "Discount": "withreach:Discount",
    "Address": "withreach:Address",
    "Street": {
      "@id": "withreach:Street",
      "@type": "xsd:string"
    },
    "City": {
      "@id": "withreach:City",
      "@type": "xsd:string"
    },
    "Region": {
      "@id": "withreach:Region",
      "@type": "xsd:string"
    },
    "Country": {
      "@id": "withreach:Country",
      "@type": "xsd:string"
    },
    "Postcode": {
      "@id": "withreach:Postcode",
      "@type": "xsd:string"
    },
    "Payment": "withreach:Payment",
    "Type": {
      "@id": "withreach:Type",
      "@type": "xsd:string"
    },
    "Method": {
      "@id": "withreach:Method",
      "@type": "xsd:string"
    },
    "ReturnUrl": {
      "@id": "withreach:ReturnUrl",
      "@type": "xsd:string"
    },
    "Online": {
      "@id": "withreach:Online"
    },
    "Card": {
      "@id": "withreach:Card"
    },
    "Offline": {
      "@id": "withreach:Offline"
    },
    "Ideal": "withreach:Ideal",
    "IssuerId": {
      "@id": "withreach:IssuerId",
      "@type": "xsd:string"
    },
    "Paypal": "withreach:Paypal",
    "Email": {
      "@id": "withreach:Email",
      "@type": "xsd:string"
    },
    "Expiry": "withreach:Expiry",
    "Month": {
      "@id": "withreach:Month",
      "@type": "xsd:string"
    },
    "Year": {
      "@id": "withreach:Year",
      "@type": "xsd:string"
    },
    "Action": "withreach:Action",
    "Redirect": {
      "@id": "withreach:Redirect",
      "@type": "xsd:string"
    },
    "Challenge": {
      "@id": "withreach:Challenge",
      "@type": "xsd:string"
    },
    "Display": {
      "@id": "withreach:Display",
      "@type": "@id"
    },
    "Times": "withreach:Times",
    "Created": {
      "@id": "withreach:Created",
      "@type": "xsd:string"
    },
    "Authorized": {
      "@id": "withreach:Authorized",
      "@type": "xsd:string"
    },
    "Processed": {
      "@id": "withreach:Processed",
      "@type": "xsd:string"
    },
    "Error": "withreach:Error",
    "Code": {
      "@id": "withreach:Code",
      "@type": "xsd:string"
    },
    "Message": {
      "@id": "withreach:Message",
      "@type": "xsd:string"
    },
    "FieldErrors": {
      "@id": "withreach:FieldErrors",
      "@container": "@list"
    },
    "CaptureResultResource": "withreach:CaptureResultResource",
    "OrderState": {
      "@id": "withreach:OrderState",
      "@type": "xsd:string"
    },
    "Refund": "withreach:Refund",
    "RefundId": {
      "@id": "withreach:RefundId",
      "@type": "xsd:string"
    },
    "RefundReference": {
      "@id": "withreach:RefundReference",
      "@type": "xsd:string"
    },
    "Quote": "withreach:Quote",
    "Id": {
      "@id": "withreach:Id",
      "@type": "xsd:string"
    },
    "Reference": {
      "@id": "withreach:Reference",
      "@type": "xsd:string"
    },
    "ShippingAddress": {
      "@id": "withreach:ShippingAddress",
      "@type": "@id"
    },
    "WarehouseAddress": {
      "@id": "withreach:WarehouseAddress",
      "@type": "@id"
    },
    "BusinessIdentificationNumber": {
      "@id": "withreach:BusinessIdentificationNumber",
      "@type": "xsd:string"
    },
    "Tax": "withreach:Tax",
    "TransactionDetailsModeA": "withreach:TransactionDetailsModeA",
    "PspTransactionId": {
      "@id": "withreach:PspTransactionId",
      "@type": "xsd:string"
    },
    "PspName": {
      "@id": "withreach:PspName",
      "@type": "xsd:string"
    },
    "ParentPspTransactionId": {
      "@id": "withreach:ParentPspTransactionId",
      "@type": "xsd:string"
    },
    "ParentReference": {
      "@id": "withreach:ParentReference",
      "@type": "xsd:string"
    },
    "TaxProviderId": {
      "@id": "withreach:TaxProviderId",
      "@type": "xsd:string"
    },
    "TaxProviderReferenceId": {
      "@id": "withreach:TaxProviderReferenceId",
      "@type": "xsd:string"
    },
    "TaxDate": {
      "@id": "withreach:TaxDate",
      "@type": "xsd:string"
    },
    "TransactionDetailsModeB": "withreach:TransactionDetailsModeB",
    "LineItem": "withreach:LineItem",
    "Sku": {
      "@id": "withreach:Sku",
      "@type": "xsd:string"
    },
    "Description": {
      "@id": "withreach:Description",
      "@type": "xsd:string"
    },
    "CountryOfOrigin": {
      "@id": "withreach:CountryOfOrigin",
      "@type": "xsd:string"
    },
    "ProviderTaxCode": {
      "@id": "withreach:ProviderTaxCode",
      "@type": "xsd:string"
    },
    "ProviderTaxCategory": {
      "@id": "withreach:ProviderTaxCategory",
      "@type": "xsd:string"
    },
    "ProviderParentTaxCategory": {
      "@id": "withreach:ProviderParentTaxCategory",
      "@type": "xsd:string"
    },
    "ItemTaxes": {
      "@id": "withreach:ItemTaxes",
      "@container": "@list"
    },
    "ItemTax": "withreach:ItemTax",
    "JurisdictionName": {
      "@id": "withreach:JurisdictionName",
      "@type": "xsd:string"
    },
    "JurisdictionLevel": {
      "@id": "withreach:JurisdictionLevel",
      "@type": "xsd:string"
    },
    "JurisdictionCountryCode": {
      "@id": "withreach:JurisdictionCountryCode",
      "@type": "xsd:string"
    },
    "JurisdictionRegionCode": {
      "@id": "withreach:JurisdictionRegionCode",
      "@type": "xsd:string"
    },
    "TaxableAmount": {
      "@id": "withreach:TaxableAmount",
      "@type": "xsd:decimal"
    },
    "NonTaxableAmount": {
      "@id": "withreach:NonTaxableAmount",
      "@type": "xsd:decimal"
    },
    "TaxRate": {
      "@id": "withreach:TaxRate",
      "@type": "xsd:decimal"
    },
    "TransactionType": {
      "@id": "withreach:TransactionType",
      "@type": "xsd:integer"
    },
    "ServiceType": {
      "@id": "withreach:ServiceType",
      "@type": "xsd:integer"
    },
    "ErrorResponse": "withreach:ErrorResponse",
    "FieldError": "withreach:FieldError",
    "Field": {
      "@id": "withreach:Field",
      "@type": "xsd:string"
    },
    "AuthErrorResponse": "withreach:AuthErrorResponse"
  },
  "@type": "schema:Dataset",
  "schema:name": "Reach API JSON-LD context",
  "schema:description": "A JSON-LD @context for the objects Reach'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/withreach-reach-checkout-api-openapi.yml, openapi/withreach-reach-s-drop-in-api-openapi.yml, openapi/withreach-tax-quote-api-openapi.yml.",
  "dcterms:created": "2026-10-28",
  "dcterms:source": [
    "openapi/withreach-reach-checkout-api-openapi.yml",
    "openapi/withreach-reach-s-drop-in-api-openapi.yml",
    "openapi/withreach-tax-quote-api-openapi.yml",
    "openapi/withreach-transaction-details-api-openapi.yml"
  ]
}