Admin API
Merchant API: what the Mobiari admin and mobile apps use, open to your own integrations, scripts and back-office tools.
The merchant API behind the Mobiari admin and mobile apps, open to your own integrations. Authenticate with Authorization: Bearer <token>: a session token from POST /auth/login or a store API token (mobi_st_…) issued under /stores/{store_id}/api-tokens, which works only for that store.
| Base URL | https://api.mobiari.com/v1 |
| Authentication | Authorization: Bearer <token> on every operation, see Authentication |
| Conventions | Errors, pagination, idempotency, rate limits: API conventions |
| OpenAPI document | admin.json (version 1.0.0) |
Paths below are relative to the base URL.
Auth
Sign-in, sessions, refresh tokens and two-factor authentication
| Method | Path | Operation |
|---|---|---|
POST | /auth/2fa/totp/verify | Finish signing in with an authenticator code |
POST | /auth/login | Sign in |
POST | /auth/logout | Sign out |
POST | /auth/otp/send | Send a sign-in code over WhatsApp |
POST | /auth/otp/verify | Finish signing in with a WhatsApp code |
POST | /auth/refresh | Refresh a session |
POST | /auth/register | Create an account |
Me
The signed-in user: profile, access, devices and preferences
| Method | Path | Operation |
|---|---|---|
GET | /me | Get my profile |
PATCH | /me | Update my profile |
POST | /me/2fa/totp/disable | Turn off the authenticator app |
POST | /me/2fa/totp/enable | Turn on the authenticator app |
GET | /me/2fa/totp/setup | Start setting up an authenticator app |
POST | /me/2fa/whatsapp/confirm-setup | Turn on WhatsApp sign-in codes |
POST | /me/2fa/whatsapp/disable | Turn off WhatsApp sign-in codes |
POST | /me/2fa/whatsapp/start-setup | Start setting up WhatsApp sign-in codes |
GET | /me/access | Get my stores and permissions |
POST | /me/change-password | Change my password |
GET | /me/sessions | List my sessions |
POST | /me/sessions/revoke-others | Sign out my other sessions |
DELETE | /me/sessions/{session_id} | Revoke one of my sessions |
Tenants
Organizations that own stores
| Method | Path | Operation |
|---|---|---|
GET | /tenants | List tenants |
POST | /tenants | Create a tenant |
GET | /tenants/{tenant_id} | Get a tenant |
PATCH | /tenants/{tenant_id} | Update a tenant |
Billing
The organization's Mobiari subscription: plans and prices, the trial, plan changes, cancellation, invoices (paid by Pix) and usage against the plan's limits. Every plan includes every module; plans differ in size
| Method | Path | Operation |
|---|---|---|
GET | /billing/plans | List plans |
GET | /tenants/{tenant_id}/invoices | List invoices |
GET | /tenants/{tenant_id}/subscription | Get the subscription |
PUT | /tenants/{tenant_id}/subscription | Change the plan |
POST | /tenants/{tenant_id}/subscription/cancel | Cancel the subscription |
POST | /tenants/{tenant_id}/subscription/pay | Pay the subscription |
POST | /tenants/{tenant_id}/subscription/resume | Resume the subscription |
Stores
Stores and their settings
| Method | Path | Operation |
|---|---|---|
GET | /stores | List a tenant's stores |
POST | /stores | Create a store |
GET | /stores/{store_id}/onboarding | Get the setup checklist |
GET | /stores/{store_id}/settings | Get store settings |
PATCH | /stores/{store_id}/settings | Update store settings |
GET | /stores/{store_id}/usage | Get the store's usage |
Team
Store members, invites, roles and permissions
| Method | Path | Operation |
|---|---|---|
POST | /invites/accept | Accept an invite |
GET | /permissions/catalog | Get the permission catalog |
GET | /stores/{store_id}/invites | List pending invites |
POST | /stores/{store_id}/invites | Invite someone to the store |
DELETE | /stores/{store_id}/invites/{invite_id} | Cancel an invite |
GET | /stores/{store_id}/members | List store members |
DELETE | /stores/{store_id}/members/{user_id} | Remove a member |
GET | /stores/{store_id}/roles | List roles |
POST | /stores/{store_id}/roles | Create a role |
GET | /stores/{store_id}/roles/audit | List role and membership changes |
PATCH | /stores/{store_id}/roles/{role_id} | Update a role |
DELETE | /stores/{store_id}/roles/{role_id} | Delete a role |
POST | /stores/{store_id}/transfer-ownership | Transfer store ownership |
GET | /stores/{store_id}/users/{user_id}/roles | List a member's roles |
PUT | /stores/{store_id}/users/{user_id}/roles | Set a member's roles |
GET | /users | List users |
API Tokens
Store API tokens for scripts and integrations: each works for one store
| Method | Path | Operation |
|---|---|---|
GET | /stores/{store_id}/api-tokens | List API tokens |
POST | /stores/{store_id}/api-tokens | Create an API token |
DELETE | /stores/{store_id}/api-tokens/{token_id} | Revoke an API token |
POST | /stores/{store_id}/api-tokens/{token_id}/rotate | Rotate an API token |
Webhooks
Outbound event subscriptions and deliveries
| Method | Path | Operation |
|---|---|---|
GET | /stores/{store_id}/webhooks | List webhooks |
POST | /stores/{store_id}/webhooks | Create a webhook |
PUT | /stores/{store_id}/webhooks/{webhook_id} | Update a webhook |
DELETE | /stores/{store_id}/webhooks/{webhook_id} | Delete a webhook |
GET | /stores/{store_id}/webhooks/{webhook_id}/deliveries | List a webhook's deliveries |
GET | /stores/{store_id}/webhooks/{webhook_id}/events | List a webhook's events |
POST | /stores/{store_id}/webhooks/{webhook_id}/events | Subscribe a webhook to events |
DELETE | /stores/{store_id}/webhooks/{webhook_id}/events/{event} | Unsubscribe a webhook from an event |
Events
Domain events: the store's outbox and the catalog of event names
| Method | Path | Operation |
|---|---|---|
GET | /events/catalog | Get the event catalog |
GET | /stores/{store_id}/events | List store events |
Audit
Who changed what, and when
| Method | Path | Operation |
|---|---|---|
GET | /stores/{store_id}/audit | List the audit log |
GET | /stores/{store_id}/audit/actions | List audited action names |
Search
One search across a store's orders, customers, products, campaigns and conversations
| Method | Path | Operation |
|---|---|---|
GET | /stores/{store_id}/search | Search the store |
Places
Address autocomplete and lookup (Brazil)
| Method | Path | Operation |
|---|---|---|
GET | /places/autocomplete | Suggest addresses |
GET | /places/details/{place_id} | Get an address |
Products
Products, variants, options, media, and the SKU/barcode lookup. Stock per location comes with the product and the variant; stock movements are under Inventory
| Method | Path | Operation |
|---|---|---|
PUT | /stores/{store_id}/option-groups/{option_group_id} | Update an option group |
DELETE | /stores/{store_id}/option-groups/{option_group_id} | Delete an option group |
GET | /stores/{store_id}/option-groups/{option_group_id}/values | List an option group's values |
POST | /stores/{store_id}/option-groups/{option_group_id}/values | Create an option value |
PUT | /stores/{store_id}/option-values/{option_value_id} | Update an option value |
DELETE | /stores/{store_id}/option-values/{option_value_id} | Delete an option value |
GET | /stores/{store_id}/products | List products |
POST | /stores/{store_id}/products | Create a product |
POST | /stores/{store_id}/products/dedupe-drafts | Remove duplicate drafts |
POST | /stores/{store_id}/products/purge-archived | Delete every archived product |
POST | /stores/{store_id}/products/purge-drafts | Delete every draft product |
GET | /stores/{store_id}/products/{product_id} | Get a product |
PUT | /stores/{store_id}/products/{product_id} | Update a product |
DELETE | /stores/{store_id}/products/{product_id} | Delete a product |
GET | /stores/{store_id}/products/{product_id}/images | List a product's media |
POST | /stores/{store_id}/products/{product_id}/images | Upload a product image |
POST | /stores/{store_id}/products/{product_id}/images/associate | Add a library file to a product's gallery |
PATCH | /stores/{store_id}/products/{product_id}/images/{image_id} | Update a product image |
DELETE | /stores/{store_id}/products/{product_id}/images/{image_id} | Delete a product image |
GET | /stores/{store_id}/products/{product_id}/option-groups | List a product's option groups |
POST | /stores/{store_id}/products/{product_id}/option-groups | Create an option group |
GET | /stores/{store_id}/products/{product_id}/sales-channels | Get a product's sales channels |
PUT | /stores/{store_id}/products/{product_id}/sales-channels | Set a product's sales channels |
PATCH | /stores/{store_id}/products/{product_id}/slug | Change a product's slug |
GET | /stores/{store_id}/products/{product_id}/slug-redirects | List a product's slug redirects |
DELETE | /stores/{store_id}/products/{product_id}/slug-redirects/{redirect_id} | Delete a slug redirect |
GET | /stores/{store_id}/products/{product_id}/specs | Get a product's specifications |
PUT | /stores/{store_id}/products/{product_id}/specs/{field_id} | Set a product's specification value |
GET | /stores/{store_id}/products/{product_id}/stock | Get a kit's component stock |
GET | /stores/{store_id}/products/{product_id}/suggested | List a product's suggested products |
PUT | /stores/{store_id}/products/{product_id}/suggested | Set a product's suggested products |
GET | /stores/{store_id}/products/{product_id}/variants | List a product's variants |
POST | /stores/{store_id}/products/{product_id}/variants | Create a variant |
PUT | /stores/{store_id}/products/{product_id}/variants/reorder | Reorder a product's variants |
POST | /stores/{store_id}/products/{product_id}/videos | Add a video to a product's gallery |
GET | /stores/{store_id}/spec-fields/{field_id}/suggestions | List values used for a spec field |
GET | /stores/{store_id}/variants/lookup | Look up a variant by SKU or barcode |
GET | /stores/{store_id}/variants/{variant_id} | Get a variant |
PUT | /stores/{store_id}/variants/{variant_id} | Update a variant |
DELETE | /stores/{store_id}/variants/{variant_id} | Delete a variant |
GET | /stores/{store_id}/variants/{variant_id}/options | Get a variant's options |
POST | /stores/{store_id}/variants/{variant_id}/options | Give a variant an option value |
Categories
Product categories and the Google/Meta marketplace taxonomies
| Method | Path | Operation |
|---|---|---|
GET | /stores/{store_id}/categories | List categories |
POST | /stores/{store_id}/categories | Create a category |
GET | /stores/{store_id}/categories/{category_id} | Get a category |
PUT | /stores/{store_id}/categories/{category_id} | Update a category |
DELETE | /stores/{store_id}/categories/{category_id} | Delete a category |
POST | /stores/{store_id}/product-categories | Add a product to a category |
DELETE | /stores/{store_id}/product-categories | Remove a product from a category |
GET | /stores/{store_id}/products/{product_id}/categories | List a product's categories |
GET | /taxonomy/by-id | Get a marketplace category |
GET | /taxonomy/search | Search marketplace categories |
Collections
Curated product collections
| Method | Path | Operation |
|---|---|---|
POST | /stores/{store_id}/collection-products | Add a product to a collection |
DELETE | /stores/{store_id}/collection-products | Remove a product from a collection |
GET | /stores/{store_id}/collections | List collections |
POST | /stores/{store_id}/collections | Create a collection |
GET | /stores/{store_id}/collections/{collection_id} | Get a collection |
PUT | /stores/{store_id}/collections/{collection_id} | Update a collection |
DELETE | /stores/{store_id}/collections/{collection_id} | Delete a collection |
GET | /stores/{store_id}/collections/{collection_id}/products | List a collection's products |
GET | /stores/{store_id}/collections/{collection_id}/sales-channels | Get a collection's sales channels |
PUT | /stores/{store_id}/collections/{collection_id}/sales-channels | Set a collection's sales channels |
GET | /stores/{store_id}/products/{product_id}/collections | List a product's collections |
Product Feeds
Google Merchant Center, Meta catalog and marketplace feeds, with per-product overrides
| Method | Path | Operation |
|---|---|---|
GET | /stores/{store_id}/product-feeds | List product feeds |
POST | /stores/{store_id}/product-feeds | Create a product feed |
GET | /stores/{store_id}/product-feeds/{feed_id} | Get a product feed |
PUT | /stores/{store_id}/product-feeds/{feed_id} | Update a product feed |
DELETE | /stores/{store_id}/product-feeds/{feed_id} | Delete a product feed |
POST | /stores/{store_id}/product-feeds/{feed_id}/generate | Generate a product feed |
GET | /stores/{store_id}/product-feeds/{feed_id}/overrides | List a feed's overrides |
POST | /stores/{store_id}/product-feeds/{feed_id}/overrides | Create a feed override |
PUT | /stores/{store_id}/product-feeds/{feed_id}/overrides/{override_id} | Update a feed override |
DELETE | /stores/{store_id}/product-feeds/{feed_id}/overrides/{override_id} | Delete a feed override |
Files
The organization's file library: folders, uploads, stars and search
| Method | Path | Operation |
|---|---|---|
GET | /tenants/{tenant_id}/files | List files |
GET | /tenants/{tenant_id}/files/search | Search files |
GET | /tenants/{tenant_id}/files/storage-summary | Get the tenant's storage use |
GET | /tenants/{tenant_id}/files/tree | Get the file tree |
POST | /tenants/{tenant_id}/files/upload | Upload a file |
PATCH | /tenants/{tenant_id}/files/{file_id} | Update a file |
DELETE | /tenants/{tenant_id}/files/{file_id} | Delete a file |
GET | /tenants/{tenant_id}/files/{file_id}/connected-products | List the products using a file |
GET | /tenants/{tenant_id}/files/{file_id}/content/{variant} | Get a file's content |
POST | /tenants/{tenant_id}/files/{file_id}/star | Star a file |
DELETE | /tenants/{tenant_id}/files/{file_id}/star | Unstar a file |
POST | /tenants/{tenant_id}/folders | Create a folder |
PATCH | /tenants/{tenant_id}/folders/{folder_id} | Update a folder |
GET | /tenants/{tenant_id}/folders/{folder_id}/files | List a folder's files |
Inventory
Stock per variant and location, adjustments, transfers, the movement ledger, reservations, counts and locations. Stock writes refuse kits (logical_stock_readonly: adjust the components) and, while an ERP owns the store's stock (inventory_mode), answer 409 inventory_managed_externally unless sent with force: true. Send an Idempotency-Key on every stock write
| Method | Path | Operation |
|---|---|---|
GET | /stores/{store_id}/inventory-locations | List inventory locations |
POST | /stores/{store_id}/inventory-locations | Create an inventory location |
PUT | /stores/{store_id}/inventory-locations/{location_id} | Update an inventory location |
DELETE | /stores/{store_id}/inventory-locations/{location_id} | Delete an inventory location |
GET | /stores/{store_id}/reservations | List reservations |
POST | /stores/{store_id}/reservations/{reservation_id}/consume | Consume a reservation |
POST | /stores/{store_id}/reservations/{reservation_id}/release | Release a reservation |
GET | /stores/{store_id}/stock | List stock |
GET | /stores/{store_id}/stock-counts | List stock counts |
POST | /stores/{store_id}/stock-counts | Start a stock count |
GET | /stores/{store_id}/stock-counts/{count_id} | Get a stock count |
POST | /stores/{store_id}/stock-counts/{count_id}/cancel | Cancel a stock count |
PUT | /stores/{store_id}/stock-counts/{count_id}/import | Import counted quantities from CSV |
PATCH | /stores/{store_id}/stock-counts/{count_id}/items/{line_id} | Enter a counted quantity |
POST | /stores/{store_id}/stock-counts/{count_id}/post | Post a stock count |
POST | /stores/{store_id}/stock/bulk-adjust | Adjust stock in bulk |
POST | /stores/{store_id}/stock/bulk-reorder | Set reorder points in bulk |
GET | /stores/{store_id}/stock/export | Export stock as CSV |
GET | /stores/{store_id}/stock/movements | List stock movements |
POST | /stores/{store_id}/stock/movements/{movement_id}/reverse | Reverse a stock movement |
GET | /stores/{store_id}/stock/overview | Get the stock overview |
GET | /stores/{store_id}/variants/{variant_id}/stock | Get a variant's stock per location |
POST | /stores/{store_id}/variants/{variant_id}/stock/adjust | Adjust a variant's stock |
GET | /stores/{store_id}/variants/{variant_id}/stock/movements | List a variant's stock movements |
PUT | /stores/{store_id}/variants/{variant_id}/stock/reorder | Set a variant's reorder point |
POST | /stores/{store_id}/variants/{variant_id}/stock/transfer | Transfer a variant's stock between locations |
Purchasing
Suppliers, purchase orders and receiving. An order goes draft, ordered, partial, received (or cancelled); receiving writes the stock
| Method | Path | Operation |
|---|---|---|
GET | /stores/{store_id}/purchase-orders | List purchase orders |
POST | /stores/{store_id}/purchase-orders | Create a purchase order |
GET | /stores/{store_id}/purchase-orders/{po_id} | Get a purchase order |
PATCH | /stores/{store_id}/purchase-orders/{po_id} | Update a purchase order |
POST | /stores/{store_id}/purchase-orders/{po_id}/receive | Receive a purchase order |
POST | /stores/{store_id}/stock/reorder-draft | Draft a purchase order from low stock |
GET | /stores/{store_id}/suppliers | List suppliers |
POST | /stores/{store_id}/suppliers | Create a supplier |
PUT | /stores/{store_id}/suppliers/{supplier_id} | Update a supplier |
Manufacturing
Components, kits and their bills of materials, and build jobs
| Method | Path | Operation |
|---|---|---|
GET | /stores/{store_id}/build-jobs | List build jobs |
GET | /stores/{store_id}/build-jobs/{job_id} | Get a build job |
PUT | /stores/{store_id}/build-jobs/{job_id} | Update a build job |
POST | /stores/{store_id}/build-jobs/{job_id}/start | Start a build job |
GET | /stores/{store_id}/component-candidates | List component candidates |
GET | /stores/{store_id}/components | List components |
POST | /stores/{store_id}/components | Create a component |
PATCH | /stores/{store_id}/components/{variant_id} | Update a component |
DELETE | /stores/{store_id}/components/{variant_id} | Delete a component |
GET | /stores/{store_id}/components/{variant_id}/usage | List where a component is used |
GET | /stores/{store_id}/kits | List kits |
GET | /stores/{store_id}/kits/{variant_id}/bom | Get a kit's bill of materials |
POST | /stores/{store_id}/kits/{variant_id}/bom | Set a bill-of-materials line |
DELETE | /stores/{store_id}/kits/{variant_id}/bom/{component_variant_id} | Remove a bill-of-materials line |
GET | /stores/{store_id}/products/{product_id}/base-bom | Get a product's base bill of materials |
POST | /stores/{store_id}/products/{product_id}/base-bom | Set a base bill-of-materials line |
DELETE | /stores/{store_id}/products/{product_id}/base-bom/{component_variant_id} | Remove a base bill-of-materials line |
Shipping Boxes
Box sizes the store packs orders in, and which boxes each variant ships in, for freight quotes
| Method | Path | Operation |
|---|---|---|
GET | /stores/{store_id}/shipping-boxes | List shipping boxes |
POST | /stores/{store_id}/shipping-boxes | Create a shipping box |
GET | /stores/{store_id}/shipping-boxes/{box_id} | Get a shipping box |
PUT | /stores/{store_id}/shipping-boxes/{box_id} | Update a shipping box |
DELETE | /stores/{store_id}/shipping-boxes/{box_id} | Delete a shipping box |
GET | /stores/{store_id}/variants/{variant_id}/shipping-boxes | List a variant's shipping boxes |
POST | /stores/{store_id}/variants/{variant_id}/shipping-boxes | Assign a shipping box to a variant |
PUT | /stores/{store_id}/variants/{variant_id}/shipping-boxes/{box_id} | Update a variant's shipping box |
DELETE | /stores/{store_id}/variants/{variant_id}/shipping-boxes/{box_id} | Remove a shipping box from a variant |
Integrations
ERP connections (Tiny): OAuth, health, the link report, manual syncs and imports, and their logs. The scheduled sync runs on its own
| Method | Path | Operation |
|---|---|---|
GET | /stores/{store_id}/capabilities | Get store capabilities |
PUT | /stores/{store_id}/capabilities/inventory | Choose the inventory module |
GET | /stores/{store_id}/erp-providers | List ERP providers |
POST | /stores/{store_id}/erp-providers | Connect an ERP |
PUT | /stores/{store_id}/erp-providers/{provider_id} | Update an ERP provider |
GET | /stores/{store_id}/erp-providers/{provider_id}/health | Check an ERP provider |
GET | /stores/{store_id}/erp-providers/{provider_id}/sync-logs | List ERP sync runs |
GET | /stores/{store_id}/erp-providers/{provider_id}/sync-logs/{log_id} | Get an ERP sync run |
GET | /stores/{store_id}/erp-providers/{provider_id}/tiny/info | Get the Tiny account |
GET | /stores/{store_id}/erp-providers/{provider_id}/tiny/link-report | Get the Tiny link report |
GET | /stores/{store_id}/erp-providers/{provider_id}/tiny/oauth/authorize-url | Get Tiny's OAuth authorize URL |
POST | /stores/{store_id}/erp-providers/{provider_id}/tiny/oauth/token | Exchange Tiny's OAuth code |
GET | /stores/{store_id}/erp-providers/{provider_id}/tiny/orders | List Tiny orders |
GET | /stores/{store_id}/erp-providers/{provider_id}/tiny/products | List Tiny products |
POST | /stores/{store_id}/erp-providers/{provider_id}/tiny/products/import | Import products from Tiny |
POST | /stores/{store_id}/erp-providers/{provider_id}/tiny/products/import/stream | Import products from Tiny, streaming progress |
POST | /stores/{store_id}/erp-providers/{provider_id}/tiny/sync | Sync stock from Tiny |
Orders
Orders, status changes and manual sales
| Method | Path | Operation |
|---|---|---|
GET | /stores/{store_id}/orders | List orders |
POST | /stores/{store_id}/orders | Create an order |
POST | /stores/{store_id}/orders/manual | Record a counter sale |
GET | /stores/{store_id}/orders/{order_id} | Get an order |
GET | /stores/{store_id}/orders/{order_id}/adjustments | List an order's item adjustments |
POST | /stores/{store_id}/orders/{order_id}/adjustments | Add an item adjustment |
PATCH | /stores/{store_id}/orders/{order_id}/status | Change an order's status |
PATCH | /stores/{store_id}/orders/{order_id}/test | Flag an order as test data |
Carts
Open and abandoned carts
| Method | Path | Operation |
|---|---|---|
GET | /stores/{store_id}/carts | List carts |
GET | /stores/{store_id}/carts/{cart_id} | Get a cart |
DELETE | /stores/{store_id}/carts/{cart_id} | Delete a cart |
Quotes
Quotes built at the counter and shared with the customer as a payment link
| Method | Path | Operation |
|---|---|---|
GET | /stores/{store_id}/quotes | List quotes |
POST | /stores/{store_id}/quotes | Create a quote |
POST | /stores/{store_id}/quotes/{cart_id}/expire | Expire a quote |
Shipments
Fulfillment, freight quotes, labels and tracking
| Method | Path | Operation |
|---|---|---|
GET | /stores/{store_id}/freight/cancel-reasons | List freight cancel reasons |
GET | /stores/{store_id}/freight/settings | Get freight settings |
POST | /stores/{store_id}/orders/{order_id}/nfe | Attach a nota fiscal |
GET | /stores/{store_id}/orders/{order_id}/shipments | List an order's shipments |
POST | /stores/{store_id}/orders/{order_id}/shipments | Create a shipment |
PATCH | /stores/{store_id}/orders/{order_id}/shipments/{shipment_id} | Update a shipment |
DELETE | /stores/{store_id}/orders/{order_id}/shipments/{shipment_id} | Delete a shipment |
POST | /stores/{store_id}/orders/{order_id}/shipments/{shipment_id}/cancel | Cancel a shipment |
POST | /stores/{store_id}/orders/{order_id}/shipments/{shipment_id}/confirm-collect | Confirm the carrier collected |
POST | /stores/{store_id}/orders/{order_id}/shipments/{shipment_id}/generate | Create the carrier order |
PUT | /stores/{store_id}/orders/{order_id}/shipments/{shipment_id}/items | Set a shipment's contents |
POST | /stores/{store_id}/orders/{order_id}/shipments/{shipment_id}/quote | Quote a shipment |
POST | /stores/{store_id}/orders/{order_id}/shipments/{shipment_id}/sync | Sync a shipment with the carrier |
POST | /stores/{store_id}/orders/{order_id}/shipments/{shipment_id}/unlink | Unlink a shipment from its carrier order |
GET | /stores/{store_id}/orders/{order_id}/unshipped-items | List an order's unshipped items |
Payments
Payments, providers and refunds
| Method | Path | Operation |
|---|---|---|
GET | /stores/{store_id}/orders/{order_id}/payments | List an order's payments |
POST | /stores/{store_id}/orders/{order_id}/refund | Refund an order |
GET | /stores/{store_id}/payment-providers | List payment providers |
POST | /stores/{store_id}/payment-providers | Connect a payment provider |
GET | /stores/{store_id}/payment-providers/catalog | List the payment gateway catalog |
PUT | /stores/{store_id}/payment-providers/{provider_id} | Update a payment provider |
GET | /stores/{store_id}/payment-providers/{provider_id}/health | Check a payment provider |
GET | /stores/{store_id}/refunds | List refunds |
Freight
Carrier integrations and the store's own delivery zones
| Method | Path | Operation |
|---|---|---|
GET | /stores/{store_id}/delivery-zones | List delivery zones |
POST | /stores/{store_id}/delivery-zones | Create a delivery zone |
PUT | /stores/{store_id}/delivery-zones/{zone_id} | Update a delivery zone |
DELETE | /stores/{store_id}/delivery-zones/{zone_id} | Delete a delivery zone |
GET | /stores/{store_id}/freight-providers | List freight providers |
POST | /stores/{store_id}/freight-providers | Connect a freight provider |
PUT | /stores/{store_id}/freight-providers/{provider_id} | Update a freight provider |
GET | /stores/{store_id}/freight-providers/{provider_id}/cargo-types | List a provider's cargo types |
GET | /stores/{store_id}/freight-providers/{provider_id}/health | Check a freight provider |
Locations
Physical stores, pickup points and the store locator
| Method | Path | Operation |
|---|---|---|
GET | /stores/{store_id}/locations | List store locations |
POST | /stores/{store_id}/locations | Create a store location |
GET | /stores/{store_id}/locations/{location_id} | Get a store location |
PUT | /stores/{store_id}/locations/{location_id} | Update a store location |
DELETE | /stores/{store_id}/locations/{location_id} | Delete a store location |
Discounts
Discount codes and automatic promotions
| Method | Path | Operation |
|---|---|---|
GET | /stores/{store_id}/discount-codes | List discount codes |
POST | /stores/{store_id}/discount-codes | Create a discount code |
POST | /stores/{store_id}/discount-codes/validate | Validate a discount code |
PUT | /stores/{store_id}/discount-codes/{code_id} | Update a discount code |
DELETE | /stores/{store_id}/discount-codes/{code_id} | Delete a discount code |
GET | /stores/{store_id}/discounts | List automatic discounts |
POST | /stores/{store_id}/discounts | Create an automatic discount |
PUT | /stores/{store_id}/discounts/{discount_id} | Update an automatic discount |
DELETE | /stores/{store_id}/discounts/{discount_id} | Delete an automatic discount |
Sales Channels
Where orders come from
| Method | Path | Operation |
|---|---|---|
GET | /stores/{store_id}/sales-channels | List sales channels |
POST | /stores/{store_id}/sales-channels | Create a sales channel |
PUT | /stores/{store_id}/sales-channels/{channel_id} | Update a sales channel |
DELETE | /stores/{store_id}/sales-channels/{channel_id} | Delete a sales channel |
POST | /stores/{store_id}/sales-channels/{channel_id}/generate-api-key | Generate a sales channel API key |
Reviews
Product reviews and moderation
| Method | Path | Operation |
|---|---|---|
GET | /stores/{store_id}/reviews | List reviews |
GET | /stores/{store_id}/reviews/settings | Get review settings |
PUT | /stores/{store_id}/reviews/settings | Update review settings |
PATCH | /stores/{store_id}/reviews/{review_id} | Moderate a review |
DELETE | /stores/{store_id}/reviews/{review_id} | Delete a review |
Customers
Customers, addresses, identities, consent and data rights
| Method | Path | Operation |
|---|---|---|
GET | /stores/{store_id}/customers | List customers |
POST | /stores/{store_id}/customers | Create a customer |
GET | /stores/{store_id}/customers/duplicates | List duplicate customers |
GET | /stores/{store_id}/customers/{customer_id} | Get a customer |
PATCH | /stores/{store_id}/customers/{customer_id} | Update a customer |
DELETE | /stores/{store_id}/customers/{customer_id} | Delete a customer |
GET | /stores/{store_id}/customers/{customer_id}/addresses | List a customer's addresses |
POST | /stores/{store_id}/customers/{customer_id}/addresses | Add an address to a customer |
PATCH | /stores/{store_id}/customers/{customer_id}/addresses/{address_id} | Update a customer address |
DELETE | /stores/{store_id}/customers/{customer_id}/addresses/{address_id} | Delete a customer address |
POST | /stores/{store_id}/customers/{customer_id}/consent | Record a customer's consent |
GET | /stores/{store_id}/customers/{customer_id}/email-activity | Get a customer's e-mail activity |
POST | /stores/{store_id}/customers/{customer_id}/erase | Erase a customer's personal data (LGPD) |
GET | /stores/{store_id}/customers/{customer_id}/export | Export a customer's data (LGPD) |
GET | /stores/{store_id}/customers/{customer_id}/graph | Get a customer's identity graph |
GET | /stores/{store_id}/customers/{customer_id}/interactions | List a customer's timeline entries |
POST | /stores/{store_id}/customers/{customer_id}/interactions | Log a timeline entry |
POST | /stores/{store_id}/customers/{customer_id}/merge | Merge a duplicate into a customer |
GET | /stores/{store_id}/customers/{customer_id}/timeline | Get a customer's timeline |
Conversations
The shared inbox: WhatsApp, e-mail and storefront chat. Conversations, messages, attachments, notes, assignment and the assisted-sale cart. Live updates come over the agent WebSocket (see the realtime guide)
| Method | Path | Operation |
|---|---|---|
GET | /stores/{store_id}/conversations | List conversations |
POST | /stores/{store_id}/conversations/bulk | Act on many conversations |
GET | /stores/{store_id}/conversations/counts | Count conversations |
GET | /stores/{store_id}/conversations/reports | Get the attendance report |
GET | /stores/{store_id}/conversations/stats | Get inbox stats |
POST | /stores/{store_id}/conversations/ws-ticket | Get a WebSocket ticket |
GET | /stores/{store_id}/conversations/{conversation_id} | Get a conversation |
PATCH | /stores/{store_id}/conversations/{conversation_id} | Update a conversation |
GET | /stores/{store_id}/conversations/{conversation_id}/cart | Get the conversation's cart |
GET | /stores/{store_id}/conversations/{conversation_id}/cart/customer | Get the cart's contact details |
PUT | /stores/{store_id}/conversations/{conversation_id}/cart/customer | Set the cart's contact details |
POST | /stores/{store_id}/conversations/{conversation_id}/cart/freight | Quote or select freight |
POST | /stores/{store_id}/conversations/{conversation_id}/cart/items | Add an item to the conversation's cart |
PATCH | /stores/{store_id}/conversations/{conversation_id}/cart/items/{variant_id} | Change an item's quantity |
DELETE | /stores/{store_id}/conversations/{conversation_id}/cart/items/{variant_id} | Remove an item from the cart |
POST | /stores/{store_id}/conversations/{conversation_id}/cart/pix | Charge the cart by PIX |
POST | /stores/{store_id}/conversations/{conversation_id}/cart/reset | Detach the cart |
GET | /stores/{store_id}/conversations/{conversation_id}/cart/search | Search variants to sell |
POST | /stores/{store_id}/conversations/{conversation_id}/cart/send | Send the payment link |
GET | /stores/{store_id}/conversations/{conversation_id}/messages | List a conversation's messages |
POST | /stores/{store_id}/conversations/{conversation_id}/messages | Send a reply |
GET | /stores/{store_id}/conversations/{conversation_id}/messages/{message_id}/attachments/{index} | Download an attachment |
POST | /stores/{store_id}/conversations/{conversation_id}/notes | Add an internal note |
DELETE | /stores/{store_id}/conversations/{conversation_id}/notes/{note_id} | Delete an internal note |
POST | /stores/{store_id}/conversations/{conversation_id}/read | Mark a conversation as read |
POST | /stores/{store_id}/conversations/{conversation_id}/suggest | Suggest a reply |
POST | /stores/{store_id}/conversations/{conversation_id}/summary | Summarize a conversation |
POST | /stores/{store_id}/conversations/{conversation_id}/typing | Signal typing |
Conversation Settings
Inbox channels (site chat, WhatsApp, e-mail), WhatsApp signup, the chat bot and canned replies
| Method | Path | Operation |
|---|---|---|
GET | /stores/{store_id}/canned-replies | List canned replies |
POST | /stores/{store_id}/canned-replies | Create a canned reply |
PATCH | /stores/{store_id}/canned-replies/{reply_id} | Update a canned reply |
DELETE | /stores/{store_id}/canned-replies/{reply_id} | Delete a canned reply |
GET | /stores/{store_id}/conversation-channels | List inbox channels |
POST | /stores/{store_id}/conversation-channels | Create an inbox channel |
GET | /stores/{store_id}/conversation-channels/meta-config | Get the WhatsApp signup configuration |
POST | /stores/{store_id}/conversation-channels/whatsapp/connect | Connect a WhatsApp number |
PATCH | /stores/{store_id}/conversation-channels/{channel_id} | Update an inbox channel |
DELETE | /stores/{store_id}/conversation-channels/{channel_id} | Delete an inbox channel |
POST | /stores/{store_id}/conversation-channels/{channel_id}/rotate-key | Rotate a channel's public key |
GET | /stores/{store_id}/conversation-channels/{channel_id}/whatsapp-status | Check a WhatsApp channel |
GET | /stores/{store_id}/conversations-ai | Get the chat bot settings |
PUT | /stores/{store_id}/conversations-ai | Update the chat bot settings |
Knowledge Base
Articles the chat bot answers from
| Method | Path | Operation |
|---|---|---|
GET | /stores/{store_id}/kb/articles | List knowledge base articles |
POST | /stores/{store_id}/kb/articles | Create a knowledge base article |
GET | /stores/{store_id}/kb/articles/{article_id} | Get a knowledge base article |
PATCH | /stores/{store_id}/kb/articles/{article_id} | Update a knowledge base article |
DELETE | /stores/{store_id}/kb/articles/{article_id} | Delete a knowledge base article |
GET | /stores/{store_id}/kb/collections | List knowledge base collections |
POST | /stores/{store_id}/kb/collections | Create a knowledge base collection |
PATCH | /stores/{store_id}/kb/collections/{collection_id} | Update a knowledge base collection |
DELETE | /stores/{store_id}/kb/collections/{collection_id} | Delete a knowledge base collection |
POST | /stores/{store_id}/kb/reindex | Re-index the knowledge base |
POST | /stores/{store_id}/kb/search | Search the knowledge base |
E-mail marketing: templates and the block editor, campaigns (broadcasts) with reports and A/B tests, segments, subscription forms, contact import and product "let me know" subscriptions
| Method | Path | Operation |
|---|---|---|
POST | /stores/{store_id}/email/audience-preview | Preview a campaign audience |
GET | /stores/{store_id}/email/broadcasts | List campaigns |
POST | /stores/{store_id}/email/broadcasts | Create a campaign |
GET | /stores/{store_id}/email/broadcasts/{broadcast_id} | Get a campaign |
PATCH | /stores/{store_id}/email/broadcasts/{broadcast_id} | Update a campaign |
DELETE | /stores/{store_id}/email/broadcasts/{broadcast_id} | Delete a campaign |
GET | /stores/{store_id}/email/broadcasts/{broadcast_id}/ab | Get a campaign's A/B results |
POST | /stores/{store_id}/email/broadcasts/{broadcast_id}/cancel | Cancel a campaign |
GET | /stores/{store_id}/email/broadcasts/{broadcast_id}/recipients | List a campaign's recipients |
GET | /stores/{store_id}/email/broadcasts/{broadcast_id}/report | Get a campaign report |
POST | /stores/{store_id}/email/broadcasts/{broadcast_id}/resend-unopened | Resend to non-openers |
POST | /stores/{store_id}/email/broadcasts/{broadcast_id}/send | Send a campaign now |
POST | /stores/{store_id}/email/contacts/import | Import contacts from a CSV |
GET | /stores/{store_id}/email/design-catalog | Get the e-mail design catalog |
GET | /stores/{store_id}/email/forms | List subscription forms |
POST | /stores/{store_id}/email/forms | Create a subscription form |
PUT | /stores/{store_id}/email/forms/{form_id} | Replace a subscription form |
DELETE | /stores/{store_id}/email/forms/{form_id} | Delete a subscription form |
GET | /stores/{store_id}/email/overview | Get the e-mail overview |
GET | /stores/{store_id}/email/product-subscriptions | List product subscriptions |
GET | /stores/{store_id}/email/product-subscriptions/summary | Summarize product subscriptions |
GET | /stores/{store_id}/email/products | List products for e-mails |
GET | /stores/{store_id}/email/segments | List segments |
POST | /stores/{store_id}/email/segments | Create a segment |
GET | /stores/{store_id}/email/segments/fields | List segment fields |
POST | /stores/{store_id}/email/segments/preview | Preview segment rules |
PUT | /stores/{store_id}/email/segments/{segment_id} | Replace a segment |
DELETE | /stores/{store_id}/email/segments/{segment_id} | Delete a segment |
GET | /stores/{store_id}/email/segments/{segment_id}/export.csv | Export a segment as CSV |
GET | /stores/{store_id}/email/segments/{segment_id}/members | List a segment's members |
GET | /stores/{store_id}/email/templates | List e-mail templates |
POST | /stores/{store_id}/email/templates | Create an e-mail template |
POST | /stores/{store_id}/email/templates/ai | Draft an e-mail with the assistant |
POST | /stores/{store_id}/email/templates/render | Render an e-mail design |
GET | /stores/{store_id}/email/templates/{template_id} | Get an e-mail template |
PATCH | /stores/{store_id}/email/templates/{template_id} | Update an e-mail template |
DELETE | /stores/{store_id}/email/templates/{template_id} | Delete an e-mail template |
POST | /stores/{store_id}/email/templates/{template_id}/test | Send an e-mail template test |
Transactional Email
The e-mails the store sends on its own (order confirmation, shipping, password reset...) and the sending settings: sender identity, provider, reply routing
| Method | Path | Operation |
|---|---|---|
GET | /stores/{store_id}/email-templates | List transactional e-mails |
GET | /stores/{store_id}/email-templates/{event} | Get a transactional e-mail |
PUT | /stores/{store_id}/email-templates/{event} | Save a transactional e-mail |
DELETE | /stores/{store_id}/email-templates/{event} | Reset a transactional e-mail |
POST | /stores/{store_id}/email-templates/{event}/preview | Preview a transactional e-mail |
POST | /stores/{store_id}/email-templates/{event}/test | Send a transactional e-mail test |
GET | /stores/{store_id}/email/config | Get the e-mail settings |
PATCH | /stores/{store_id}/email/config | Update the e-mail settings |
POST | /stores/{store_id}/email/test | Send a test e-mail |
Email Deliverability
Sending domains (SES identities and their DNS records), the suppression list and deliverability health
| Method | Path | Operation |
|---|---|---|
GET | /stores/{store_id}/email/domains | List sending domains |
POST | /stores/{store_id}/email/domains | Add a sending domain |
DELETE | /stores/{store_id}/email/domains/{domain_id} | Remove a sending domain |
POST | /stores/{store_id}/email/domains/{domain_id}/check | Check a sending domain |
GET | /stores/{store_id}/email/health | Get e-mail deliverability health |
GET | /stores/{store_id}/email/suppressions | List suppressed addresses |
POST | /stores/{store_id}/email/suppressions | Suppress an address |
DELETE | /stores/{store_id}/email/suppressions/{suppression_id} | Remove a suppression |
Ads
Segments mirrored to Meta Custom Audiences, and ad spend next to the revenue attributed to Meta
| Method | Path | Operation |
|---|---|---|
GET | /stores/{store_id}/ads/connection | Get the ads connection |
GET | /stores/{store_id}/ads/performance | Get ads performance |
GET | /stores/{store_id}/audiences | List ad audiences |
POST | /stores/{store_id}/audiences | Create an ad audience |
DELETE | /stores/{store_id}/audiences/{audience_id} | Delete an ad audience |
POST | /stores/{store_id}/audiences/{audience_id}/sync | Sync an ad audience now |
Workflows
Automations and customer journeys: a graph of steps started by a trigger (manual, customer event, webhook or schedule). Edit the draft, publish to make it fire; runs, approvals, step tests and the secrets steps use
| Method | Path | Operation |
|---|---|---|
GET | /stores/{store_id}/workflow-runs | List the store's runs |
POST | /stores/{store_id}/workflow-runs/{run_id}/approval | Decide a run's approval |
POST | /stores/{store_id}/workflow-runs/{run_id}/cancel | Cancel a run |
POST | /stores/{store_id}/workflow-runs/{run_id}/retry | Retry a run |
GET | /stores/{store_id}/workflow-secrets | List workflow secrets |
POST | /stores/{store_id}/workflow-secrets | Save a workflow secret |
DELETE | /stores/{store_id}/workflow-secrets/{name} | Delete a workflow secret |
GET | /stores/{store_id}/workflows | List workflows |
POST | /stores/{store_id}/workflows | Create a workflow |
GET | /stores/{store_id}/workflows/catalog | Get the workflow node catalog |
GET | /stores/{store_id}/workflows/{workflow_id} | Get a workflow |
PATCH | /stores/{store_id}/workflows/{workflow_id} | Update a workflow |
DELETE | /stores/{store_id}/workflows/{workflow_id} | Delete a workflow |
POST | /stores/{store_id}/workflows/{workflow_id}/duplicate | Duplicate a workflow |
POST | /stores/{store_id}/workflows/{workflow_id}/fire | Run a workflow now |
POST | /stores/{store_id}/workflows/{workflow_id}/publish | Publish a workflow |
POST | /stores/{store_id}/workflows/{workflow_id}/resume | Resume a workflow |
GET | /stores/{store_id}/workflows/{workflow_id}/runs | List a workflow's runs |
GET | /stores/{store_id}/workflows/{workflow_id}/runs/{run_id} | Get a run |
POST | /stores/{store_id}/workflows/{workflow_id}/test-node | Test a workflow step |
POST | /stores/{store_id}/workflows/{workflow_id}/unpublish | Pause a workflow |
GET | /stores/{store_id}/workflows/{workflow_id}/validate | Validate a workflow |
GET | /stores/{store_id}/workflows/{workflow_id}/versions | List a workflow's versions |
POST | /stores/{store_id}/workflows/{workflow_id}/versions/{version}/restore | Restore a workflow version |
Help
Answers from the Mobiari documentation: a public, rate-limited question endpoint the docs site and the admin's help panel use
| Method | Path | Operation |
|---|---|---|
POST | /docs/ask | Ask the documentation |
Assistant
The AI assistant: a chat that reads the store and proposes writes (applied only after approval, recorded as undoable actions), streamed as server-sent events; also over WhatsApp from linked numbers
| Method | Path | Operation |
|---|---|---|
PATCH | /assistant/conversations/{conversation_id} | Rename a conversation |
DELETE | /assistant/conversations/{conversation_id} | Delete a conversation |
GET | /assistant/conversations/{conversation_id}/messages | Get a conversation's messages |
POST | /assistant/conversations/{conversation_id}/stop | Stop the assistant |
POST | /assistant/proposals/{proposal_id}/approve | Approve a proposal |
POST | /assistant/proposals/{proposal_id}/decline | Decline a proposal |
GET | /stores/{store_id}/assistant/actions | List assistant actions |
POST | /stores/{store_id}/assistant/actions/{action_id}/undo | Undo an assistant action |
POST | /stores/{store_id}/assistant/chat | Talk to the assistant |
GET | /stores/{store_id}/assistant/conversations | List your assistant conversations |
GET | /stores/{store_id}/assistant/phones | List your assistant phones |
POST | /stores/{store_id}/assistant/phones/verify-complete | Verify a phone |
POST | /stores/{store_id}/assistant/phones/verify-start | Send a phone verification code |
GET | /stores/{store_id}/assistant/prefs | Get the assistant preferences |
PUT | /stores/{store_id}/assistant/prefs | Update the assistant preferences |
GET | /stores/{store_id}/assistant/usage | Get the assistant usage |
Notifications
The store's notification log and each member's inbox over it, customer-facing notification channels, members' own WhatsApp/e-mail alert channels and the team's sale-alert roster
| Method | Path | Operation |
|---|---|---|
GET | /stores/{store_id}/alert-subscriptions | List team alert subscriptions |
PUT | /stores/{store_id}/alert-subscriptions/{user_id} | Set a member's team alerts |
GET | /stores/{store_id}/me/platform-notifications | List my alert channels |
PUT | /stores/{store_id}/me/platform-notifications | Replace my alert channels |
GET | /stores/{store_id}/notification-channels | List notification channels |
POST | /stores/{store_id}/notification-channels | Create a notification channel |
PATCH | /stores/{store_id}/notification-channels/{channel_id} | Update a notification channel |
DELETE | /stores/{store_id}/notification-channels/{channel_id} | Delete a notification channel |
POST | /stores/{store_id}/notification-channels/{channel_id}/test | Send a test through a channel |
GET | /stores/{store_id}/notification-inbox | List my notification inbox |
POST | /stores/{store_id}/notification-inbox/mark-all-read | Mark all notifications read |
GET | /stores/{store_id}/notification-inbox/unread-count | Count my unread notifications |
POST | /stores/{store_id}/notification-inbox/{log_id}/read | Mark a notification read |
GET | /stores/{store_id}/notification-logs | List notification logs |
Push Notifications
Push to the Mobiari mobile apps: registering a device (/me/devices), per-store push preferences and test pushes. Payloads and deep links are described in the push notifications guide
| Method | Path | Operation |
|---|---|---|
GET | /me/devices | List my devices |
POST | /me/devices | Register a device for push |
DELETE | /me/devices/{device_id} | Unregister a device |
POST | /me/devices/{device_id}/test | Send a test push |
GET | /stores/{store_id}/me/push-preferences | Get my push preferences for a store |
PUT | /stores/{store_id}/me/push-preferences | Set my push preferences for a store |
Brand
Brand system: logo, palette, typography and assets
| Method | Path | Operation |
|---|---|---|
GET | /stores/{store_id}/brand-kit | Get the e-mail brand kit |
PUT | /stores/{store_id}/brand-kit | Save the e-mail brand kit |
POST | /stores/{store_id}/brand-kit/ai | Revise the e-mail brand kit with the assistant |
POST | /stores/{store_id}/brand-kit/import | Suggest a brand kit from a website |
GET | /stores/{store_id}/brand-system | Get the brand system |
PUT | /stores/{store_id}/brand-system | Save the brand system |
POST | /stores/{store_id}/brand-system/ai | Revise the brand system with AI |
POST | /stores/{store_id}/brand-system/assets | Upload a brand asset |
GET | /stores/{store_id}/brand-system/export | Export the brand system |
POST | /stores/{store_id}/brand-system/generate | Generate the brand system |
POST | /stores/{store_id}/brand-system/import | Import a design-system package |
GET | /stores/{store_id}/brand-system/jobs/{job_id} | Get a brand job |
GET | /stores/{store_id}/brand-system/versions/{version} | Get a brand system version |
POST | /stores/{store_id}/brand-system/versions/{version}/restore | Restore a brand system version |
Storefront
Storefront pages, themes, domains and deployments
| Method | Path | Operation |
|---|---|---|
POST | /preview-auth/grant | Grant a preview session |
GET | /stores/{store_id}/domains | List storefront domains |
POST | /stores/{store_id}/domains | Add a custom domain |
DELETE | /stores/{store_id}/domains/{domain_id} | Remove a custom domain |
POST | /stores/{store_id}/domains/{domain_id}/primary | Make a domain primary |
POST | /stores/{store_id}/domains/{domain_id}/verify | Verify a custom domain |
GET | /stores/{store_id}/github/connect | Start connecting GitHub |
GET | /stores/{store_id}/github/export | Export the active deployment |
GET | /stores/{store_id}/github/installation | Get the GitHub connection |
POST | /stores/{store_id}/github/link | Link a repository |
DELETE | /stores/{store_id}/github/link | Unlink the repository |
GET | /stores/{store_id}/github/repos | List GitHub repositories |
GET | /stores/{store_id}/pages | List pages |
POST | /stores/{store_id}/pages | Create a page |
GET | /stores/{store_id}/pages/{page_id} | Get a page |
PUT | /stores/{store_id}/pages/{page_id} | Update a page |
DELETE | /stores/{store_id}/pages/{page_id} | Delete a page |
GET | /stores/{store_id}/storefront/deployments | List theme deployments |
POST | /stores/{store_id}/storefront/deployments/{deployment_id}/promote | Promote a deployment |
GET | /stores/{store_id}/storefront/preview-suffix | Get preview settings |
Content
CMS collections and documents that storefront themes render
| Method | Path | Operation |
|---|---|---|
GET | /stores/{store_id}/cms/collections | List content collections |
GET | /stores/{store_id}/cms/collections/{collection_slug} | Get a content collection |
GET | /stores/{store_id}/cms/collections/{collection_slug}/documents | List a collection's documents |
POST | /stores/{store_id}/cms/collections/{collection_slug}/documents | Create a document |
POST | /stores/{store_id}/cms/collections/{collection_slug}/documents/reorder | Reorder documents |
GET | /stores/{store_id}/cms/collections/{collection_slug}/documents/{document_id} | Get a document |
PUT | /stores/{store_id}/cms/collections/{collection_slug}/documents/{document_id} | Update a document |
DELETE | /stores/{store_id}/cms/collections/{collection_slug}/documents/{document_id} | Delete a document |
Analytics
The store dashboard; storefront traffic from the built-in tracker (visitors, sessions, pages, referrers, events) and revenue attribution by source; and the ad-platform tracking setup: Meta pixel and Conversions API, Google Ads conversions, the per-order conversion delivery log and the Meta catalog sync
| Method | Path | Operation |
|---|---|---|
GET | /stores/{store_id}/dashboard/attention | Get what needs attention |
GET | /stores/{store_id}/dashboard/stats | Get dashboard numbers |
POST | /stores/{store_id}/marketing/catalog/sync | Sync the Meta catalog |
GET | /stores/{store_id}/marketing/config | Get the tracking configuration |
PATCH | /stores/{store_id}/marketing/config | Update the tracking configuration |
GET | /stores/{store_id}/marketing/conversions | List conversion deliveries |
POST | /stores/{store_id}/marketing/conversions/{order_id}/resend | Resend an order's conversions |
GET | /stores/{store_id}/marketing/insights | Get the attribution report |
GET | /stores/{store_id}/marketing/recent-events | List recent events |
GET | /stores/{store_id}/marketing/stats | Get traffic totals |
GET | /stores/{store_id}/marketing/top-events | List the top events |
GET | /stores/{store_id}/marketing/top-pages | List the most viewed pages |
GET | /stores/{store_id}/marketing/top-referrers | List the top referrers |
GET | /stores/{store_id}/marketing/visitors | List visitors |
GET | /stores/{store_id}/marketing/visitors/{visitor_id} | Get a visitor |