Spree Commerce · JSON-LD Context
Spree Api Context
JSON-LD context defining the semantic vocabulary for Spree Api from Spree Commerce.
0 Classes
857 Properties
3 Namespaces
Namespaces
xsd:
http://www.w3.org/2001/XMLSchema#
schema:
https://schema.org/
spree:
https://spreecommerce.org/api/v3/
Properties
| Property | Type | Container |
|---|---|---|
| PaginationMeta_page | integer | |
| PaginationMeta_limit | integer | |
| PaginationMeta_count | integer | |
| PaginationMeta_pages | integer | |
| PaginationMeta_from | integer | |
| PaginationMeta_to | integer | |
| PaginationMeta_in | integer | |
| PaginationMeta_previous | integer | |
| PaginationMeta_next | integer | |
| PaginationMeta | ||
| ErrorResponse_error | reference | |
| ErrorResponse | ||
| AuthResponse_token | string | |
| AuthResponse_refresh_token | string | |
| AuthResponse_user | reference | |
| AuthResponse | ||
| PermissionRule_allow | reference | |
| PermissionRule_actions | reference | |
| PermissionRule_subjects | reference | |
| PermissionRule_has_conditions | reference | |
| PermissionRule | ||
| MeResponse_user | reference | |
| MeResponse_permissions | reference | |
| MeResponse | ||
| CheckoutRequirement_step | string | |
| CheckoutRequirement_field | string | |
| CheckoutRequirement_message | string | |
| CheckoutRequirement | ||
| CartWarning_code | string | |
| CartWarning_message | string | |
| CartWarning_line_item_id | string | |
| CartWarning_variant_id | string | |
| CartWarning | ||
| FulfillmentManifestItem_item_id | string | |
| FulfillmentManifestItem_variant_id | string | |
| FulfillmentManifestItem_quantity | integer | |
| FulfillmentManifestItem | ||
| AdminUserRoleAssignment_id | string | |
| AdminUserRoleAssignment_name | string | |
| AdminUserRoleAssignment | ||
| PreferenceField_key | string | |
| PreferenceField_type | string | |
| PreferenceField_default | reference | |
| PreferenceField | ||
| PromotionActionCalculator_type | string | |
| PromotionActionCalculator_label | string | |
| PromotionActionCalculator_preferences | reference | |
| PromotionActionCalculator_preference_schema | reference | |
| PromotionActionCalculator | ||
| PromotionActionLineItem_variant_id | string | |
| PromotionActionLineItem_quantity | integer | |
| PromotionActionLineItem | ||
| Address_id | string | |
| Address_first_name | string | |
| Address_last_name | string | |
| Address_full_name | string | |
| Address_address1 | string | |
| Address_address2 | string | |
| Address_postal_code | string | |
| Address_city | string | |
| Address_phone | string | |
| Address_company | string | |
| Address_country_name | string | |
| Address_country_iso | string | |
| Address_state_text | string | |
| Address_state_abbr | string | |
| Address_quick_checkout | reference | |
| Address_is_default_billing | reference | |
| Address_is_default_shipping | reference | |
| Address_state_name | string | |
| Address | ||
| Base_id | string | |
| Base | ||
| Cart_id | string | |
| Cart_market_id | string | |
| Cart_number | string | |
| Cart_token | string | |
| Cart_email | string | |
| Cart_customer_note | string | |
| Cart_currency | string | |
| Cart_locale | string | |
| Cart_total_quantity | reference | |
| Cart_item_total | string | |
| Cart_display_item_total | string | |
| Cart_adjustment_total | string | |
| Cart_display_adjustment_total | string | |
| Cart_discount_total | string | |
| Cart_display_discount_total | string | |
| Cart_tax_total | string | |
| Cart_display_tax_total | string | |
| Cart_included_tax_total | string | |
| Cart_display_included_tax_total | string | |
| Cart_additional_tax_total | string | |
| Cart_display_additional_tax_total | string | |
| Cart_total | string | |
| Cart_display_total | string | |
| Cart_gift_card_total | string | |
| Cart_display_gift_card_total | string | |
| Cart_amount_due | string | |
| Cart_display_amount_due | string | |
| Cart_delivery_total | string | |
| Cart_display_delivery_total | string | |
| Cart_warnings | reference | |
| Cart_store_credit_total | string | |
| Cart_display_store_credit_total | string | |
| Cart_covered_by_store_credit | reference | |
| Cart_current_step | string | |
| Cart_completed_steps | reference | |
| Cart_requirements | reference | |
| Cart_shipping_eq_billing_address | reference | |
| Cart_discounts | reference | |
| Cart_items | reference | |
| Cart_fulfillments | reference | |
| Cart_payments | reference | |
| Cart_billing_address | reference | |
| Cart_shipping_address | reference | |
| Cart_payment_methods | reference | |
| Cart_gift_card | reference | |
| Cart_market | reference | |
| Cart | ||
| Category_id | string | |
| Category_name | string | |
| Category_permalink | string | |
| Category_position | reference | |
| Category_depth | reference | |
| Category_meta_title | string | |
| Category_meta_description | string | |
| Category_meta_keywords | string | |
| Category_children_count | reference | |
| Category_parent_id | string | |
| Category_description | string | |
| Category_description_html | string | |
| Category_image_url | string | |
| Category_square_image_url | string | |
| Category_is_root | reference | |
| Category_is_child | reference | |
| Category_is_leaf | reference | |
| Category_parent | reference | |
| Category_children | reference | |
| Category_ancestors | reference | |
| Category_custom_fields | reference | |
| Category | ||
| Channel_id | string | |
| Channel_name | string | |
| Channel_code | string | |
| Channel_active | reference | |
| Channel | ||
| Country_iso | string | |
| Country_iso3 | string | |
| Country_name | string | |
| Country_states_required | reference | |
| Country_zipcode_required | reference | |
| Country_states | reference | |
| Country_market | reference | |
| Country | ||
| CreditCard_id | string | |
| CreditCard_brand | string | |
| CreditCard_last4 | string | |
| CreditCard_month | reference | |
| CreditCard_year | reference | |
| CreditCard_name | string | |
| CreditCard_default | reference | |
| CreditCard_gateway_payment_profile_id | string | |
| CreditCard | ||
| Currency_iso_code | string | |
| Currency_name | string | |
| Currency_symbol | string | |
| Currency | ||
| CustomField_id | string | |
| CustomField_label | string | |
| CustomField_type | string | |
| CustomField_field_type | string | |
| CustomField_key | string | |
| CustomField_value | reference | |
| CustomField | ||
| Customer_id | string | |
| Customer_email | string | |
| Customer_first_name | string | |
| Customer_last_name | string | |
| Customer_phone | string | |
| Customer_accepts_email_marketing | reference | |
| Customer_full_name | string | |
| Customer_available_store_credit_total | string | |
| Customer_display_available_store_credit_total | string | |
| Customer_addresses | reference | |
| Customer_default_billing_address | reference | |
| Customer_default_shipping_address | reference | |
| Customer | ||
| DeliveryMethod_id | string | |
| DeliveryMethod_name | string | |
| DeliveryMethod_code | string | |
| DeliveryMethod | ||
| DeliveryRate_id | string | |
| DeliveryRate_delivery_method_id | string | |
| DeliveryRate_name | string | |
| DeliveryRate_selected | reference | |
| DeliveryRate_cost | string | |
| DeliveryRate_total | string | |
| DeliveryRate_additional_tax_total | string | |
| DeliveryRate_included_tax_total | string | |
| DeliveryRate_tax_total | string | |
| DeliveryRate_display_cost | string | |
| DeliveryRate_display_total | string | |
| DeliveryRate_display_additional_tax_total | string | |
| DeliveryRate_display_included_tax_total | string | |
| DeliveryRate_display_tax_total | string | |
| DeliveryRate_delivery_method | reference | |
| DeliveryRate | ||
| DigitalLink_id | string | |
| DigitalLink_access_counter | reference | |
| DigitalLink_filename | string | |
| DigitalLink_content_type | string | |
| DigitalLink_download_url | string | |
| DigitalLink_authorizable | reference | |
| DigitalLink_expired | reference | |
| DigitalLink_access_limit_exceeded | reference | |
| DigitalLink | ||
| Digital_id | string | |
| Digital_created_at | string | |
| Digital_updated_at | string | |
| Digital_variant_id | string | |
| Digital | ||
| Discount_id | string | |
| Discount_promotion_id | string | |
| Discount_name | string | |
| Discount_description | string | |
| Discount_code | string | |
| Discount_amount | string | |
| Discount_display_amount | string | |
| Discount | ||
| Fulfillment_id | string | |
| Fulfillment_number | string | |
| Fulfillment_tracking | string | |
| Fulfillment_tracking_url | string | |
| Fulfillment_cost | string | |
| Fulfillment_display_cost | string | |
| Fulfillment_total | string | |
| Fulfillment_display_total | string | |
| Fulfillment_discount_total | string | |
| Fulfillment_display_discount_total | string | |
| Fulfillment_additional_tax_total | string | |
| Fulfillment_display_additional_tax_total | string | |
| Fulfillment_included_tax_total | string | |
| Fulfillment_display_included_tax_total | string | |
| Fulfillment_tax_total | string | |
| Fulfillment_display_tax_total | string | |
| Fulfillment_status | string | |
| Fulfillment_fulfillment_type | string | |
| Fulfillment_fulfilled_at | string | |
| Fulfillment_items | reference | |
| Fulfillment_delivery_method | reference | |
| Fulfillment_stock_location | reference | |
| Fulfillment_delivery_rates | reference | |
| Fulfillment | ||
| GiftCardBatch_id | string | |
| GiftCardBatch_codes_count | reference | |
| GiftCardBatch_currency | string | |
| GiftCardBatch_prefix | string | |
| GiftCardBatch_created_at | string | |
| GiftCardBatch_updated_at | string | |
| GiftCardBatch_amount | string | |
| GiftCardBatch_expires_at | string | |
| GiftCardBatch_created_by_id | string | |
| GiftCardBatch | ||
| GiftCard_id | string | |
| GiftCard_code | string | |
| GiftCard_status | string | |
| GiftCard_currency | string | |
| GiftCard_amount | string | |
| GiftCard_amount_used | string | |
| GiftCard_amount_authorized | string | |
| GiftCard_amount_remaining | string | |
| GiftCard_display_amount | string | |
| GiftCard_display_amount_used | string | |
| GiftCard_display_amount_remaining | string | |
| GiftCard_expires_at | string | |
| GiftCard_redeemed_at | string | |
| GiftCard_expired | reference | |
| GiftCard_active | reference | |
| GiftCard | ||
| Invitation_id | string | |
| Invitation_email | string | |
| Invitation_resource_type | string | |
| Invitation_inviter_type | string | |
| Invitation_invitee_type | string | |
| Invitation_created_at | string | |
| Invitation_updated_at | string | |
| Invitation_status | string | |
| Invitation_resource_id | string | |
| Invitation_inviter_id | string | |
| Invitation_invitee_id | string | |
| Invitation_role_id | string | |
| Invitation_expires_at | string | |
| Invitation_accepted_at | string | |
| Invitation | ||
| LineItem_id | string | |
| LineItem_variant_id | string | |
| LineItem_quantity | reference | |
| LineItem_currency | string | |
| LineItem_name | string | |
| LineItem_slug | string | |
| LineItem_options_text | string | |
| LineItem_price | string | |
| LineItem_display_price | string | |
| LineItem_total | string | |
| LineItem_display_total | string | |
| LineItem_adjustment_total | string | |
| LineItem_display_adjustment_total | string | |
| LineItem_additional_tax_total | string | |
| LineItem_display_additional_tax_total | string | |
| LineItem_included_tax_total | string | |
| LineItem_display_included_tax_total | string | |
| LineItem_discount_total | string | |
| LineItem_display_discount_total | string | |
| LineItem_pre_tax_amount | string | |
| LineItem_display_pre_tax_amount | string | |
| LineItem_discounted_amount | string | |
| LineItem_display_discounted_amount | string | |
| LineItem_display_compare_at_amount | string | |
| LineItem_compare_at_amount | string | |
| LineItem_thumbnail_url | string | |
| LineItem_option_values | reference | |
| LineItem_digital_links | reference | |
| LineItem | ||
| Locale_code | string | |
| Locale_name | string | |
| Locale | ||
| Market_id | string | |
| Market_name | string | |
| Market_currency | string | |
| Market_default_locale | string | |
| Market_tax_inclusive | reference | |
| Market_default | reference | |
| Market_country_isos | reference | |
| Market_supported_locales | reference | |
| Market_countries | reference | |
| Market | ||
| Media_id | string | |
| Media_product_id | string | |
| Media_variant_ids | reference | |
| Media_position | reference | |
| Media_alt | string | |
| Media_media_type | string | |
| Media_focal_point_x | reference | |
| Media_focal_point_y | reference | |
| Media_external_video_url | string | |
| Media_original_url | string | |
| Media_mini_url | string | |
| Media_small_url | string | |
| Media_medium_url | string | |
| Media_large_url | string | |
| Media_xlarge_url | string | |
| Media_og_image_url | string | |
| Media | ||
| NewsletterSubscriber_id | string | |
| NewsletterSubscriber_email | string | |
| NewsletterSubscriber_created_at | string | |
| NewsletterSubscriber_updated_at | string | |
| NewsletterSubscriber_verified | reference | |
| NewsletterSubscriber_verified_at | string | |
| NewsletterSubscriber_customer_id | string | |
| NewsletterSubscriber | ||
| OptionType_id | string | |
| OptionType_name | string | |
| OptionType_label | string | |
| OptionType_position | reference | |
| OptionType_kind | string | |
| OptionType | ||
| OptionValue_id | string | |
| OptionValue_option_type_id | string | |
| OptionValue_name | string | |
| OptionValue_label | string | |
| OptionValue_position | reference | |
| OptionValue_color_code | string | |
| OptionValue_option_type_name | string | |
| OptionValue_option_type_label | string | |
| OptionValue_image_url | string | |
| OptionValue | ||
| Order_id | string | |
| Order_market_id | string | |
| Order_channel_id | string | |
| Order_number | string | |
| Order_email | string | |
| Order_customer_note | string | |
| Order_currency | string | |
| Order_locale | string | |
| Order_total_quantity | reference | |
| Order_item_total | string | |
| Order_display_item_total | string | |
| Order_adjustment_total | string | |
| Order_display_adjustment_total | string | |
| Order_discount_total | string | |
| Order_display_discount_total | string | |
| Order_tax_total | string | |
| Order_display_tax_total | string | |
| Order_included_tax_total | string | |
| Order_display_included_tax_total | string | |
| Order_additional_tax_total | string | |
| Order_display_additional_tax_total | string | |
| Order_total | string | |
| Order_display_total | string | |
| Order_gift_card_total | string | |
| Order_display_gift_card_total | string | |
| Order_amount_due | string | |
| Order_display_amount_due | string | |
| Order_delivery_total | string | |
| Order_display_delivery_total | string | |
| Order_fulfillment_status | string | |
| Order_payment_status | string | |
| Order_completed_at | string | |
| Order_store_credit_total | string | |
| Order_display_store_credit_total | string | |
| Order_covered_by_store_credit | reference | |
| Order_discounts | reference | |
| Order_items | reference | |
| Order_fulfillments | reference | |
| Order_payments | reference | |
| Order_billing_address | reference | |
| Order_shipping_address | reference | |
| Order_gift_card | reference | |
| Order_market | reference | |
| Order | ||
| PaymentMethod_id | string | |
| PaymentMethod_name | string | |
| PaymentMethod_description | string | |
| PaymentMethod_type | string | |
| PaymentMethod_session_required | reference | |
| PaymentMethod_source_required | reference | |
| PaymentMethod | ||
| Payment_id | string | |
| Payment_payment_method_id | string | |
| Payment_response_code | string | |
| Payment_number | string | |
| Payment_amount | string | |
| Payment_display_amount | string | |
| Payment_status | string | |
| Payment_source_type | string | |
| Payment_source_id | string | |
| Payment_source | reference | |
| Payment_payment_method | reference | |
| Payment | ||
| PaymentSession_id | string | |
| PaymentSession_status | string | |
| PaymentSession_currency | string | |
| PaymentSession_external_id | string | |
| PaymentSession_external_data | reference | |
| PaymentSession_customer_external_id | string | |
| PaymentSession_expires_at | string | |
| PaymentSession_amount | string | |
| PaymentSession_payment_method_id | string | |
| PaymentSession_order_id | string | |
| PaymentSession_payment_method | reference | |
| PaymentSession_payment | reference | |
| PaymentSession | ||
| PaymentSetupSession_id | string | |
| PaymentSetupSession_status | string | |
| PaymentSetupSession_external_id | string | |
| PaymentSetupSession_external_client_secret | string | |
| PaymentSetupSession_external_data | reference | |
| PaymentSetupSession_payment_method_id | string | |
| PaymentSetupSession_payment_source_id | string | |
| PaymentSetupSession_payment_source_type | string | |
| PaymentSetupSession_customer_id | string | |
| PaymentSetupSession_payment_method | reference | |
| PaymentSetupSession | ||
| PaymentSource_id | string | |
| PaymentSource_gateway_payment_profile_id | string | |
| PaymentSource | ||
| Policy_id | string | |
| Policy_name | string | |
| Policy_slug | string | |
| Policy_body | string | |
| Policy_body_html | string | |
| Policy | ||
| PriceHistory_id | string | |
| PriceHistory_amount | string | |
| PriceHistory_amount_in_cents | reference | |
| PriceHistory_currency | string | |
| PriceHistory_display_amount | string | |
| PriceHistory_recorded_at | string | |
| PriceHistory | ||
| Price_id | string | |
| Price_amount | string | |
| Price_amount_in_cents | reference | |
| Price_compare_at_amount | string | |
| Price_compare_at_amount_in_cents | reference | |
| Price_currency | string | |
| Price_display_amount | string | |
| Price_display_compare_at_amount | string | |
| Price_price_list_id | string | |
| Price | ||
| Product_id | string | |
| Product_name | string | |
| Product_slug | string | |
| Product_meta_title | string | |
| Product_meta_description | string | |
| Product_meta_keywords | string | |
| Product_variant_count | reference | |
| Product_available_on | string | |
| Product_purchasable | reference | |
| Product_in_stock | reference | |
| Product_backorderable | reference | |
| Product_available | reference | |
| Product_description | string | |
| Product_description_html | string | |
| Product_default_variant_id | string | |
| Product_thumbnail_url | string | |
| Product_tags | reference | |
| Product_price | reference | |
| Product_original_price | reference | |
| Product_primary_media | reference | |
| Product_media | reference | |
| Product_variants | reference | |
| Product_default_variant | reference | |
| Product_option_types | reference | |
| Product_categories | reference | |
| Product_custom_fields | reference | |
| Product_prior_price | reference | |
| Product | ||
| Promotion_id | string | |
| Promotion_name | string | |
| Promotion_description | string | |
| Promotion_code | string | |
| Promotion | ||
| Refund_id | string | |
| Refund_transaction_id | string | |
| Refund_amount | string | |
| Refund_payment_id | string | |
| Refund_refund_reason_id | string | |
| Refund_reimbursement_id | string | |
| Refund | ||
| ReturnAuthorization_id | string | |
| ReturnAuthorization_number | string | |
| ReturnAuthorization_status | string | |
| ReturnAuthorization_order_id | string | |
| ReturnAuthorization_stock_location_id | string | |
| ReturnAuthorization_return_authorization_reason_id | string | |
| ReturnAuthorization | ||
| ReturnItem_id | string | |
| ReturnItem_reception_status | string | |
| ReturnItem_acceptance_status | string | |
| ReturnItem_created_at | string | |
| ReturnItem_updated_at | string | |
| ReturnItem_pre_tax_amount | string | |
| ReturnItem_included_tax_total | string | |
| ReturnItem_additional_tax_total | string | |
| ReturnItem_inventory_unit_id | string | |
| ReturnItem_return_authorization_id | string | |
| ReturnItem_customer_return_id | string | |
| ReturnItem_reimbursement_id | string | |
| ReturnItem_exchange_variant_id | string | |
| ReturnItem | ||
| State_abbr | string | |
| State_name | string | |
| State | ||
| StockLocation_id | string | |
| StockLocation_state_abbr | string | |
| StockLocation_name | string | |
| StockLocation_address1 | string | |
| StockLocation_city | string | |
| StockLocation_zipcode | string | |
| StockLocation_country_iso | string | |
| StockLocation_country_name | string | |
| StockLocation_state_text | string | |
| StockLocation | ||
| StockReservation_id | string | |
| StockReservation | ||
| StoreCredit_id | string | |
| StoreCredit_amount | string | |
| StoreCredit_amount_used | string | |
| StoreCredit_amount_remaining | string | |
| StoreCredit_display_amount | string | |
| StoreCredit_display_amount_used | string | |
| StoreCredit_display_amount_remaining | string | |
| StoreCredit_currency | string | |
| StoreCredit | ||
| Variant_id | string | |
| Variant_product_id | string | |
| Variant_sku | string | |
| Variant_options_text | string | |
| Variant_track_inventory | reference | |
| Variant_media_count | reference | |
| Variant_thumbnail_url | string | |
| Variant_purchasable | reference | |
| Variant_in_stock | reference | |
| Variant_backorderable | reference | |
| Variant_weight | reference | |
| Variant_height | reference | |
| Variant_width | reference | |
| Variant_depth | reference | |
| Variant_price | reference | |
| Variant_original_price | reference | |
| Variant_primary_media | reference | |
| Variant_media | reference | |
| Variant_option_values | reference | |
| Variant_custom_fields | reference | |
| Variant_prior_price | reference | |
| Variant | ||
| WishlistItem_id | string | |
| WishlistItem_variant_id | string | |
| WishlistItem_wishlist_id | string | |
| WishlistItem_quantity | reference | |
| WishlistItem_variant | reference | |
| WishlistItem | ||
| Wishlist_id | string | |
| Wishlist_name | string | |
| Wishlist_token | string | |
| Wishlist_is_default | reference | |
| Wishlist_is_private | reference | |
| Wishlist_items | reference | |
| Wishlist | ||
| Adjustment_id | string | |
| Adjustment_label | string | |
| Adjustment_display_amount | string | |
| Adjustment_included | reference | |
| Adjustment_created_at | string | |
| Adjustment_updated_at | string | |
| Adjustment_amount | string | |
| Adjustment_order_id | string | |
| Adjustment | ||
| AdminUser_id | string | |
| AdminUser_email | string | |
| AdminUser_first_name | string | |
| AdminUser_last_name | string | |
| AdminUser_full_name | string | |
| AdminUser_created_at | string | |
| AdminUser_updated_at | string | |
| AdminUser_roles | reference | |
| AdminUser | ||
| AllowedOrigin_id | string | |
| AllowedOrigin_origin | string | |
| AllowedOrigin_created_at | string | |
| AllowedOrigin_updated_at | string | |
| AllowedOrigin | ||
| ApiKey_id | string | |
| ApiKey_name | string | |
| ApiKey_key_type | string | |
| ApiKey_token_prefix | string | |
| ApiKey_scopes | reference | |
| ApiKey_created_at | string | |
| ApiKey_updated_at | string | |
| ApiKey_revoked_at | string | |
| ApiKey_last_used_at | string | |
| ApiKey_plaintext_token | string | |
| ApiKey_created_by_email | string | |
| ApiKey | ||
| CouponCode_id | string | |
| CouponCode_code | string | |
| CouponCode_state | string | |
| CouponCode_created_at | string | |
| CouponCode_updated_at | string | |
| CouponCode_promotion_id | string | |
| CouponCode_order_id | string | |
| CouponCode | ||
| CustomFieldDefinition_id | string | |
| CustomFieldDefinition_namespace | string | |
| CustomFieldDefinition_key | string | |
| CustomFieldDefinition_label | string | |
| CustomFieldDefinition_field_type | string | |
| CustomFieldDefinition_resource_type | string | |
| CustomFieldDefinition_storefront_visible | reference | |
| CustomFieldDefinition_created_at | string | |
| CustomFieldDefinition_updated_at | string | |
| CustomFieldDefinition | ||
| CustomerGroup_id | string | |
| CustomerGroup_name | string | |
| CustomerGroup_description | string | |
| CustomerGroup_customers_count | reference | |
| CustomerGroup_created_at | string | |
| CustomerGroup_updated_at | string | |
| CustomerGroup_customers | reference | |
| CustomerGroup | ||
| Export_id | string | |
| Export_number | string | |
| Export_type | string | |
| Export_format | string | |
| Export_created_at | string | |
| Export_updated_at | string | |
| Export_user_id | string | |
| Export_done | reference | |
| Export_filename | string | |
| Export_byte_size | reference | |
| Export_download_url | string | |
| Export | ||
| PriceList_id | string | |
| PriceList_name | string | |
| PriceList_description | string | |
| PriceList_status | string | |
| PriceList_position | reference | |
| PriceList_match_policy | string | |
| PriceList_starts_at | string | |
| PriceList_ends_at | string | |
| PriceList_deleted_at | string | |
| PriceList_created_at | string | |
| PriceList_updated_at | string | |
| PriceList_currently_active | reference | |
| PriceList_products_count | reference | |
| PriceList_prices_count | reference | |
| PriceList_product_ids | reference | |
| PriceList_price_rules | reference | |
| PriceList | ||
| PriceRule_id | string | |
| PriceRule_created_at | string | |
| PriceRule_updated_at | string | |
| PriceRule_type | string | |
| PriceRule_price_list_id | string | |
| PriceRule_preferences | reference | |
| PriceRule_preference_schema | reference | |
| PriceRule_label | string | |
| PriceRule_description | string | |
| PriceRule_markets | reference | |
| PriceRule_customer_groups | reference | |
| PriceRule_customers | reference | |
| PriceRule | ||
| ProductPublication_id | string | |
| ProductPublication_published_at | string | |
| ProductPublication_unpublished_at | string | |
| ProductPublication_product_id | string | |
| ProductPublication_channel_id | string | |
| ProductPublication_created_at | string | |
| ProductPublication_updated_at | string | |
| ProductPublication | ||
| PromotionAction_id | string | |
| PromotionAction_created_at | string | |
| PromotionAction_updated_at | string | |
| PromotionAction_type | string | |
| PromotionAction_promotion_id | string | |
| PromotionAction_preferences | reference | |
| PromotionAction_preference_schema | reference | |
| PromotionAction_label | string | |
| PromotionAction_calculator | reference | |
| PromotionAction_line_items | reference | |
| PromotionAction | ||
| PromotionRule_id | string | |
| PromotionRule_created_at | string | |
| PromotionRule_updated_at | string | |
| PromotionRule_type | string | |
| PromotionRule_promotion_id | string | |
| PromotionRule_preferences | reference | |
| PromotionRule_preference_schema | reference | |
| PromotionRule_label | string | |
| PromotionRule_product_ids | reference | |
| PromotionRule_category_ids | reference | |
| PromotionRule_customer_ids | reference | |
| PromotionRule_products | reference | |
| PromotionRule_categories | reference | |
| PromotionRule_customers | reference | |
| PromotionRule_customer_groups | reference | |
| PromotionRule_countries | reference | |
| PromotionRule | ||
| Reimbursement_id | string | |
| Reimbursement_number | string | |
| Reimbursement_reimbursement_status | string | |
| Reimbursement_total | string | |
| Reimbursement_order_id | string | |
| Reimbursement_customer_return_id | string | |
| Reimbursement_created_at | string | |
| Reimbursement_updated_at | string | |
| Reimbursement_order | reference | |
| Reimbursement | ||
| Role_id | string | |
| Role_name | string | |
| Role_created_at | string | |
| Role_updated_at | string | |
| Role | ||
| StockItem_id | string | |
| StockItem_count_on_hand | reference | |
| StockItem_backorderable | reference | |
| StockItem_stock_location_id | string | |
| StockItem_variant_id | string | |
| StockItem_metadata | reference | |
| StockItem_created_at | string | |
| StockItem_updated_at | string | |
| StockItem_allocated_count | reference | |
| StockItem_available_count | reference | |
| StockItem_stock_location | reference | |
| StockItem_variant | reference | |
| StockItem | ||
| StockTransfer_id | string | |
| StockTransfer_number | string | |
| StockTransfer_reference | string | |
| StockTransfer_metadata | reference | |
| StockTransfer_created_at | string | |
| StockTransfer_updated_at | string | |
| StockTransfer_source_location_id | string | |
| StockTransfer_destination_location_id | string | |
| StockTransfer_source_location | reference | |
| StockTransfer_destination_location | reference | |
| StockTransfer | ||
| StoreCreditCategory_id | string | |
| StoreCreditCategory_name | string | |
| StoreCreditCategory_created_at | string | |
| StoreCreditCategory_updated_at | string | |
| StoreCreditCategory_non_expiring | reference | |
| StoreCreditCategory | ||
| Store_id | string | |
| Store_metadata | reference | |
| Store_name | string | |
| Store_default_currency | string | |
| Store_default_locale | string | |
| Store_mail_from_address | string | |
| Store_customer_support_email | string | |
| Store_new_order_notifications_email | string | |
| Store_preferred_send_consumer_transactional_emails | reference | |
| Store_preferred_admin_locale | string | |
| Store_preferred_timezone | string | |
| Store_preferred_weight_unit | string | |
| Store_preferred_unit_system | string | |
| Store_created_at | string | |
| Store_updated_at | string | |
| Store_url | string | |
| Store_supported_currencies | reference | |
| Store_supported_locales | reference | |
| Store_logo_url | string | |
| Store_mailer_logo_url | string | |
| Store | ||
| TaxCategory_id | string | |
| TaxCategory_name | string | |
| TaxCategory_tax_code | string | |
| TaxCategory_description | string | |
| TaxCategory_is_default | reference | |
| TaxCategory_created_at | string | |
| TaxCategory_updated_at | string | |
| TaxCategory | ||
| WebhookDelivery_id | string | |
| WebhookDelivery_event_name | string | |
| WebhookDelivery_event_id | string | |
| WebhookDelivery_response_code | reference | |
| WebhookDelivery_execution_time | reference | |
| WebhookDelivery_error_type | string | |
| WebhookDelivery_request_errors | string | |
| WebhookDelivery_response_body | string | |
| WebhookDelivery_success | reference | |
| WebhookDelivery_payload | reference | |
| WebhookDelivery_created_at | string | |
| WebhookDelivery_updated_at | string | |
| WebhookDelivery_delivered_at | string | |
| WebhookDelivery_webhook_endpoint_id | string | |
| WebhookDelivery_webhook_endpoint_url | string | |
| WebhookDelivery | ||
| WebhookEndpoint_id | string | |
| WebhookEndpoint_name | string | |
| WebhookEndpoint_url | string | |
| WebhookEndpoint_active | reference | |
| WebhookEndpoint_subscriptions | reference | |
| WebhookEndpoint_disabled_reason | string | |
| WebhookEndpoint_created_at | string | |
| WebhookEndpoint_updated_at | string | |
| WebhookEndpoint_disabled_at | string | |
| WebhookEndpoint_secret_key | string | |
| WebhookEndpoint_last_delivery_at | string | |
| WebhookEndpoint_recent_delivery_count | reference | |
| WebhookEndpoint_recent_failure_count | reference | |
| WebhookEndpoint_total_delivery_count | reference | |
| WebhookEndpoint_successful_delivery_count | reference | |
| WebhookEndpoint_failed_delivery_count | reference | |
| WebhookEndpoint |
JSON-LD Document
{
"@context": {
"@vocab": "https://spreecommerce.org/api/v3/",
"xsd": "http://www.w3.org/2001/XMLSchema#",
"schema": "https://schema.org/",
"spree": "https://spreecommerce.org/api/v3/",
"PaginationMeta_page": {
"@id": "spree:PaginationMeta/page",
"@type": "xsd:integer"
},
"PaginationMeta_limit": {
"@id": "spree:PaginationMeta/limit",
"@type": "xsd:integer"
},
"PaginationMeta_count": {
"@id": "spree:PaginationMeta/count",
"@type": "xsd:integer"
},
"PaginationMeta_pages": {
"@id": "spree:PaginationMeta/pages",
"@type": "xsd:integer"
},
"PaginationMeta_from": {
"@id": "spree:PaginationMeta/from",
"@type": "xsd:integer"
},
"PaginationMeta_to": {
"@id": "spree:PaginationMeta/to",
"@type": "xsd:integer"
},
"PaginationMeta_in": {
"@id": "spree:PaginationMeta/in",
"@type": "xsd:integer"
},
"PaginationMeta_previous": {
"@id": "spree:PaginationMeta/previous",
"@type": "xsd:integer"
},
"PaginationMeta_next": {
"@id": "spree:PaginationMeta/next",
"@type": "xsd:integer"
},
"PaginationMeta": {
"@id": "spree:PaginationMeta"
},
"ErrorResponse_error": {
"@id": "spree:ErrorResponse/error",
"@type": "@id"
},
"ErrorResponse": {
"@id": "spree:ErrorResponse"
},
"AuthResponse_token": {
"@id": "spree:AuthResponse/token",
"@type": "xsd:string"
},
"AuthResponse_refresh_token": {
"@id": "spree:AuthResponse/refresh_token",
"@type": "xsd:string"
},
"AuthResponse_user": {
"@id": "spree:AuthResponse/user",
"@type": "@id"
},
"AuthResponse": {
"@id": "spree:AuthResponse"
},
"PermissionRule_allow": {
"@id": "spree:PermissionRule/allow",
"@type": "@id"
},
"PermissionRule_actions": {
"@id": "spree:PermissionRule/actions",
"@type": "@id"
},
"PermissionRule_subjects": {
"@id": "spree:PermissionRule/subjects",
"@type": "@id"
},
"PermissionRule_has_conditions": {
"@id": "spree:PermissionRule/has_conditions",
"@type": "@id"
},
"PermissionRule": {
"@id": "spree:PermissionRule",
"@comment": "A single permission rule (CanCanCan rule). Rules are applied in order, last-matching-wins."
},
"MeResponse_user": {
"@id": "spree:MeResponse/user",
"@type": "@id"
},
"MeResponse_permissions": {
"@id": "spree:MeResponse/permissions",
"@type": "@id"
},
"MeResponse": {
"@id": "spree:MeResponse",
"@comment": "Current admin user profile and serialized permissions"
},
"CheckoutRequirement_step": {
"@id": "spree:CheckoutRequirement/step",
"@type": "xsd:string"
},
"CheckoutRequirement_field": {
"@id": "spree:CheckoutRequirement/field",
"@type": "xsd:string"
},
"CheckoutRequirement_message": {
"@id": "spree:CheckoutRequirement/message",
"@type": "xsd:string"
},
"CheckoutRequirement": {
"@id": "spree:CheckoutRequirement"
},
"CartWarning_code": {
"@id": "spree:CartWarning/code",
"@type": "xsd:string"
},
"CartWarning_message": {
"@id": "spree:CartWarning/message",
"@type": "xsd:string"
},
"CartWarning_line_item_id": {
"@id": "spree:CartWarning/line_item_id",
"@type": "xsd:string"
},
"CartWarning_variant_id": {
"@id": "spree:CartWarning/variant_id",
"@type": "xsd:string"
},
"CartWarning": {
"@id": "spree:CartWarning",
"@comment": "A warning about a cart issue (e.g., item removed due to stock change)"
},
"FulfillmentManifestItem_item_id": {
"@id": "spree:FulfillmentManifestItem/item_id",
"@type": "xsd:string"
},
"FulfillmentManifestItem_variant_id": {
"@id": "spree:FulfillmentManifestItem/variant_id",
"@type": "xsd:string"
},
"FulfillmentManifestItem_quantity": {
"@id": "spree:FulfillmentManifestItem/quantity",
"@type": "xsd:integer"
},
"FulfillmentManifestItem": {
"@id": "spree:FulfillmentManifestItem",
"@comment": "An item within a fulfillment \u2014 which line item and how many units are in this fulfillment"
},
"AdminUserRoleAssignment_id": {
"@id": "spree:AdminUserRoleAssignment/id",
"@type": "xsd:string"
},
"AdminUserRoleAssignment_name": {
"@id": "spree:AdminUserRoleAssignment/name",
"@type": "xsd:string"
},
"AdminUserRoleAssignment": {
"@id": "spree:AdminUserRoleAssignment",
"@comment": "A role assignment for the current store on a staff member"
},
"PreferenceField_key": {
"@id": "spree:PreferenceField/key",
"@type": "xsd:string"
},
"PreferenceField_type": {
"@id": "spree:PreferenceField/type",
"@type": "xsd:string"
},
"PreferenceField_default": {
"@id": "spree:PreferenceField/default",
"@type": "@id"
},
"PreferenceField": {
"@id": "spree:PreferenceField",
"@comment": "A single configurable preference on a payment method, promotion rule/action, or calculator. The frontend uses `type` + `default` to render a sensible input."
},
"PromotionActionCalculator_type": {
"@id": "spree:PromotionActionCalculator/type",
"@type": "xsd:string"
},
"PromotionActionCalculator_label": {
"@id": "spree:PromotionActionCalculator/label",
"@type": "xsd:string"
},
"PromotionActionCalculator_preferences": {
"@id": "spree:PromotionActionCalculator/preferences",
"@type": "@id"
},
"PromotionActionCalculator_preference_schema": {
"@id": "spree:PromotionActionCalculator/preference_schema",
"@type": "@id"
},
"PromotionActionCalculator": {
"@id": "spree:PromotionActionCalculator",
"@comment": "The action's nested calculator (when the action carries one \u2014 null for actions like `free_shipping`)"
},
"PromotionActionLineItem_variant_id": {
"@id": "spree:PromotionActionLineItem/variant_id",
"@type": "xsd:string"
},
"PromotionActionLineItem_quantity": {
"@id": "spree:PromotionActionLineItem/quantity",
"@type": "xsd:integer"
},
"PromotionActionLineItem": {
"@id": "spree:PromotionActionLineItem",
"@comment": "One row in a `create_line_items` action \u2014 the variant added to the order and how many"
},
"Address_id": {
"@id": "spree:Address/id",
"@type": "xsd:string"
},
"Address_first_name": {
"@id": "spree:Address/first_name",
"@type": "xsd:string"
},
"Address_last_name": {
"@id": "spree:Address/last_name",
"@type": "xsd:string"
},
"Address_full_name": {
"@id": "spree:Address/full_name",
"@type": "xsd:string"
},
"Address_address1": {
"@id": "spree:Address/address1",
"@type": "xsd:string"
},
"Address_address2": {
"@id": "spree:Address/address2",
"@type": "xsd:string"
},
"Address_postal_code": {
"@id": "spree:Address/postal_code",
"@type": "xsd:string"
},
"Address_city": {
"@id": "spree:Address/city",
"@type": "xsd:string"
},
"Address_phone": {
"@id": "spree:Address/phone",
"@type": "xsd:string"
},
"Address_company": {
"@id": "spree:Address/company",
"@type": "xsd:string"
},
"Address_country_name": {
"@id": "spree:Address/country_name",
"@type": "xsd:string"
},
"Address_country_iso": {
"@id": "spree:Address/country_iso",
"@type": "xsd:string"
},
"Address_state_text": {
"@id": "spree:Address/state_text",
"@type": "xsd:string"
},
"Address_state_abbr": {
"@id": "spree:Address/state_abbr",
"@type": "xsd:string"
},
"Address_quick_checkout": {
"@id": "spree:Address/quick_checkout",
"@type": "@id"
},
"Address_is_default_billing": {
"@id": "spree:Address/is_default_billing",
"@type": "@id"
},
"Address_is_default_shipping": {
"@id": "spree:Address/is_default_shipping",
"@type": "@id"
},
"Address_state_name": {
"@id": "spree:Address/state_name",
"@type": "xsd:string"
},
"Address": {
"@id": "schema:PostalAddress"
},
"Base_id": {
"@id": "spree:Base/id",
"@type": "xsd:string"
},
"Base": {
"@id": "spree:Base"
},
"Cart_id": {
"@id": "spree:Cart/id",
"@type": "xsd:string"
},
"Cart_market_id": {
"@id": "spree:Cart/market_id",
"@type": "xsd:string"
},
"Cart_number": {
"@id": "spree:Cart/number",
"@type": "xsd:string"
},
"Cart_token": {
"@id": "spree:Cart/token",
"@type": "xsd:string"
},
"Cart_email": {
"@id": "spree:Cart/email",
"@type": "xsd:string"
},
"Cart_customer_note": {
"@id": "spree:Cart/customer_note",
"@type": "xsd:string"
},
"Cart_currency": {
"@id": "spree:Cart/currency",
"@type": "xsd:string"
},
"Cart_locale": {
"@id": "spree:Cart/locale",
"@type": "xsd:string"
},
"Cart_total_quantity": {
"@id": "spree:Cart/total_quantity",
"@type": "@id"
},
"Cart_item_total": {
"@id": "spree:Cart/item_total",
"@type": "xsd:string"
},
"Cart_display_item_total": {
"@id": "spree:Cart/display_item_total",
"@type": "xsd:string"
},
"Cart_adjustment_total": {
"@id": "spree:Cart/adjustment_total",
"@type": "xsd:string"
},
"Cart_display_adjustment_total": {
"@id": "spree:Cart/display_adjustment_total",
"@type": "xsd:string"
},
"Cart_discount_total": {
"@id": "spree:Cart/discount_total",
"@type": "xsd:string"
},
"Cart_display_discount_total": {
"@id": "spree:Cart/display_discount_total",
"@type": "xsd:string"
},
"Cart_tax_total": {
"@id": "spree:Cart/tax_total",
"@type": "xsd:string"
},
"Cart_display_tax_total": {
"@id": "spree:Cart/display_tax_total",
"@type": "xsd:string"
},
"Cart_included_tax_total": {
"@id": "spree:Cart/included_tax_total",
"@type": "xsd:string"
},
"Cart_display_included_tax_total": {
"@id": "spree:Cart/display_included_tax_total",
"@type": "xsd:string"
},
"Cart_additional_tax_total": {
"@id": "spree:Cart/additional_tax_total",
"@type": "xsd:string"
},
"Cart_display_additional_tax_total": {
"@id": "spree:Cart/display_additional_tax_total",
"@type": "xsd:string"
},
"Cart_total": {
"@id": "spree:Cart/total",
"@type": "xsd:string"
},
"Cart_display_total": {
"@id": "spree:Cart/display_total",
"@type": "xsd:string"
},
"Cart_gift_card_total": {
"@id": "spree:Cart/gift_card_total",
"@type": "xsd:string"
},
"Cart_display_gift_card_total": {
"@id": "spree:Cart/display_gift_card_total",
"@type": "xsd:string"
},
"Cart_amount_due": {
"@id": "spree:Cart/amount_due",
"@type": "xsd:string"
},
"Cart_display_amount_due": {
"@id": "spree:Cart/display_amount_due",
"@type": "xsd:string"
},
"Cart_delivery_total": {
"@id": "spree:Cart/delivery_total",
"@type": "xsd:string"
},
"Cart_display_delivery_total": {
"@id": "spree:Cart/display_delivery_total",
"@type": "xsd:string"
},
"Cart_warnings": {
"@id": "spree:Cart/warnings",
"@type": "@id"
},
"Cart_store_credit_total": {
"@id": "spree:Cart/store_credit_total",
"@type": "xsd:string"
},
"Cart_display_store_credit_total": {
"@id": "spree:Cart/display_store_credit_total",
"@type": "xsd:string"
},
"Cart_covered_by_store_credit": {
"@id": "spree:Cart/covered_by_store_credit",
"@type": "@id"
},
"Cart_current_step": {
"@id": "spree:Cart/current_step",
"@type": "xsd:string"
},
"Cart_completed_steps": {
"@id": "spree:Cart/completed_steps",
"@type": "@id"
},
"Cart_requirements": {
"@id": "spree:Cart/requirements",
"@type": "@id"
},
"Cart_shipping_eq_billing_address": {
"@id": "spree:Cart/shipping_eq_billing_address",
"@type": "@id"
},
"Cart_discounts": {
"@id": "spree:Cart/discounts",
"@type": "@id"
},
"Cart_items": {
"@id": "spree:Cart/items",
"@type": "@id"
},
"Cart_fulfillments": {
"@id": "spree:Cart/fulfillments",
"@type": "@id"
},
"Cart_payments": {
"@id": "spree:Cart/payments",
"@type": "@id"
},
"Cart_billing_address": {
"@id": "spree:Cart/billing_address",
"@type": "@id"
},
"Cart_shipping_address": {
"@id": "spree:Cart/shipping_address",
"@type": "@id"
},
"Cart_payment_methods": {
"@id": "spree:Cart/payment_methods",
"@type": "@id"
},
"Cart_gift_card": {
"@id": "spree:Cart/gift_card",
"@type": "@id"
},
"Cart_market": {
"@id": "spree:Cart/market",
"@type": "@id"
},
"Cart": {
"@id": "spree:Cart"
},
"Category_id": {
"@id": "spree:Category/id",
"@type": "xsd:string"
},
"Category_name": {
"@id": "spree:Category/name",
"@type": "xsd:string"
},
"Category_permalink": {
"@id": "spree:Category/permalink",
"@type": "xsd:string"
},
"Category_position": {
"@id": "spree:Category/position",
"@type": "@id"
},
"Category_depth": {
"@id": "spree:Category/depth",
"@type": "@id"
},
"Category_meta_title": {
"@id": "spree:Category/meta_title",
"@type": "xsd:string"
},
"Category_meta_description": {
"@id": "spree:Category/meta_description",
"@type": "xsd:string"
},
"Category_meta_keywords": {
"@id": "spree:Category/meta_keywords",
"@type": "xsd:string"
},
"Category_children_count": {
"@id": "spree:Category/children_count",
"@type": "@id"
},
"Category_parent_id": {
"@id": "spree:Category/parent_id",
"@type": "xsd:string"
},
"Category_description": {
"@id": "spree:Category/description",
"@type": "xsd:string"
},
"Category_description_html": {
"@id": "spree:Category/description_html",
"@type": "xsd:string"
},
"Category_image_url": {
"@id": "spree:Category/image_url",
"@type": "xsd:string"
},
"Category_square_image_url": {
"@id": "spree:Category/square_image_url",
"@type": "xsd:string"
},
"Category_is_root": {
"@id": "spree:Category/is_root",
"@type": "@id"
},
"Category_is_child": {
"@id": "spree:Category/is_child",
"@type": "@id"
},
"Category_is_leaf": {
"@id": "spree:Category/is_leaf",
"@type": "@id"
},
"Category_parent": {
"@id": "spree:Category/parent",
"@type": "@id"
},
"Category_children": {
"@id": "spree:Category/children",
"@type": "@id"
},
"Category_ancestors": {
"@id": "spree:Category/ancestors",
"@type": "@id"
},
"Category_custom_fields": {
"@id": "spree:Category/custom_fields",
"@type": "@id"
},
"Category": {
"@id": "schema:Category"
},
"Channel_id": {
"@id": "spree:Channel/id",
"@type": "xsd:string"
},
"Channel_name": {
"@id": "spree:Channel/name",
"@type": "xsd:string"
},
"Channel_code": {
"@id": "spree:Channel/code",
"@type": "xsd:string"
},
"Channel_active": {
"@id": "spree:Channel/active",
"@type": "@id"
},
"Channel": {
"@id": "spree:Channel"
},
"Country_iso": {
"@id": "spree:Country/iso",
"@type": "xsd:string"
},
"Country_iso3": {
"@id": "spree:Country/iso3",
"@type": "xsd:string"
},
"Country_name": {
"@id": "spree:Country/name",
"@type": "xsd:string"
},
"Country_states_required": {
"@id": "spree:Country/states_required",
"@type": "@id"
},
"Country_zipcode_required": {
"@id": "spree:Country/zipcode_required",
"@type": "@id"
},
"Country_states": {
"@id": "spree:Country/states",
"@type": "@id"
},
"Country_market": {
"@id": "spree:Country/market",
"@type": "@id"
},
"Country": {
"@id": "schema:Country"
},
"CreditCard_id": {
"@id": "spree:CreditCard/id",
"@type": "xsd:string"
},
"CreditCard_brand": {
"@id": "spree:CreditCard/brand",
"@type": "xsd:string"
},
"CreditCard_last4": {
"@id": "spree:CreditCard/last4",
"@type": "xsd:string"
},
"CreditCard_month": {
"@id": "spree:CreditCard/month",
"@type": "@id"
},
"CreditCard_year": {
"@id": "spree:CreditCard/year",
"@type": "@id"
},
"CreditCard_name": {
"@id": "spree:CreditCard/name",
"@type": "xsd:string"
},
"CreditCard_default": {
"@id": "spree:CreditCard/default",
"@type": "@id"
},
"CreditCard_gateway_payment_profile_id": {
"@id": "spree:CreditCard/gateway_payment_profile_id",
"@type": "xsd:string"
},
"CreditCard": {
"@id": "schema:PaymentCard"
},
"Currency_iso_code": {
"@id": "spree:Currency/iso_code",
"@type": "xsd:string"
},
"Currency_name": {
"@id": "spree:Currency/name",
"@type": "xsd:string"
},
"Currency_symbol": {
"@id": "spree:Currency/symbol",
"@type": "xsd:string"
},
"Currency": {
"@id": "spree:Currency"
},
"CustomField_id": {
"@id": "spree:CustomField/id",
"@type": "xsd:string"
},
"CustomField_label": {
"@id": "spree:CustomField/label",
"@type": "xsd:string"
},
"CustomField_type": {
"@id": "spree:CustomField/type",
"@type": "xsd:string"
},
"CustomField_field_type": {
"@id": "spree:CustomField/field_type",
"@type": "xsd:string"
},
"CustomField_key": {
"@id": "spree:CustomField/key",
"@type": "xsd:string"
},
"CustomField_value": {
"@id": "spree:CustomField/value",
"@type": "@id"
},
"CustomField": {
"@id": "spree:CustomField"
},
"Customer_id": {
"@id": "spree:Customer/id",
"@type": "xsd:string"
},
"Customer_email": {
"@id": "spree:Customer/email",
"@type": "xsd:string"
},
"Customer_first_name": {
"@id": "spree:Customer/first_name",
"@type": "xsd:string"
},
"Customer_last_name": {
"@id": "spree:Customer/last_name",
"@type": "xsd:string"
},
"Customer_phone": {
"@id": "spree:Customer/phone",
"@type": "xsd:string"
},
"Customer_accepts_email_marketing": {
"@id": "spree:Customer/accepts_email_marketing",
"@type": "@id"
},
"Customer_full_name": {
"@id": "spree:Customer/full_name",
"@type": "xsd:string"
},
"Customer_available_store_credit_total": {
"@id": "spree:Customer/available_store_credit_total",
"@type": "xsd:string"
},
"Customer_display_available_store_credit_total": {
"@id": "spree:Customer/display_available_store_credit_total",
"@type": "xsd:string"
},
"Customer_addresses": {
"@id": "spree:Customer/addresses",
"@type": "@id"
},
"Customer_default_billing_address": {
"@id": "spree:Customer/default_billing_address",
"@type": "@id"
},
"Customer_default_shipping_address": {
"@id": "spree:Customer/default_shipping_address",
"@type": "@id"
},
"Customer": {
"@id": "spree:Customer"
},
"DeliveryMethod_id": {
"@id": "spree:DeliveryMethod/id",
"@type": "xsd:string"
},
"DeliveryMethod_name": {
"@id": "spree:DeliveryMethod/name",
"@type": "xsd:string"
},
"DeliveryMethod_code": {
"@id": "spree:DeliveryMethod/code",
"@type": "xsd:string"
},
"DeliveryMethod": {
"@id": "spree:DeliveryMethod"
},
"DeliveryRate_id": {
"@id": "spree:DeliveryRate/id",
"@type": "xsd:string"
},
"DeliveryRate_delivery_method_id": {
"@id": "spree:DeliveryRate/delivery_method_id",
"@type": "xsd:string"
},
"DeliveryRate_name": {
"@id": "spree:DeliveryRate/name",
"@type": "xsd:string"
},
"DeliveryRate_selected": {
"@id": "spree:DeliveryRate/selected",
"@type": "@id"
},
"DeliveryRate_cost": {
"@id": "spree:DeliveryRate/cost",
"@type": "xsd:string"
},
"DeliveryRate_total": {
"@id": "spree:DeliveryRate/total",
"@type": "xsd:string"
},
"DeliveryRate_additional_tax_total": {
"@id": "spree:DeliveryRate/additional_tax_total",
"@type": "xsd:string"
},
"DeliveryRate_included_tax_total": {
"@id": "spree:DeliveryRate/included_tax_total",
"@type": "xsd:string"
},
"DeliveryRate_tax_total": {
"@id": "spree:DeliveryRate/tax_total",
"@type": "xsd:string"
},
"DeliveryRate_display_cost": {
"@id": "spree:DeliveryRate/display_cost",
"@type": "xsd:string"
},
"DeliveryRate_display_total": {
"@id": "spree:DeliveryRate/display_total",
"@type": "xsd:string"
},
"DeliveryRate_display_additional_tax_total": {
"@id": "spree:DeliveryRate/display_additional_tax_total",
"@type": "xsd:string"
},
"DeliveryRate_display_included_tax_total": {
"@id": "spree:DeliveryRate/display_included_tax_total",
"@type": "xsd:string"
},
"DeliveryRate_display_tax_total": {
"@id": "spree:DeliveryRate/display_tax_total",
"@type": "xsd:string"
},
"DeliveryRate_delivery_method": {
"@id": "spree:DeliveryRate/delivery_method",
"@type": "@id"
},
"DeliveryRate": {
"@id": "spree:DeliveryRate"
},
"DigitalLink_id": {
"@id": "spree:DigitalLink/id",
"@type": "xsd:string"
},
"DigitalLink_access_counter": {
"@id": "spree:DigitalLink/access_counter",
"@type": "@id"
},
"DigitalLink_filename": {
"@id": "spree:DigitalLink/filename",
"@type": "xsd:string"
},
"DigitalLink_content_type": {
"@id": "spree:DigitalLink/content_type",
"@type": "xsd:string"
},
"DigitalLink_download_url": {
"@id": "spree:DigitalLink/download_url",
"@type": "xsd:string"
},
"DigitalLink_authorizable": {
"@id": "spree:DigitalLink/authorizable",
"@type": "@id"
},
"DigitalLink_expired": {
"@id": "spree:DigitalLink/expired",
"@type": "@id"
},
"DigitalLink_access_limit_exceeded": {
"@id": "spree:DigitalLink/access_limit_exceeded",
"@type": "@id"
},
"DigitalLink": {
"@id": "spree:DigitalLink"
},
"Digital_id": {
"@id": "spree:Digital/id",
"@type": "xsd:string"
},
"Digital_created_at": {
"@id": "spree:Digital/created_at",
"@type": "xsd:string"
},
"Digital_updated_at": {
"@id": "spree:Digital/updated_at",
"@type": "xsd:string"
},
"Digital_variant_id": {
"@id": "spree:Digital/variant_id",
"@type": "xsd:string"
},
"Digital": {
"@id": "spree:Digital"
},
"Discount_id": {
"@id": "spree:Discount/id",
"@type": "xsd:string"
},
"Discount_promotion_id": {
"@id": "spree:Discount/promotion_id",
"@type": "xsd:string"
},
"Discount_name": {
"@id": "spree:Discount/name",
"@type": "xsd:string"
},
"Discount_description": {
"@id": "spree:Discount/description",
"@type": "xsd:string"
},
"Discount_code": {
"@id": "spree:Discount/code",
"@type": "xsd:string"
},
"Discount_amount": {
"@id": "spree:Discount/amount",
"@type": "xsd:string"
},
"Discount_display_amount": {
"@id": "spree:Discount/display_amount",
"@type": "xsd:string"
},
"Discount": {
"@id": "spree:Discount"
},
"Fulfillment_id": {
"@id": "spree:Fulfillment/id",
"@type": "xsd:string"
},
"Fulfillment_number": {
"@id": "spree:Fulfillment/number",
"@type": "xsd:string"
},
"Fulfillment_tracking": {
"@id": "spree:Fulfillment/tracking",
"@type": "xsd:string"
},
"Fulfillment_tracking_url": {
"@id": "spree:Fulfillment/tracking_url",
"@type": "xsd:string"
},
"Fulfillment_cost": {
"@id": "spree:Fulfillment/cost",
"@type": "xsd:string"
},
"Fulfillment_display_cost": {
"@id": "spree:Fulfillment/display_cost",
"@type": "xsd:string"
},
"Fulfillment_total": {
"@id": "spree:Fulfillment/total",
"@type": "xsd:string"
},
"Fulfillment_display_total": {
"@id": "spree:Fulfillment/display_total",
"@type": "xsd:string"
},
"Fulfillment_discount_total": {
"@id": "spree:Fulfillment/discount_total",
"@type": "xsd:string"
},
"Fulfillment_display_discount_total": {
"@id": "spree:Fulfillment/display_discount_total",
"@type": "xsd:string"
},
"Fulfillment_additional_tax_total": {
"@id": "spree:Fulfillment/additional_tax_total",
"@type": "xsd:string"
},
"Fulfillment_display_additional_tax_total": {
"@id": "spree:Fulfillment/display_additional_tax_total",
"@type": "xsd:string"
},
"Fulfillment_included_tax_total": {
"@id": "spree:Fulfillment/included_tax_total",
"@type": "xsd:string"
},
"Fulfillment_display_included_tax_total": {
"@id": "spree:Fulfillment/display_included_tax_total",
"@type": "xsd:string"
},
"Fulfillment_tax_total": {
"@id": "spree:Fulfillment/tax_total",
"@type": "xsd:string"
},
"Fulfillment_display_tax_total": {
"@id": "spree:Fulfillment/display_tax_total",
"@type": "xsd:string"
},
"Fulfillment_status": {
"@id": "spree:Fulfillment/status",
"@type": "xsd:string"
},
"Fulfillment_fulfillment_type": {
"@id": "spree:Fulfillment/fulfillment_type",
"@type": "xsd:string"
},
"Fulfillment_fulfilled_at": {
"@id": "spree:Fulfillment/fulfilled_at",
"@type": "xsd:string"
},
"Fulfillment_items": {
"@id": "spree:Fulfillment/items",
"@type": "@id"
},
"Fulfillment_delivery_method": {
"@id": "spree:Fulfillment/delivery_method",
"@type": "@id"
},
"Fulfillment_stock_location": {
"@id": "spree:Fulfillment/stock_location",
"@type": "@id"
},
"Fulfillment_delivery_rates": {
"@id": "spree:Fulfillment/delivery_rates",
"@type": "@id"
},
"Fulfillment": {
"@id": "spree:Fulfillment"
},
"GiftCardBatch_id": {
"@id": "spree:GiftCardBatch/id",
"@type": "xsd:string"
},
"GiftCardBatch_codes_count": {
"@id": "spree:GiftCardBatch/codes_count",
"@type": "@id"
},
"GiftCardBatch_currency": {
"@id": "spree:GiftCardBatch/currency",
"@type": "xsd:string"
},
"GiftCardBatch_prefix": {
"@id": "spree:GiftCardBatch/prefix",
"@type": "xsd:string"
},
"GiftCardBatch_created_at": {
"@id": "spree:GiftCardBatch/created_at",
"@type": "xsd:string"
},
"GiftCardBatch_updated_at": {
"@id": "spree:GiftCardBatch/updated_at",
"@type": "xsd:string"
},
"GiftCardBatch_amount": {
"@id": "spree:GiftCardBatch/amount",
"@type": "xsd:string"
},
"GiftCardBatch_expires_at": {
"@id": "spree:GiftCardBatch/expires_at",
"@type": "xsd:string"
},
"GiftCardBatch_created_by_id": {
"@id": "spree:GiftCardBatch/created_by_id",
"@type": "xsd:string"
},
"GiftCardBatch": {
"@id": "spree:GiftCardBatch"
},
"GiftCard_id": {
"@id": "spree:GiftCard/id",
"@type": "xsd:string"
},
"GiftCard_code": {
"@id": "spree:GiftCard/code",
"@type": "xsd:string"
},
"GiftCard_status": {
"@id": "spree:GiftCard/status",
"@type": "xsd:string"
},
"GiftCard_currency": {
"@id": "spree:GiftCard/currency",
"@type": "xsd:string"
},
"GiftCard_amount": {
"@id": "spree:GiftCard/amount",
"@type": "xsd:string"
},
"GiftCard_amount_used": {
"@id": "spree:GiftCard/amount_used",
"@type": "xsd:string"
},
"GiftCard_amount_authorized": {
"@id": "spree:GiftCard/amount_authorized",
"@type": "xsd:string"
},
"GiftCard_amount_remaining": {
"@id": "spree:GiftCard/amount_remaining",
"@type": "xsd:string"
},
"GiftCard_display_amount": {
"@id": "spree:GiftCard/display_amount",
"@type": "xsd:string"
},
"GiftCard_display_amount_used": {
"@id": "spree:GiftCard/display_amount_used",
"@type": "xsd:string"
},
"GiftCard_display_amount_remaining": {
"@id": "spree:GiftCard/display_amount_remaining",
"@type": "xsd:string"
},
"GiftCard_expires_at": {
"@id": "spree:GiftCard/expires_at",
"@type": "xsd:string"
},
"GiftCard_redeemed_at": {
"@id": "spree:GiftCard/redeemed_at",
"@type": "xsd:string"
},
"GiftCard_expired": {
"@id": "spree:GiftCard/expired",
"@type": "@id"
},
"GiftCard_active": {
"@id": "spree:GiftCard/active",
"@type": "@id"
},
"GiftCard": {
"@id": "spree:GiftCard"
},
"Invitation_id": {
"@id": "spree:Invitation/id",
"@type": "xsd:string"
},
"Invitation_email": {
"@id": "spree:Invitation/email",
"@type": "xsd:string"
},
"Invitation_resource_type": {
"@id": "spree:Invitation/resource_type",
"@type": "xsd:string"
},
"Invitation_inviter_type": {
"@id": "spree:Invitation/inviter_type",
"@type": "xsd:string"
},
"Invitation_invitee_type": {
"@id": "spree:Invitation/invitee_type",
"@type": "xsd:string"
},
"Invitation_created_at": {
"@id": "spree:Invitation/created_at",
"@type": "xsd:string"
},
"Invitation_updated_at": {
"@id": "spree:Invitation/updated_at",
"@type": "xsd:string"
},
"Invitation_status": {
"@id": "spree:Invitation/status",
"@type": "xsd:string"
},
"Invitation_resource_id": {
"@id": "spree:Invitation/resource_id",
"@type": "xsd:string"
},
"Invitation_inviter_id": {
"@id": "spree:Invitation/inviter_id",
"@type": "xsd:string"
},
"Invitation_invitee_id": {
"@id": "spree:Invitation/invitee_id",
"@type": "xsd:string"
},
"Invitation_role_id": {
"@id": "spree:Invitation/role_id",
"@type": "xsd:string"
},
"Invitation_expires_at": {
"@id": "spree:Invitation/expires_at",
"@type": "xsd:string"
},
"Invitation_accepted_at": {
"@id": "spree:Invitation/accepted_at",
"@type": "xsd:string"
},
"Invitation": {
"@id": "spree:Invitation"
},
"LineItem_id": {
"@id": "spree:LineItem/id",
"@type": "xsd:string"
},
"LineItem_variant_id": {
"@id": "spree:LineItem/variant_id",
"@type": "xsd:string"
},
"LineItem_quantity": {
"@id": "spree:LineItem/quantity",
"@type": "@id"
},
"LineItem_currency": {
"@id": "spree:LineItem/currency",
"@type": "xsd:string"
},
"LineItem_name": {
"@id": "spree:LineItem/name",
"@type": "xsd:string"
},
"LineItem_slug": {
"@id": "spree:LineItem/slug",
"@type": "xsd:string"
},
"LineItem_options_text": {
"@id": "spree:LineItem/options_text",
"@type": "xsd:string"
},
"LineItem_price": {
"@id": "spree:LineItem/price",
"@type": "xsd:string"
},
"LineItem_display_price": {
"@id": "spree:LineItem/display_price",
"@type": "xsd:string"
},
"LineItem_total": {
"@id": "spree:LineItem/total",
"@type": "xsd:string"
},
"LineItem_display_total": {
"@id": "spree:LineItem/display_total",
"@type": "xsd:string"
},
"LineItem_adjustment_total": {
"@id": "spree:LineItem/adjustment_total",
"@type": "xsd:string"
},
"LineItem_display_adjustment_total": {
"@id
# --- truncated at 32 KB (88 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/spree/refs/heads/main/json-ld/spree-api-context.jsonld