For AI agents: visit https://docs.cratejoy.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI. Append .md to any documentation page URL to get its markdown version.

Jump to Content

API Reference

Cratejoy APIs

Introduction
Collections
Filtering and Searching
Working with Object Relationships
Relation Map

Themes Overview

Theme Structure
Theme Technologies
Subscribe Flow
Theme Helpers
Customer Pages
Example Themes

Theme Logic & Components

Introduction to Theme Logic
Filters
Page Variables
Page Variable Types
Components
Components in Depth
Theme Component Settings
Settings in Depth
Adding a Custom Component

Store API

Introduction

Store API Methods

Add-to-cart URLs
Customer Methods
ECom Inventory Methods
Subscription Methods
Product Methods
Shipment Methods
Address Methods
Survey Methods

Merchant API

Introduction
Authorization
Add Tracking to a Shipment

Merchant API Relationships

Customers to Orders, Subscriptions

Merchant API Methods

Address Methods
Cart Methods
Customer Methods
Instance & Inventory Methods
Order Methods
Page Redirect Methods
Product Methods
Product Survey Methods
Shipment Methods
Shipment Batch Methods
Store Methods
Subscription Methods
Transaction Methods
Web Hook Methods

Merchant API Resources

Address
Cart
Customer
Inventory
Order
Page Redirect
Product
Product Instances
Product Survey Results
Shipment
Shipment Batch
Subscription
Transaction
Web Hook

Merchant API Subresources

Cart Coupon
Cart Metadata
Cart Products
Customer Metadata
Fulfillment
Metadata
Product Billing
Shipment Metadata
Shipping Label
Store Metadata
Subscription Coupons
Subscription Gift Info
Subscription Metadata
Subscription Term
Shipment Stats

Powered by

Themes Overview

Example Themes

Theme examples are available in our example github repository.

Updated less than a minute ago

Did this page help you?

Updated less than a minute ago

Did this page help you?