DKShop Admin API

Version 1.0.0 · 186 paths · 277 operations

Authenticate with a store API key: Authorization: Bearer dk_sk_…. Create one in the dashboard under Settings → API keys. The key names its own store, so no store header is sent.

Every operation needs the scope in its row, and the ones marked admin need a key of that role. The full machine-readable description, with request and response shapes, is at openapi.json.

API keys

Managing API keys. Deliberately unreachable with an API key.

Endpoint	What it does	Returns	Scope	Role
`GET` `/api/v1/store/api-keys`	List API keys	`api_keys` APIKeyView[]	`api-keys:read`	admin
`POST` `/api/v1/store/api-keys`	Create an API key	`api_key` APIKeyView	`api-keys:write`	admin
`GET` `/api/v1/store/api-keys/scopes`	List the grantable API scopes	`actions` string[] `resources` ScopeResourceView[]	`api-keys:read`	admin
`DELETE` `/api/v1/store/api-keys/{id}`	Revoke an API key	`api_key` APIKeyView	`api-keys:write`	admin

Abandoned carts and checkouts

Baskets and checkouts that did not become an order.

Endpoint	What it does	Returns	Scope	Role
`GET` `/api/v1/store/abandoned-carts`	List abandoned carts	`abandoned` AbandonedCartRowView[] `stats` AbandonmentStatsView	`abandoned:read`	any
`GET` `/api/v1/store/abandoned-checkouts`	List abandoned checkouts	`abandoned` AbandonedCheckoutRowView[] `stats` AbandonmentStatsView	`abandoned:read`	any
`GET` `/api/v1/store/abandoned-checkouts/{token}`	Get an abandoned checkout	`checkout` AbandonedcartDetail	`abandoned:read`	any

Analytics

Sales, conversion and post-purchase reporting.

Endpoint	What it does	Returns	Scope	Role
`GET` `/api/v1/store/analytics`	Get the analytics overview	`analytics` AnalyticsOverview	`analytics:read`	any
`GET` `/api/v1/store/analytics/upsell`	Get post-purchase upsell totals	`upsell` AnalyticsUpsellReport	`analytics:read`	any
`GET` `/api/v1/store/analytics/upsell/report`	Get the detailed post-purchase upsell report	`report` AnalyticsUpsellDeepReport	`analytics:read`	any

Audit log

Who changed what, including which API key did it.

Endpoint	What it does	Returns	Scope	Role
`GET` `/api/v1/store/audit-logs`	List audit log	`logs` AuditLog[]	`audit-logs:read`	admin

Blog

Blog articles.

Endpoint	What it does	Returns	Scope	Role
`GET` `/api/v1/store/articles`	List blog articles	`articles` ArticleView[]	`blog:read`	any
`POST` `/api/v1/store/articles`	Create a blog article	`article` ArticleView	`blog:write`	admin
`GET` `/api/v1/store/articles/{id}`	Get a blog article	`article` ArticleView	`blog:read`	any
`PUT` `/api/v1/store/articles/{id}`	Update a blog article	`article` ArticleView	`blog:write`	admin
`DELETE` `/api/v1/store/articles/{id}`	Delete a blog article	—	`blog:write`	admin

Checkout and post-purchase

Checkout zones and pages, post-purchase upsell funnels, and tipping.

Endpoint	What it does	Returns	Scope	Role
`GET` `/api/v1/store/checkout-pages`	List checkout pages	`pages` CheckoutPageListView[]	`checkout:read`	any
`POST` `/api/v1/store/checkout-pages`	Create a checkout page	`page` CheckoutPageView	`checkout:write`	admin
`GET` `/api/v1/store/checkout-pages/{id}`	Get a checkout page	`page` CheckoutPageView	`checkout:read`	any
`PUT` `/api/v1/store/checkout-pages/{id}`	Update a checkout page	`page` CheckoutPageView	`checkout:write`	admin
`DELETE` `/api/v1/store/checkout-pages/{id}`	Delete a checkout page	—	`checkout:write`	admin
`PUT` `/api/v1/store/checkout-pages/{id}/default`	Set defaults	`page` CheckoutPageView	`checkout:write`	admin
`PUT` `/api/v1/store/checkout-pages/{id}/sections`	Set sections	`page` CheckoutPageView	`checkout:write`	admin
`GET` `/api/v1/store/checkout-zones`	List checkout zones	`zones` CheckoutZoneView[]	`checkout:read`	any
`POST` `/api/v1/store/checkout-zones`	Create a checkout zone	`zone` CheckoutZoneView	`checkout:write`	admin
`GET` `/api/v1/store/checkout-zones/{id}`	Get a checkout zone	`zone` CheckoutZoneView	`checkout:read`	any
`PUT` `/api/v1/store/checkout-zones/{id}`	Update a checkout zone	`zone` CheckoutZoneView	`checkout:write`	admin
`DELETE` `/api/v1/store/checkout-zones/{id}`	Delete a checkout zone	—	`checkout:write`	admin
`GET` `/api/v1/store/pp15`	Get a pp15	`config` FeatureflagsPP15Config `platform` PP15PlatformView	`checkout:read`	any
`PUT` `/api/v1/store/pp15`	Set pp15s	—	`checkout:write`	admin
`GET` `/api/v1/store/tipping`	Get a tipping	`tipping` TippingConfig	`checkout:read`	any
`PUT` `/api/v1/store/tipping`	Set tippings	`tipping` TippingConfig	`checkout:write`	admin
`GET` `/api/v1/store/upsell-funnels`	List post-purchase funnels	`funnels` FunnelSummaryView[]	`checkout:read`	any
`POST` `/api/v1/store/upsell-funnels`	Create a post-purchase funnel	`funnel` FunnelView	`checkout:write`	admin
`GET` `/api/v1/store/upsell-funnels/{id}`	Get a post-purchase funnel	`funnel` FunnelView	`checkout:read`	any
`PUT` `/api/v1/store/upsell-funnels/{id}`	Update a post-purchase funnel	`funnel` FunnelView	`checkout:write`	admin
`DELETE` `/api/v1/store/upsell-funnels/{id}`	Delete a post-purchase funnel	—	`checkout:write`	admin
`POST` `/api/v1/store/upsell-funnels/{id}/checkout-page`	Ensure a funnel has a checkout page	`page` CheckoutPageRefView	`checkout:write`	admin
`PUT` `/api/v1/store/upsell-funnels/{id}/pp15`	Override the store's handling surcharge for this funnel (null inherits it again)	—	`checkout:write`	admin
`PUT` `/api/v1/store/upsell-funnels/{id}/steps/{stepId}/upsell-page`	Set one step's own upsell design	—	`checkout:write`	admin
`DELETE` `/api/v1/store/upsell-funnels/{id}/steps/{stepId}/upsell-page`	Clear a step's own upsell design so it inherits the funnel's	—	`checkout:write`	admin
`PUT` `/api/v1/store/upsell-funnels/{id}/tipping`	Override the store's tipping rule for this funnel (null inherits it again)	—	`checkout:write`	admin
`PUT` `/api/v1/store/upsell-funnels/{id}/upsell-page`	Set upsell pages	—	`checkout:write`	admin

Collections

Manual and smart groupings of products, and their membership.

Endpoint	What it does	Returns	Scope	Role
`GET` `/api/v1/store/collections`	List collections	`collections` CollectionListView[]	`collections:read`	any
`POST` `/api/v1/store/collections`	Create a collection	`collection` CollectionView	`collections:write`	admin
`POST` `/api/v1/store/collections/bulk-delete`	Delete several collections	`deleted` integer `ids` any	`collections:write`	admin
`GET` `/api/v1/store/collections/handle-available`	Check whether a collection handle is free	`available` boolean	`collections:read`	any
`GET` `/api/v1/store/collections/options`	List collections as id and title, for pickers	`collections` CatalogCollectionOption[]	`collections:read`	any
`POST` `/api/v1/store/collections/preview`	Preview which products a smart-collection rule matches	`collection_type` any `created_at` any `description` any `disjunctive` any `handle` any `id` any `image_src` any `position` any `price_cents` any `products` CollectionMemberView[] `published` any `rules` any `seo` any `sort_order` any `title` any `updated_at` any	`collections:write`	admin
`GET` `/api/v1/store/collections/{id}`	Get a collection	`collection` CollectionView	`collections:read`	any
`PUT` `/api/v1/store/collections/{id}`	Update a collection	`collection` CollectionView	`collections:write`	admin
`DELETE` `/api/v1/store/collections/{id}`	Delete a collection	—	`collections:write`	admin
`GET` `/api/v1/store/collections/{id}/products`	List the products in a collection	`products` CollectionMemberView[]	`collections:read`	any
`POST` `/api/v1/store/collections/{id}/products`	Add a product to a collection	—	`collections:write`	admin
`PUT` `/api/v1/store/collections/{id}/products/reorder`	Reorder the products in a collection	—	`collections:write`	admin
`DELETE` `/api/v1/store/collections/{id}/products/{pid}`	Remove a product from a collection	—	`collections:write`	admin

Custom domains

Domains connected to this storefront.

Endpoint	What it does	Returns	Scope	Role
`GET` `/api/v1/store/domains`	List custom domains	`domains` DomainView[]	`domains:read`	any
`POST` `/api/v1/store/domains`	Connect a custom domain	`domain` DomainView	`domains:write`	admin
`DELETE` `/api/v1/store/domains/{id}`	Delete a custom domain	—	`domains:write`	admin
`POST` `/api/v1/store/domains/{id}/primary`	Set primarys	—	`domains:write`	admin
`POST` `/api/v1/store/domains/{id}/verify`	Re-check a custom domain now	`domain` DomainView	`domains:write`	admin

Discounts

Discount codes and automatic discounts.

Endpoint	What it does	Returns	Scope	Role
`GET` `/api/v1/store/discounts`	List discounts	`discounts` DiscountView[]	`discounts:read`	any
`POST` `/api/v1/store/discounts`	Create a discount	`discount` DiscountView	`discounts:write`	admin
`GET` `/api/v1/store/discounts/{id}`	Get a discount	`discount` DiscountDetailView	`discounts:read`	any
`PUT` `/api/v1/store/discounts/{id}`	Update a discount	`discount` DiscountView	`discounts:write`	admin
`DELETE` `/api/v1/store/discounts/{id}`	Delete a discount	—	`discounts:write`	admin

Draft orders

Orders a seller builds by hand, before they are paid.

Endpoint	What it does	Returns	Scope	Role
`GET` `/api/v1/store/draft-orders`	List draft orders	`draft_orders` DraftOrderView[]	`draft-orders:read`	any
`POST` `/api/v1/store/draft-orders`	Create a draft order	`draft_order` DraftOrderView	`draft-orders:write`	admin
`GET` `/api/v1/store/draft-orders/{id}`	Get a draft order	`draft_order` DraftOrderView	`draft-orders:read`	any
`PUT` `/api/v1/store/draft-orders/{id}/contact`	Set contacts	`draft_order` DraftOrderView	`draft-orders:write`	admin
`POST` `/api/v1/store/draft-orders/{id}/line-items`	Add a line item to a draft order	`draft_order` DraftOrderView	`draft-orders:write`	admin
`DELETE` `/api/v1/store/draft-orders/{id}/line-items/{lineId}`	Remove a line item from a draft order	`draft_order` DraftOrderView	`draft-orders:write`	admin
`POST` `/api/v1/store/draft-orders/{id}/mark-as-paid`	Mark a draft order as paid	`custom` any `id` any `line_total_cents` any `order_id` integer `order_number` any `order_number_display` any `price_cents` any `quantity` any `sku` any `title` any `variant_id` any `variant_title` any	`draft-orders:write`	admin

Email settings

Per-store SMTP.

Endpoint	What it does	Returns	Scope	Role
`GET` `/api/v1/store/email`	Get an email	`email` StoremailConfig	`email:read`	any
`PUT` `/api/v1/store/email`	Set emails	`email` StoremailConfig	`email:write`	admin
`POST` `/api/v1/store/email/test`	Send a test email	—	`email:write`	admin

Form submissions

Contact-form, newsletter and popup submissions.

Endpoint	What it does	Returns	Scope	Role
`GET` `/api/v1/store/form-submissions`	List form submissions	`counts` any `submissions` FormSubmissionView[]	`forms:read`	any
`GET` `/api/v1/store/form-submissions/export`	Export form submissions as CSV	—	`forms:read`	any
`DELETE` `/api/v1/store/form-submissions/{id}`	Delete a form submission	—	`forms:write`	admin
`PUT` `/api/v1/store/form-submissions/{id}/read`	Mark a form submission as read	`submission` FormSubmissionView	`forms:write`	admin

Fulfillments

Shipments against an order, with tracking.

Endpoint	What it does	Returns	Scope	Role
`POST` `/api/v1/store/fulfillments/{id}/cancel`	Cancel a fulfillment	`fulfillment_status` string	`fulfillments:write`	admin

Marketing and tracking

Marketing pixels, conversion APIs, Klaviyo and abandonment recovery.

Endpoint	What it does	Returns	Scope	Role
`GET` `/api/v1/store/klaviyo`	Get a klaviyo	`klaviyo` KlaviyoView	`marketing:read`	any
`PUT` `/api/v1/store/klaviyo`	Set klaviyos	`klaviyo` KlaviyoView	`marketing:write`	admin
`GET` `/api/v1/store/klaviyo/lists`	Get a list	`lists` KlaviyoListDTO[] `next_cursor` any	`marketing:read`	any
`POST` `/api/v1/store/klaviyo/test`	Test the Klaviyo connection	`account` KlaviyoAccountView	`marketing:write`	admin
`GET` `/api/v1/store/recovery-settings`	Get a recovery setting	`recovery` AbandonedcartPolicy	`marketing:read`	any
`PUT` `/api/v1/store/recovery-settings`	Set recovery settings	`recovery` AbandonedcartPolicy	`marketing:write`	admin
`GET` `/api/v1/store/tracking`	Get a tracking	`tracking` TrackingConfig	`marketing:read`	any
`PUT` `/api/v1/store/tracking`	Set trackings	`tracking` TrackingConfig	`marketing:write`	admin
`GET` `/api/v1/store/tracking/axon-capi`	Get an axon capi	`axon_capi` TrackingAxonCAPIView	`marketing:read`	any
`PUT` `/api/v1/store/tracking/axon-capi`	Set axon capis	`axon_capi` TrackingAxonCAPIView	`marketing:write`	admin
`GET` `/api/v1/store/tracking/capi`	Get a capi	`capi` TrackingCAPIView	`marketing:read`	any
`PUT` `/api/v1/store/tracking/capi`	Set capis	`capi` TrackingCAPIView	`marketing:write`	admin

Media uploads

Presigned uploads for product and theme imagery.

Endpoint	What it does	Returns	Scope	Role
`POST` `/api/v1/store/uploads/finalize`	Finalize an upload	`filename` any `height` any `src` string `thumbhash` any `width` any	`media:write`	admin
`POST` `/api/v1/store/uploads/request`	Request a presigned upload URL	`headers` any `key` any `max_bytes` any `method` any `upload_url` string	`media:write`	admin

Navigation menus

Storefront navigation.

Endpoint	What it does	Returns	Scope	Role
`GET` `/api/v1/store/menus`	List menus	`menus` MenuView[]	`menus:read`	any
`PUT` `/api/v1/store/menus/{handle}`	Create or replace a menu	`menu` MenuRefView	`menus:write`	admin
`DELETE` `/api/v1/store/menus/{handle}`	Delete a menu	—	`menus:write`	admin

Orders

Placed orders, their line items, refunds, cancellation and export.

Endpoint	What it does	Returns	Scope	Role
`GET` `/api/v1/store/orders`	List orders	`orders` OrderSummaryView[]	`orders:read`	any
`GET` `/api/v1/store/orders/awaiting-capture`	List payments authorized but not yet captured	`awaiting` AwaitingCaptureView[]	`orders:read`	any
`GET` `/api/v1/store/orders/export`	Export orders as CSV	—	`orders:read`	admin
`GET` `/api/v1/store/orders/{id}`	Get an order	`order` OrderDetailView	`orders:read`	any
`PUT` `/api/v1/store/orders/{id}`	Update an order	`note` string `tags` any	`orders:write`	admin
`POST` `/api/v1/store/orders/{id}/archive`	Archive an order	`order_status` string	`orders:write`	admin
`POST` `/api/v1/store/orders/{id}/cancel`	Cancel an order	`order_status` string	`orders:write`	admin
`GET` `/api/v1/store/orders/{id}/fulfillments`	List fulfillments	`fulfilled` FulfilledQuantityView[] `fulfillments` FulfillmentView[]	`orders:read`	any
`POST` `/api/v1/store/orders/{id}/fulfillments`	Create a fulfillment	`fulfillment` FulfillmentView `fulfillment_status` any	`orders:write`	admin
`POST` `/api/v1/store/orders/{id}/refund`	Refund an order	`refund` RefundView	`orders:write`	admin
`GET` `/api/v1/store/orders/{id}/renders`	List renders	`renders` RenderView[]	`orders:read`	any

Pages

Standalone content pages.

Endpoint	What it does	Returns	Scope	Role
`GET` `/api/v1/store/pages`	List pages	`pages` PageView[]	`pages:read`	any
`POST` `/api/v1/store/pages`	Create a page	`page` PageView	`pages:write`	admin
`GET` `/api/v1/store/pages/{id}`	Get a page	`page` PageView	`pages:read`	any
`PUT` `/api/v1/store/pages/{id}`	Update a page	`page` PageView	`pages:write`	admin
`DELETE` `/api/v1/store/pages/{id}`	Delete a page	—	`pages:write`	admin

Payment gateways

Connected gateways. Reading is open to API keys; changing them is not.

Endpoint	What it does	Returns	Scope	Role
`GET` `/api/v1/store/payment-providers`	List payment gateways	`providers` PaymentProviderView[]	`payments:read`	any
`POST` `/api/v1/store/payment-providers`	Connect a payment gateway	`provider` PaymentProviderView	`payments:write`	admin
`POST` `/api/v1/store/payment-providers/test`	Test payment gateway credentials	`valid` boolean	`payments:write`	admin
`PUT` `/api/v1/store/payment-providers/{id}`	Update a payment gateway	`provider` PaymentProviderView	`payments:write`	admin
`DELETE` `/api/v1/store/payment-providers/{id}`	Delete a payment gateway	—	`payments:write`	admin
`PUT` `/api/v1/store/payment-providers/{id}/card-fields`	Set card fields	`provider` PaymentProviderView	`payments:write`	admin
`PUT` `/api/v1/store/payment-providers/{id}/enabled`	Set enableds	—	`payments:write`	admin
`POST` `/api/v1/store/payment-providers/{id}/wallet-domains`	Register this store's domains for wallet payments	`provider` PaymentProviderView `results` WalletRegistrationView[]	`payments:write`	admin

Plan and billing

What this store pays the platform. Reading is open to API keys; changing it is not.

Endpoint	What it does	Returns	Scope	Role
`GET` `/api/v1/store/billing`	Get this store's plan and accrued fees	`accrued` any `cards` any `collection_enabled` any `invoices` any `plan` any `subscription` BillingSubscriptionDTO	`billing:read`	any
`PUT` `/api/v1/store/billing/cancel`	Set cancels	`subscription` BillingSubscriptionDTO	`billing:write`	admin
`POST` `/api/v1/store/billing/card`	Save a billing card	`card` BillingCardDTO	`billing:write`	admin
`POST` `/api/v1/store/billing/card/setup`	Start saving a billing card	`client_secret` string `publishable_key` any	`billing:write`	admin
`DELETE` `/api/v1/store/billing/card/{id}`	Delete a billing card	—	`billing:write`	admin
`GET` `/api/v1/store/billing/invoices`	List billing invoices	`invoices` BillingInvoiceDTO[] `page` any `page_size` any	`billing:read`	any
`GET` `/api/v1/store/billing/invoices/{id}`	Get a billing invoice	`charges` any `invoice` BillingInvoiceDTO `lines` any	`billing:read`	any
`PUT` `/api/v1/store/billing/plan`	Change this store's billing plan	`subscription` BillingSubscriptionDTO	`billing:write`	admin
`GET` `/api/v1/store/billing/plans`	List the available billing plans	`plans` BillingPlanDTO[]	`billing:read`	any

Product customizer

Personalisation: designs, option sets, product bases and the renders they produce.

Endpoint	What it does	Returns	Scope	Role
`GET` `/api/v1/store/customizer/bindings/{productId}`	List a product's customizer bindings	`bindings` CzProductBindingView[]	`customizer:read`	any
`PUT` `/api/v1/store/customizer/bindings/{productId}`	Bind a customizer template to a product, optionally scoped to one option value	`binding` CzProductBindingView	`customizer:write`	admin
`DELETE` `/api/v1/store/customizer/bindings/{productId}`	Delete every binding on a product	—	`customizer:write`	admin
`DELETE` `/api/v1/store/customizer/bindings/{productId}/{bindingId}`	Delete one of a product's bindings	—	`customizer:write`	admin
`GET` `/api/v1/store/customizer/designs`	List designs	`designs` CzDesignView[]	`customizer:read`	any
`POST` `/api/v1/store/customizer/designs`	Create a design	`design` CzDesignView	`customizer:write`	admin
`GET` `/api/v1/store/customizer/designs/{id}`	Get a design	`design` CzDesignView	`customizer:read`	any
`PUT` `/api/v1/store/customizer/designs/{id}`	Update a design	`design` CzDesignView	`customizer:write`	admin
`DELETE` `/api/v1/store/customizer/designs/{id}`	Delete a design	—	`customizer:write`	admin
`PUT` `/api/v1/store/customizer/designs/{id}/element-order`	Re-stack a design's elements in one request — ids in paint order, position assigns z_index	—	`customizer:write`	admin
`GET` `/api/v1/store/customizer/designs/{id}/elements`	List design elements	`elements` CzElementView[]	`customizer:read`	any
`POST` `/api/v1/store/customizer/designs/{id}/elements`	Create a design element	`element` CzElementView	`customizer:write`	admin
`GET` `/api/v1/store/customizer/designs/{id}/studio`	One read for the design studio: a design, its elements with reference counts, and every product base it is placed on	`studio` CzStudioView	`customizer:read`	any
`PUT` `/api/v1/store/customizer/elements/{id}`	Update a design element	`element` CzElementView	`customizer:write`	admin
`DELETE` `/api/v1/store/customizer/elements/{id}`	Delete a design element	—	`customizer:write`	admin
`GET` `/api/v1/store/customizer/libraries`	List libraries	`libraries` CzLibraryView[]	`customizer:read`	any
`POST` `/api/v1/store/customizer/libraries`	Create a library	`library` CzLibraryView	`customizer:write`	admin
`PUT` `/api/v1/store/customizer/libraries/{id}`	Rename a library	`library` CzLibraryView	`customizer:write`	admin
`DELETE` `/api/v1/store/customizer/libraries/{id}`	Delete a library	—	`customizer:write`	admin
`GET` `/api/v1/store/customizer/libraries/{id}/items`	List items	`items` CzLibraryItemView[]	`customizer:read`	any
`POST` `/api/v1/store/customizer/libraries/{id}/items`	Create an item	`item` CzLibraryItemView	`customizer:write`	admin
`PUT` `/api/v1/store/customizer/libraries/{id}/items`	Put an artwork at a position	`item` CzLibraryItemView	`customizer:write`	admin
`GET` `/api/v1/store/customizer/library-catalogues`	List artwork catalogues, with hole counts	`catalogues` CzLibraryCatalogueView[]	`customizer:read`	any
`DELETE` `/api/v1/store/customizer/library-items/{id}`	Delete a library item	—	`customizer:write`	admin
`PUT` `/api/v1/store/customizer/mockups/{id}`	Rename a mockup, move it, or replace its photo (a differently sized photo rescales its print areas)	`mockup` CzMockupView `print_areas` CzPrintAreaView[]	`customizer:write`	admin
`DELETE` `/api/v1/store/customizer/mockups/{id}`	Delete a mockup	—	`customizer:write`	admin
`GET` `/api/v1/store/customizer/mockups/{id}/print-areas`	List print areas	`print_areas` CzPrintAreaView[]	`customizer:read`	any
`POST` `/api/v1/store/customizer/mockups/{id}/print-areas`	Create a print area	`print_area` CzPrintAreaView	`customizer:write`	admin
`GET` `/api/v1/store/customizer/option-sets`	List option sets	`option_sets` CzOptionSetView[]	`customizer:read`	any
`POST` `/api/v1/store/customizer/option-sets`	Create an option set	`option_set` CzOptionSetView	`customizer:write`	admin
`GET` `/api/v1/store/customizer/option-sets/{id}`	Get an option set	`option_set` CzOptionSetView	`customizer:read`	any
`PUT` `/api/v1/store/customizer/option-sets/{id}`	Update an option set	`option_set` CzOptionSetView	`customizer:write`	admin
`DELETE` `/api/v1/store/customizer/option-sets/{id}`	Delete an option set	—	`customizer:write`	admin
`PUT` `/api/v1/store/customizer/option-sets/{id}/option-order`	Re-order an option set's options (whole list, position assigns the order)	—	`customizer:write`	admin
`GET` `/api/v1/store/customizer/option-sets/{id}/options`	List options	`options` CzOptionView[]	`customizer:read`	any
`POST` `/api/v1/store/customizer/option-sets/{id}/options`	Create an option	`option` CzOptionView	`customizer:write`	admin
`PUT` `/api/v1/store/customizer/option-values/{id}`	Update an option value	`value` CzOptionValueView	`customizer:write`	admin
`DELETE` `/api/v1/store/customizer/option-values/{id}`	Delete an option value	—	`customizer:write`	admin
`PUT` `/api/v1/store/customizer/options/{id}`	Update an option	`option` CzOptionView	`customizer:write`	admin
`DELETE` `/api/v1/store/customizer/options/{id}`	Delete an option	—	`customizer:write`	admin
`PUT` `/api/v1/store/customizer/options/{id}/value-order`	Re-order an option's values (whole list, position assigns the order)	—	`customizer:write`	admin
`GET` `/api/v1/store/customizer/options/{id}/values`	List values	`values` CzOptionValueView[]	`customizer:read`	any
`POST` `/api/v1/store/customizer/options/{id}/values`	Create a value	`value` CzOptionValueView	`customizer:write`	admin
`PUT` `/api/v1/store/customizer/options/{id}/values`	Replace an option's values in bulk (upsert by value slug; deletes what it does not name only when prune is set)	`result` CzReplaceOptionValuesView	`customizer:write`	admin
`PUT` `/api/v1/store/customizer/print-areas/{id}`	Update a print area	`print_area` CzPrintAreaView	`customizer:write`	admin
`DELETE` `/api/v1/store/customizer/print-areas/{id}`	Delete a print area	—	`customizer:write`	admin
`GET` `/api/v1/store/customizer/product-bases`	List product bases	`product_bases` CzProductBaseView[]	`customizer:read`	any
`POST` `/api/v1/store/customizer/product-bases`	Create a product base	`product_base` CzProductBaseView	`customizer:write`	admin
`GET` `/api/v1/store/customizer/product-bases/{id}`	Get a product base	`product_base` CzProductBaseView	`customizer:read`	any
`PUT` `/api/v1/store/customizer/product-bases/{id}`	Update a product base	`product_base` CzProductBaseView	`customizer:write`	admin
`DELETE` `/api/v1/store/customizer/product-bases/{id}`	Delete a product base	—	`customizer:write`	admin
`GET` `/api/v1/store/customizer/product-bases/{id}/mockups`	List mockups	`mockups` CzMockupView[]	`customizer:read`	any
`POST` `/api/v1/store/customizer/product-bases/{id}/mockups`	Create a mockup	`mockup` CzMockupView	`customizer:write`	admin
`PUT` `/api/v1/store/customizer/quantity-tiers/{id}`	Update a quantity tier	`quantity_tier` CzQuantityTierView	`customizer:write`	admin
`DELETE` `/api/v1/store/customizer/quantity-tiers/{id}`	Delete a quantity tier	—	`customizer:write`	admin
`GET` `/api/v1/store/customizer/status`	Get the product customizer's status for this store	`platform_enabled` boolean	`customizer:read`	any
`GET` `/api/v1/store/customizer/templates`	List customizer templates	`templates` CzTemplateView[]	`customizer:read`	any
`POST` `/api/v1/store/customizer/templates`	Create a customizer template	`template` CzTemplateView	`customizer:write`	admin
`GET` `/api/v1/store/customizer/templates/{id}`	Get a customizer template	`template` CzTemplateView	`customizer:read`	any
`PUT` `/api/v1/store/customizer/templates/{id}`	Update a customizer template	`template` CzTemplateView	`customizer:write`	admin
`DELETE` `/api/v1/store/customizer/templates/{id}`	Delete a customizer template	—	`customizer:write`	admin
`GET` `/api/v1/store/customizer/templates/{id}/preview`	One read for the personalization preview: the design, the product photo it prints onto, and one binding's controls with artwork resolved to that binding's finish	`preview` CzTemplatePreviewView	`customizer:read`	any
`GET` `/api/v1/store/customizer/templates/{id}/quantity-tiers`	List quantity tiers	`quantity_tiers` CzQuantityTierView[]	`customizer:read`	any
`POST` `/api/v1/store/customizer/templates/{id}/quantity-tiers`	Create a quantity tier	`quantity_tier` CzQuantityTierView	`customizer:write`	admin

Product reviews

Reviews, moderation, replies and CSV import/export.

Endpoint	What it does	Returns	Scope	Role
`GET` `/api/v1/store/reviews`	List reviews	`counts` any `reviews` ReviewRowView[]	`reviews:read`	any
`POST` `/api/v1/store/reviews/bulk`	Approve, reject or delete several reviews	`applied` integer	`reviews:write`	admin
`GET` `/api/v1/store/reviews/export`	Export reviews as CSV	—	`reviews:read`	admin
`POST` `/api/v1/store/reviews/import`	Import reviews from CSV	`created` integer `errors` any `products` any `replaced` any `skipped` any	`reviews:write`	admin
`GET` `/api/v1/store/reviews/import/template`	Download the review import CSV template	—	`reviews:read`	admin
`DELETE` `/api/v1/store/reviews/{id}`	Delete a review	—	`reviews:write`	admin
`PUT` `/api/v1/store/reviews/{id}/featured`	Set featureds	`review` ReviewView	`reviews:write`	admin
`PUT` `/api/v1/store/reviews/{id}/reply`	Reply to a review	`review` ReviewView	`reviews:write`	admin
`PUT` `/api/v1/store/reviews/{id}/status`	Set status	`review` ReviewView	`reviews:write`	admin

Products

The catalogue: products, their variants, options and images.

Endpoint	What it does	Returns	Scope	Role
`GET` `/api/v1/store/products`	List products	`products` ProductListView[]	`products:read`	any
`POST` `/api/v1/store/products`	Create a product	`product` ProductView	`products:write`	admin
`POST` `/api/v1/store/products/bulk-axon-category`	Set the Axon category on several products	`ids` any `updated` integer	`products:write`	admin
`POST` `/api/v1/store/products/bulk-delete`	Delete several products	`deleted` integer `ids` any	`products:write`	admin
`GET` `/api/v1/store/products/export`	Export products as Shopify-format CSV	—	`products:read`	admin
`GET` `/api/v1/store/products/handle-available`	Check whether a product handle is free	`available` boolean	`products:read`	any
`POST` `/api/v1/store/products/import`	Import products from a Shopify-format CSV	`cleaned_cells` any `created` integer `errors` any `renamed_skus` any `skipped` any `updated` any	`products:write`	admin
`GET` `/api/v1/store/products/import/template`	Download the product import CSV template	—	`products:read`	admin
`GET` `/api/v1/store/products/options`	List products as id and title, for pickers	`products` CatalogProductOption[]	`products:read`	any
`GET` `/api/v1/store/products/{id}`	Get a product	`product` ProductView	`products:read`	any
`PUT` `/api/v1/store/products/{id}`	Update a product	`product` ProductView	`products:write`	admin
`DELETE` `/api/v1/store/products/{id}`	Delete a product	—	`products:write`	admin

Shipping

Shipping zones and the rates inside them.

Endpoint	What it does	Returns	Scope	Role
`PUT` `/api/v1/store/shipping/rates/{id}`	Update a shipping rate	`rate` ShippingRateView	`shipping:write`	admin
`DELETE` `/api/v1/store/shipping/rates/{id}`	Delete a shipping rate	—	`shipping:write`	admin
`GET` `/api/v1/store/shipping/zones`	List shipping zones	`zones` ShippingZoneView[]	`shipping:read`	any
`POST` `/api/v1/store/shipping/zones`	Create a shipping zone	`zone` ShippingZoneView	`shipping:write`	admin
`PUT` `/api/v1/store/shipping/zones/{id}`	Update a shipping zone	`zone` ShippingZoneView	`shipping:write`	admin
`DELETE` `/api/v1/store/shipping/zones/{id}`	Delete a shipping zone	—	`shipping:write`	admin
`POST` `/api/v1/store/shipping/zones/{id}/rates`	Add a rate to a shipping zone	`rate` ShippingRateView	`shipping:write`	admin

Shopify import

Importing a Shopify store's catalogue and content.

Endpoint	What it does	Returns	Scope	Role
`POST` `/api/v1/store/shopify-import`	Start a Shopify import	`import_id` integer	`shopify-import:write`	admin
`POST` `/api/v1/store/shopify-import/browser`	Start a browser-driven Shopify import	`import_id` integer	`shopify-import:write`	admin
`POST` `/api/v1/store/shopify-import/cancel`	Cancel the running Shopify import	`cancelled` boolean	`shopify-import:write`	admin
`POST` `/api/v1/store/shopify-import/clear`	Delete everything a Shopify import created	—	`shopify-import:write`	admin
`GET` `/api/v1/store/shopify-import/latest`	Get the most recent Shopify import	`import` ShopifyimportStatus	`shopify-import:read`	any
`POST` `/api/v1/store/shopify-import/probe`	Probe a Shopify store before importing	`probe` ShopifyimportProbeResult	`shopify-import:write`	admin
`POST` `/api/v1/store/shopify-import/{id}/collections`	Submit collections for a browser-driven Shopify import	`counts` ShopifyimportCounts `item_errors` ShopifyimportItemError[]	`shopify-import:write`	admin
`POST` `/api/v1/store/shopify-import/{id}/finish`	Finish a browser-driven Shopify import	`done` boolean `failed` any `tail` any	`shopify-import:write`	admin
`POST` `/api/v1/store/shopify-import/{id}/products`	Submit products for a browser-driven Shopify import	`counts` ShopifyimportCounts `item_errors` ShopifyimportItemError[]	`shopify-import:write`	admin

Staff

Members of this store. Readable by an API key; not changeable by one.

Endpoint	What it does	Returns	Scope	Role
`GET` `/api/v1/store/members`	List staff	`members` StoreMemberView[]	`staff:read`	any
`POST` `/api/v1/store/members/invite`	Invite a staff member	`added` boolean `invited` any	`staff:write`	admin
`PUT` `/api/v1/store/members/{userId}`	Set staff	—	`staff:write`	admin
`DELETE` `/api/v1/store/members/{userId}`	Remove a staff member	—	`staff:write`	admin

Store profile

The store itself: name, contact details, currency, units, and switching the storefront on or off.

Endpoint	What it does	Returns	Scope	Role
`GET` `/api/v1/store`	Get this store	`role` any `store` any `store_id` integer	`store:read`	any
`PUT` `/api/v1/store`	Update a store	`store` StoreProfileView	`store:write`	admin
`POST` `/api/v1/store/close`	Close this store	`store` StoreProfileView	`store:write`	any
`PUT` `/api/v1/store/storefront-enabled`	Set storefront enableds	`store` StoreProfileView	`store:write`	admin
`GET` `/api/v1/store/storefront-funnel`	Get the storefront conversion funnel	`funnel` StoreeventsFunnel	`store:read`	any

Store settings

The generic settings namespace.

Endpoint	What it does	Returns	Scope	Role
`GET` `/api/v1/store/settings`	List settings	`settings` StoreSettingView[]	`settings:read`	any
`PUT` `/api/v1/store/settings`	Create or replace a setting	`setting` StoreSettingRefView	`settings:write`	admin

Tax

Tax rates by region.

Endpoint	What it does	Returns	Scope	Role
`GET` `/api/v1/store/tax/rates`	List shipping rates	`rates` TaxRateView[]	`tax:read`	any
`POST` `/api/v1/store/tax/rates`	Create a shipping rate	`rate` TaxRateView	`tax:write`	admin
`PUT` `/api/v1/store/tax/rates/{id}`	Update a shipping rate	`rate` TaxRateView	`tax:write`	admin
`DELETE` `/api/v1/store/tax/rates/{id}`	Delete a shipping rate	—	`tax:write`	admin

Themes

Installed themes, their drafts, versions and the marketplace.

Endpoint	What it does	Returns	Scope	Role
`GET` `/api/v1/store/theme`	Get a theme	`theme` ThemeDraftView	`themes:read`	any
`PUT` `/api/v1/store/theme`	Update a theme	`updated_at` string (date-time)	`themes:write`	admin
`GET` `/api/v1/store/theme-market`	List theme markets	`templates` MarketTemplateListView[]	`themes:read`	any
`POST` `/api/v1/store/theme-market/install`	Install a theme from the marketplace	`theme_id` integer	`themes:write`	admin
`GET` `/api/v1/store/theme-market/{key}`	Get a theme market	`template` MarketTemplateView	`themes:read`	any
`POST` `/api/v1/store/theme/publish`	Publish the active theme's draft	`publication_id` any `version` integer	`themes:write`	admin
`POST` `/api/v1/store/theme/rollback`	Roll the active theme back to an earlier version	`version` integer	`themes:write`	admin
`GET` `/api/v1/store/theme/versions`	List published versions of the active theme	`versions` ThemeVersionView[]	`themes:read`	any
`GET` `/api/v1/store/themes`	List themes	`live_id` integer `themes` ThemeListView[]	`themes:read`	any
`POST` `/api/v1/store/themes`	Create a theme	`id` integer	`themes:write`	admin
`GET` `/api/v1/store/themes/{id}`	Get a theme	`theme` ThemeDetailView	`themes:read`	any
`PUT` `/api/v1/store/themes/{id}`	Update a theme	`updated_at` string (date-time)	`themes:write`	admin
`PATCH` `/api/v1/store/themes/{id}`	Rename a theme	`name` string	`themes:write`	admin
`DELETE` `/api/v1/store/themes/{id}`	Delete a theme	—	`themes:write`	admin
`POST` `/api/v1/store/themes/{id}/duplicate`	Duplicate a theme	`id` integer	`themes:write`	admin
`POST` `/api/v1/store/themes/{id}/preview-token`	Mint a preview token for a theme	`token` string	`themes:write`	admin
`POST` `/api/v1/store/themes/{id}/publish`	Publish a theme's draft	`publication_id` any `version` integer	`themes:write`	admin
`POST` `/api/v1/store/themes/{id}/rollback`	Roll a theme back to an earlier version	`version` integer	`themes:write`	admin
`POST` `/api/v1/store/themes/{id}/update-from-template`	Update an update from template	`name` any `theme_id` integer	`themes:write`	admin
`GET` `/api/v1/store/themes/{id}/versions`	List published versions of a theme	`versions` ThemeVersionView[]	`themes:read`	any

Volume bundles

Buy-more-save-more offers and their tiers.

Endpoint	What it does	Returns	Scope	Role
`GET` `/api/v1/store/bundles`	List volume bundles	`bundles` BundleSummaryView[]	`bundles:read`	any
`POST` `/api/v1/store/bundles`	Create a volume bundle	`bundle` BundleOfferView	`bundles:write`	admin
`GET` `/api/v1/store/bundles/{id}`	Get a volume bundle	`bundle` BundleOfferView	`bundles:read`	any
`PUT` `/api/v1/store/bundles/{id}`	Update a volume bundle	`bundle` BundleOfferView	`bundles:write`	admin
`DELETE` `/api/v1/store/bundles/{id}`	Delete a volume bundle	—	`bundles:write`	admin

Webhooks

Outbound webhook subscriptions and their delivery history.

Endpoint	What it does	Returns	Scope	Role
`GET` `/api/v1/store/webhooks`	List webhook subscriptions	`webhooks` WebhookSubscriptionView[]	`webhooks:read`	any
`POST` `/api/v1/store/webhooks`	Create a webhook subscription	`webhook` WebhookSubscriptionView	`webhooks:write`	admin
`PUT` `/api/v1/store/webhooks/{id}`	Update a webhook subscription	`webhook` WebhookSubscriptionView	`webhooks:write`	admin
`DELETE` `/api/v1/store/webhooks/{id}`	Delete a webhook subscription	—	`webhooks:write`	admin
`GET` `/api/v1/store/webhooks/{id}/deliveries`	List recent deliveries for a webhook subscription	`deliveries` WebhookDeliveryView[]	`webhooks:read`	any

Schemas

Reflected from the Go types the handlers return. A field marked required is always present.

APIKeyView

Field	Type	Always present
`created_at`	string (date-time)	yes
`created_by`	integer	yes
`expires_at`	string (date-time)	no
`hint`	string	yes
`id`	integer	yes
`key`	string	no
`last_used_at`	string (date-time)	no
`name`	string	yes
`revoked_at`	string (date-time)	no
`role`	string	yes
`scopes`	string[]	yes
`status`	string	yes

AbandonedCartRowView

Field	Type	Always present
`abandoned_at`	string (date-time)	yes
`currency`	string	yes
`email`	string	yes
`item_count`	integer	yes
`recovered`	boolean	yes
`recovered_at`	string (date-time)	no
`recovery_emails`	integer	yes
`subtotal_cents`	integer	yes
`token`	string	yes

AbandonedCheckoutRowView

Field	Type	Always present
`abandoned_at`	string (date-time)	no
`attempts`	integer	yes
`created_at`	string (date-time)	yes
`currency`	string	yes
`email`	string	yes
`item_count`	integer	yes
`payment_error`	string	no
`payment_status`	string	no
`recovered`	boolean	yes
`recovered_at`	string (date-time)	no
`recovery_emails`	integer	yes
`state`	string	yes
`token`	string	yes
`total_cents`	integer	yes

AbandonedcartDetail

Field	Type	Always present
`abandoned_at`	string (date-time)	no
`attempts`	AbandonedcartPaymentAttempt[]	yes
`billing_address`	any	no
`created_at`	string (date-time)	yes
`currency`	string	yes
`discount_cents`	integer	yes
`discount_code`	string	no
`email`	string	yes
`expires_at`	string (date-time)	yes
`lines`	AbandonedcartDetailLine[]	yes
`marketing_consent`	boolean	yes
`phone`	string	yes
`recovered_at`	string (date-time)	no
`recovery_emails`	integer	yes
`shipping_address`	any	no
`shipping_cents`	integer	yes
`shipping_line`	any	no
`state`	string	yes
`subtotal_cents`	integer	yes
`surcharge_cents`	integer	yes
`tax_cents`	integer	yes
`timeline`	AbandonedcartTimelineEvent[]	yes
`tip_cents`	integer	yes
`token`	string	yes
`total_cents`	integer	yes
`updated_at`	string (date-time)	yes
`utm`	object	no

AbandonedcartDetailLine

Field	Type	Always present
`image_src`	string	no
`price_cents`	integer	yes
`properties`	any	no
`quantity`	integer	yes
`sku`	string	no
`title`	string	yes
`variant_title`	string	no

AbandonedcartPaymentAttempt

Field	Type	Always present
`amount_cents`	integer	yes
`capture_model`	string	no
`created_at`	string (date-time)	yes
`currency`	string	yes
`error`	string	no
`payment_method`	string	no
`provider`	string	yes
`status`	string	yes
`transaction_id`	integer	yes

AbandonedcartPolicy

Field	Type	Always present
`cart`	AbandonedcartSurface	yes
`checkout`	AbandonedcartSurface	yes

AbandonedcartSurface

Field	Type	Always present
`delays_minutes`	integer[]	yes
`discount_enabled`	boolean	no
`discount_from_step`	integer	no
`discount_ttl_hours`	integer	no
`discount_value`	integer	no
`discount_value_type`	string	no
`idle_minutes`	integer	yes
`mode`	string	yes

AbandonedcartTimelineEvent

Field	Type	Always present
`amount_cents`	integer	no
`currency`	string	no
`detail`	object	no
`error_code`	string	no
`error_message`	string	no
`name`	string	yes
`occurred_at`	string (date-time)	yes
`payment_method`	string	no
`provider`	string	no
`source`	string	yes
`transaction_id`	integer	no

AbandonmentStatsView

Field	Type	Always present
`recovered`	integer	yes
`recovered_cents`	integer	yes
`recovery_rate`	number	yes
`total`	integer	yes

AnalyticsCampaignStat

Field	Type	Always present
`campaign`	string	yes
`gross_cents`	integer	yes
`order_count`	integer	yes
`source`	string	yes

AnalyticsCustomers

Field	Type	Always present
`new`	integer	yes
`returning`	integer	yes
`returning_rate`	number	yes

AnalyticsDeltas

Field	Type	Always present
`aov_pct`	number	no
`gross_pct`	number	no
`orders_pct`	number	no

AnalyticsDiscountStat

Field	Type	Always present
`code`	string	yes
`discount_cents`	integer	yes
`order_count`	integer	yes

AnalyticsFunnelStat

Field	Type	Always present
`accepted`	integer	yes
`accepts_per_entry`	number	yes
`entered`	integer	yes
`funnel_id`	integer	yes
`name`	string	yes
`revenue_cents`	integer	yes

AnalyticsMetrics

Field	Type	Always present
`aov_cents`	integer	yes
`discount_cents`	integer	yes
`gross_cents`	integer	yes
`net_cents`	integer	yes
`order_count`	integer	yes
`refund_cents`	integer	yes
`refunded_order_count`	integer	yes
`shipping_cents`	integer	yes
`tax_cents`	integer	yes
`tip_cents`	integer	yes
`units`	integer	yes

AnalyticsOverview

Field	Type	Always present
`by_campaign`	AnalyticsCampaignStat[]	yes
`by_source`	AnalyticsSourceStat[]	yes
`customers`	AnalyticsCustomers	yes
`deltas`	AnalyticsDeltas	yes
`from`	string	yes
`interval`	string	yes
`metrics`	AnalyticsMetrics	yes
`previous`	AnalyticsMetrics	yes
`series`	AnalyticsSeriesPoint[]	yes
`to`	string	yes
`top_discounts`	AnalyticsDiscountStat[]	yes
`top_products`	AnalyticsProductStat[]	yes

AnalyticsProductStat

Field	Type	Always present
`product_id`	integer	yes
`revenue_cents`	integer	yes
`title`	string	yes
`units`	integer	yes

AnalyticsSeriesPoint

Field	Type	Always present
`bucket`	string	yes
`gross_cents`	integer	yes
`order_count`	integer	yes

AnalyticsSourceStat

Field	Type	Always present
`gross_cents`	integer	yes
`order_count`	integer	yes
`source`	string	yes

AnalyticsStepStat

Field	Type	Always present
`accepted`	integer	yes
`add_rate`	number	yes
`charged`	integer	yes
`declined`	integer	yes
`funnel_id`	integer	yes
`funnel_name`	string	yes
`position`	integer	yes
`product_id`	integer	yes
`product_title`	string	yes
`sales_cents`	integer	yes
`shown`	integer	yes
`step_name`	string	yes
`unavailable`	integer	yes
`undecided`	integer	yes
`units`	integer	yes
`variant_id`	integer	yes
`zone_id`	integer	yes
`zone_name`	string	yes

AnalyticsUTMStat

Field	Type	Always present
`campaign`	string	yes
`content`	string	yes
`gross_cents`	integer	yes
`medium`	string	yes
`order_count`	integer	yes
`source`	string	yes
`term`	string	yes

AnalyticsUpsellDeepReport

Field	Type	Always present
`by_step`	AnalyticsStepStat[]	yes
`by_zone_funnel`	AnalyticsZoneFunnelStat[]	yes
`from`	string	yes
`interval`	string	yes
`kpis`	AnalyticsUpsellKPIs	yes
`series`	AnalyticsUpsellSeriesPoint[]	yes
`to`	string	yes
`utm`	AnalyticsUTMStat[]	yes
`utm_total_gross_cents`	integer	yes
`utm_total_orders`	integer	yes

AnalyticsUpsellKPIs

Field	Type	Always present
`accepted`	integer	yes
`aov_cents`	integer	yes
`carts`	integer	yes
`cohort_orders`	integer	yes
`cohort_revenue_cents`	integer	yes
`completed`	integer	yes
`declined`	integer	yes
`entered`	integer	yes
`offers_shown`	integer	yes
`order_cr`	number	yes
`orders`	integer	yes
`revenue_cents`	integer	yes
`surcharge_cents`	integer	yes
`unavailable`	integer	yes
`undecided`	integer	yes
`upsell_cr`	number	yes
`upsell_order_cr`	number	yes
`upsell_orders`	integer	yes
`upsell_revenue_cents`	integer	yes

AnalyticsUpsellReport

Field	Type	Always present
`accepted`	integer	yes
`by_funnel`	AnalyticsFunnelStat[]	yes
`completed`	integer	yes
`declined`	integer	yes
`entered`	integer	yes
`from`	string	yes
`offers_shown`	integer	yes
`other`	integer	yes
`surcharge_cents`	integer	yes
`take_rate`	number	yes
`to`	string	yes
`upsell_lines`	integer	yes
`upsell_orders`	integer	yes
`upsell_revenue_cents`	integer	yes

AnalyticsUpsellSeriesPoint

Field	Type	Always present
`accepted`	integer	yes
`bucket`	string	yes
`carts`	integer	yes
`cohort_orders`	integer	yes
`entered`	integer	yes
`order_cr`	number	yes
`orders`	integer	yes
`revenue_cents`	integer	yes
`shown`	integer	yes
`upsell_cr`	number	yes
`upsell_orders`	integer	yes
`upsell_revenue_cents`	integer	yes

AnalyticsZoneFunnelStat

Field	Type	Always present
`aov_cents`	integer	yes
`carts`	integer	yes
`funnel_id`	integer	yes
`funnel_name`	string	yes
`order_cr`	number	yes
`orders`	integer	yes
`revenue_cents`	integer	yes
`upsell_orders`	integer	yes
`upsell_revenue_cents`	integer	yes
`zone_id`	integer	yes
`zone_name`	string	yes

ArticleView

Field	Type	Always present
`author`	string	yes
`body_html`	string	yes
`created_at`	string (date-time)	yes
`excerpt`	string	yes
`handle`	string	yes
`id`	integer	yes
`image_src`	string	yes
`image_thumbhash`	string	yes
`published`	boolean	yes
`published_at`	string (date-time)	no
`seo`	any	yes
`tags`	string[]	yes
`title`	string	yes
`updated_at`	string (date-time)	yes

AuditLog

Field	Type	Always present
`action`	string	yes
`actor_id`	integer	no
`actor_type`	string	yes
`created_at`	string (date-time)	yes
`id`	integer	yes
`ip`	string	yes
`metadata`	object	yes
`method`	string	yes
`path`	string	yes
`status_code`	integer	yes
`store_id`	integer	no
`user_agent`	string	yes

AwaitingCaptureView

Field	Type	Always present
`amount_cents`	integer	yes
`attempts`	integer	yes
`authorized_at`	string (date-time)	yes
`capture_model`	string	yes
`currency`	string	yes
`current_position`	integer	no
`draft_order_id`	integer	yes
`email`	string	yes
`error`	string	yes
`expires_at`	string (date-time)	no
`funnel_id`	integer	no
`funnel_name`	string	no
`has_funnel`	boolean	yes
`needs_attention`	boolean	yes
`offer_count`	integer	no
`provider`	string	yes
`state`	string	yes
`total_cents`	integer	yes
`transaction_id`	integer	yes

BillingCardDTO

Field	Type	Always present
`brand`	string	yes
`exp_month`	integer	yes
`exp_year`	integer	yes
`id`	integer	yes
`is_default`	boolean	yes
`last4`	string	yes

BillingInvoiceDTO

Field	Type	Always present
`amount_paid_cents`	integer	yes
`attempt_count`	integer	yes
`currency`	string	yes
`due_at`	string	no
`external_id`	string	yes
`id`	integer	yes
`issued_at`	string	yes
`last_error`	string	yes
`note`	string	yes
`number`	string	yes
`paid_at`	string	no
`paid_via`	string	yes
`period_end`	string	yes
`period_start`	string	yes
`status`	string	yes
`store_handle`	string	no
`store_id`	integer	yes
`store_name`	string	no
`subtotal_cents`	integer	yes
`total_cents`	integer	yes

BillingPlanDTO

Field	Type	Always present
`billing_interval`	string	yes
`currency`	string	yes
`description`	string	yes
`features`	string[]	yes
`id`	integer	yes
`is_default`	boolean	yes
`key`	string	yes
`name`	string	yes
`price_cents`	integer	yes
`sort`	integer	yes
`status`	string	yes
`transaction_fee_bps`	integer	yes
`transaction_fee_fixed_cents`	integer	yes
`trial_days`	integer	yes

BillingSubscriptionDTO

Field	Type	Always present
`billing_interval`	string	yes
`cancel_at_period_end`	boolean	yes
`currency`	string	yes
`current_period_end`	string	yes
`current_period_start`	string	yes
`id`	integer	yes
`plan_id`	integer	yes
`price_cents`	integer	yes
`status`	string	yes
`store_id`	integer	yes
`transaction_fee_bps`	integer	yes
`transaction_fee_fixed_cents`	integer	yes
`trial_ends_at`	string	no

BundleOfferTierView

Field	Type	Always present
`benefit_label`	string	yes
`caption`	string	yes
`discount_bps`	integer	yes
`discount_display`	string	yes
`free_shipping`	boolean	yes
`id`	integer	yes
`label`	string	yes
`preselected`	boolean	yes
`quantity`	integer	yes
`title`	string	yes

BundleOfferView

Field	Type	Always present
`applies_to`	string	yes
`collection_ids`	integer[]	yes
`enabled`	boolean	yes
`id`	integer	yes
`include_plain_items`	boolean	yes
`product_ids`	integer[]	yes
`tiers`	BundleOfferTierView[]	yes
`title`	string	yes
`variant_selectors`	boolean	yes
`variant_selectors_single`	boolean	yes

BundleSummaryView

Field	Type	Always present
`applies_to`	string	yes
`collection_count`	integer	yes
`enabled`	boolean	yes
`id`	integer	yes
`include_plain_items`	boolean	yes
`product_count`	integer	yes
`tier_count`	integer	yes
`title`	string	yes

CardFieldsView

Field	Type	Always present
`eligible`	boolean	yes
`enabled`	boolean	yes
`probed`	boolean	yes
`probed_at`	string	yes
`supported`	boolean	yes

CatalogCollectionOption

Field	Type	Always present
`handle`	string	yes
`id`	integer	yes
`image_src`	string	yes
`published`	boolean	yes
`title`	string	yes

CatalogProductOption

Field	Type	Always present
`handle`	string	yes
`id`	integer	yes
`image_src`	string	yes
`status`	string	yes
`title`	string	yes

CheckoutPageListView

Field	Type	Always present
`funnel_count`	integer	yes
`id`	integer	yes
`is_default`	boolean	yes
`name`	string	yes
`sections`	any	no
`updated_at`	string (date-time)	yes

CheckoutPageRefView

Field	Type	Always present
`id`	integer	yes
`is_default`	boolean	yes
`name`	string	yes

CheckoutPageView

Field	Type	Always present
`id`	integer	yes
`is_default`	boolean	yes
`name`	string	yes
`sections`	any	no
`updated_at`	string (date-time)	yes

CheckoutZoneFunnelView

Field	Type	Always present
`enabled`	boolean	yes
`funnel_id`	integer	yes
`funnel_name`	string	yes
`position`	integer	yes
`weight`	integer	yes

CheckoutZoneView

Field	Type	Always present
`catch_all`	boolean	yes
`countries`	string[]	yes
`funnels`	CheckoutZoneFunnelView[]	yes
`id`	integer	yes
`name`	string	yes
`position`	integer	yes
`region_warning`	string	no

CollectionListView

Field	Type	Always present
`collection_type`	string	yes
`created_at`	string (date-time)	yes
`description`	string	yes
`disjunctive`	boolean	yes
`handle`	string	yes
`id`	integer	yes
`image_src`	string	yes
`products_count`	integer	yes
`published`	boolean	yes
`rules`	any	yes
`seo`	any	yes
`sort_order`	string	yes
`title`	string	yes
`updated_at`	string (date-time)	yes

CollectionMemberView

Field	Type	Always present
`handle`	string	yes
`id`	integer	yes
`image_src`	string	yes
`position`	integer	yes
`price_cents`	integer	yes
`status`	string	yes
`title`	string	yes

CollectionView

Field	Type	Always present
`collection_type`	string	yes
`created_at`	string (date-time)	yes
`description`	string	yes
`disjunctive`	boolean	yes
`handle`	string	yes
`id`	integer	yes
`image_src`	string	yes
`published`	boolean	yes
`rules`	any	yes
`seo`	any	yes
`sort_order`	string	yes
`title`	string	yes
`updated_at`	string (date-time)	yes

CustomizerCondition

Field	Type	Always present
`op`	string	yes
`option_id`	integer	yes
`value`	string	no
`values`	string[]	no

CustomizerFunction

Field	Type	Always present
`element_key`	string	no
`group_key`	string	no
`property`	string	yes
`value`	string	yes

CzDesignView

Field	Type	Always present
`height_px`	integer	yes
`id`	integer	yes
`name`	string	yes
`width_px`	integer	yes

CzElementView

Field	Type	Always present
`design_id`	integer	yes
`element_key`	string	yes
`group_key`	string	yes
`h`	number	yes
`id`	integer	yes
`rotation_deg`	number	yes
`settings`	any	yes
`type`	string	yes
`w`	number	yes
`x`	number	yes
`y`	number	yes
`z_index`	integer	yes

CzLibraryCatalogueView

Field	Type	Always present
`finishes`	integer	yes
`group_key`	string	yes
`holes`	integer	yes
`items`	integer	yes

CzLibraryItemView

Field	Type	Always present
`id`	integer	yes
`library_id`	integer	yes
`position`	integer	yes
`value`	any	yes

CzLibraryView

Field	Type	Always present
`group_key`	string	yes
`id`	integer	yes
`kind`	string	yes
`name`	string	yes
`scope_value`	string	yes

CzMockupView

Field	Type	Always present
`id`	integer	yes
`image_height`	integer	yes
`image_src`	string	yes
`image_width`	integer	yes
`name`	string	yes
`position`	integer	yes
`product_base_id`	integer	yes

CzOptionSetView

Field	Type	Always present
`id`	integer	yes
`name`	string	yes

CzOptionValueView

Field	Type	Always present
`functions`	CustomizerFunction[]	yes
`id`	integer	yes
`label`	string	yes
`option_id`	integer	yes
`position`	integer	yes
`price_delta_cents`	integer	yes
`thumbnail_url`	string	yes
`value`	string	yes

CzOptionView

Field	Type	Always present
`conditions`	CustomizerCondition[]	yes
`help_text`	string	yes
`id`	integer	yes
`label`	string	yes
`option_set_id`	integer	yes
`position`	integer	yes
`price_per_char_cents`	integer	yes
`required`	boolean	yes
`section`	string	yes
`settings`	any	yes
`type`	string	yes
`validation`	CzTextValidationView	yes

CzPreviewBindingView

Field	Type	Always present
`default_selections`	object	yes
`id`	integer	yes
`library_scope`	string	yes
`option_name`	string	yes
`option_set_id`	integer	yes
`option_set_name`	string	yes
`option_value`	string	yes
`product_handle`	string	yes
`product_id`	integer	yes
`product_title`	string	yes
`template_id`	integer	yes

CzPreviewOptionSetView

Field	Type	Always present
`id`	integer	yes
`name`	string	yes
`options`	CzPreviewOptionView[]	yes

CzPreviewOptionView

Field	Type	Always present
`conditions`	CustomizerCondition[]	yes
`help_text`	string	yes
`id`	integer	yes
`label`	string	yes
`option_set_id`	integer	yes
`position`	integer	yes
`price_per_char_cents`	integer	yes
`required`	boolean	yes
`section`	string	yes
`settings`	any	yes
`type`	string	yes
`validation`	CzTextValidationView	yes
`values`	CzOptionValueView[]	yes

CzPrintAreaView

Field	Type	Always present
`h`	number	yes
`id`	integer	yes
`mockup_id`	integer	yes
`name`	string	yes
`position`	integer	yes
`rotation_deg`	number	yes
`w`	number	yes
`x`	number	yes
`y`	number	yes

CzProductBaseView

Field	Type	Always present
`id`	integer	yes
`name`	string	yes

CzProductBindingView

Field	Type	Always present
`default_selections`	object	yes
`id`	integer	yes
`library_scope`	string	yes
`option_name`	string	yes
`option_set_id`	integer	yes
`option_value`	string	yes
`product_id`	integer	yes
`template_id`	integer	yes

CzQuantityTierView

Field	Type	Always present
`id`	integer	yes
`min_qty`	integer	yes
`position`	integer	yes
`price_cents`	integer	yes
`template_id`	integer	yes

CzReplaceOptionValuesView

Field	Type	Always present
`created`	integer	yes
`deleted`	integer	yes
`updated`	integer	yes
`values`	CzOptionValueView[]	yes

CzSelectionView

Field	Type	Always present
`picked`	boolean	yes
`raw`	string	yes
`value_id`	integer	yes

CzStudioElementView

Field	Type	Always present
`design_id`	integer	yes
`element_key`	string	yes
`group_key`	string	yes
`h`	number	yes
`id`	integer	yes
`referenced_by`	integer	yes
`rotation_deg`	number	yes
`settings`	any	yes
`type`	string	yes
`w`	number	yes
`x`	number	yes
`y`	number	yes
`z_index`	integer	yes

CzStudioMockupView

Field	Type	Always present
`id`	integer	yes
`image_height`	integer	yes
`image_src`	string	yes
`image_width`	integer	yes
`name`	string	yes
`position`	integer	yes
`print_areas`	CzPrintAreaView[]	yes
`product_base_id`	integer	yes

CzStudioPlacementView

Field	Type	Always present
`base`	CzProductBaseView	yes
`mockups`	CzStudioMockupView[]	yes
`template`	CzTemplateView	yes

CzStudioView

Field	Type	Always present
`design`	CzDesignView	yes
`elements`	CzStudioElementView[]	yes
`placements`	CzStudioPlacementView[]	yes

CzTemplatePreviewView

Field	Type	Always present
`base`	CzProductBaseView	yes
`binding`	CzPreviewBindingView	no
`bindings`	CzPreviewBindingView[]	yes
`design`	CzDesignView	yes
`elements`	CzElementView[]	yes
`mockups`	CzStudioMockupView[]	yes
`option_set`	CzPreviewOptionSetView	no
`quantity_tiers`	CzQuantityTierView[]	yes
`template`	CzTemplateView	yes

CzTemplateView

Field	Type	Always present
`design_id`	integer	yes
`export_format`	string	yes
`id`	integer	yes
`included_colors`	integer	yes
`included_elements`	integer	yes
`name`	string	yes
`ppi`	integer	yes
`price_per_extra_color_cents`	integer	yes
`price_per_extra_element_cents`	integer	yes
`product_base_id`	integer	yes

CzTextValidationView

Field	Type	Always present
`chars_per_line`	integer	yes
`max_length`	integer	yes
`max_lines`	integer	yes
`mode`	string	yes
`pattern`	string	yes

DiscountDetailView

Field	Type	Always present
`applies_to`	string	yes
`buy_collection_ids`	integer[]	yes
`buy_product_ids`	integer[]	yes
`buy_quantity`	integer	yes
`class`	string	yes
`code`	string	yes
`collection_ids`	integer[]	yes
`enabled`	boolean	yes
`ends_at`	string (date-time)	no
`get_collection_ids`	integer[]	yes
`get_product_ids`	integer[]	yes
`get_quantity`	integer	yes
`get_value`	integer	yes
`get_value_type`	string	yes
`id`	integer	yes
`minimum_subtotal_cents`	integer	yes
`once_per_customer`	boolean	yes
`per_customer_limit`	integer	no
`product_ids`	integer[]	yes
`starts_at`	string (date-time)	no
`type`	string	yes
`usage_limit`	integer	no
`used_count`	integer	yes
`value`	integer	yes
`value_type`	string	yes

DiscountView

Field	Type	Always present
`applies_to`	string	yes
`buy_quantity`	integer	yes
`class`	string	yes
`code`	string	yes
`enabled`	boolean	yes
`ends_at`	string (date-time)	no
`get_quantity`	integer	yes
`get_value`	integer	yes
`get_value_type`	string	yes
`id`	integer	yes
`minimum_subtotal_cents`	integer	yes
`once_per_customer`	boolean	yes
`per_customer_limit`	integer	no
`starts_at`	string (date-time)	no
`type`	string	yes
`usage_limit`	integer	no
`used_count`	integer	yes
`value`	integer	yes
`value_type`	string	yes

DomainView

Field	Type	Always present
`dns_records`	DomainmgrDNSRecord[]	yes
`hostname`	string	yes
`id`	integer	yes
`is_primary`	boolean	yes
`last_error`	string	yes
`ssl_status`	string	yes
`status`	string	yes
`verification_records`	any	yes

DomainmgrDNSRecord

Field	Type	Always present
`name`	string	yes
`note`	string	no
`purpose`	string	yes
`type`	string	yes
`value`	string	yes

DraftOrderLineView

Field	Type	Always present
`custom`	boolean	yes
`id`	integer	yes
`line_total_cents`	integer	yes
`price_cents`	integer	yes
`quantity`	integer	yes
`sku`	string	yes
`title`	string	yes
`variant_id`	integer	no
`variant_title`	string	yes

DraftOrderView

Field	Type	Always present
`currency`	string	yes
`email`	string	yes
`id`	integer	yes
`invoice_sent_at`	string (date-time)	no
`lines`	DraftOrderLineView[]	yes
`name`	string	yes
`note`	string	yes
`order_id`	integer	no
`status`	string	yes
`subtotal_cents`	integer	yes
`tags`	string[]	yes
`token`	string	yes
`total_cents`	integer	yes

Error

Field	Type	Always present
`message`	string	yes
`status`	boolean	yes

FeatureflagsPP15Config

Field	Type	Always present
`active`	boolean	yes
`cap_cents`	integer	yes
`value_bps`	integer	yes

FormSubmissionView

Field	Type	Always present
`created_at`	string (date-time)	yes
`email`	string	yes
`id`	string	yes
`message`	string	yes
`name`	string	yes
`read`	boolean	yes
`read_at`	string (date-time)	no
`source_url`	string	yes
`type`	string	yes

FulfilledQuantityView

Field	Type	Always present
`line_item_id`	integer	yes
`quantity`	integer	yes

FulfillmentView

Field	Type	Always present
`carrier`	string	yes
`created_at`	string (date-time)	yes
`id`	integer	yes
`note`	string	yes
`order_id`	integer	yes
`status`	string	yes
`tracking_number`	string	yes
`tracking_url`	string	yes

FunnelStepView

Field	Type	Always present
`accept_next_position`	integer	no
`config`	any	yes
`decline_next_position`	integer	no
`id`	integer	yes
`name`	string	yes
`position`	integer	yes
`type`	string	yes
`upsell_page`	any	yes

FunnelSummaryView

Field	Type	Always present
`checkout_page_id`	integer	no
`enabled`	boolean	yes
`id`	integer	yes
`name`	string	yes
`timeout_seconds`	integer	yes

FunnelView

Field	Type	Always present
`checkout_page_id`	integer	no
`enabled`	boolean	yes
`id`	integer	yes
`name`	string	yes
`offers`	FunnelStepView[]	yes
`pp15`	FeatureflagsPP15Config	no
`timeout_seconds`	integer	yes
`tipping`	TippingConfig	no
`upsell_page`	any	yes

KlaviyoAccountView

Field	Type	Always present
`id`	string	yes
`name`	string	yes
`test_account`	boolean	yes

KlaviyoCredentialsView

Field	Type	Always present
`account_id`	string	yes
`account_name`	string	yes
`auth_method`	string	yes
`backfill_done`	integer	yes
`backfill_status`	string	yes
`backfill_total`	integer	yes
`enabled`	boolean	yes
`has_key`	boolean	yes
`key_hint`	string	yes
`list_id`	string	yes
`list_name`	string	yes
`metric_variant`	string	yes
`test_account`	boolean	yes

KlaviyoListDTO

Field	Type	Always present
`id`	string	yes
`name`	string	yes
`opt_in_process`	string	yes

KlaviyoPublicConfig

Field	Type	Always present
`added_to_cart`	boolean	yes
`onsite_enabled`	boolean	yes
`site_id`	string	yes
`viewed_product`	boolean	yes

KlaviyoView

Field	Type	Always present
`credentials`	KlaviyoCredentialsView	yes
`public`	KlaviyoPublicConfig	yes

MarketTemplateListView

Field	Type	Always present
`author`	string	yes
`category`	string	yes
`currency`	string	yes
`description`	string	yes
`family`	string	yes
`key`	string	yes
`latest_version`	integer	yes
`name`	string	yes
`owned`	boolean	yes
`preview_images`	any	yes
`price_cents`	integer	yes
`tagline`	string	yes
`theme_version`	string	yes
`thumbnail_url`	string	yes

MarketTemplateView

Field	Type	Always present
`author`	string	yes
`category`	string	yes
`currency`	string	yes
`description`	string	yes
`family`	string	yes
`key`	string	yes
`latest_version`	integer	yes
`name`	string	yes
`preview_images`	any	yes
`price_cents`	integer	yes
`tagline`	string	yes
`theme_version`	string	yes
`thumbnail_url`	string	yes

MenuRefView

Field	Type	Always present
`handle`	string	yes
`title`	string	yes

MenuView

Field	Type	Always present
`handle`	string	yes
`items`	any	yes
`title`	string	yes

OrderAttributionView

Field	Type	Always present
`utm_campaign`	string	yes
`utm_content`	string	yes
`utm_medium`	string	yes
`utm_source`	string	yes
`utm_term`	string	yes

OrderCustomerView

Field	Type	Always present
`accepts_marketing`	boolean	yes
`created_at`	string (date-time)	yes
`email`	string	yes
`first_name`	string	yes
`id`	integer	yes
`last_name`	string	yes
`orders_count`	integer	yes
`phone`	string	yes

OrderDetailView

Field	Type	Always present
`attribution`	OrderAttributionView	no
`billing_address`	any	yes
`cancel_reason`	string	yes
`cancelled_at`	string (date-time)	no
`checkout_started_at`	string (date-time)	no
`created_at`	string (date-time)	yes
`currency`	string	yes
`customer`	OrderCustomerView	no
`discount_cents`	integer	yes
`discount_code`	string	yes
`email`	string	yes
`financial_status`	string	yes
`fulfillment_status`	string	yes
`id`	integer	yes
`line_items`	OrderLineItemView[]	yes
`note`	string	yes
`order_number`	integer	yes
`order_number_display`	string	yes
`paid_at`	string (date-time)	no
`shipping_address`	any	yes
`shipping_cents`	integer	yes
`shipping_line`	any	yes
`status`	string	yes
`subtotal_cents`	integer	yes
`system_tags`	string[]	yes
`tags`	string[]	yes
`tax_cents`	integer	yes
`tip_cents`	integer	yes
`token`	string	yes
`total_cents`	integer	yes
`transactions`	OrderTransactionView[]	yes
`upsell`	OrderUpsellView	no

OrderLineItemView

Field	Type	Always present
`bundle_group`	string	no
`bundle_title`	string	no
`id`	integer	yes
`image_src`	string	yes
`image_thumbhash`	string	yes
`original_price_cents`	integer	no
`price_cents`	integer	yes
`properties`	object	no
`quantity`	integer	yes
`requires_shipping`	boolean	yes
`sku`	string	yes
`source`	string	yes
`title`	string	yes
`variant_title`	string	yes

OrderSummaryView

Field	Type	Always present
`created_at`	string (date-time)	yes
`currency`	string	yes
`email`	string	yes
`financial_status`	string	yes
`fulfillment_status`	string	yes
`id`	integer	yes
`order_number`	integer	yes
`order_number_display`	string	yes
`status`	string	yes
`system_tags`	string[]	yes
`tags`	string[]	yes
`total_cents`	integer	yes

OrderTransactionView

Field	Type	Always present
`amount_cents`	integer	yes
`created_at`	string (date-time)	yes
`currency`	string	yes
`error`	string	no
`external_id`	string	yes
`id`	integer	yes
`kind`	string	yes
`payment_method`	string	no
`provider`	string	yes
`status`	string	yes

OrderUpsellView

Field	Type	Always present
`entered_at`	string (date-time)	yes
`funnel_name`	string	yes
`status`	string	yes

PP15PlatformView

Field	Type	Always present
`post_upsell_enabled`	boolean	yes
`pp15_enabled`	boolean	yes

PageView

Field	Type	Always present
`body_html`	string	yes
`created_at`	string (date-time)	yes
`handle`	string	yes
`id`	integer	yes
`published`	boolean	yes
`published_at`	string (date-time)	no
`seo`	any	yes
`title`	string	yes
`updated_at`	string (date-time)	yes

PaymentFeaturesView

Field	Type	Always present
`holds_funds_at_checkout`	boolean	yes
`manual_capture`	boolean	yes
`refunds`	boolean	yes
`settle_retryable`	boolean	yes
`upsell`	boolean	yes
`wallets`	string[]	yes
`webhook_autoreg`	boolean	yes

PaymentProviderView

Field	Type	Always present
`capabilities`	any	yes
`card_fields`	CardFieldsView	yes
`display_name`	string	yes
`enabled`	boolean	yes
`features`	PaymentFeaturesView	yes
`has_credentials`	boolean	yes
`has_webhook_secret`	boolean	yes
`id`	integer	yes
`mode`	string	yes
`provider`	string	yes
`public_config`	any	yes
`public_id`	string	yes
`wallet_domains`	WalletDomainView[]	yes
`webhook_path`	string	yes
`webhook_registered`	boolean	yes
`webhook_url`	string	yes

ProductImageView

Field	Type	Always present
`alt`	string	yes
`height`	integer	yes
`id`	integer	yes
`position`	integer	yes
`src`	string	yes
`thumbhash`	string	yes
`width`	integer	yes

ProductListView

Field	Type	Always present
`handle`	string	yes
`id`	integer	yes
`image_src`	string	no
`price_cents`	integer	no
`product_type`	string	yes
`rating_avg`	integer	yes
`rating_count`	integer	yes
`status`	string	yes
`tags`	string[]	yes
`title`	string	yes
`updated_at`	string (date-time)	yes
`vendor`	string	yes

ProductOptionView

Field	Type	Always present
`name`	string	yes
`position`	integer	yes
`values`	string[]	yes

ProductVariantView

Field	Type	Always present
`barcode`	string	yes
`compare_at_price_cents`	integer	no
`cost_cents`	integer	no
`id`	integer	yes
`image_id`	integer	no
`inventory_policy`	string	yes
`inventory_quantity`	integer	yes
`option1`	string	yes
`option2`	string	yes
`option3`	string	yes
`position`	integer	yes
`price_cents`	integer	yes
`requires_shipping`	boolean	yes
`sku`	string	yes
`taxable`	boolean	yes
`title`	string	yes
`track_inventory`	boolean	yes
`weight_grams`	integer	yes

ProductView

Field	Type	Always present
`axon_category_id`	integer	yes
`body_html`	string	yes
`collection_ids`	integer[]	yes
`handle`	string	yes
`id`	integer	yes
`images`	ProductImageView[]	yes
`options`	ProductOptionView[]	yes
`product_type`	string	yes
`rating_avg`	integer	yes
`rating_count`	integer	yes
`seo`	any	yes
`status`	string	yes
`tags`	string[]	yes
`title`	string	yes
`updated_at`	string (date-time)	yes
`variants`	ProductVariantView[]	yes
`vendor`	string	yes

RefundView

Field	Type	Always present
`amount_cents`	integer	yes
`currency`	string	yes
`id`	integer	yes
`order_financial_status`	string	yes
`status`	string	yes

RenderView

Field	Type	Always present
`height_px`	integer	no
`id`	integer	no
`line_item_id`	integer	yes
`note`	string	no
`status`	string	yes
`title`	string	yes
`variant_title`	string	yes
`width_px`	integer	no

ReviewPhoto

Field	Type	Always present
`height`	integer	yes
`src`	string	yes
`thumbhash`	string	no
`width`	integer	yes

ReviewRowView

Field	Type	Always present
`author`	string	yes
`body`	string	yes
`created_at`	string (date-time)	yes
`email`	string	yes
`featured`	boolean	yes
`id`	string	yes
`order_id`	string	no
`photos`	ReviewPhoto[]	yes
`product_handle`	string	yes
`product_id`	string	yes
`product_title`	string	yes
`rating`	integer	yes
`replied_at`	string (date-time)	no
`reply`	string	yes
`source`	string	yes
`status`	string	yes
`title`	string	yes
`verified`	boolean	yes

ReviewView

Field	Type	Always present
`author`	string	yes
`body`	string	yes
`created_at`	string (date-time)	yes
`email`	string	yes
`featured`	boolean	yes
`id`	string	yes
`order_id`	string	no
`photos`	ReviewPhoto[]	yes
`product_id`	string	yes
`rating`	integer	yes
`replied_at`	string (date-time)	no
`reply`	string	yes
`source`	string	yes
`status`	string	yes
`title`	string	yes
`verified`	boolean	yes

ScopeResourceView

Field	Type	Always present
`label`	string	yes
`resource`	string	yes

ShippingRateView

Field	Type	Always present
`id`	integer	yes
`max_subtotal_cents`	integer	no
`max_weight_grams`	integer	no
`min_subtotal_cents`	integer	no
`min_weight_grams`	integer	no
`name`	string	yes
`position`	integer	yes
`price_cents`	integer	yes
`zone_id`	integer	yes

ShippingZoneView

Field	Type	Always present
`countries`	string[]	yes
`default_rate_id`	integer	no
`id`	integer	yes
`name`	string	yes
`position`	integer	yes
`rates`	ShippingRateView[]	yes
`region_warning`	string	no

ShopifyimportCounts

Field	Type	Always present
`articles`	integer	yes
`collections`	integer	yes
`images`	integer	yes
`pages`	integer	yes
`products`	integer	yes

ShopifyimportItemError

Field	Type	Always present
`msg`	string	yes
`phase`	string	yes

ShopifyimportProbeResult

Field	Type	Always present
`articles`	integer	yes
`collections`	integer	yes
`collections_at_least`	boolean	yes
`domain`	string	yes
`has_blog`	boolean	yes
`import_limit`	integer	yes
`is_shopify`	boolean	yes
`pages`	integer	yes
`products`	integer	yes
`store_name`	string	yes

ShopifyimportStatus

Field	Type	Always present
`counts`	ShopifyimportCounts	yes
`error_message`	string	yes
`errors`	ShopifyimportItemError[]	yes
`finished_at`	string	yes
`id`	integer	yes
`mode`	string	yes
`phase`	string	yes
`source`	string	yes
`started_at`	string	yes
`status`	string	yes

StoreMemberView

Field	Type	Always present
`email`	string	yes
`name`	string	yes
`role`	string	yes
`status`	string	yes
`user_id`	integer	yes

StoreProfileView

Field	Type	Always present
`address`	any	yes
`contact_email`	string	yes
`contact_phone`	string	yes
`currency`	string	yes
`handle`	string	yes
`id`	integer	yes
`locale`	string	yes
`name`	string	yes
`order_number_prefix`	string	yes
`order_number_suffix`	string	yes
`status`	string	yes
`timezone`	string	yes
`weight_unit`	string	yes

StoreSettingRefView

Field	Type	Always present
`key`	string	yes
`namespace`	string	yes

StoreSettingView

Field	Type	Always present
`key`	string	yes
`namespace`	string	yes
`value`	any	yes

StoreeventsFunnel

Field	Type	Always present
`added_to_cart`	integer	yes
`purchased`	integer	yes
`reached_checkout`	integer	yes
`sessions`	integer	yes
`viewed_product`	integer	yes

StoremailConfig

Field	Type	Always present
`enabled`	boolean	yes
`encryption`	string	yes
`from_email`	string	yes
`from_name`	string	yes
`has_password`	boolean	yes
`host`	string	yes
`port`	integer	yes
`reply_to`	string	yes
`username`	string	yes

TaxRateView

Field	Type	Always present
`country`	string	yes
`id`	integer	yes
`name`	string	yes
`position`	integer	yes
`province`	string	yes
`rate_bps`	integer	yes
`region_warning`	string	no

ThemeDetailView

Field	Type	Always present
`base_key`	string	yes
`draft_settings`	any	yes
`id`	integer	yes
`name`	string	yes
`source_template_key`	string	no
`source_theme_version`	string	no
`thumbnail_url`	string	no

ThemeDraftView

Field	Type	Always present
`base_key`	string	yes
`draft_settings`	any	yes
`id`	integer	yes
`name`	string	yes

ThemeListView

Field	Type	Always present
`id`	integer	yes
`latest_theme_version`	string	no
`live`	boolean	yes
`name`	string	yes
`source_template_key`	string	no
`source_theme_version`	string	no
`thumbnail_url`	string	no
`update_available`	boolean	no
`updated_at`	string (date-time)	yes

ThemeVersionView

Field	Type	Always present
`publication_id`	integer	yes
`published_at`	string (date-time)	yes
`version`	integer	yes

TippingConfig

Field	Type	Always present
`allow_custom`	boolean	yes
`default_preset`	integer	no
`description`	string	no
`enabled`	boolean	yes
`label`	string	no
`max_percent`	integer	no
`mode`	string	no
`presets`	integer[]	yes

TrackingAxonCAPIView

Field	Type	Always present
`enabled`	boolean	yes
`has_token`	boolean	yes
`pixel_id`	string	yes

TrackingAxonConfig

Field	Type	Always present
`category_id`	integer	no
`event_keys`	string[]	yes

TrackingCAPIView

Field	Type	Always present
`enabled`	boolean	yes
`has_token`	boolean	yes
`pixel_id`	string	yes
`test_event_code`	string	yes

TrackingConfig

Field	Type	Always present
`axon`	TrackingAxonConfig	yes
`google`	TrackingGoogleConfig	yes
`meta`	TrackingMetaConfig	yes
`options`	TrackingOptions	yes
`pinterest`	TrackingPinterestConfig	yes
`tiktok`	TrackingTikTokConfig	yes

TrackingGoogleConfig

Field	Type	Always present
`ads_labels`	object	yes
`tag_ids`	string[]	yes

TrackingMetaConfig

Field	Type	Always present
`pixel_ids`	string[]	yes
`test_event_code`	string	yes

TrackingOptions

Field	Type	Always present
`content_id`	string	yes
`debug`	boolean	yes

TrackingPinterestConfig

Field	Type	Always present
`tag_ids`	string[]	yes

TrackingTikTokConfig

Field	Type	Always present
`pixel_ids`	string[]	yes

WalletDomainView

Field	Type	Always present
`host`	string	yes
`registered`	boolean	yes
`registered_at`	string	yes

WalletRegistrationView

Field	Type	Always present
`error`	string	no
`host`	string	yes
`registered`	boolean	yes

WebhookDeliveryView

Field	Type	Always present
`attempts`	integer	yes
`id`	integer	yes
`last_error`	string	yes
`last_status_code`	integer	yes
`status`	string	yes
`topic`	string	yes

WebhookSubscriptionView

Field	Type	Always present
`active`	boolean	yes
`id`	integer	yes
`secret`	string	no
`topics`	string[]	yes
`url`	string	yes