catalogapi-com · JSON-LD Context
Catalogapi Com Context
JSON-LD context defining the semantic vocabulary for Catalogapi Com from catalogapi-com.
59 Classes
162 Properties
4 Namespaces
Namespaces
schema:
https://schema.org/
xsd:
http://www.w3.org/2001/XMLSchema#
dcterms:
http://purl.org/dc/terms/
catalogapi:
https://catalogapi.com/schema#
Classes
Socket
ErrorResponse
SetAddressRequest
ListAvailableCatalogsResponse
SocketListResponse
ItemDetailsResponse
BetweenOperator
CartMetadataResponse
Order
BrandsResponse
Cart
StockResponse
GetOrdersResponse
ItemTypesResponse
DirectOrderRequest
OrderLineItem
MarketingBlock
OrOperator
ConflictErrorResponse
DirectOrderItem
NotFoundErrorResponse
CatalogItemImage
LteOperator
UpdateLineItemRequest
PlaceOrderRequest
AddItemsRequest
ValidateCartRequest
OrderTrackResponse
EqOperator
GtOperator
StockRevalidationResponse
PingResponse
LineItemPayment
ItemType
RedemptionActiveResponse
NeOperator
LtOperator
CategoriesResponse
Brand
CartViewResponse
AndOperator
BadRequestErrorResponse
MarketingResponse
TagBreakdownResponse
ItemsSearchRequest
UnprocessableEntityErrorResponse
SocketResponse
NotInOperator
StockInfo
Tag
CatalogMarketingResponse
ItemsSearchResponse
Category
CatalogItem
AddCartItem
InOperator
GteOperator
OrderFulfillment
UpdateCartMetadataRequest
Properties
| Property | Type | Container |
|---|---|---|
| currency | string | |
| download | string | |
| features | ||
| language | string | |
| point_to_currency_ratio | string | |
| region | string | |
| socket_id | integer | |
| socket_name | string | |
| error_code | string | |
| message | string | |
| success | boolean | |
| timestamp | string | |
| address_1 | string | |
| address_2 | string | |
| address_3 | string | |
| address_4 | string | |
| city | string | |
| country | string | |
| string | ||
| given_name | string | |
| phone_number | string | |
| postal_code | string | |
| state_or_region | string | |
| surname | string | |
| sockets | list | |
| total_sockets | integer | |
| catalog_item | reference | |
| matched_entities | list | |
| between | ||
| cart_version | string | |
| metadata | ||
| created | dateTime | |
| external_order_id | string | |
| external_user_id | string | |
| fulfillments | list | |
| is_test | boolean | |
| line_items | list | |
| order_number | string | |
| updated | dateTime | |
| brands | list | |
| total_brands | integer | |
| is_locked | boolean | |
| total | string | |
| total_line_items | integer | |
| total_points | integer | |
| unique_item_count | integer | |
| stock | reference | |
| orders | list | |
| pagination | ||
| item_types | list | |
| total_item_types | integer | |
| items | list | |
| shipping_address | ||
| price_paid | string | |
| category_ids | list | |
| shipping_estimate | string | |
| is_primary | boolean | |
| original_points | integer | |
| updated_at | dateTime | |
| stock_reserved_until | string | |
| errors | list | |
| price | string | |
| item_type_id | integer | |
| rank | integer | |
| description | string | |
| catalog_item_id | integer | |
| supplier_reference_id | string | |
| images | list | |
| created_at | dateTime | |
| status | string | |
| name | string | |
| product_id | string | |
| retail_price | string | |
| fulfillment_type | string | |
| is_available | boolean | |
| is_explicit | boolean | |
| is_limited_stock | boolean | |
| brand_id | integer | |
| availability | string | |
| original_price | string | |
| line_item_id | string | |
| model | string | |
| product_options | ||
| supplier_id | integer | |
| options | list | |
| required_fields | ||
| is_taxable | boolean | |
| brand | string | |
| shipping_paid | string | |
| points_paid | integer | |
| tag_ids | list | |
| is_stock_reserved | boolean | |
| tax_paid | string | |
| points | integer | |
| type | string | |
| or | list | |
| alt | string | |
| order | integer | |
| urls | ||
| lte | ||
| line_item_payments | list | |
| lock | boolean | |
| eq | ||
| gt | ||
| reservation_expires_at | dateTime | |
| stock_reserved | boolean | |
| token | string | |
| authenticated | boolean | |
| customer | ||
| version | string | |
| item_count | integer | |
| is_redemption_active | boolean | |
| ne | ||
| lt | ||
| categories | list | |
| total_categories | integer | |
| display_name | string | |
| num_items | integer | |
| cart | reference | |
| and | list | |
| blocks | list | |
| load_items | list | |
| tags | list | |
| total_tags | integer | |
| brand_faceting | string | |
| filter | reference | |
| page | integer | |
| per_page | integer | |
| search | string | |
| sort | string | |
| tag_faceting | string | |
| socket | reference | |
| not_in | ||
| available | boolean | |
| estimated_ship_date | date | |
| last_updated | string | |
| quantity_available | integer | |
| discount_percent | string | |
| tag_id | integer | |
| facets | list | |
| search_keys | ||
| searched_entities | list | |
| total_count | integer | |
| category_id | integer | |
| is_root | boolean | |
| parent_id | integer | |
| price_high | string | |
| points_low | integer | |
| face_currency | string | |
| price_low | string | |
| face_value | string | |
| points_high | integer | |
| product_name | string | |
| in | ||
| gte | ||
| fulfillment_id | string | |
| fulfillment_instructions | string | |
| line_item_ids | list | |
| shipper | string | |
| tracking_number | string | |
| virtual_code_link | string | |
| virtual_code_pin | string |
JSON-LD Document
{
"@context": {
"@vocab": "https://catalogapi.com/schema#",
"schema": "https://schema.org/",
"xsd": "http://www.w3.org/2001/XMLSchema#",
"dcterms": "http://purl.org/dc/terms/",
"catalogapi": "https://catalogapi.com/schema#",
"Socket": "catalogapi:Socket",
"currency": {
"@id": "catalogapi:currency",
"@type": "xsd:string"
},
"download": {
"@id": "catalogapi:download",
"@type": "xsd:string"
},
"features": {
"@id": "catalogapi:features"
},
"language": {
"@id": "catalogapi:language",
"@type": "xsd:string"
},
"point_to_currency_ratio": {
"@id": "catalogapi:point_to_currency_ratio",
"@type": "xsd:string"
},
"region": {
"@id": "catalogapi:region",
"@type": "xsd:string"
},
"socket_id": {
"@id": "catalogapi:socket_id",
"@type": "xsd:integer"
},
"socket_name": {
"@id": "catalogapi:socket_name",
"@type": "xsd:string"
},
"ErrorResponse": "catalogapi:ErrorResponse",
"error_code": {
"@id": "catalogapi:error_code",
"@type": "xsd:string"
},
"message": {
"@id": "catalogapi:message",
"@type": "xsd:string"
},
"success": {
"@id": "catalogapi:success",
"@type": "xsd:boolean"
},
"timestamp": {
"@id": "catalogapi:timestamp",
"@type": "xsd:string"
},
"SetAddressRequest": "catalogapi:SetAddressRequest",
"address_1": {
"@id": "catalogapi:address_1",
"@type": "xsd:string"
},
"address_2": {
"@id": "catalogapi:address_2",
"@type": "xsd:string"
},
"address_3": {
"@id": "catalogapi:address_3",
"@type": "xsd:string"
},
"address_4": {
"@id": "catalogapi:address_4",
"@type": "xsd:string"
},
"city": {
"@id": "catalogapi:city",
"@type": "xsd:string"
},
"country": {
"@id": "catalogapi:country",
"@type": "xsd:string"
},
"email": {
"@id": "catalogapi:email",
"@type": "xsd:string"
},
"given_name": {
"@id": "catalogapi:given_name",
"@type": "xsd:string"
},
"phone_number": {
"@id": "catalogapi:phone_number",
"@type": "xsd:string"
},
"postal_code": {
"@id": "catalogapi:postal_code",
"@type": "xsd:string"
},
"state_or_region": {
"@id": "catalogapi:state_or_region",
"@type": "xsd:string"
},
"surname": {
"@id": "catalogapi:surname",
"@type": "xsd:string"
},
"ListAvailableCatalogsResponse": "catalogapi:ListAvailableCatalogsResponse",
"sockets": {
"@id": "catalogapi:sockets",
"@container": "@list"
},
"SocketListResponse": "catalogapi:SocketListResponse",
"total_sockets": {
"@id": "catalogapi:total_sockets",
"@type": "xsd:integer"
},
"ItemDetailsResponse": "catalogapi:ItemDetailsResponse",
"catalog_item": {
"@id": "catalogapi:catalog_item",
"@type": "@id"
},
"matched_entities": {
"@id": "catalogapi:matched_entities",
"@container": "@list"
},
"BetweenOperator": "catalogapi:BetweenOperator",
"between": {
"@id": "catalogapi:between"
},
"CartMetadataResponse": "catalogapi:CartMetadataResponse",
"cart_version": {
"@id": "catalogapi:cart_version",
"@type": "xsd:string"
},
"metadata": {
"@id": "catalogapi:metadata"
},
"Order": "catalogapi:Order",
"created": {
"@id": "catalogapi:created",
"@type": "xsd:dateTime"
},
"external_order_id": {
"@id": "catalogapi:external_order_id",
"@type": "xsd:string"
},
"external_user_id": {
"@id": "catalogapi:external_user_id",
"@type": "xsd:string"
},
"fulfillments": {
"@id": "catalogapi:fulfillments",
"@container": "@list"
},
"is_test": {
"@id": "catalogapi:is_test",
"@type": "xsd:boolean"
},
"line_items": {
"@id": "catalogapi:line_items",
"@container": "@list"
},
"order_number": {
"@id": "catalogapi:order_number",
"@type": "xsd:string"
},
"updated": {
"@id": "catalogapi:updated",
"@type": "xsd:dateTime"
},
"BrandsResponse": "catalogapi:BrandsResponse",
"brands": {
"@id": "catalogapi:brands",
"@container": "@list"
},
"total_brands": {
"@id": "catalogapi:total_brands",
"@type": "xsd:integer"
},
"Cart": "catalogapi:Cart",
"is_locked": {
"@id": "catalogapi:is_locked",
"@type": "xsd:boolean"
},
"total": {
"@id": "catalogapi:total",
"@type": "xsd:string"
},
"total_line_items": {
"@id": "catalogapi:total_line_items",
"@type": "xsd:integer"
},
"total_points": {
"@id": "catalogapi:total_points",
"@type": "xsd:integer"
},
"unique_item_count": {
"@id": "catalogapi:unique_item_count",
"@type": "xsd:integer"
},
"StockResponse": "catalogapi:StockResponse",
"stock": {
"@id": "catalogapi:stock",
"@type": "@id"
},
"GetOrdersResponse": "catalogapi:GetOrdersResponse",
"orders": {
"@id": "catalogapi:orders",
"@container": "@list"
},
"pagination": {
"@id": "catalogapi:pagination"
},
"ItemTypesResponse": "catalogapi:ItemTypesResponse",
"item_types": {
"@id": "catalogapi:item_types",
"@container": "@list"
},
"total_item_types": {
"@id": "catalogapi:total_item_types",
"@type": "xsd:integer"
},
"DirectOrderRequest": "catalogapi:DirectOrderRequest",
"items": {
"@id": "catalogapi:items",
"@container": "@list"
},
"shipping_address": {
"@id": "catalogapi:shipping_address"
},
"OrderLineItem": "catalogapi:OrderLineItem",
"price_paid": {
"@id": "catalogapi:price_paid",
"@type": "xsd:string"
},
"category_ids": {
"@id": "catalogapi:category_ids",
"@container": "@list"
},
"shipping_estimate": {
"@id": "catalogapi:shipping_estimate",
"@type": "xsd:string"
},
"is_primary": {
"@id": "catalogapi:is_primary",
"@type": "xsd:boolean"
},
"original_points": {
"@id": "catalogapi:original_points",
"@type": "xsd:integer"
},
"updated_at": {
"@id": "catalogapi:updated_at",
"@type": "xsd:dateTime"
},
"stock_reserved_until": {
"@id": "catalogapi:stock_reserved_until",
"@type": "xsd:string"
},
"errors": {
"@id": "catalogapi:errors",
"@container": "@list"
},
"price": {
"@id": "catalogapi:price",
"@type": "xsd:string"
},
"item_type_id": {
"@id": "catalogapi:item_type_id",
"@type": "xsd:integer"
},
"rank": {
"@id": "catalogapi:rank",
"@type": "xsd:integer"
},
"description": {
"@id": "catalogapi:description",
"@type": "xsd:string"
},
"catalog_item_id": {
"@id": "catalogapi:catalog_item_id",
"@type": "xsd:integer"
},
"supplier_reference_id": {
"@id": "catalogapi:supplier_reference_id",
"@type": "xsd:string"
},
"images": {
"@id": "catalogapi:images",
"@container": "@list"
},
"created_at": {
"@id": "catalogapi:created_at",
"@type": "xsd:dateTime"
},
"status": {
"@id": "catalogapi:status",
"@type": "xsd:string"
},
"name": {
"@id": "catalogapi:name",
"@type": "xsd:string"
},
"product_id": {
"@id": "catalogapi:product_id",
"@type": "xsd:string"
},
"retail_price": {
"@id": "catalogapi:retail_price",
"@type": "xsd:string"
},
"fulfillment_type": {
"@id": "catalogapi:fulfillment_type",
"@type": "xsd:string"
},
"is_available": {
"@id": "catalogapi:is_available",
"@type": "xsd:boolean"
},
"is_explicit": {
"@id": "catalogapi:is_explicit",
"@type": "xsd:boolean"
},
"is_limited_stock": {
"@id": "catalogapi:is_limited_stock",
"@type": "xsd:boolean"
},
"brand_id": {
"@id": "catalogapi:brand_id",
"@type": "xsd:integer"
},
"availability": {
"@id": "catalogapi:availability",
"@type": "xsd:string"
},
"original_price": {
"@id": "catalogapi:original_price",
"@type": "xsd:string"
},
"line_item_id": {
"@id": "catalogapi:line_item_id",
"@type": "xsd:string"
},
"model": {
"@id": "catalogapi:model",
"@type": "xsd:string"
},
"product_options": {
"@id": "catalogapi:product_options"
},
"supplier_id": {
"@id": "catalogapi:supplier_id",
"@type": "xsd:integer"
},
"options": {
"@id": "catalogapi:options",
"@container": "@list"
},
"required_fields": {
"@id": "catalogapi:required_fields"
},
"is_taxable": {
"@id": "catalogapi:is_taxable",
"@type": "xsd:boolean"
},
"brand": {
"@id": "catalogapi:brand",
"@type": "xsd:string"
},
"shipping_paid": {
"@id": "catalogapi:shipping_paid",
"@type": "xsd:string"
},
"points_paid": {
"@id": "catalogapi:points_paid",
"@type": "xsd:integer"
},
"tag_ids": {
"@id": "catalogapi:tag_ids",
"@container": "@list"
},
"is_stock_reserved": {
"@id": "catalogapi:is_stock_reserved",
"@type": "xsd:boolean"
},
"tax_paid": {
"@id": "catalogapi:tax_paid",
"@type": "xsd:string"
},
"points": {
"@id": "catalogapi:points",
"@type": "xsd:integer"
},
"MarketingBlock": "catalogapi:MarketingBlock",
"type": {
"@id": "catalogapi:type",
"@type": "xsd:string"
},
"OrOperator": "catalogapi:OrOperator",
"or": {
"@id": "catalogapi:or",
"@container": "@list"
},
"ConflictErrorResponse": "catalogapi:ConflictErrorResponse",
"DirectOrderItem": "catalogapi:DirectOrderItem",
"NotFoundErrorResponse": "catalogapi:NotFoundErrorResponse",
"CatalogItemImage": "catalogapi:CatalogItemImage",
"alt": {
"@id": "catalogapi:alt",
"@type": "xsd:string"
},
"order": {
"@id": "catalogapi:order",
"@type": "xsd:integer"
},
"urls": {
"@id": "catalogapi:urls"
},
"LteOperator": "catalogapi:LteOperator",
"lte": {
"@id": "catalogapi:lte"
},
"UpdateLineItemRequest": "catalogapi:UpdateLineItemRequest",
"PlaceOrderRequest": "catalogapi:PlaceOrderRequest",
"line_item_payments": {
"@id": "catalogapi:line_item_payments",
"@container": "@list"
},
"AddItemsRequest": "catalogapi:AddItemsRequest",
"ValidateCartRequest": "catalogapi:ValidateCartRequest",
"lock": {
"@id": "catalogapi:lock",
"@type": "xsd:boolean"
},
"OrderTrackResponse": "catalogapi:OrderTrackResponse",
"EqOperator": "catalogapi:EqOperator",
"eq": {
"@id": "catalogapi:eq"
},
"GtOperator": "catalogapi:GtOperator",
"gt": {
"@id": "catalogapi:gt"
},
"StockRevalidationResponse": "catalogapi:StockRevalidationResponse",
"reservation_expires_at": {
"@id": "catalogapi:reservation_expires_at",
"@type": "xsd:dateTime"
},
"stock_reserved": {
"@id": "catalogapi:stock_reserved",
"@type": "xsd:boolean"
},
"token": {
"@id": "catalogapi:token",
"@type": "xsd:string"
},
"PingResponse": "catalogapi:PingResponse",
"authenticated": {
"@id": "catalogapi:authenticated",
"@type": "xsd:boolean"
},
"customer": {
"@id": "catalogapi:customer"
},
"version": {
"@id": "catalogapi:version",
"@type": "xsd:string"
},
"LineItemPayment": "catalogapi:LineItemPayment",
"ItemType": "catalogapi:ItemType",
"item_count": {
"@id": "catalogapi:item_count",
"@type": "xsd:integer"
},
"RedemptionActiveResponse": "catalogapi:RedemptionActiveResponse",
"is_redemption_active": {
"@id": "catalogapi:is_redemption_active",
"@type": "xsd:boolean"
},
"NeOperator": "catalogapi:NeOperator",
"ne": {
"@id": "catalogapi:ne"
},
"LtOperator": "catalogapi:LtOperator",
"lt": {
"@id": "catalogapi:lt"
},
"CategoriesResponse": "catalogapi:CategoriesResponse",
"categories": {
"@id": "catalogapi:categories",
"@container": "@list"
},
"total_categories": {
"@id": "catalogapi:total_categories",
"@type": "xsd:integer"
},
"Brand": "catalogapi:Brand",
"display_name": {
"@id": "catalogapi:display_name",
"@type": "xsd:string"
},
"num_items": {
"@id": "catalogapi:num_items",
"@type": "xsd:integer"
},
"CartViewResponse": "catalogapi:CartViewResponse",
"cart": {
"@id": "catalogapi:cart",
"@type": "@id"
},
"AndOperator": "catalogapi:AndOperator",
"and": {
"@id": "catalogapi:and",
"@container": "@list"
},
"BadRequestErrorResponse": "catalogapi:BadRequestErrorResponse",
"MarketingResponse": "catalogapi:MarketingResponse",
"blocks": {
"@id": "catalogapi:blocks",
"@container": "@list"
},
"load_items": {
"@id": "catalogapi:load_items",
"@container": "@list"
},
"TagBreakdownResponse": "catalogapi:TagBreakdownResponse",
"tags": {
"@id": "catalogapi:tags",
"@container": "@list"
},
"total_tags": {
"@id": "catalogapi:total_tags",
"@type": "xsd:integer"
},
"ItemsSearchRequest": "catalogapi:ItemsSearchRequest",
"brand_faceting": {
"@id": "catalogapi:brand_faceting",
"@type": "xsd:string"
},
"filter": {
"@id": "catalogapi:filter",
"@type": "@id"
},
"page": {
"@id": "catalogapi:page",
"@type": "xsd:integer"
},
"per_page": {
"@id": "catalogapi:per_page",
"@type": "xsd:integer"
},
"search": {
"@id": "catalogapi:search",
"@type": "xsd:string"
},
"sort": {
"@id": "catalogapi:sort",
"@type": "xsd:string"
},
"tag_faceting": {
"@id": "catalogapi:tag_faceting",
"@type": "xsd:string"
},
"UnprocessableEntityErrorResponse": "catalogapi:UnprocessableEntityErrorResponse",
"SocketResponse": "catalogapi:SocketResponse",
"socket": {
"@id": "catalogapi:socket",
"@type": "@id"
},
"NotInOperator": "catalogapi:NotInOperator",
"not_in": {
"@id": "catalogapi:not_in"
},
"StockInfo": "catalogapi:StockInfo",
"available": {
"@id": "catalogapi:available",
"@type": "xsd:boolean"
},
"estimated_ship_date": {
"@id": "catalogapi:estimated_ship_date",
"@type": "xsd:date"
},
"last_updated": {
"@id": "catalogapi:last_updated",
"@type": "xsd:string"
},
"quantity_available": {
"@id": "catalogapi:quantity_available",
"@type": "xsd:integer"
},
"Tag": "catalogapi:Tag",
"discount_percent": {
"@id": "catalogapi:discount_percent",
"@type": "xsd:string"
},
"tag_id": {
"@id": "catalogapi:tag_id",
"@type": "xsd:integer"
},
"CatalogMarketingResponse": "catalogapi:CatalogMarketingResponse",
"ItemsSearchResponse": "catalogapi:ItemsSearchResponse",
"facets": {
"@id": "catalogapi:facets",
"@container": "@list"
},
"search_keys": {
"@id": "catalogapi:search_keys"
},
"searched_entities": {
"@id": "catalogapi:searched_entities",
"@container": "@list"
},
"total_count": {
"@id": "catalogapi:total_count",
"@type": "xsd:integer"
},
"Category": "catalogapi:Category",
"category_id": {
"@id": "catalogapi:category_id",
"@type": "xsd:integer"
},
"is_root": {
"@id": "catalogapi:is_root",
"@type": "xsd:boolean"
},
"parent_id": {
"@id": "catalogapi:parent_id",
"@type": "xsd:integer"
},
"CatalogItem": "catalogapi:CatalogItem",
"price_high": {
"@id": "catalogapi:price_high",
"@type": "xsd:string"
},
"points_low": {
"@id": "catalogapi:points_low",
"@type": "xsd:integer"
},
"face_currency": {
"@id": "catalogapi:face_currency",
"@type": "xsd:string"
},
"price_low": {
"@id": "catalogapi:price_low",
"@type": "xsd:string"
},
"face_value": {
"@id": "catalogapi:face_value",
"@type": "xsd:string"
},
"points_high": {
"@id": "catalogapi:points_high",
"@type": "xsd:integer"
},
"product_name": {
"@id": "catalogapi:product_name",
"@type": "xsd:string"
},
"AddCartItem": "catalogapi:AddCartItem",
"InOperator": "catalogapi:InOperator",
"in": {
"@id": "catalogapi:in"
},
"GteOperator": "catalogapi:GteOperator",
"gte": {
"@id": "catalogapi:gte"
},
"OrderFulfillment": "catalogapi:OrderFulfillment",
"fulfillment_id": {
"@id": "catalogapi:fulfillment_id",
"@type": "xsd:string"
},
"fulfillment_instructions": {
"@id": "catalogapi:fulfillment_instructions",
"@type": "xsd:string"
},
"line_item_ids": {
"@id": "catalogapi:line_item_ids",
"@container": "@list"
},
"shipper": {
"@id": "catalogapi:shipper",
"@type": "xsd:string"
},
"tracking_number": {
"@id": "catalogapi:tracking_number",
"@type": "xsd:string"
},
"virtual_code_link": {
"@id": "catalogapi:virtual_code_link",
"@type": "xsd:string"
},
"virtual_code_pin": {
"@id": "catalogapi:virtual_code_pin",
"@type": "xsd:string"
},
"UpdateCartMetadataRequest": "catalogapi:UpdateCartMetadataRequest"
},
"@type": "schema:Dataset",
"schema:name": "catalogapi-com API JSON-LD context",
"schema:description": "A JSON-LD @context for the objects catalogapi-com'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-30) from openapi/catalogapi-com-openapi.yml.",
"dcterms:created": "2026-10-30",
"dcterms:source": [
"openapi/catalogapi-com-openapi.yml"
]
}