Skip to main content
API docs by Redocly

Tanqory Store API (2.0)

Download OpenAPI specification:Download

Per-pod store API — Products, Orders, Themes, Analytics

Products

Get product counts by status

Authorizations:
bearerbearer
path Parameters
storeId
required
string
query Parameters
previousPeriodDate
required
string

Responses

Get product counts time-series data

Authorizations:
bearerbearer
path Parameters
storeId
required
string
query Parameters
from
required
string
to
required
string
groupBy
required
string

Responses

Get tag suggestions from existing products

Authorizations:
bearerbearer
path Parameters
storeId
required
string
query Parameters
search
required
string

Responses

Get paginated tag suggestions

Authorizations:
bearerbearer
path Parameters
storeId
required
string
query Parameters
page
required
string
limit
required
string
search
required
string

Responses

Get vendor suggestions from existing products

Authorizations:
bearerbearer
path Parameters
storeId
required
string
query Parameters
search
required
string

Responses

Get paginated vendor suggestions

Authorizations:
bearerbearer
path Parameters
storeId
required
string
query Parameters
page
required
string
limit
required
string
search
required
string

Responses

Search products

Authorizations:
bearerNone
path Parameters
storeId
required
string
query Parameters
q
required
string
page
number
Default: 1
limit
number
Default: 20
cursor
string
sort
string
search
string
searchBy
string
Enum: "all" "title" "sku" "variantTitle" "barcode"

Field to search in. Default is "all" which searches across all fields.

Responses

Bulk update products status/tags

Authorizations:
bearerbearer
path Parameters
storeId
required
string

Responses

Bulk delete products

Authorizations:
bearerbearer
path Parameters
storeId
required
string

Responses

Bulk edit products and variants

Authorizations:
bearerbearer
path Parameters
storeId
required
string
Request Body schema: application/json
required
object (BulkEditProductsDto)

Responses

Request samples

Content type
application/json
{ }

Import products from CSV Deprecated

DEPRECATED — use the bulk-jobs pipeline: POST /stores/{storeId}/bulk-uploads to stage the file, then POST /stores/{storeId}/bulk-jobs with operation=IMPORT and entity=product. This endpoint parses the whole file inside the HTTP request, caps at 10 MB, and returns counts with no artifact — so a merchant whose import half succeeded learns HOW MANY rows failed and never WHICH. The pipeline returns three row-aligned files instead: the ID crosswalk, the failed rows with their original columns (re-uploadable after editing), and the rows never attempted. It also supports a dry run, which this does not. Retained per backend-standards.md §7 — the merchant frontend has already moved.

Authorizations:
bearerbearer
path Parameters
storeId
required
string

Responses

List all products

Authorizations:
bearerNone
path Parameters
storeId
required
string

Responses

Create new product

Authorizations:
bearerbearer
path Parameters
storeId
required
string
Request Body schema: application/json
required
object (CreateProductDto)

Responses

Request samples

Content type
application/json
{ }

Find live products/variants using an exact SKU (advisory)

Authorizations:
bearerbearer
path Parameters
storeId
required
string
query Parameters
sku
required
string
excludeProductId
required
string

Responses

Get product by ID

Authorizations:
bearerNone
path Parameters
storeId
required
string
id
required
string

Responses

Update product (partial)

Authorizations:
bearerbearer
path Parameters
storeId
required
string
id
required
string
Request Body schema: application/json
required
object (UpdateProductDto)

Responses

Request samples

Content type
application/json
{ }

Delete product

Authorizations:
bearerbearer
path Parameters
storeId
required
string
id
required
string

Responses

Store Settings - Products

List products for picker

Retrieve simplified product list for catalog product selection.

Authorizations:
bearer
path Parameters
storeId
required
string
query Parameters
offset
number
limit
number
status
any

Filter by status

productType
any

Filter by product type

collection
any

Filter by collection ID

search
any

Search by product name or SKU

Responses

Product Variants

Get variant by ID

Authorizations:
bearer
path Parameters
storeId
required
string
variantId
required
string

Responses

Update variant

Authorizations:
bearer
path Parameters
storeId
required
string
variantId
required
string

Responses

Delete variant

Authorizations:
bearer
path Parameters
storeId
required
string
variantId
required
string

Responses

Collections

Get collection counts by type and status

Authorizations:
bearerbearer
path Parameters
storeId
required
string

Store ID

Responses

Get collection counts time-series data

Authorizations:
bearerbearer
path Parameters
storeId
required
string

Store ID

query Parameters
from
required
string

Start date (ISO 8601)

to
required
string

End date (ISO 8601)

groupBy
string
Enum: "day" "week" "month"

Responses

List all collections

Authorizations:
bearerNone
path Parameters
storeId
required
string

Store ID

query Parameters
page
number
limit
number
search
string
collectionType
string
Enum: "MANUAL" "SMART"
status
string
Enum: "published" "draft" "scheduled"
parentId
string
sortBy
string
Enum: "title" "productCount" "createdAt" "updatedAt" "position"
sortOrder
string
Enum: "asc" "desc"
includeProducts
boolean
includeDeleted
boolean

Responses

Create a new collection

Authorizations:
bearerbearer
path Parameters
storeId
required
string

Store ID

Request Body schema: application/json
required

Collection data

string

Responses

Request samples

Content type
application/json
"string"

Get a collection by ID

Authorizations:
bearerNone
path Parameters
storeId
required
string

Store ID

id
required
string

Collection ID

query Parameters
includeProducts
boolean

Responses

Update a collection

Authorizations:
bearerbearer
path Parameters
storeId
required
string

Store ID

id
required
string

Collection ID

Request Body schema: application/json
required

Collection update data

string

Responses

Request samples

Content type
application/json
"string"

Delete a collection (soft delete)

Authorizations:
bearerbearer
path Parameters
storeId
required
string

Store ID

id
required
string

Collection ID

Responses

Get a collection by handle (URL slug)

Authorizations:
bearerNone
path Parameters
storeId
required
string

Store ID

handle
required
string

Collection handle

query Parameters
includeProducts
boolean

Responses

Permanently delete a collection

Authorizations:
bearerbearer
path Parameters
storeId
required
string

Store ID

id
required
string

Collection ID

Responses

Restore a soft-deleted collection

Authorizations:
bearerbearer
path Parameters
storeId
required
string

Store ID

id
required
string

Collection ID

Responses

Get products in a collection

Authorizations:
bearerNone
path Parameters
storeId
required
string

Store ID

id
required
string

Collection ID

query Parameters
page
number
limit
number

Responses

Add products to a manual collection

Authorizations:
bearerbearer
path Parameters
storeId
required
string

Store ID

id
required
string

Collection ID

Request Body schema: application/json
required

Array of product IDs

productIds
Array of strings

Responses

Request samples

Content type
application/json
{
  • "productIds": [
    ]
}

Remove products from a manual collection

Authorizations:
bearerbearer
path Parameters
storeId
required
string

Store ID

id
required
string

Collection ID

Request Body schema: application/json
required

Array of product IDs

productIds
Array of strings

Responses

Request samples

Content type
application/json
{
  • "productIds": [
    ]
}

Reorder products in a collection

Authorizations:
bearerbearer
path Parameters
storeId
required
string

Store ID

id
required
string

Collection ID

Request Body schema: application/json
required

Ordered array of product IDs

productIds
Array of strings

Responses

Request samples

Content type
application/json
{
  • "productIds": [
    ]
}

Publish a collection

Authorizations:
bearerbearer
path Parameters
storeId
required
string

Store ID

id
required
string

Collection ID

Responses

Unpublish a collection

Authorizations:
bearerbearer
path Parameters
storeId
required
string

Store ID

id
required
string

Collection ID

Responses

Schedule a collection for publishing

Authorizations:
bearerbearer
path Parameters
storeId
required
string

Store ID

id
required
string

Collection ID

Request Body schema: application/json
required

Publish date

publishAt
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "publishAt": "2019-08-24T14:15:22Z"
}

Refresh a smart collection (re-evaluate rules)

Authorizations:
bearerbearer
path Parameters
storeId
required
string

Store ID

id
required
string

Collection ID

Responses

Bulk delete collections

Authorizations:
bearerbearer
path Parameters
storeId
required
string

Store ID

Request Body schema: application/json
required

Array of collection IDs

ids
Array of strings

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Bulk publish collections

Authorizations:
bearerbearer
path Parameters
storeId
required
string

Store ID

Request Body schema: application/json
required

Array of collection IDs

ids
Array of strings

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Bulk unpublish collections

Authorizations:
bearerbearer
path Parameters
storeId
required
string

Store ID

Request Body schema: application/json
required

Array of collection IDs

ids
Array of strings

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Bulk edit collections (heterogeneous per-item updates)

Authorizations:
bearerbearer
path Parameters
storeId
required
string

Store ID

Responses

Store Settings - Policies

Get return rules

Retrieve return and refund rules for the store

Authorizations:
bearer
path Parameters
storeId
required
string

Responses

Update return rules

Update return and refund rules. Only owners and admins can update return rules.

Authorizations:
bearer
path Parameters
storeId
required
string
Request Body schema: application/json
required
object (UpdateReturnRulesDto)

Responses

Request samples

Content type
application/json
{ }

Create a custom return rule

Create a named, market-scoped return rule. Only owners and admins can create rules.

Authorizations:
bearer
path Parameters
storeId
required
string
Request Body schema: application/json
required
object (CreateReturnRuleDto)

Responses

Request samples

Content type
application/json
{ }

List return rules

List the default rule plus all custom market-scoped rules for the store

Authorizations:
bearer
path Parameters
storeId
required
string

Responses

Get a return rule by id

Authorizations:
bearer
path Parameters
storeId
required
string
id
required
string

Responses

Update a return rule by id

Update a default or custom return rule. Only owners and admins can update rules.

Authorizations:
bearer
path Parameters
storeId
required
string
id
required
string
Request Body schema: application/json
required
object (UpdateReturnRulesDto)

Responses

Request samples

Content type
application/json
{ }

Delete a custom return rule

Delete a custom rule. The default rule cannot be deleted.

Authorizations:
bearer
path Parameters
storeId
required
string
id
required
string

Responses

List all policies

Retrieve all policies for a store

Authorizations:
bearer
path Parameters
storeId
required
string

Responses

Create a new policy

Create a new policy for the store. Only owners and admins can create policies.

Authorizations:
bearer
path Parameters
storeId
required
string
Request Body schema: application/json
required
object (CreatePolicyDto)

Responses

Request samples

Content type
application/json
{ }

Get a specific policy by type

Retrieve a policy by its type (privacy, terms_of_service, etc.). Creates a default empty policy if not exists.

Authorizations:
bearer
path Parameters
storeId
required
string
type
required
string
Enum: "privacy" "terms_of_service" "shipping" "return_refund" "contact_information"

Policy type

Responses

Update a policy

Update an existing policy. Only owners and admins can update policies.

Authorizations:
bearer
path Parameters
storeId
required
string
type
required
string
Enum: "privacy" "terms_of_service" "shipping" "return_refund" "contact_information"

Policy type

Request Body schema: application/json
required
object (UpdatePolicyDto)

Responses

Request samples

Content type
application/json
{ }

Delete a policy

Delete a policy. Only owners and admins can delete policies.

Authorizations:
bearer
path Parameters
storeId
required
string
type
required
string
Enum: "privacy" "terms_of_service" "shipping" "return_refund" "contact_information"

Policy type

Responses

Storefront - Checkout Settings

Get checkout settings for the storefront (public, read-only)

path Parameters
storeId
required
string

Responses

Storefront - Public

Get published store policies for the storefront (public)

path Parameters
storeId
required
string

Responses

Get storefront privacy settings (cookie banner + consent flags)

path Parameters
storeId
required
string

Responses

Get connected tracking pixels for the storefront (public)

path Parameters
storeId
required
string

Responses

Store Settings - Storefront Password

Get storefront password protection

Whether the storefront is closed behind a password, and the message shown on the lock screen. Never returns the password or its digest.

Authorizations:
bearer
path Parameters
storeId
required
string

Responses

Response samples

Content type
application/json
{ }

Update storefront password protection

Turn the storefront lock screen on or off. The password is hashed server-side (sha256) and pushed to the edge as a digest — the plaintext is never stored or forwarded. Omit password to keep the current one. edgeSynced: false means the setting was saved but at least one storefront host was not updated at the edge.

Authorizations:
bearerbearer
path Parameters
storeId
required
string
header Parameters
authorization
required
string
Request Body schema: application/json
required
object (UpdateStorefrontPasswordDto)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

Media Upload

Upload media (file or URL) — hybrid sync/async

Authorizations:
bearer
path Parameters
storeId
required
string
query Parameters
mode
string
Enum: "sync" "async"

Force sync or async mode

Request Body schema:
required
file
string <binary>

File to upload

sourceUrl
string

URL to download and upload

filename
string

Custom filename

folder
string

Folder path

alt
string

Alt text

tags
Array of strings

Tags

Responses

Request samples

Content type
No sample

Get async upload job status

Authorizations:
bearer
path Parameters
storeId
required
string
jobId
required
string

Responses

Media Library

Create a media record (legacy - use /upload instead)

Authorizations:
bearer
path Parameters
storeId
required
string
Request Body schema: application/json
required
object (CreateMediaLibraryDto)

Responses

Request samples

Content type
application/json
{ }

List media with filters

Authorizations:
bearer
path Parameters
storeId
required
string

Responses

Get media statistics

Authorizations:
bearer
path Parameters
storeId
required
string

Responses

Get storage quota usage for this store

Authorizations:
bearer
path Parameters
storeId
required
string

Responses

Get a single media

Authorizations:
bearer
path Parameters
storeId
required
string
mediaId
required
string

Responses

Update media metadata

Authorizations:
bearer
path Parameters
storeId
required
string
mediaId
required
string
Request Body schema: application/json
required
object (UpdateMediaLibraryDto)

Responses

Request samples

Content type
application/json
{ }

Move media to trash (soft delete)

Authorizations:
bearer
path Parameters
storeId
required
string
mediaId
required
string

Responses

Restore media from trash

Authorizations:
bearer
path Parameters
storeId
required
string
mediaId
required
string

Responses

Permanently delete media (cannot be undone)

Authorizations:
bearer
path Parameters
storeId
required
string
mediaId
required
string

Responses

Edit image (crop, resize, transform, draw)

Authorizations:
bearer
path Parameters
storeId
required
string
mediaId
required
string
Request Body schema: application/json
required
object (EditImageDto)

Responses

Request samples

Content type
application/json
{ }

Upscale an image by 2-8x using server-side Sharp

Authorizations:
bearer
path Parameters
storeId
required
string

Responses

Generate AI alt text for a media item

Authorizations:
bearer
path Parameters
storeId
required
string
mediaId
required
string

Responses

Get version history for a media item

Authorizations:
bearer
path Parameters
storeId
required
string
mediaId
required
string

Responses

Revert media to a previous version

Authorizations:
bearer
path Parameters
storeId
required
string
mediaId
required
string
versionId
required
string

Responses

Media AI Edit

Execute AI image edit and get preview

Authorizations:
bearer
path Parameters
storeId
required
string
Request Body schema: application/json
required
object (AIEditRequestDto)

Responses

Request samples

Content type
application/json
{ }

Save AI-edited image to storage

Authorizations:
bearer
path Parameters
storeId
required
string
Request Body schema: application/json
required
object (AIEditSaveDto)

Responses

Request samples

Content type
application/json
{ }

Media Usage

Get media usages (which products/variants use this media)

Authorizations:
bearer
path Parameters
storeId
required
string
mediaId
required
string

Responses

Track media usage in a product

Authorizations:
bearer
path Parameters
storeId
required
string
mediaId
required
string
Request Body schema: application/json
required
productId
required
string

Product ID

position
number

Position in media array

Responses

Request samples

Content type
application/json
{
  • "productId": "string",
  • "position": 0
}

Remove media usage tracking from a product

Authorizations:
bearer
path Parameters
storeId
required
string
mediaId
required
string
query Parameters
productId
required
string

Responses

Track media usage in a variant

Authorizations:
bearer
path Parameters
storeId
required
string
mediaId
required
string
Request Body schema: application/json
required
variantId
required
string

Variant ID

Responses

Request samples

Content type
application/json
{
  • "variantId": "string"
}

Remove media usage tracking from a variant

Authorizations:
bearer
path Parameters
storeId
required
string
mediaId
required
string
query Parameters
variantId
required
string

Responses

Sync all media usages for a product (call when saving product)

Authorizations:
bearer
path Parameters
storeId
required
string
Request Body schema: application/json
required
productId
required
string

Product ID

required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "productId": "string",
  • "mediaItems": [
    ]
}

Media Folders

List the store's media folders (with file counts)

Authorizations:
bearer
path Parameters
storeId
required
string

Responses

Create a media folder

Authorizations:
bearer
path Parameters
storeId
required
string
Request Body schema: application/json
required
object (CreateMediaFolderDto)

Responses

Request samples

Content type
application/json
{ }

Rename a media folder (re-points its files)

Authorizations:
bearer
path Parameters
storeId
required
string
folderId
required
string
Request Body schema: application/json
required
object (RenameMediaFolderDto)

Responses

Request samples

Content type
application/json
{ }

Delete a media folder (its files move to the root)

Authorizations:
bearer
path Parameters
storeId
required
string
folderId
required
string

Responses

Language Settings

Get all languages for a store

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID

Responses

Response samples

Content type
application/json
[
  • { }
]

Add a new language to the store

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID

Request Body schema: application/json
required
object (CreateLanguageDto)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

Get available languages that can be added

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID

Responses

Response samples

Content type
application/json
{ }

Get auto-translate quota information

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID

Responses

Response samples

Content type
application/json
{ }

AI auto-translate the store content into the target language

Translates product/collection/page titles + descriptions into the language code with AI and stores them, so the storefront serves translated content for that locale.

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID

code
required
string

Target language ISO code (e.g. "th")

Responses

List translatable content + existing translations for a language

Source (default-language) content + the current translation per field, for the manual editor. Paged per resourceType.

Authorizations:
bearer
path Parameters
storeId
required
string
code
required
string

Target language ISO code

query Parameters
limit
required
string
offset
required
string

Responses

Create/update one manual translation (empty value deletes it)

Authorizations:
bearer
path Parameters
storeId
required
string
code
required
string

Target language ISO code

Responses

Delete one manual translation

Authorizations:
bearer
path Parameters
storeId
required
string
code
required
string

Target language ISO code

Responses

Update language settings

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID

languageId
required
string

Language ID

Request Body schema: application/json
required
object (UpdateLanguageDto)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

Delete a language from the store

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID

languageId
required
string

Language ID

Responses

Store Discounts — Validation

Validate discount configuration

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID (UUID)

Request Body schema: application/json
required
object (CreateDiscountDto)

Responses

Request samples

Content type
application/json
{ }

Validate discount code for checkout (simple)

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID (UUID)

Request Body schema: application/json
required
object (ValidateDiscountCodeDto)

Responses

Request samples

Content type
application/json
{ }

Validate single discount code with full cart context

PRIMARY validation endpoint for all discount code usage. Performs comprehensive validation including status, usage limits, minimum requirements, eligibility, combine rules, and more.

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID (UUID)

Request Body schema: application/json
required
object (ValidateDiscountWithContextDto)

Responses

Request samples

Content type
application/json
{ }

Validate multiple discount codes with full cart context

Validates multiple discount codes in sequence, respecting combine rules. Maximum 10 codes per request.

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID (UUID)

Request Body schema: application/json
required
object (ValidateMultipleDiscountCodesDto)

Responses

Request samples

Content type
application/json
{ }

Search available discount codes for autocomplete

Returns active discount codes matching the search query. Used in Draft Order discount code input autocomplete.

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID (UUID)

query Parameters
search
string

Search query for code or title

limit
string

Max results (default 10)

channel
string

Sales channel filter

Responses

Get automatically applicable discounts for cart

Returns all eligible automatic discounts for the given cart context.

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID (UUID)

Request Body schema: application/json
required
object (AutoApplyDiscountsDto)

Responses

Request samples

Content type
application/json
{ }

Store Discounts

List discounts with pagination and filters

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID (UUID)

Responses

Create a new discount

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID (UUID)

Request Body schema: application/json
required
object (CreateDiscountDto)

Responses

Request samples

Content type
application/json
{ }

Get discount analytics for store

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID (UUID)

Responses

Get discount counts time-series data

Authorizations:
bearer
path Parameters
storeId
required
string
query Parameters
from
required
string
to
required
string
groupBy
required
string

Responses

Export discounts to file Deprecated

NOT IMPLEMENTED — returns 503. This endpoint has never produced a file: it previously returned a downloadUrl pointing at a route that does not exist. It is retained only so the removal follows the deprecation lifecycle. Use the bulk-jobs export resource once available.

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID (UUID)

Request Body schema: application/json
required
object (ExportDiscountsDto)

Responses

Request samples

Content type
application/json
{ }

Bulk update discounts

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID (UUID)

Request Body schema: application/json
required
object (BulkUpdateDiscountsDto)

Responses

Request samples

Content type
application/json
{ }

Bulk delete discounts

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID (UUID)

Request Body schema: application/json
required
object (BulkDeleteDiscountsDto)

Responses

Request samples

Content type
application/json
{ }

Bulk change discount status

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID (UUID)

Request Body schema: application/json
required
object (BulkStatusChangeDto)

Responses

Request samples

Content type
application/json
{ }

Get discount detail with related discounts

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID (UUID)

discountId
required
string

Discount ID (UUID)

Responses

Update a discount

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID (UUID)

discountId
required
string

Discount ID (UUID)

Request Body schema: application/json
required
object (UpdateDiscountDto)

Responses

Request samples

Content type
application/json
{ }

Delete a discount

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID (UUID)

discountId
required
string

Discount ID (UUID)

Responses

Get performance metrics for a discount

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID (UUID)

discountId
required
string

Discount ID (UUID)

Responses

Duplicate a discount

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID (UUID)

discountId
required
string

Discount ID (UUID)

Responses

Deactivate a discount

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID (UUID)

discountId
required
string

Discount ID (UUID)

Responses

Activate a discount

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID (UUID)

discountId
required
string

Discount ID (UUID)

Responses

Store Discounts — Timeline

Get discount timeline events

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID (UUID)

discountId
required
string

Discount ID (UUID)

Responses

Add comment to discount timeline

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID (UUID)

discountId
required
string

Discount ID (UUID)

Request Body schema: application/json
required
object (AddTimelineCommentDto)

Responses

Request samples

Content type
application/json
{ }

Edit a timeline comment

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID (UUID)

discountId
required
string

Discount ID (UUID)

commentId
required
string

Comment ID (UUID)

Request Body schema: application/json
required
object (EditTimelineCommentDto)

Responses

Request samples

Content type
application/json
{ }

Delete a timeline comment

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID (UUID)

discountId
required
string

Discount ID (UUID)

commentId
required
string

Comment ID (UUID)

Responses

Delete attachment from discount comment

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID (UUID)

discountId
required
string

Discount ID (UUID)

commentId
required
string

Comment ID (UUID)

attachmentId
required
string

Attachment ID (UUID)

Responses

Get mentionable staff for @mentions

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID (UUID)

Responses

Resend notification from timeline event

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID (UUID)

discountId
required
string

Discount ID (UUID)

timelineEventId
required
string

Timeline Event ID (UUID)

Responses

Store Discounts — Views

List saved views for current user

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID (UUID)

Responses

Create a new saved view

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID (UUID)

Request Body schema: application/json
required
object (CreateDiscountViewDto)

Responses

Request samples

Content type
application/json
{ }

Update a saved view

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID (UUID)

viewId
required
string

View ID (UUID)

Request Body schema: application/json
required
object (UpdateDiscountViewDto)

Responses

Request samples

Content type
application/json
{ }

Delete a saved view

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID (UUID)

viewId
required
string

View ID (UUID)

Responses

Store Content - Menus

List all menus

Retrieve all navigation menus for a store with pagination

Authorizations:
bearerNone
path Parameters
storeId
required
string
query Parameters
sortOrder
string
Enum: "asc" "desc"
sortBy
string
Enum: "name" "handle" "createdAt" "updatedAt"
search
string
limit
number
page
number

Responses

Create a new menu

Create a new navigation menu. Only owners and admins can create menus.

Authorizations:
bearerbearer
path Parameters
storeId
required
string
Request Body schema: application/json
required
object (CreateMenuDto)

Responses

Request samples

Content type
application/json
{ }

Get a menu by ID

Retrieve a specific menu by its ID

Authorizations:
bearerNone
path Parameters
storeId
required
string
menuId
required
string

Menu ID

Responses

Update a menu

Update an existing menu and its items. Only owners and admins can update menus.

Authorizations:
bearerbearer
path Parameters
storeId
required
string
menuId
required
string

Menu ID

Request Body schema: application/json
required
object (UpdateMenuDto)

Responses

Request samples

Content type
application/json
{ }

Delete a menu

Delete a menu. Only owners and admins can delete menus.

Authorizations:
bearerbearer
path Parameters
storeId
required
string
menuId
required
string

Menu ID

Responses

Get a menu by handle

Retrieve a specific menu by its handle (URL-friendly slug)

Authorizations:
bearerNone
path Parameters
storeId
required
string
handle
required
string

Menu handle (e.g., "main-menu")

Responses

Duplicate a menu

Create a copy of an existing menu with a new name. Only owners and admins can duplicate menus.

Authorizations:
bearerbearer
path Parameters
storeId
required
string
menuId
required
string

Menu ID to duplicate

Request Body schema: application/json
required
object (DuplicateMenuDto)

Responses

Request samples

Content type
application/json
{ }

Bulk delete menus

Delete multiple menus at once. Only owners and admins can delete menus.

Authorizations:
bearerbearer
path Parameters
storeId
required
string
Request Body schema: application/json
required
object (BulkDeleteMenusDto)

Responses

Request samples

Content type
application/json
{ }

Pages

List all pages

Authorizations:
bearer
path Parameters
storeId
required
string

Responses

Create new page

Authorizations:
bearer
path Parameters
storeId
required
string
Request Body schema: application/json
required
title
required
string

Page title

slug
string

Page slug (auto-generated if not provided)

path
string

Page path (e.g., /about)

pageType
required
string

Page type (e.g., page, product, collection)

layoutId
string

Layout ID to use

puckData
object

theme editor data

seo
object

SEO metadata

isDefault
boolean

Set as default for this page type

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "slug": "string",
  • "path": "string",
  • "pageType": "string",
  • "layoutId": "string",
  • "puckData": { },
  • "seo": { },
  • "isDefault": true
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": { },
  • "message": "string",
  • "error": { },
  • "meta": { }
}

Get page by handle

Authorizations:
bearer
path Parameters
storeId
required
string
handle
required
string

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": { },
  • "message": "string",
  • "error": { },
  • "meta": { }
}

Bulk delete pages

Authorizations:
bearer
path Parameters
storeId
required
string
Request Body schema: application/json
required
object (BulkDeletePagesDto)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "success": true,
  • "data": { },
  • "message": "string",
  • "error": { },
  • "meta": { }
}

Bulk update pages

Authorizations:
bearer
path Parameters
storeId
required
string
Request Body schema: application/json
required
object (BulkUpdatePagesDto)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "success": true,
  • "data": { },
  • "message": "string",
  • "error": { },
  • "meta": { }
}

Get page by ID

Authorizations:
bearer
path Parameters
storeId
required
string
id
required
string

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": { },
  • "message": "string",
  • "error": { },
  • "meta": { }
}

Update page (partial)

Authorizations:
bearer
path Parameters
storeId
required
string
id
required
string
Request Body schema: application/json
required
title
string

Page title

slug
string

Page slug (auto-generated if not provided)

path
string

Page path (e.g., /about)

pageType
string

Page type (e.g., page, product, collection)

layoutId
string

Layout ID to use

puckData
object

theme editor data

seo
object

SEO metadata

isDefault
boolean

Set as default for this page type

content
object

theme editor content (alias for puckData)

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "slug": "string",
  • "path": "string",
  • "pageType": "string",
  • "layoutId": "string",
  • "puckData": { },
  • "seo": { },
  • "isDefault": true,
  • "content": { }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": { },
  • "message": "string",
  • "error": { },
  • "meta": { }
}

Update page (full)

Authorizations:
bearer
path Parameters
storeId
required
string
id
required
string
Request Body schema: application/json
required
title
string

Page title

slug
string

Page slug (auto-generated if not provided)

path
string

Page path (e.g., /about)

pageType
string

Page type (e.g., page, product, collection)

layoutId
string

Layout ID to use

puckData
object

theme editor data

seo
object

SEO metadata

isDefault
boolean

Set as default for this page type

content
object

theme editor content (alias for puckData)

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "slug": "string",
  • "path": "string",
  • "pageType": "string",
  • "layoutId": "string",
  • "puckData": { },
  • "seo": { },
  • "isDefault": true,
  • "content": { }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": { },
  • "message": "string",
  • "error": { },
  • "meta": { }
}

Delete page

Authorizations:
bearer
path Parameters
storeId
required
string
id
required
string

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": { },
  • "message": "string",
  • "error": { },
  • "meta": { }
}

Store Content - Pages

Get a page by ID

Retrieve a specific page by its ID

Authorizations:
bearerNone
path Parameters
storeId
required
string
pageId
required
string

Page ID

Responses

Update a page

Update an existing page. Only owners and admins can update pages.

Authorizations:
bearerbearer
path Parameters
storeId
required
string
pageId
required
string

Page ID

Request Body schema: application/json
required
title
string

Page title

slug
string

Page slug (auto-generated if not provided)

path
string

Page path (e.g., /about)

pageType
string

Page type (e.g., page, product, collection)

layoutId
string

Layout ID to use

puckData
object

theme editor data

seo
object

SEO metadata

isDefault
boolean

Set as default for this page type

content
object

theme editor content (alias for puckData)

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "slug": "string",
  • "path": "string",
  • "pageType": "string",
  • "layoutId": "string",
  • "puckData": { },
  • "seo": { },
  • "isDefault": true,
  • "content": { }
}

Delete a page

Delete a page. Only owners and admins can delete pages.

Authorizations:
bearerbearer
path Parameters
storeId
required
string
pageId
required
string

Page ID

Responses

Duplicate a page

Create a copy of an existing page. Only owners and admins can duplicate pages.

Authorizations:
bearerbearer
path Parameters
storeId
required
string
pageId
required
string

Page ID to duplicate

Responses

Blogs

BlogsController_listBlogs_v1

path Parameters
storeId
required
string

Responses

BlogsController_createBlog_v1

path Parameters
storeId
required
string
Request Body schema: application/json
required
object (CreateBlogDto)

Responses

Request samples

Content type
application/json
{ }

BlogsController_getBlog_v1

path Parameters
storeId
required
string
blogId
required
string

Responses

BlogsController_updateBlog_v1

path Parameters
storeId
required
string
blogId
required
string
Request Body schema: application/json
required
object (UpdateBlogDto)

Responses

Request samples

Content type
application/json
{ }

BlogsController_deleteBlog_v1

path Parameters
storeId
required
string
blogId
required
string

Responses

BlogsController_getBlogByHandle_v1

path Parameters
storeId
required
string
handle
required
string

Responses

BlogsController_bulkDeleteBlogs_v1

path Parameters
storeId
required
string
Request Body schema: application/json
required
object (BulkDeleteBlogsDto)

Responses

Request samples

Content type
application/json
{ }

BlogsController_listBlogArticles_v1

path Parameters
storeId
required
string
blogId
required
string

Responses

BlogsController_createArticle_v1

path Parameters
storeId
required
string
blogId
required
string
Request Body schema: application/json
required
object (CreateArticleDto)

Responses

Request samples

Content type
application/json
{ }

BlogsController_getArticle_v1

path Parameters
storeId
required
string
articleId
required
string

Responses

BlogsController_updateArticle_v1

path Parameters
storeId
required
string
articleId
required
string
Request Body schema: application/json
required
object (UpdateArticleDto)

Responses

Request samples

Content type
application/json
{ }

BlogsController_deleteArticle_v1

path Parameters
storeId
required
string
articleId
required
string

Responses

Articles

ArticlesController_listAllArticles_v1

path Parameters
storeId
required
string

Responses

ArticlesController_createArticle_v1

path Parameters
storeId
required
string
Request Body schema: application/json
required
object (CreateArticleDto)

Responses

Request samples

Content type
application/json
{ }

ArticlesController_getArticle_v1

path Parameters
storeId
required
string
articleId
required
string

Responses

ArticlesController_updateArticle_v1

path Parameters
storeId
required
string
articleId
required
string
Request Body schema: application/json
required
object (UpdateArticleDto)

Responses

Request samples

Content type
application/json
{ }

ArticlesController_deleteArticle_v1

path Parameters
storeId
required
string
articleId
required
string

Responses

ArticlesController_bulkDeleteArticles_v1

path Parameters
storeId
required
string
Request Body schema: application/json
required
object (BulkDeleteArticlesDto)

Responses

Request samples

Content type
application/json
{ }

ArticlesController_bulkUpdateArticles_v1

path Parameters
storeId
required
string
Request Body schema: application/json
required
object (BulkUpdateArticlesDto)

Responses

Request samples

Content type
application/json
{ }

Store Content - Articles

Get article tag suggestions

Get tag suggestions for autocomplete from existing articles. Results are cached for 10 minutes.

Authorizations:
bearerbearer
path Parameters
storeId
required
string
query Parameters
search
string

Responses

Get all article tags (paginated)

Get paginated list of all tags for the "View all" feature.

Authorizations:
bearerbearer
path Parameters
storeId
required
string
query Parameters
page
number
limit
number
search
string

Responses

Customers

CustomersController_getCustomerCounts_v1

Authorizations:
None
path Parameters
storeId
required
string

Responses

CustomersController_getCustomerCountsTimeseries_v1

Authorizations:
None
path Parameters
storeId
required
string
query Parameters
from
required
string
to
required
string
groupBy
required
string

Responses

CustomersController_getTagSuggestions_v1

Authorizations:
None
path Parameters
storeId
required
string
query Parameters
search
required
string

Responses

CustomersController_getTagSuggestionsPaginated_v1

Authorizations:
None
path Parameters
storeId
required
string
query Parameters
page
required
number
limit
required
number
search
required
string

Responses

CustomersController_listCustomers_v1

Authorizations:
None
path Parameters
storeId
required
string

Responses

CustomersController_createCustomer_v1

Authorizations:
bearer
path Parameters
storeId
required
string
Request Body schema: application/json
required
object (CreateCustomerDto)

Responses

Request samples

Content type
application/json
{ }

CustomersController_getCustomer_v1

Authorizations:
None
path Parameters
storeId
required
string
id
required
string

Responses

CustomersController_updateCustomer_v1

Authorizations:
bearer
path Parameters
storeId
required
string
id
required
string
Request Body schema: application/json
required
object (UpdateCustomerDto)

Responses

Request samples

Content type
application/json
{ }

CustomersController_deleteCustomer_v1

Authorizations:
bearer
path Parameters
storeId
required
string
id
required
string

Responses

CustomersController_importCustomers_v1

Authorizations:
bearer
path Parameters
storeId
required
string

Responses

CustomersController_bulkDeleteCustomers_v1

Authorizations:
bearer
path Parameters
storeId
required
string
Request Body schema: application/json
required
object (BulkDeleteCustomersDto)

Responses

Request samples

Content type
application/json
{ }

CustomersController_bulkAddTags_v1

Authorizations:
bearer
path Parameters
storeId
required
string
Request Body schema: application/json
required
object (BulkAddTagsDto)

Responses

Request samples

Content type
application/json
{ }

CustomersController_bulkRemoveTags_v1

Authorizations:
bearer
path Parameters
storeId
required
string
Request Body schema: application/json
required
object (BulkRemoveTagsDto)

Responses

Request samples

Content type
application/json
{ }

CustomersController_bulkEditCustomers_v1

Authorizations:
bearer
path Parameters
storeId
required
string

Responses

CustomersController_mergeCustomers_v1

Authorizations:
bearer
path Parameters
storeId
required
string
Request Body schema: application/json
required
object (MergeCustomersDto)

Responses

Request samples

Content type
application/json
{ }

CustomersController_sendMarketingEmail_v1

Authorizations:
bearer
path Parameters
storeId
required
string
Request Body schema: application/json
required
object (SendMarketingEmailDto)

Responses

Request samples

Content type
application/json
{ }

Store - Customer Data Requests

Request a customer data export (enters PENDING_REVIEW)

Authorizations:
bearer
path Parameters
storeId
required
string
customerId
required
string

Responses

List a customer’s data requests (status + due date)

Authorizations:
bearer
path Parameters
storeId
required
string
customerId
required
string

Responses

List all data requests for the store (review queue)

Authorizations:
bearer
path Parameters
storeId
required
string

Responses

Approve a data request → generate the export → COMPLETED

Authorizations:
bearerbearer
path Parameters
storeId
required
string
requestId
required
string

Responses

Reject a data request (no export)

Authorizations:
bearerbearer
path Parameters
storeId
required
string
requestId
required
string

Responses

Store - Customer Erasure

Schedule personal-data erasure after a grace period

Authorizations:
bearerbearer
path Parameters
storeId
required
string
customerId
required
string

Responses

Cancel a scheduled erasure (only within the grace period)

Authorizations:
bearerbearer
path Parameters
storeId
required
string
customerId
required
string

Responses

CustomerAddresses

CustomerAddressesController_addCustomerAddress_v1

Authorizations:
bearer
path Parameters
storeId
required
string
id
required
string
Request Body schema: application/json
required
object (AddCustomerAddressDto)

Responses

Request samples

Content type
application/json
{ }

CustomerAddressesController_updateCustomerAddress_v1

Authorizations:
bearer
path Parameters
storeId
required
string
id
required
string
addressId
required
string
Request Body schema: application/json
required
object (UpdateCustomerAddressDto)

Responses

Request samples

Content type
application/json
{ }

CustomerAddressesController_deleteCustomerAddress_v1

Authorizations:
bearer
path Parameters
storeId
required
string
id
required
string
addressId
required
string

Responses

CustomerAddressesController_setDefaultAddress_v1

Authorizations:
bearer
path Parameters
storeId
required
string
id
required
string
addressId
required
string

Responses

CustomerNotes

CustomerNotesController_getCustomerNotes_v1

Authorizations:
None
path Parameters
storeId
required
string
id
required
string

Responses

CustomerNotesController_addCustomerNote_v1

Authorizations:
bearer
path Parameters
storeId
required
string
id
required
string
Request Body schema: application/json
required
object (AddCustomerNoteBodyDto)

Responses

Request samples

Content type
application/json
{ }

CustomerNotesController_deleteCustomerNote_v1

Authorizations:
bearer
path Parameters
storeId
required
string
id
required
string
noteId
required
string

Responses

CustomerNotesController_getCustomerTimeline_v1

Authorizations:
None
path Parameters
storeId
required
string
id
required
string

Responses

CustomerNotesController_addTimelineComment_v1

Authorizations:
bearer
path Parameters
storeId
required
string
id
required
string
Request Body schema: application/json
required
object (AddTimelineCommentBodyDto)

Responses

Request samples

Content type
application/json
{ }

CustomerNotesController_editTimelineComment_v1

Authorizations:
bearer
path Parameters
storeId
required
string
id
required
string
commentId
required
string
Request Body schema: application/json
required
object (EditTimelineCommentBodyDto)

Responses

Request samples

Content type
application/json
{ }

CustomerNotesController_deleteTimelineComment_v1

Authorizations:
bearer
path Parameters
storeId
required
string
id
required
string
commentId
required
string

Responses

CustomerNotesController_getCustomerOrders_v1

Authorizations:
None
path Parameters
storeId
required
string
id
required
string
query Parameters
page
required
number
limit
required
number

Responses

CustomerSegments

CustomerSegmentsController_getTemplates_v1

Authorizations:
None
path Parameters
storeId
required
string

Responses

CustomerSegmentsController_validateQuery_v1

Authorizations:
bearer
path Parameters
storeId
required
string
Request Body schema: application/json
required
object (ValidateQueryDto)

Responses

Request samples

Content type
application/json
{ }

CustomerSegmentsController_generateSegmentWithAI_v1

Authorizations:
bearer
path Parameters
storeId
required
string
Request Body schema: application/json
required
object (AISegmentRequestDto)

Responses

Request samples

Content type
application/json
{ }

CustomerSegmentsController_previewSegment_v1

Authorizations:
bearer
path Parameters
storeId
required
string
Request Body schema: application/json
required
object (PreviewSegmentDto)

Responses

Request samples

Content type
application/json
{ }

CustomerSegmentsController_listSegments_v1

Authorizations:
None
path Parameters
storeId
required
string
query Parameters
page
required
number
limit
required
number
category
required
string
status
required
string
type
required
string
search
required
string
sortBy
required
string
sortOrder
required
string

Responses

CustomerSegmentsController_createSegment_v1

Authorizations:
bearer
path Parameters
storeId
required
string
Request Body schema: application/json
required
object (CreateSegmentDto)

Responses

Request samples

Content type
application/json
{ }

CustomerSegmentsController_getSegment_v1

Authorizations:
None
path Parameters
storeId
required
string
id
required
string

Responses

CustomerSegmentsController_updateSegment_v1

Authorizations:
bearer
path Parameters
storeId
required
string
id
required
string
Request Body schema: application/json
required
object (UpdateSegmentDto)

Responses

Request samples

Content type
application/json
{ }

CustomerSegmentsController_deleteSegment_v1

Authorizations:
bearer
path Parameters
storeId
required
string
id
required
string

Responses

CustomerSegmentsMembers

CustomerSegmentsMembersController_getSegmentMembers_v1

Authorizations:
None
path Parameters
storeId
required
string
id
required
string
query Parameters
page
required
number
limit
required
number
sortBy
required
string
sortOrder
required
string

Responses

CustomerSegmentsMembersController_addCustomersToSegment_v1

Authorizations:
bearer
path Parameters
storeId
required
string
id
required
string
Request Body schema: application/json
required
object (SegmentMemberIdsDto)

Responses

Request samples

Content type
application/json
{ }

CustomerSegmentsMembersController_removeCustomersFromSegment_v1

Authorizations:
bearer
path Parameters
storeId
required
string
id
required
string
Request Body schema: application/json
required
object (SegmentMemberIdsDto)

Responses

Request samples

Content type
application/json
{ }

CustomerSegmentsMembersController_getTopMembers_v1

Authorizations:
None
path Parameters
storeId
required
string
id
required
string
query Parameters
limit
required
number
sortBy
required
string

Responses

CustomerSegmentsMembersController_getMembershipChanges_v1

Authorizations:
None
path Parameters
storeId
required
string
id
required
string
query Parameters
startDate
required
string
endDate
required
string

Responses

CustomerSegmentsMembersController_getSegmentAnalytics_v1

Authorizations:
None
path Parameters
storeId
required
string
id
required
string
query Parameters
startDate
required
string
endDate
required
string

Responses

CustomerSegmentsMembersController_getSegmentTrend_v1

Authorizations:
None
path Parameters
storeId
required
string
id
required
string
query Parameters
days
required
number
granularity
required
string

Responses

ComputedTraits

ComputedTraitsController_getCustomerTraits_v1

path Parameters
storeId
required
string
customerId
required
string

Responses

CustomerEvents

CustomerEventsController_getCustomerEvents_v1

Authorizations:
None
path Parameters
storeId
required
string
customerId
required
string

Responses

CustomerEventsController_getCustomerJourney_v1

Authorizations:
None
path Parameters
storeId
required
string
customerId
required
string

Responses

Store Settings - Markets

List all markets

Authorizations:
bearer
path Parameters
storeId
required
string
query Parameters
limit
number
page
number
sortBy
string
Enum: "name-asc" "name-desc" "updated-newest" "updated-oldest"
currency
any
status
string
Enum: "active" "inactive" "suspended" "all"
search
any

Responses

Create a new market

Authorizations:
bearer
path Parameters
storeId
required
string
Request Body schema: application/json
required
object (CreateMarketDto)

Responses

Request samples

Content type
application/json
{ }

Get market statistics

Authorizations:
bearer
path Parameters
storeId
required
string

Responses

Get catalog counts time-series data

Authorizations:
bearer
path Parameters
storeId
required
string
query Parameters
from
required
string
to
required
string
groupBy
required
string

Responses

List market activities

Authorizations:
bearer
path Parameters
storeId
required
string
query Parameters
limit
number
page
number
marketId
any

Responses

Get markets for catalog assignment

Authorizations:
bearer
path Parameters
storeId
required
string
query Parameters
limit
number
page
number
search
any

Responses

Get a specific market

Authorizations:
bearer
path Parameters
storeId
required
string
marketId
required
string

Market ID (UUID)

Responses

Update a market

Authorizations:
bearer
path Parameters
storeId
required
string
marketId
required
string

Market ID (UUID)

Request Body schema: application/json
required
object (UpdateMarketDto)

Responses

Request samples

Content type
application/json
{ }

Delete a market

Authorizations:
bearer
path Parameters
storeId
required
string
marketId
required
string

Market ID (UUID)

Responses

Update market status

Authorizations:
bearer
path Parameters
storeId
required
string
marketId
required
string

Market ID (UUID)

Request Body schema: application/json
required
object (UpdateMarketStatusDto)

Responses

Request samples

Content type
application/json
{ }

Bulk update market status

Authorizations:
bearer
path Parameters
storeId
required
string
Request Body schema: application/json
required
object (BulkUpdateMarketStatusDto)

Responses

Request samples

Content type
application/json
{ }

Bulk delete markets

Authorizations:
bearer
path Parameters
storeId
required
string
Request Body schema: application/json
required
object (BulkDeleteMarketsDto)

Responses

Request samples

Content type
application/json
{ }

Get read-only shipping summary for a market

Authorizations:
bearer
path Parameters
storeId
required
string
marketId
required
string

Responses

Store Settings - Catalogs

List all catalogs

Retrieve all catalogs for the store with optional filtering and pagination.

Authorizations:
bearer
path Parameters
storeId
required
string
query Parameters
offset
number
limit
number
sortOrder
string
Enum: "asc" "desc"
sortBy
string
Enum: "name" "updated" "products"
marketId
any

Filter by market ID

status
string
Enum: "active" "inactive" "draft" "all"
search
any

Search by catalog name

Responses

Create a new catalog

Create a new catalog for the store.

Authorizations:
bearer
path Parameters
storeId
required
string
Request Body schema: application/json
required
object (CreateCatalogDto)

Responses

Request samples

Content type
application/json
{ }

Get a specific catalog

Retrieve details of a specific catalog.

Authorizations:
bearer
path Parameters
storeId
required
string
catalogId
required
string

Catalog ID (UUID)

Responses

Update a catalog

Update an existing catalog.

Authorizations:
bearer
path Parameters
storeId
required
string
catalogId
required
string

Catalog ID (UUID)

Request Body schema: application/json
required
object (UpdateCatalogDto)

Responses

Request samples

Content type
application/json
{ }

Delete a catalog

Delete a catalog.

Authorizations:
bearer
path Parameters
storeId
required
string
catalogId
required
string

Catalog ID (UUID)

Responses

Duplicate a catalog

Create a copy of an existing catalog.

Authorizations:
bearer
path Parameters
storeId
required
string
catalogId
required
string

Catalog ID (UUID)

Responses

Add products to a catalog

Add products to a catalog. For SPECIFIC catalogs, creates inclusion entries. For ALL catalogs, removes exclusion entries.

Authorizations:
bearer
path Parameters
storeId
required
string
catalogId
required
string

Catalog ID (UUID)

Request Body schema: application/json
required
object (AddProductsToCatalogDto)

Responses

Request samples

Content type
application/json
{ }

Remove products from a catalog

Remove products from a catalog. For SPECIFIC catalogs, deletes inclusion entries. For ALL catalogs, creates exclusion entries.

Authorizations:
bearer
path Parameters
storeId
required
string
catalogId
required
string

Catalog ID (UUID)

Request Body schema: application/json
required
object (RemoveProductsFromCatalogDto)

Responses

Request samples

Content type
application/json
{ }

Update catalog status

Update the status of a catalog.

Authorizations:
bearer
path Parameters
storeId
required
string
catalogId
required
string

Catalog ID (UUID)

Request Body schema: application/json
required
object (UpdateCatalogStatusDto)

Responses

Request samples

Content type
application/json
{ }

Bulk update catalog status

Update the status of multiple catalogs at once.

Authorizations:
bearer
path Parameters
storeId
required
string
Request Body schema: application/json
required
object (BulkUpdateCatalogStatusDto)

Responses

Request samples

Content type
application/json
{ }

Bulk delete catalogs

Delete multiple catalogs at once.

Authorizations:
bearer
path Parameters
storeId
required
string
Request Body schema: application/json
required
object (BulkDeleteCatalogsDto)

Responses

Request samples

Content type
application/json
{ }

Import catalogs

Import catalogs from a CSV file.

Authorizations:
bearer
path Parameters
storeId
required
string
Request Body schema: multipart/form-data
required
file
string <binary>
updateExisting
boolean
createNewOnly
boolean

Responses

Export catalogs

Export catalogs to a CSV file.

Authorizations:
bearer
path Parameters
storeId
required
string
Request Body schema: application/json
required
object (ExportCatalogsDto)

Responses

Request samples

Content type
application/json
{ }

Orders - Abandoned Checkouts

List abandoned checkouts

Retrieve abandoned checkouts for a store with pagination and filters

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID

query Parameters
search
string
recovered
boolean
contacted
boolean
limit
number
page
number

Responses

Get abandoned checkout details

Retrieve a single abandoned checkout by ID

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID

checkoutId
required
string

Checkout ID

Responses

Send recovery email

Send a recovery email to the customer who abandoned their checkout

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID

Request Body schema: application/json
required
object (SendRecoveryEmailDto)

Responses

Request samples

Content type
application/json
{ }

Update abandoned checkout note

Update the internal note on an abandoned checkout

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID

checkoutId
required
string

Checkout ID

Responses

Product Categories

List product categories

Get a paginated list of product categories. Filter by parentId (null for root), level, or search by name.

Authorizations:
bearer
query Parameters
limit
any

Items per page (default: 50, max: 100)

page
any

Page number (default: 1)

search
any

Search categories by name

level
any

Filter by hierarchy level (0 = root)

parentId
any

Filter by parent category ID (null for root categories)

Responses

List root categories

Get top-level product categories (level 0)

Authorizations:
bearer
query Parameters
page
number

Page number (default: 1)

limit
number

Items per page (default: 50, max: 100)

Responses

List categories as tree

Get categories with nested children structure. Use childrenDepth to control nesting.

Authorizations:
bearer
query Parameters
childrenDepth
any

How many levels deep to include children (default: 1, max: 5)

limit
any

Items per page (default: 50, max: 100)

page
any

Page number (default: 1)

search
any

Search categories by name

parentId
any

Start from a specific parent (null for root)

Responses

Search categories

Search product categories by name

Authorizations:
bearer
query Parameters
limit
any

Max results (default: 20, max: 50)

query
required
any

Search query

Responses

Get category by ID

Get a single product category by its ID

Authorizations:
bearer
path Parameters
id
required
string

Category ID

Responses

Get category children

Get direct children of a category

Authorizations:
bearer
path Parameters
id
required
string

Parent category ID

query Parameters
page
number

Page number (default: 1)

limit
number

Items per page (default: 50, max: 100)

Responses

Get category ancestors

Get the full path from root to this category (for breadcrumbs)

Authorizations:
bearer
path Parameters
id
required
string

Category ID

Responses

Get category attributes

Get all attributes (metafields) applicable to this category, including their default values (entries). Includes inherited attributes from parent categories.

Authorizations:
bearer
path Parameters
id
required
string

Category ID

query Parameters
includeInherited
boolean

Include inherited attributes from parent categories (default: true)

Responses

Get attribute by handle

Get a specific taxonomy attribute by handle with all its default values (entries)

Authorizations:
bearer
path Parameters
handle
required
string

Attribute handle (e.g., "color", "age-group")

Responses

Get attribute by ID

Get a specific taxonomy attribute with all its default values (entries)

Authorizations:
bearer
path Parameters
attributeId
required
string

Attribute ID

Responses

Inventory

Get inventory counts by stock status

Authorizations:
bearer
path Parameters
storeId
required
string
query Parameters
locationId
required
string

Responses

Get inventory counts timeseries for analytics charts

Authorizations:
bearer
path Parameters
storeId
required
string
query Parameters
from
required
string
to
required
string
locationId
required
string
groupBy
required
string

Responses

Adjust inventory quantity

Authorizations:
bearer
path Parameters
storeId
required
string
Request Body schema: application/json
required
object (AdjustInventoryDto)

Responses

Request samples

Content type
application/json
{ }

Bulk adjust inventory quantities

Authorizations:
bearer
path Parameters
storeId
required
string
Request Body schema: application/json
required
object (BulkAdjustInventoryDto)

Responses

Request samples

Content type
application/json
{ }

Set inventory level for a variant at a location

Authorizations:
bearer
path Parameters
storeId
required
string
Request Body schema: application/json
required
object (SetInventoryLevelDto)

Responses

Request samples

Content type
application/json
{ }

Set available quantity for a variant at a location

Authorizations:
bearer
path Parameters
storeId
required
string
Request Body schema: application/json
required
object (SetAvailableDto)

Responses

Request samples

Content type
application/json
{ }

Bulk set available quantities

Authorizations:
bearer
path Parameters
storeId
required
string
Request Body schema: application/json
required
object (BulkSetAvailableDto)

Responses

Request samples

Content type
application/json
{ }

Bulk set bin-name labels per (variant, location). Empty string clears the label. Skips inventory math.

Authorizations:
bearer
path Parameters
storeId
required
string
Request Body schema: application/json
required
object (BulkSetBinNamesDto)

Responses

Request samples

Content type
application/json
{ }

Set unavailable breakdown for a variant at a location

Authorizations:
bearer
path Parameters
storeId
required
string
Request Body schema: application/json
required
object (SetUnavailableBreakdownDto)

Responses

Request samples

Content type
application/json
{ }

Bulk set unavailable breakdown

Authorizations:
bearer
path Parameters
storeId
required
string
Request Body schema: application/json
required
object (BulkSetUnavailableBreakdownDto)

Responses

Request samples

Content type
application/json
{ }

List inventory items

Authorizations:
bearer
path Parameters
storeId
required
string
query Parameters
taxable
required
string

Responses

Get inventory item by variant ID

Authorizations:
bearer
path Parameters
storeId
required
string
variantId
required
string

Responses

Get inventory adjustment history

Authorizations:
bearer
path Parameters
storeId
required
string
variantId
required
string

Responses

Get orders with committed inventory for a variant

Authorizations:
bearer
path Parameters
storeId
required
string
variantId
required
string
query Parameters
locationId
required
string

Responses

Inventory Locations

List locations for inventory

Authorizations:
None
path Parameters
storeId
required
string

Responses

Get location for inventory

Authorizations:
None
path Parameters
storeId
required
string
locationId
required
string

Responses

Orders

OrdersController_getOrderCounts_v1

Authorizations:
None
path Parameters
storeId
required
string

Responses

OrdersController_getOrderAnalytics_v1

Authorizations:
None
path Parameters
storeId
required
string
query Parameters
startDate
required
string
endDate
required
string
groupBy
required
string

Responses

OrdersController_getTagSuggestions_v1

Authorizations:
None
path Parameters
storeId
required
string
query Parameters
search
required
string

Responses

OrdersController_getTagSuggestionsPaginated_v1

Authorizations:
None
path Parameters
storeId
required
string
query Parameters
page
required
string
limit
required
string
search
required
string

Responses

OrdersController_listOrders_v1

Authorizations:
None
path Parameters
storeId
required
string

Responses

OrdersController_bulkArchiveOrders_v1

Authorizations:
bearer
path Parameters
storeId
required
string
Request Body schema: application/json
required
object (BulkArchiveOrdersDto)

Responses

Request samples

Content type
application/json
{ }

OrdersController_bulkUnarchiveOrders_v1

Authorizations:
bearer
path Parameters
storeId
required
string
Request Body schema: application/json
required
object (BulkArchiveOrdersDto)

Responses

Request samples

Content type
application/json
{ }

OrdersController_bulkAddTags_v1

Authorizations:
bearer
path Parameters
storeId
required
string
Request Body schema: application/json
required
object (BulkTagsDto)

Responses

Request samples

Content type
application/json
{ }

OrdersController_bulkRemoveTags_v1

Authorizations:
bearer
path Parameters
storeId
required
string
Request Body schema: application/json
required
object (BulkTagsDto)

Responses

Request samples

Content type
application/json
{ }

OrdersController_bulkFulfillOrders_v1

Authorizations:
bearer
path Parameters
storeId
required
string
Request Body schema: application/json
required
object (BulkFulfillOrdersDto)

Responses

Request samples

Content type
application/json
{ }

OrdersController_bulkUnfulfillOrders_v1

Authorizations:
bearer
path Parameters
storeId
required
string
Request Body schema: application/json
required
object (BulkUnfulfillOrdersDto)

Responses

Request samples

Content type
application/json
{ }

OrdersController_bulkMarkInProgress_v1

Authorizations:
bearer
path Parameters
storeId
required
string
Request Body schema: application/json
required
object (BulkMarkInProgressDto)

Responses

Request samples

Content type
application/json
{ }

OrdersController_bulkMarkOnHold_v1

Authorizations:
bearer
path Parameters
storeId
required
string
Request Body schema: application/json
required
object (BulkMarkOnHoldDto)

Responses

Request samples

Content type
application/json
{ }

OrdersController_bulkChangeLocation_v1

Authorizations:
bearer
path Parameters
storeId
required
string
Request Body schema: application/json
required
object (BulkChangeLocationDto)

Responses

Request samples

Content type
application/json
{ }

OrdersController_bulkMarkAsPaid_v1

Authorizations:
bearer
path Parameters
storeId
required
string
Request Body schema: application/json
required
object (BulkMarkAsPaidDto)

Responses

Request samples

Content type
application/json
{ }

OrdersController_bulkCancelOrders_v1

Authorizations:
bearer
path Parameters
storeId
required
string
Request Body schema: application/json
required
object (BulkCancelOrdersDto)

Responses

Request samples

Content type
application/json
{ }

OrdersController_getOrder_v1

Authorizations:
None
path Parameters
storeId
required
string
id
required
string

Responses

OrdersController_orderUpdate_v1

Authorizations:
bearer
path Parameters
storeId
required
string
id
required
string

Responses

OrdersController_deleteOrder_v1

Authorizations:
bearer
path Parameters
storeId
required
string
id
required
string

Responses

OrdersController_getOrderTimeline_v1

Authorizations:
None
path Parameters
storeId
required
string
id
required
string

Responses

OrdersController_getMentionableStaff_v1

Authorizations:
None
path Parameters
storeId
required
string

Responses

OrdersController_calculateOrder_v1

Authorizations:
bearer
path Parameters
storeId
required
string

Responses

OrdersController_fulfillOrder_v1

Authorizations:
bearer
path Parameters
storeId
required
string
id
required
string
Request Body schema: application/json
required
object (FulfillOrderDto)

Responses

Request samples

Content type
application/json
{ }

OrdersController_updateOrderStatus_v1

Authorizations:
bearer
path Parameters
storeId
required
string
id
required
string
Request Body schema: application/json
required
object (UpdateOrderStatusDto)

Responses

Request samples

Content type
application/json
{ }

OrdersController_cancelOrder_v1

Authorizations:
bearer
path Parameters
storeId
required
string
id
required
string

Responses

OrdersController_archiveOrder_v1

Authorizations:
bearer
path Parameters
storeId
required
string
id
required
string

Responses

OrdersController_unarchiveOrder_v1

Authorizations:
bearer
path Parameters
storeId
required
string
id
required
string

Responses

OrdersController_duplicateOrder_v1

Authorizations:
bearer
path Parameters
storeId
required
string
id
required
string

Responses

OrdersActions

OrdersActionsController_addTimelineComment_v1

Authorizations:
bearer
path Parameters
storeId
required
string
id
required
string
Request Body schema: application/json
required
object (AddTimelineCommentDto)

Responses

Request samples

Content type
application/json
{ }

OrdersActionsController_editTimelineComment_v1

Authorizations:
bearer
path Parameters
storeId
required
string
id
required
string
commentId
required
string
Request Body schema: application/json
required
object (EditTimelineCommentDto)

Responses

Request samples

Content type
application/json
{ }

OrdersActionsController_deleteTimelineComment_v1

Authorizations:
bearer
path Parameters
storeId
required
string
id
required
string
commentId
required
string

Responses

OrdersActionsController_deleteTimelineAttachment_v1

Authorizations:
bearer
path Parameters
storeId
required
string
id
required
string
commentId
required
string
attachmentId
required
string

Responses

OrdersActionsController_resendTimelineNotification_v1

Authorizations:
bearer
path Parameters
storeId
required
string
id
required
string
timelineEventId
required
string

Responses

OrdersActionsController_sendInvoice_v1

Authorizations:
bearer
path Parameters
storeId
required
string
id
required
string
Request Body schema: application/json
required
object (SendOrderInvoiceDto)

Responses

Request samples

Content type
application/json
{ }

StoreTransactions

StoreTransactionsController_listStoreTransactions_v1

Authorizations:
bearer
path Parameters
storeId
required
string

Responses

Transactions

TransactionsController_listTransactions_v1

Authorizations:
None
path Parameters
storeId
required
string
orderId
required
string

Responses

TransactionsController_getTransaction_v1

Authorizations:
None
path Parameters
storeId
required
string
orderId
required
string
transactionId
required
string

Responses

TransactionsController_createSale_v1

Authorizations:
bearer
path Parameters
storeId
required
string
orderId
required
string
Request Body schema: application/json
required
object (CreateSaleDto)

Responses

Request samples

Content type
application/json
{ }

TransactionsController_capturePayment_v1

Authorizations:
bearer
path Parameters
storeId
required
string
orderId
required
string
authorizationId
required
string
Request Body schema: application/json
required
object (CapturePaymentDto)

Responses

Request samples

Content type
application/json
{ }

TransactionsController_voidAuthorization_v1

Authorizations:
bearer
path Parameters
storeId
required
string
orderId
required
string
authorizationId
required
string
Request Body schema: application/json
required
object (VoidPaymentDto)

Responses

Request samples

Content type
application/json
{ }

TransactionsController_updateTransactionStatus_v1

Authorizations:
bearer
path Parameters
storeId
required
string
orderId
required
string
transactionId
required
string
Request Body schema: application/json
required
object (UpdateTransactionStatusDto)

Responses

Request samples

Content type
application/json
{ }

Refunds

RefundsController_calculateRefund_v1

Authorizations:
bearer
path Parameters
storeId
required
string
orderId
required
string
Request Body schema: application/json
required
object (CalculateRefundDto)

Responses

Request samples

Content type
application/json
{ }

RefundsController_createRefund_v1

Authorizations:
bearer
path Parameters
storeId
required
string
orderId
required
string
Request Body schema: application/json
required
object (CreateRefundDto)

Responses

Request samples

Content type
application/json
{ }

RefundsController_listRefunds_v1

Authorizations:
None
path Parameters
storeId
required
string
orderId
required
string

Responses

RefundsController_retryRefund_v1

Authorizations:
bearer
path Parameters
storeId
required
string
orderId
required
string
refundId
required
string

Responses

RefundsController_getRefund_v1

Authorizations:
None
path Parameters
storeId
required
string
orderId
required
string
refundId
required
string

Responses

FulfillmentOrders

FulfillmentOrdersController_listFulfillmentOrders_v1

Authorizations:
None
path Parameters
storeId
required
string
orderId
required
string

Responses

FulfillmentOrdersController_getFulfillmentSummary_v1

Authorizations:
None
path Parameters
storeId
required
string
orderId
required
string

Responses

FulfillmentOrdersController_getFulfillmentOrder_v1

Authorizations:
None
path Parameters
storeId
required
string
orderId
required
string
fulfillmentOrderId
required
string

Responses

FulfillmentOrdersController_holdFulfillmentOrder_v1

Authorizations:
bearer
path Parameters
storeId
required
string
orderId
required
string
fulfillmentOrderId
required
string
Request Body schema: application/json
required
object (HoldFulfillmentOrderDto)

Responses

Request samples

Content type
application/json
{ }

FulfillmentOrdersController_holdPartial_v1

Authorizations:
bearer
path Parameters
storeId
required
string
orderId
required
string
fulfillmentOrderId
required
string
Request Body schema: application/json
required
object (HoldPartialDto)

Responses

Request samples

Content type
application/json
{ }

FulfillmentOrdersController_releaseHold_v1

Authorizations:
bearer
path Parameters
storeId
required
string
orderId
required
string
fulfillmentOrderId
required
string

Responses

FulfillmentOrdersController_markAsInProgress_v1

Authorizations:
bearer
path Parameters
storeId
required
string
orderId
required
string
fulfillmentOrderId
required
string

Responses

FulfillmentOrdersController_markAsUnfulfilled_v1

Authorizations:
bearer
path Parameters
storeId
required
string
orderId
required
string
fulfillmentOrderId
required
string

Responses

FulfillmentOrdersController_cancelFulfillmentOrder_v1

Authorizations:
bearer
path Parameters
storeId
required
string
orderId
required
string
fulfillmentOrderId
required
string

Responses

FulfillmentOrdersActions

FulfillmentOrdersActionsController_rescheduleFulfillmentOrder_v1

Authorizations:
bearer
path Parameters
storeId
required
string
orderId
required
string
fulfillmentOrderId
required
string
Request Body schema: application/json
required
object (RescheduleFulfillmentOrderDto)

Responses

Request samples

Content type
application/json
{ }

FulfillmentOrdersActionsController_moveFulfillmentOrder_v1

Authorizations:
bearer
path Parameters
storeId
required
string
orderId
required
string
fulfillmentOrderId
required
string
Request Body schema: application/json
required
object (MoveFulfillmentOrderDto)

Responses

Request samples

Content type
application/json
{ }

FulfillmentOrdersActionsController_splitFulfillmentOrder_v1

Authorizations:
bearer
path Parameters
storeId
required
string
orderId
required
string
fulfillmentOrderId
required
string
Request Body schema: application/json
required
object (SplitFulfillmentOrderDto)

Responses

Request samples

Content type
application/json
{ }

FulfillmentOrdersActionsController_mergeFulfillmentOrders_v1

Authorizations:
bearer
path Parameters
storeId
required
string
orderId
required
string
Request Body schema: application/json
required
object (MergeFulfillmentOrdersDto)

Responses

Request samples

Content type
application/json
{ }

FulfillmentOrdersActionsController_createFulfillment_v1

Authorizations:
bearer
path Parameters
storeId
required
string
orderId
required
string
fulfillmentOrderId
required
string
Request Body schema: application/json
required
object (CreateFulfillmentDto)

Responses

Request samples

Content type
application/json
{ }

FulfillmentBatches

FulfillmentBatchesController_list_v1

path Parameters
storeId
required
string

Responses

FulfillmentBatchesController_create_v1

path Parameters
storeId
required
string

Responses

FulfillmentBatchesController_getWorkflow_v1

path Parameters
storeId
required
string

Responses

FulfillmentBatchesController_saveWorkflow_v1

path Parameters
storeId
required
string

Responses

FulfillmentBatchesController_listBatchable_v1

path Parameters
storeId
required
string
query Parameters
days
required
string

Responses

FulfillmentBatchesController_get_v1

path Parameters
storeId
required
string
batchId
required
string

Responses

FulfillmentBatchesController_update_v1

path Parameters
storeId
required
string
batchId
required
string

Responses

FulfillmentBatchesController_remove_v1

path Parameters
storeId
required
string
batchId
required
string

Responses

FulfillmentBatchesController_timeline_v1

path Parameters
storeId
required
string
batchId
required
string

Responses

FulfillmentBatchesController_addComment_v1

path Parameters
storeId
required
string
batchId
required
string

Responses

FulfillmentBatchesController_addOrders_v1

path Parameters
storeId
required
string
batchId
required
string

Responses

FulfillmentBatchesController_removeOrder_v1

path Parameters
storeId
required
string
batchId
required
string
orderId
required
string

Responses

FulfillmentBatchesController_moveOrders_v1

path Parameters
storeId
required
string
batchId
required
string

Responses

FulfillmentBatchesController_assignStage_v1

path Parameters
storeId
required
string
batchId
required
string

Responses

FulfillmentBatchesController_recordDocuments_v1

path Parameters
storeId
required
string
batchId
required
string

Responses

FulfillmentBatchesController_setClosed_v1

path Parameters
storeId
required
string
batchId
required
string

Responses

Fulfillments

FulfillmentsController_listFulfillments_v1

Authorizations:
None
path Parameters
storeId
required
string
orderId
required
string

Responses

FulfillmentsController_getFulfillment_v1

Authorizations:
None
path Parameters
storeId
required
string
orderId
required
string
fulfillmentId
required
string

Responses

FulfillmentsController_listTrackings_v1

Authorizations:
None
path Parameters
storeId
required
string
orderId
required
string
fulfillmentId
required
string

Responses

FulfillmentsController_addTracking_v1

Authorizations:
bearer
path Parameters
storeId
required
string
orderId
required
string
fulfillmentId
required
string
Request Body schema: application/json
required
object (AddTrackingNumberDto)

Responses

Request samples

Content type
application/json
{ }

FulfillmentsController_updateTracking_v1

Authorizations:
bearer
path Parameters
storeId
required
string
orderId
required
string
fulfillmentId
required
string
trackingId
required
string
Request Body schema: application/json
required
object (UpdateTrackingStatusDto)

Responses

Request samples

Content type
application/json
{ }

FulfillmentsController_removeTracking_v1

Authorizations:
bearer
path Parameters
storeId
required
string
orderId
required
string
fulfillmentId
required
string
trackingId
required
string

Responses

FulfillmentsController_cancelFulfillment_v1

Authorizations:
bearer
path Parameters
storeId
required
string
orderId
required
string
fulfillmentId
required
string
Request Body schema: application/json
required
object (CancelFulfillmentDto)

Responses

Request samples

Content type
application/json
{ }

FulfillmentsController_markDelivered_v1

Authorizations:
bearer
path Parameters
storeId
required
string
orderId
required
string
fulfillmentId
required
string

Responses

FulfillmentsController_addFulfillmentEvent_v1

Authorizations:
bearer
path Parameters
storeId
required
string
orderId
required
string
fulfillmentId
required
string
Request Body schema: application/json
required
object (AddFulfillmentEventDto)

Responses

Request samples

Content type
application/json
{ }

FulfillmentsController_listFulfillmentEvents_v1

Authorizations:
None
path Parameters
storeId
required
string
orderId
required
string
fulfillmentId
required
string

Responses

FulfillmentsController_syncTracking_v1

Authorizations:
bearer
path Parameters
storeId
required
string
orderId
required
string
fulfillmentId
required
string
Request Body schema: application/json
required
object (SyncTrackingDto)

Responses

Request samples

Content type
application/json
{ }

OrderOrderEdits

OrderOrderEditsController_beginOrderEdit_v1

Authorizations:
bearer
path Parameters
storeId
required
string
orderId
required
string
Request Body schema: application/json
required
object (BeginOrderEditDto)

Responses

Request samples

Content type
application/json
{ }

OrderOrderEditsController_listOrderEdits_v1

Authorizations:
None
path Parameters
storeId
required
string
orderId
required
string

Responses

OrderOrderEditsController_calculateOrderEditPreview_v1

Authorizations:
bearer
path Parameters
storeId
required
string
orderId
required
string
Request Body schema: application/json
required
object (ApplyOrderEditDto)

Responses

Request samples

Content type
application/json
{ }

OrderOrderEditsController_applyOrderEdit_v1

Authorizations:
bearer
path Parameters
storeId
required
string
orderId
required
string
Request Body schema: application/json
required
object (ApplyOrderEditDto)

Responses

Request samples

Content type
application/json
{ }

OrderOrderEditsController_getRemovedItems_v1

Authorizations:
None
path Parameters
storeId
required
string
orderId
required
string

Responses

OrderRisks

OrderRisksController_listRisks_v1

Authorizations:
None
path Parameters
storeId
required
string

Responses

OrderRisksController_getHighRiskOrders_v1

Authorizations:
None
path Parameters
storeId
required
string

Responses

OrderRisksController_getRiskStatistics_v1

Authorizations:
None
path Parameters
storeId
required
string

Responses

OrderRisksController_getRisk_v1

Authorizations:
None
path Parameters
storeId
required
string
riskId
required
string

Responses

OrderRisksController_updateRisk_v1

Authorizations:
bearer
path Parameters
storeId
required
string
riskId
required
string
Request Body schema: application/json
required
object (UpdateOrderRiskDto)

Responses

Request samples

Content type
application/json
{ }

OrderRisksController_deleteRisk_v1

Authorizations:
bearer
path Parameters
storeId
required
string
riskId
required
string

Responses

OrderOrderRisks

OrderOrderRisksController_listOrderRisks_v1

Authorizations:
None
path Parameters
storeId
required
string
orderId
required
string

Responses

OrderOrderRisksController_createRisk_v1

Authorizations:
bearer
path Parameters
storeId
required
string
orderId
required
string
Request Body schema: application/json
required
object (CreateOrderRiskDto)

Responses

Request samples

Content type
application/json
{ }

OrderOrderRisksController_getOrderRiskAggregate_v1

Authorizations:
None
path Parameters
storeId
required
string
orderId
required
string

Responses

OrderOrderRisksController_assessOrderRisk_v1

Authorizations:
bearer
path Parameters
storeId
required
string
orderId
required
string
Request Body schema: application/json
required
object (AssessOrderRiskDto)

Responses

Request samples

Content type
application/json
{ }

ShippingLabels

ShippingLabelsController_purchaseLabel_v1

Authorizations:
bearer
path Parameters
storeId
required
string
orderId
required
string

Responses

ShippingLabelsController_listLabels_v1

Authorizations:
None
path Parameters
storeId
required
string
orderId
required
string

Responses

ShippingLabelsController_listLabelsGroupedByFulfillmentOrder_v1

Authorizations:
None
path Parameters
storeId
required
string
orderId
required
string

Responses

ShippingLabelsController_getLabel_v1

Authorizations:
None
path Parameters
storeId
required
string
orderId
required
string
labelId
required
string

Responses

ShippingLabelsController_reprintLabel_v1

Authorizations:
bearer
path Parameters
storeId
required
string
orderId
required
string
labelId
required
string

Responses

ShippingLabelsController_voidLabel_v1

Authorizations:
bearer
path Parameters
storeId
required
string
orderId
required
string
labelId
required
string

Responses

ShippingLabelsBulk

ShippingLabelsBulkController_getBalancePreview_v1

Authorizations:
bearer
path Parameters
storeId
required
string
query Parameters
amount
required
string
currency
required
string
provider
required
string

Responses

ShippingLabelsBulkController_getFeeInfo_v1

Authorizations:
None

Responses

ShippingLabelsBulkController_getLabelQueue_v1

Authorizations:
bearer
path Parameters
storeId
required
string

Responses

ShippingLabelsBulkController_getFulfillmentOrdersAtLocation_v1

Authorizations:
bearer
path Parameters
storeId
required
string
locationId
required
string

Responses

ShippingLabelsBulkController_bulkPurchase_v1

Authorizations:
bearer
path Parameters
storeId
required
string

Responses

ShippingLabelsBulkController_getJobStatus_v1

Authorizations:
None
path Parameters
storeId
required
string
jobId
required
string

Responses

ShippingLabelsBulkController_listJobs_v1

Authorizations:
None
path Parameters
storeId
required
string
query Parameters
limit
required
string

Responses

CustomsDeclarations

CustomsDeclarationsController_get_v1

Authorizations:
bearer
path Parameters
storeId
required
string
fulfillmentOrderId
required
string

Responses

CustomsDeclarationsController_upsert_v1

Authorizations:
bearer
path Parameters
storeId
required
string
fulfillmentOrderId
required
string
Request Body schema: application/json
required
object (UpsertCustomsDeclarationDto)

Responses

Request samples

Content type
application/json
{ }

CustomsDeclarationsController_delete_v1

Authorizations:
bearer
path Parameters
storeId
required
string
fulfillmentOrderId
required
string

Responses

Gift Cards

Get gift card counts by status

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID

Responses

Get gift card counts timeseries for analytics charts

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID

query Parameters
from
required
string

Start date (ISO 8601)

to
required
string

End date (ISO 8601)

groupBy
string
Enum: "day" "week" "month"

Responses

List all gift cards

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID

query Parameters
status
Array of strings
search
string
limit
number
page
number

Responses

Create/issue new gift card

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID

Request Body schema: application/json
required
object (CreateGiftCardDto)

Responses

Request samples

Content type
application/json
{ }

Get gift card by ID

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID

id
required
string

Gift Card ID

Responses

Update gift card

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID

id
required
string

Gift Card ID

Request Body schema: application/json
required
object (UpdateGiftCardDto)

Responses

Request samples

Content type
application/json
{ }

Delete gift card

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID

id
required
string

Gift Card ID

Responses

Bulk deactivate gift cards

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID

Request Body schema: application/json
required
object (BulkDeactivateDto)

Responses

Request samples

Content type
application/json
{ }

Bulk send gift cards to recipients

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID

Request Body schema: application/json
required
object (BulkSendDto)

Responses

Request samples

Content type
application/json
{ }

Deactivate gift card

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID

id
required
string

Gift Card ID

Responses

Send gift card email

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID

id
required
string

Gift Card ID

Request Body schema: application/json
required
object (SendGiftCardDto)

Responses

Request samples

Content type
application/json
{ }

Check gift card balance by code

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID

code
required
string

Gift Card Code (e.g., XXXX-XXXX-XXXX-XXXX)

Responses

Redeem gift card (deduct balance)

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID

Request Body schema: application/json
required
object (RedeemGiftCardDto)

Responses

Request samples

Content type
application/json
{ }

Refund to gift card (add balance back)

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID

Request Body schema: application/json
required
object (RefundToGiftCardDto)

Responses

Request samples

Content type
application/json
{ }

Add comment to gift card timeline

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID

id
required
string

Gift Card ID

Responses

Edit gift card comment

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID

id
required
string

Gift Card ID

commentId
required
string

Comment ID

Responses

Delete gift card comment

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID

id
required
string

Gift Card ID

commentId
required
string

Comment ID

Responses

Delete attachment from gift card comment

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID

id
required
string

Gift Card ID

commentId
required
string

Comment ID

attachmentId
required
string

Attachment ID

Responses

Cart

Calculate cart totals with discounts and taxes 

  PRIMARY endpoint for cart/order calculations.

  Features:
  - Line-level discounts (per item)
  - Order-level discounts (manual)
  - Discount code validation and application
  - Destination-based tax calculation
  - Shipping cost calculation

  Returns:
  - subtotal: Sum of line items after line-level discounts
  - discount: Total discount (order + codes)
  - shipping: Shipping cost (after shipping discounts)
  - tax: Calculated tax based on shipping address
  - total: Final total
  - taxLines: Tax breakdown by jurisdiction
  - appliedDiscountCodes: Successfully applied discount codes
  - warnings: Any validation warnings
  - lineItems: Processed line items with totals

  Note: If no shipping address is provided, tax will be 0.
  Tax will be calculated when shipping address is added.
Authorizations:
bearer
path Parameters
storeId
required
string

Store ID

Request Body schema: application/json
required
object (CalculateCartTotalsDto)

Responses

Request samples

Content type
application/json
{ }

StoreCredits

StoreCreditsController_getBalance_v1

path Parameters
storeId
required
string
customerId
required
string

Responses

StoreCreditsController_getSummary_v1

path Parameters
storeId
required
string
customerId
required
string

Responses

StoreCreditsController_expireCustomerCredit_v1

path Parameters
storeId
required
string
customerId
required
string

Responses

StoreCreditsController_issueCredit_v1

path Parameters
storeId
required
string
Request Body schema: application/json
required
object (IssueStoreCreditDto)

Responses

Request samples

Content type
application/json
{ }

StoreCreditsController_applyCredit_v1

path Parameters
storeId
required
string
Request Body schema: application/json
required
object (ApplyStoreCreditDto)

Responses

Request samples

Content type
application/json
{ }

StoreCreditsController_adjustCredit_v1

path Parameters
storeId
required
string
Request Body schema: application/json
required
object (AdjustStoreCreditDto)

Responses

Request samples

Content type
application/json
{ }

StoreCreditsController_transferCredit_v1

path Parameters
storeId
required
string
Request Body schema: application/json
required
object (TransferStoreCreditDto)

Responses

Request samples

Content type
application/json
{ }

StoreCreditsController_refundToStoreCredit_v1

path Parameters
storeId
required
string
Request Body schema: application/json
required
object (RefundToStoreCreditDto)

Responses

Request samples

Content type
application/json
{ }

StoreCreditsController_listTransactions_v1

path Parameters
storeId
required
string
query Parameters
customerId
required
string
type
required
string
source
required
string
orderId
required
string
startDate
required
string
endDate
required
string
page
required
string
limit
required
string

Responses

DraftOrders

DraftOrdersController_list_v1

Authorizations:
bearer
path Parameters
storeId
required
string

Responses

DraftOrdersController_create_v1

Authorizations:
bearer
path Parameters
storeId
required
string
Request Body schema: application/json
required
object (CreateDraftOrderDto)

Responses

Request samples

Content type
application/json
{ }

DraftOrdersController_count_v1

Authorizations:
bearer
path Parameters
storeId
required
string

Responses

DraftOrdersController_get_v1

Authorizations:
bearer
path Parameters
storeId
required
string
id
required
string

Responses

DraftOrdersController_update_v1

Authorizations:
bearer
path Parameters
storeId
required
string
id
required
string
Request Body schema: application/json
required
object (UpdateDraftOrderDto)

Responses

Request samples

Content type
application/json
{ }

DraftOrdersController_delete_v1

Authorizations:
bearer
path Parameters
storeId
required
string
id
required
string

Responses

DraftOrdersController_previewInvoice_v1

Authorizations:
bearer
path Parameters
storeId
required
string
id
required
string
Request Body schema: application/json
required
object (SendInvoiceDto)

Responses

Request samples

Content type
application/json
{ }

DraftOrdersController_sendInvoice_v1

Authorizations:
bearer
path Parameters
storeId
required
string
id
required
string
Request Body schema: application/json
required
object (SendInvoiceDto)

Responses

Request samples

Content type
application/json
{ }

DraftOrdersController_markAsPaid_v1

Authorizations:
bearer
path Parameters
storeId
required
string
id
required
string
Request Body schema: application/json
required
object (CompleteDraftOrderDto)

Responses

Request samples

Content type
application/json
{ }

DraftOrdersController_complete_v1

Authorizations:
bearer
path Parameters
storeId
required
string
id
required
string
Request Body schema: application/json
required
object (CompleteDraftOrderDto)

Responses

Request samples

Content type
application/json
{ }

DraftOrdersController_duplicate_v1

Authorizations:
bearer
path Parameters
storeId
required
string
id
required
string

Responses

DraftOrdersController_validateDiscounts_v1

Authorizations:
bearer
path Parameters
storeId
required
string
Request Body schema: application/json
required
object (ValidateDiscountCodesDto)

Responses

Request samples

Content type
application/json
{ }

DraftOrdersController_getConversionMetrics_v1

Authorizations:
bearer
path Parameters
storeId
required
string
query Parameters
startDate
required
string
endDate
required
string
groupBy
required
string

Responses

DraftOrdersController_getTimeline_v1

Authorizations:
bearer
path Parameters
storeId
required
string
id
required
string

Responses

DraftOrdersController_addTimelineComment_v1

Authorizations:
bearer
path Parameters
storeId
required
string
id
required
string
Request Body schema: application/json
required
object (AddTimelineCommentDto)

Responses

Request samples

Content type
application/json
{ }

DraftOrdersController_editTimelineComment_v1

Authorizations:
bearer
path Parameters
storeId
required
string
id
required
string
commentId
required
string
Request Body schema: application/json
required
object (EditTimelineCommentDto)

Responses

Request samples

Content type
application/json
{ }

DraftOrdersController_deleteTimelineComment_v1

Authorizations:
bearer
path Parameters
storeId
required
string
id
required
string
commentId
required
string

Responses

DraftOrdersController_deleteTimelineAttachment_v1

Authorizations:
bearer
path Parameters
storeId
required
string
id
required
string
commentId
required
string
attachmentId
required
string

Responses

DraftOrdersController_getMentionableStaff_v1

Authorizations:
bearer
path Parameters
storeId
required
string

Responses

DraftOrdersController_resendTimelineNotification_v1

Authorizations:
bearer
path Parameters
storeId
required
string
id
required
string
timelineEventId
required
string

Responses

DraftOrdersController_bulkAddTags_v1

Authorizations:
bearer
path Parameters
storeId
required
string
Request Body schema: application/json
required
object (BulkDraftOrderTagsDto)

Responses

Request samples

Content type
application/json
{ }

DraftOrdersController_bulkRemoveTags_v1

Authorizations:
bearer
path Parameters
storeId
required
string
Request Body schema: application/json
required
object (BulkDraftOrderTagsDto)

Responses

Request samples

Content type
application/json
{ }

Checkout

Create checkout

Create a checkout session from cart or line items

path Parameters
storeId
required
string

Store ID

Request Body schema: application/json
required
cartId
string

Cart ID to create checkout from

email
string

Customer email

customerId
string

Customer ID (if logged in)

Array of objects (CheckoutLineItemDto)

Line items (if not using cartId)

note
string

Customer note

presentmentCurrency
string

Presentment currency (customer display currency, e.g. JPY)

Responses

Request samples

Content type
application/json
{
  • "cartId": "string",
  • "email": "string",
  • "customerId": "string",
  • "lineItems": [
    ],
  • "note": "string",
  • "presentmentCurrency": "string"
}

Get checkout

Retrieve checkout by ID

path Parameters
storeId
required
string

Store ID

checkoutId
required
string

Checkout ID

query Parameters
sessionToken
string

Session token (required for guest checkout)

Responses

Update checkout

Update checkout information (email, addresses, shipping, payment)

path Parameters
storeId
required
string

Store ID

checkoutId
required
string

Checkout ID

Request Body schema: application/json
required
email
string

Customer email

phone
string

Contact phone number

acceptsEmailMarketing
boolean

Shopper opted in to email marketing

acceptsSmsMarketing
boolean

Shopper opted in to SMS marketing

object

Shipping address

object

Billing address

shippingMethodId
string

Shipping method ID, exactly as returned by POST /checkout/:id/shipping-rates. One of: a zone-rate UUID, "ld_", "pickup:", "combined_[.…]", or "carrier_".

note
string

Customer note

tipAmount
number >= 0

Gratuity amount in the checkout presentment currency (Settings → Checkout → Tipping)

sessionToken
string

Session token (required for guest checkout)

paymentMethod
object

Payment method info (no sensitive data)

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "phone": "string",
  • "acceptsEmailMarketing": true,
  • "acceptsSmsMarketing": true,
  • "shippingAddress": {
    },
  • "billingAddress": {
    },
  • "shippingMethodId": "string",
  • "note": "string",
  • "tipAmount": 0,
  • "sessionToken": "string",
  • "paymentMethod": { }
}

Get shipping rates

Calculate available shipping rates for checkout

path Parameters
storeId
required
string

Store ID

checkoutId
required
string

Checkout ID

Request Body schema: application/json
required
required
object

Shipping address for rate calculation

sessionToken
string

Session token (required for guest checkout)

Responses

Request samples

Content type
application/json
{
  • "shippingAddress": {
    },
  • "sessionToken": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Apply discount code

Apply a discount code to the checkout

path Parameters
storeId
required
string

Store ID

checkoutId
required
string

Checkout ID

Request Body schema: application/json
required
code
required
string

Discount code

sessionToken
string

Session token (required for guest checkout)

Responses

Request samples

Content type
application/json
{
  • "code": "SUMMER2025",
  • "sessionToken": "string"
}

Remove discount code

Remove the discount code from checkout

path Parameters
storeId
required
string

Store ID

checkoutId
required
string

Checkout ID

query Parameters
sessionToken
string

Session token (required for guest checkout)

Responses

Validate a gift card at checkout (balance check only)

Storefront-safe, read-only gift-card lookup (store-api#540). Confirms the caller owns the checkout session, then returns the card status + spendable balance without redeeming anything. Applying it as tender is a follow-up.

path Parameters
storeId
required
string

Store ID

checkoutId
required
string

Checkout ID

Responses

Complete checkout

Finalize checkout and create order

path Parameters
storeId
required
string

Store ID

checkoutId
required
string

Checkout ID

Request Body schema: application/json
required
paymentMethodId
required
string
paymentIntentId
string

Responses

Request samples

Content type
application/json
{
  • "paymentMethodId": "stripe",
  • "paymentIntentId": "pi_1234567890"
}

Create payment intent

Create a Stripe PaymentIntent for the checkout. Order is created via webhook after payment confirmation. Requires an Idempotency-Key header (UUID v4).

path Parameters
storeId
required
string

Store ID

checkoutId
required
string

Checkout ID

Responses

Get payment status

Check payment and order status. Poll this after payment confirmation.

path Parameters
storeId
required
string

Store ID

checkoutId
required
string

Checkout ID

query Parameters
sessionToken
string

Session token (required for guest checkout)

Responses

Returns

ReturnsController_listReturns_v1

path Parameters
storeId
required
string

Responses

ReturnsController_getReturn_v1

path Parameters
storeId
required
string
returnId
required
string

Responses

ReturnsController_getSuggestedRefund_v1

path Parameters
storeId
required
string
returnId
required
string

Responses

ReturnsController_approveReturn_v1

path Parameters
storeId
required
string
returnId
required
string
Request Body schema: application/json
required
object (ApproveReturnDto)

Responses

Request samples

Content type
application/json
{ }

ReturnsController_declineReturn_v1

path Parameters
storeId
required
string
returnId
required
string
Request Body schema: application/json
required
object (DeclineReturnDto)

Responses

Request samples

Content type
application/json
{ }

ReturnsController_cancelReturn_v1

path Parameters
storeId
required
string
returnId
required
string
Request Body schema: application/json
required
object (CancelReturnDto)

Responses

Request samples

Content type
application/json
{ }

ReturnsController_closeReturn_v1

path Parameters
storeId
required
string
returnId
required
string

Responses

ReturnsController_reopenReturn_v1

path Parameters
storeId
required
string
returnId
required
string

Responses

ReturnsController_updateReturnTracking_v1

path Parameters
storeId
required
string
returnId
required
string

Responses

ReturnsController_uploadReturnLabel_v1

path Parameters
storeId
required
string
returnId
required
string

Responses

ReturnsController_removeReturnLabel_v1

path Parameters
storeId
required
string
returnId
required
string

Responses

ReturnsController_removeReturnLineItems_v1

path Parameters
storeId
required
string
returnId
required
string
Request Body schema: application/json
required
object (RemoveReturnLineItemsDto)

Responses

Request samples

Content type
application/json
{ }

ReturnsController_processReturn_v1

path Parameters
storeId
required
string
returnId
required
string
Request Body schema: application/json
required
object (ReturnProcessDto)

Responses

Request samples

Content type
application/json
{ }

ReturnsController_getExchangeSummary_v1

path Parameters
storeId
required
string
returnId
required
string

Responses

ReturnsController_processExchange_v1

path Parameters
storeId
required
string
returnId
required
string
Request Body schema: application/json
required
object (ProcessExchangeDto)

Responses

Request samples

Content type
application/json
{ }

ReturnsController_releaseExchangeHold_v1

path Parameters
storeId
required
string
returnId
required
string

Responses

OrderReturns

OrderReturnsController_getReturnableItems_v1

path Parameters
storeId
required
string
orderId
required
string

Responses

OrderReturnsController_getOrderReturnSummary_v1

path Parameters
storeId
required
string
orderId
required
string

Responses

OrderReturnsController_syncOrderReturnStatus_v1

path Parameters
storeId
required
string
orderId
required
string

Responses

OrderReturnsController_listOrderReturns_v1

path Parameters
storeId
required
string
orderId
required
string

Responses

OrderReturnsController_requestReturn_v1

path Parameters
storeId
required
string
orderId
required
string
Request Body schema: application/json
required
object (RequestReturnDto)

Responses

Request samples

Content type
application/json
{ }

OrderReturnsController_requestExchange_v1

path Parameters
storeId
required
string
orderId
required
string
Request Body schema: application/json
required
object (RequestExchangeDto)

Responses

Request samples

Content type
application/json
{ }

OrderReturnsController_calculateReturnPreview_v1

path Parameters
storeId
required
string
orderId
required
string
Request Body schema: application/json
required
object (CalculateReturnPreviewDto)

Responses

Request samples

Content type
application/json
{ }

Transfers

List all transfers

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID

query Parameters
sortOrder
string
Enum: "asc" "desc"
sortBy
string
dateTo
string <date-time>
dateFrom
string <date-time>
destinationId
string
originId
string
status
string

Comma-separated statuses

search
string
limit
number
page
number

Responses

Create a new transfer

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID

Request Body schema: application/json
required
object (CreateTransferDto)

Responses

Request samples

Content type
application/json
{ }

Get transfer counts by status

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID

Responses

Get transfer counts time-series data

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID

query Parameters
from
required
string

Start date (ISO 8601)

to
required
string

End date (ISO 8601)

groupBy
string
Enum: "day" "week" "month"

Grouping granularity (default: day)

Responses

Get tag suggestions from existing transfers

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID

query Parameters
search
string

Responses

Get paginated tag suggestions

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID

query Parameters
page
number
limit
number
search
string

Responses

Bulk add tags to transfers

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID

Request Body schema: application/json
required
object (BulkTransferTagsDto)

Responses

Request samples

Content type
application/json
{ }

Bulk remove tags from transfers

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID

Request Body schema: application/json
required
object (BulkTransferTagsDto)

Responses

Request samples

Content type
application/json
{ }

Get a transfer by ID

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID

id
required
string

Transfer ID

Responses

Update a transfer

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID

id
required
string

Transfer ID

Request Body schema: application/json
required
object (UpdateTransferDto)

Responses

Request samples

Content type
application/json
{ }

Delete a transfer

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID

id
required
string

Transfer ID

Responses

Update a transfer item Move quantity. DRAFT: only DB. READY_TO_SHIP: also delta-adjusts origin + destination inventory.

Authorizations:
bearer
path Parameters
storeId
required
string
id
required
string
itemId
required
string

Responses

Remove a transfer item. READY_TO_SHIP: reverses the inventory move first.

Authorizations:
bearer
path Parameters
storeId
required
string
id
required
string
itemId
required
string

Responses

One-click "Move to in transit" from READY_TO_SHIP. Creates a shipment with all remaining items in IN_TRANSIT status and flips the transfer to IN_TRANSIT.

Authorizations:
bearer
path Parameters
storeId
required
string
id
required
string

Responses

Mark transfer as TRANSFERRED in one shot (skips R2S/IN_TRANSIT). Applies the full inventory move from DRAFT if needed, then writes a synthetic Received shipment.

Authorizations:
bearer
path Parameters
storeId
required
string
id
required
string

Responses

Cancel a transfer (DRAFT/READY_TO_SHIP/IN_TRANSIT). Reverses inventory move and sets status to CANCELLED.

Authorizations:
bearer
path Parameters
storeId
required
string
id
required
string

Responses

Mark transfer as ready to ship

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID

id
required
string

Transfer ID

Responses

Link a transfer to a purchase order (or unlink)

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID

id
required
string

Transfer ID

Responses

Create a shipment for a transfer

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID

id
required
string

Transfer ID

Request Body schema: application/json
required
object (CreateShipmentDto)

Responses

Request samples

Content type
application/json
{ }

Update shipment tracking information

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID

id
required
string

Transfer ID

shipmentId
required
string

Shipment ID

Responses

Update shipment cost + adjustments

Pure metadata write — sets the shipment's base cost, currency, and adjustment list. No inventory side-effects.

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID

id
required
string

Transfer ID

shipmentId
required
string

Shipment ID

Responses

Mark shipment as in transit

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID

id
required
string

Transfer ID

shipmentId
required
string

Shipment ID

Responses

Adjust accepted/rejected on an already-received shipment (delta inventory adjust).

Authorizations:
bearer
path Parameters
storeId
required
string
id
required
string
shipmentId
required
string
Request Body schema: application/json
required
object (ReceiveTransferDto)

Responses

Request samples

Content type
application/json
{ }

Receive specific shipment

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID

id
required
string

Transfer ID

shipmentId
required
string

Shipment ID

Request Body schema: application/json
required
object (ReceiveTransferDto)

Responses

Request samples

Content type
application/json
{ }

Receive items for a transfer (legacy)

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID

id
required
string

Transfer ID

Request Body schema: application/json
required
object (ReceiveTransferDto)

Responses

Request samples

Content type
application/json
{ }

Add a comment to transfer timeline

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID

id
required
string

Transfer ID

Request Body schema: application/json
required
object (CreateCommentDto)

Responses

Request samples

Content type
application/json
{ }

Edit a comment in transfer timeline

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID

id
required
string

Transfer ID

commentId
required
string

Comment ID

Request Body schema: application/json
required
object (UpdateCommentDto)

Responses

Request samples

Content type
application/json
{ }

Delete a comment from transfer timeline

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID

id
required
string

Transfer ID

commentId
required
string

Comment ID

Responses

Delete an attachment from a transfer timeline comment

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID

id
required
string

Transfer ID

commentId
required
string

Comment ID

attachmentId
required
string

Attachment ID

Responses

Suppliers

List all suppliers

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID

query Parameters
includeArchived
boolean

Include archived suppliers

sortOrder
string
Enum: "asc" "desc"
sortBy
string
search
string
limit
number
page
number

Responses

Create a new supplier

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID

Request Body schema: application/json
required
object (CreateSupplierDto)

Responses

Request samples

Content type
application/json
{ }

Get a supplier by ID

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID

id
required
string

Supplier ID

Responses

Update a supplier

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID

id
required
string

Supplier ID

Request Body schema: application/json
required
object (UpdateSupplierDto)

Responses

Request samples

Content type
application/json
{ }

Delete a supplier (hard delete, only if no purchase orders)

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID

id
required
string

Supplier ID

Responses

List variants purchased from this supplier across all POs

Aggregates PurchaseOrderItem rows by variant so the supplier detail view can render the "products purchased from this supplier" table (standard). Returns the latest supplier SKU + last purchase price per variant.

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID

id
required
string

Supplier ID

query Parameters
page
number
limit
number
search
string

Responses

Get supplier deletion info for UI warnings

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID

id
required
string

Supplier ID

Responses

Archive a supplier (soft delete)

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID

id
required
string

Supplier ID

Responses

Unarchive a supplier (restore)

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID

id
required
string

Supplier ID

Responses

Companies (B2B)

List companies

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID

Responses

Create a company and its primary location

Authorizations:
bearer
path Parameters
storeId
required
string
Request Body schema: application/json
required
object (CreateCompanyDto)

Responses

Request samples

Content type
application/json
{ }

Retrieve a company with its locations and contacts

Authorizations:
bearer
path Parameters
storeId
required
string
id
required
string

Responses

Update a company

Authorizations:
bearer
path Parameters
storeId
required
string
id
required
string
Request Body schema: application/json
required
object (UpdateCompanyDto)

Responses

Request samples

Content type
application/json
{ }

Delete a company (soft, cascades to locations and contacts)

Authorizations:
bearer
path Parameters
storeId
required
string
id
required
string

Responses

List a company's locations

Authorizations:
bearer
path Parameters
storeId
required
string
id
required
string

Responses

Add a location to a company

Authorizations:
bearer
path Parameters
storeId
required
string
id
required
string
Request Body schema: application/json
required
object (CreateCompanyLocationDto)

Responses

Request samples

Content type
application/json
{ }

Retrieve a company location

Authorizations:
bearer
path Parameters
storeId
required
string
id
required
string
locationId
required
string

Responses

Update a company location

Authorizations:
bearer
path Parameters
storeId
required
string
id
required
string
locationId
required
string
Request Body schema: application/json
required
object (UpdateCompanyLocationDto)

Responses

Request samples

Content type
application/json
{ }

Delete a company location (soft; the primary one cannot be deleted)

Authorizations:
bearer
path Parameters
storeId
required
string
id
required
string
locationId
required
string

Responses

List a location's contacts

Authorizations:
bearer
path Parameters
storeId
required
string
id
required
string
locationId
required
string

Responses

Attach a customer to a location as a contact

Authorizations:
bearer
path Parameters
storeId
required
string
id
required
string
locationId
required
string
Request Body schema: application/json
required
object (CreateCompanyContactDto)

Responses

Request samples

Content type
application/json
{ }

Change a contact's role or B2B ordering access

Authorizations:
bearer
path Parameters
storeId
required
string
id
required
string
locationId
required
string
contactId
required
string
Request Body schema: application/json
required
object (UpdateCompanyContactDto)

Responses

Request samples

Content type
application/json
{ }

Remove a contact from a location (soft)

Authorizations:
bearer
path Parameters
storeId
required
string
id
required
string
locationId
required
string
contactId
required
string

Responses

List a company location's store-credit balances

Authorizations:
bearer
path Parameters
storeId
required
string
locationId
required
string

Company location ID

Responses

Issue store credit to a company location

Authorizations:
bearer
path Parameters
storeId
required
string
locationId
required
string
Request Body schema: application/json
required
object (IssueCreditDto)

Responses

Request samples

Content type
application/json
{ }

List a company location's store-credit ledger

Authorizations:
bearer
path Parameters
storeId
required
string
locationId
required
string

Responses

Adjust a company location's store-credit balance

Authorizations:
bearer
path Parameters
storeId
required
string
locationId
required
string
Request Body schema: application/json
required
object (AdjustCreditDto)

Responses

Request samples

Content type
application/json
{ }

Purchase Orders

Get purchase order PDF (inline)

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID

id
required
string

Purchase Order ID

query Parameters
locale
string

Locale for PDF (e.g., en-US, th-TH)

Responses

Response samples

Content type
application/json
{ }

List all purchase orders

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID

query Parameters
sortOrder
string
Enum: "asc" "desc"
sortBy
string
dateTo
string <date-time>
dateFrom
string <date-time>
destinationId
string
supplierId
string
status
string

Comma-separated statuses

search
string
limit
number
page
number

Responses

Create a new purchase order

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID

Request Body schema: application/json
required
object (CreatePurchaseOrderDto)

Responses

Request samples

Content type
application/json
{ }

Get purchase order counts by status

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID

Responses

Get purchase order counts timeseries for analytics charts

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID

query Parameters
from
required
string

Start date (ISO 8601)

to
required
string

End date (ISO 8601)

groupBy
string
Enum: "day" "week" "month"

Responses

Get tag suggestions from existing purchase orders

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID

query Parameters
search
string

Responses

Get paginated tag suggestions

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID

query Parameters
page
number
limit
number
search
string

Responses

Bulk add tags to purchase orders

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID

Request Body schema: application/json
required
object (BulkPurchaseOrderTagsDto)

Responses

Request samples

Content type
application/json
{ }

Bulk remove tags from purchase orders

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID

Request Body schema: application/json
required
object (BulkPurchaseOrderTagsDto)

Responses

Request samples

Content type
application/json
{ }

Get a purchase order by ID

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID

id
required
string

Purchase Order ID

Responses

Update a purchase order

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID

id
required
string

Purchase Order ID

Request Body schema: application/json
required
object (UpdatePurchaseOrderDto)

Responses

Request samples

Content type
application/json
{ }

Delete a purchase order

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID

id
required
string

Purchase Order ID

Responses

Create a transfer from this purchase order

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID

id
required
string

Purchase Order ID

Request Body schema: application/json
required
object (CreateTransferFromPurchaseOrderDto)

Responses

Request samples

Content type
application/json
{ }

Mark purchase order as ordered

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID

id
required
string

Purchase Order ID

Responses

Receive items for a purchase order

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID

id
required
string

Purchase Order ID

Request Body schema: application/json
required
object (ReceivePurchaseOrderDto)

Responses

Request samples

Content type
application/json
{ }

Close a purchase order

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID

id
required
string

Purchase Order ID

Responses

Reopen a closed purchase order

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID

id
required
string

Purchase Order ID

Responses

Add a comment to purchase order timeline

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID

id
required
string

Purchase Order ID

Request Body schema: application/json
required
object (CreateCommentDto)

Responses

Request samples

Content type
application/json
{ }

Edit a comment in purchase order timeline

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID

id
required
string

Purchase Order ID

commentId
required
string

Comment ID

Request Body schema: application/json
required
object (UpdateCommentDto)

Responses

Request samples

Content type
application/json
{ }

Delete a comment from purchase order timeline

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID

id
required
string

Purchase Order ID

commentId
required
string

Comment ID

Responses

Delete an attachment from a comment

Authorizations:
bearer
path Parameters
storeId
required
string

Store ID

id
required
string

Purchase Order ID

commentId
required
string

Comment ID

attachmentId
required
string

Attachment ID

Responses

Selling Plans

List all selling plan groups

Authorizations:
bearer
path Parameters
storeId
required
string <uuid>
query Parameters
page
number
limit
number
isActive
boolean
search
string
sortBy
string
Enum: "createdAt" "name" "position"
sortOrder
string
Enum: "asc" "desc"

Responses

Create a new selling plan group

Authorizations:
bearer
path Parameters
storeId
required
string <uuid>
Request Body schema: application/json
required
object (CreateSellingPlanGroupDto)

Responses

Request samples

Content type
application/json
{ }

Get a selling plan group by ID

Authorizations:
bearer
path Parameters
storeId
required
string <uuid>
groupId
required
string <uuid>

Responses

Update a selling plan group

Authorizations:
bearer
path Parameters
storeId
required
string <uuid>
groupId
required
string <uuid>
Request Body schema: application/json
required
object (UpdateSellingPlanGroupDto)

Responses

Request samples

Content type
application/json
{ }

Delete a selling plan group

Authorizations:
bearer
path Parameters
storeId
required
string <uuid>
groupId
required
string <uuid>

Responses

Get a selling plan by ID

Authorizations:
bearer
path Parameters
storeId
required
string <uuid>
planId
required
string <uuid>

Responses

Update a selling plan

Authorizations:
bearer
path Parameters
storeId
required
string <uuid>
planId
required
string <uuid>
Request Body schema: application/json
required
object (UpdateSellingPlanDto)

Responses

Request samples

Content type
application/json
{ }

Delete a selling plan

Authorizations:
bearer
path Parameters
storeId
required
string <uuid>
planId
required
string <uuid>

Responses

Create a selling plan in a group

Authorizations:
bearer
path Parameters
storeId
required
string <uuid>
groupId
required
string <uuid>
Request Body schema: application/json
required
object (CreateSellingPlanDto)

Responses

Request samples

Content type
application/json
{ }

Associate products with a selling plan group

Authorizations:
bearer
path Parameters
storeId
required
string <uuid>
groupId
required
string <uuid>
Request Body schema: application/json
required
object (AssociateProductsDto)

Responses

Request samples

Content type
application/json
{ }

Remove products from a selling plan group

Authorizations:
bearer
path Parameters
storeId
required
string <uuid>
groupId
required
string <uuid>
Request Body schema: application/json
required
object (AssociateProductsDto)

Responses

Request samples

Content type
application/json
{ }

Associate variants with a selling plan group

Authorizations:
bearer
path Parameters
storeId
required
string <uuid>
groupId
required
string <uuid>
Request Body schema: application/json
required
object (AssociateVariantsDto)

Responses

Request samples

Content type
application/json
{ }

Remove variants from a selling plan group

Authorizations:
bearer
path Parameters
storeId
required
string <uuid>
groupId
required
string <uuid>
Request Body schema: application/json
required
object (AssociateVariantsDto)

Responses

Request samples

Content type
application/json
{ }

Get selling plan groups for a product

Authorizations:
bearer
path Parameters
storeId
required
string <uuid>
productId
required
string <uuid>

Responses

Get selling plan groups for a variant

Authorizations:
bearer
path Parameters
storeId
required
string <uuid>
variantId
required
string <uuid>

Responses

Marketing

MarketingController_getTopChannels_v1

path Parameters
storeId
required
string
query Parameters
limit
required
string
startDate
required
string
endDate
required
string
attributionModel
required
string

Responses

MarketingController_getCampaigns_v1

path Parameters
storeId
required
string
query Parameters
startDate
required
string
endDate
required
string

Responses

MarketingController_createCampaign_v1

path Parameters
storeId
required
string

Responses

MarketingController_getRecentCampaigns_v1

path Parameters
storeId
required
string
query Parameters
limit
required
string
startDate
required
string
endDate
required
string

Responses

MarketingController_getCampaign_v1

path Parameters
storeId
required
string
id
required
string

Responses

MarketingController_updateCampaign_v1

path Parameters
storeId
required
string
id
required
string

Responses

MarketingController_deleteCampaign_v1

path Parameters
storeId
required
string
id
required
string

Responses

MarketingController_getCampaignBreakdown_v1

path Parameters
storeId
required
string
id
required
string
query Parameters
startDate
required
string
endDate
required
string
attributionModel
required
string

Responses

MarketingController_createAutoMatchRule_v1

path Parameters
storeId
required
string
campaignId
required
string

Responses

MarketingController_deleteAutoMatchRule_v1

path Parameters
storeId
required
string
campaignId
required
string
ruleId
required
string

Responses

MarketingController_getAttributionData_v1

path Parameters
storeId
required
string
query Parameters
startDate
required
string
endDate
required
string

Responses

MarketingController_getChannelAttribution_v1

path Parameters
storeId
required
string
query Parameters
startDate
required
string
endDate
required
string
attributionModel
required
string

Responses

MarketingController_getCampaignAttribution_v1

path Parameters
storeId
required
string
query Parameters
startDate
required
string
endDate
required
string

Responses

MarketingController_getAttributionTimeSeries_v1

path Parameters
storeId
required
string
query Parameters
startDate
required
string
endDate
required
string
groupBy
required
string

Responses

Automations

AutomationsController_getOverallStats_v1

path Parameters
storeId
required
string

Responses

AutomationsController_getAllExecutions_v1

path Parameters
storeId
required
string
query Parameters
status
required
string
limit
required
string

Responses

AutomationsController_listWorkflows_v1

path Parameters
storeId
required
string

Responses

AutomationsController_createWorkflow_v1

path Parameters
storeId
required
string
Request Body schema: application/json
required
object (CreateWorkflowDto)

Responses

Request samples

Content type
application/json
{ }

AutomationsController_getVocabulary_v1

path Parameters
storeId
required
string

Responses

AutomationsController_listTemplates_v1

path Parameters
storeId
required
string

Responses

AutomationsController_createFromTemplate_v1

path Parameters
storeId
required
string
templateId
required
string

Responses

AutomationsController_getSamplePayload_v1

path Parameters
storeId
required
string
query Parameters
trigger
required
string

Responses

AutomationsController_generateWorkflow_v1

path Parameters
storeId
required
string
Request Body schema: application/json
required
object (GenerateWorkflowDto)

Responses

Request samples

Content type
application/json
{ }

AutomationsController_getWorkflow_v1

path Parameters
storeId
required
string
id
required
string

Responses

AutomationsController_updateWorkflow_v1

path Parameters
storeId
required
string
id
required
string
Request Body schema: application/json
required
object (UpdateWorkflowDto)

Responses

Request samples

Content type
application/json
{ }

AutomationsController_deleteWorkflow_v1

path Parameters
storeId
required
string
id
required
string

Responses

AutomationsController_triggerWorkflow_v1

path Parameters
storeId
required
string
id
required
string

Responses

AutomationsController_testWorkflow_v1

path Parameters
storeId
required
string
id
required
string
Request Body schema: application/json
required
object (TestRunDto)

Responses

Request samples

Content type
application/json
{ }

AutomationsController_getExecutionHistory_v1

path Parameters
storeId
required
string
id
required
string
query Parameters
limit
required
string

Responses

AutomationsController_getExecutionStats_v1

path Parameters
storeId
required
string
id
required
string

Responses

Metafields

Get all resource types with definition counts

Authorizations:
bearerNone
path Parameters
storeId
required
string

Responses

List all metafield definitions

Authorizations:
bearerNone
path Parameters
storeId
required
string

Responses

Create new metafield definition

Authorizations:
bearerbearer
path Parameters
storeId
required
string
Request Body schema: application/json
required
object (CreateMetafieldDefinitionDto)

Responses

Request samples

Content type
application/json
{ }

Check if metafield key already exists

Authorizations:
bearerNone
path Parameters
storeId
required
string

Responses

Reorder pinned metafield definitions

Authorizations:
bearerbearer
path Parameters
storeId
required
string
Request Body schema: application/json
required
object (ReorderMetafieldDefinitionsDto)

Responses

Request samples

Content type
application/json
{ }

List products that use this metafield definition

Authorizations:
bearerNone
path Parameters
storeId
required
string
id
required
string

Responses

Get metafield definition by ID

Authorizations:
bearerNone
path Parameters
storeId
required
string
id
required
string

Responses

Update metafield definition

Authorizations:
bearerbearer
path Parameters
storeId
required
string
id
required
string
Request Body schema: application/json
required
object (UpdateMetafieldDefinitionDto)

Responses

Request samples

Content type
application/json
{ }

Delete metafield definition

Authorizations:
bearerbearer
path Parameters
storeId
required
string
id
required
string

Responses

Marketing - Email Campaigns

List the store's email campaigns

Authorizations:
bearer
path Parameters
storeId
required
string

Responses

Response samples

Content type
application/json
{ }

Create an email campaign

Authorizations:
bearer
path Parameters
storeId
required
string
Request Body schema: application/json
required
object (CreateEmailCampaignDto)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

Segment size and how many of those may be sent marketing

Authorizations:
bearer
path Parameters
storeId
required
string
segmentId
required
string

Responses

Response samples

Content type
application/json
{ }

Counts-only audience summary (app-safe: no recipient identities)

Authorizations:
bearer
path Parameters
storeId
required
string
segmentId
required
string

Responses

Response samples

Content type
application/json
{ }

Get one email campaign

Authorizations:
bearer
path Parameters
storeId
required
string
id
required
string

Responses

Response samples

Content type
application/json
{ }

Update an email campaign, or schedule it

Authorizations:
bearer
path Parameters
storeId
required
string
id
required
string
Request Body schema: application/json
required
object (UpdateEmailCampaignDto)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

Delete an email campaign

Authorizations:
bearer
path Parameters
storeId
required
string
id
required
string

Responses

Subscriptions

Get subscription summary for dashboard

Authorizations:
bearer
path Parameters
storeId
required
string <uuid>

Responses

Get subscription counts time-series data

Authorizations:
bearer
path Parameters
storeId
required
string
query Parameters
from
required
string
to
required
string
groupBy
required
string

Responses

List all subscription contracts

Authorizations:
bearer
path Parameters
storeId
required
string <uuid>
query Parameters
page
number
limit
number
status
string
Enum: "ACTIVE" "PAUSED" "CANCELLED" "EXPIRED" "FAILED"
customerId
string
search
string
sortBy
string
Enum: "createdAt" "nextBillingDate" "contractNumber"
sortOrder
string
Enum: "asc" "desc"

Responses

Create a new subscription contract

Authorizations:
bearer
path Parameters
storeId
required
string <uuid>
Request Body schema: application/json
required
object (CreateSubscriptionContractDto)

Responses

Request samples

Content type
application/json
{ }

Get a subscription contract by ID

Authorizations:
bearer
path Parameters
storeId
required
string <uuid>
contractId
required
string <uuid>

Responses

Update a subscription contract

Authorizations:
bearer
path Parameters
storeId
required
string <uuid>
contractId
required
string <uuid>
Request Body schema: application/json
required
object (UpdateSubscriptionContractDto)

Responses

Request samples

Content type
application/json
{ }

Cancel a subscription

Authorizations:
bearer
path Parameters
storeId
required
string <uuid>
contractId
required
string <uuid>
Request Body schema: application/json
required
reason
required
string

Cancellation reason

feedback
string

Additional feedback

Responses

Request samples

Content type
application/json
{
  • "reason": "string",
  • "feedback": "string"
}

Pause a subscription

Authorizations:
bearer
path Parameters
storeId
required
string <uuid>
contractId
required
string <uuid>
Request Body schema: application/json
required
skipCycles
number
Default: 1

Number of billing cycles to skip

Responses

Request samples

Content type
application/json
{
  • "skipCycles": 1
}

Resume a paused subscription

Authorizations:
bearer
path Parameters
storeId
required
string <uuid>
contractId
required
string <uuid>

Responses

Get billing attempts for a subscription

Authorizations:
bearer
path Parameters
storeId
required
string <uuid>
contractId
required
string <uuid>
query Parameters
page
number
limit
number
status
string
Enum: "PENDING" "PROCESSING" "SUCCESS" "FAILED" "SKIPPED"

Responses

Retry a failed billing attempt

Authorizations:
bearer
path Parameters
storeId
required
string <uuid>
attemptId
required
string <uuid>

Responses

Get payment methods for a customer

Authorizations:
bearer
path Parameters
storeId
required
string <uuid>
customerId
required
string <uuid>

Responses

Add a payment method for a customer

Authorizations:
bearer
path Parameters
storeId
required
string <uuid>
customerId
required
string <uuid>
Request Body schema: application/json
required
object (CreateCustomerPaymentMethodDto)

Responses

Request samples

Content type
application/json
{ }

Set a payment method as default

Authorizations:
bearer
path Parameters
storeId
required
string <uuid>
customerId
required
string <uuid>
paymentMethodId
required
string <uuid>

Responses

Remove a payment method

Authorizations:
bearer
path Parameters
storeId
required
string <uuid>
customerId
required
string <uuid>
paymentMethodId
required
string <uuid>

Responses

Manually trigger billing for a subscription (Admin only)

Authorizations:
bearer
path Parameters
storeId
required
string <uuid>
contractId
required
string <uuid>

Responses

StorefrontAddressValidation

StorefrontAddressValidationController_validate_v1

path Parameters
storeId
required
string
Request Body schema: application/json
required
object (ValidateAddressDto)

Responses

Request samples

Content type
application/json
{ }

Payouts

Get payout schedule

Retrieve the payout schedule configuration.

Authorizations:
bearer
path Parameters
storeId
required
string

Responses

Response samples

Content type
application/json
{ }

Update payout schedule

Update the payout schedule configuration.

Authorizations:
bearer
path Parameters
storeId
required
string
Request Body schema: application/json
required
object (UpdatePayoutScheduleDto)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

List payouts

Retrieve payout history with optional filters.

Authorizations:
bearer
path Parameters
storeId
required
string

Responses

Get payout

Retrieve a specific payout by ID.

Authorizations:
bearer
path Parameters
storeId
required
string
payoutId
required
string

Responses

Response samples

Content type
application/json
{ }

Request manual payout

Request an immediate payout to a bank account.

Authorizations:
bearer
path Parameters
storeId
required
string
Request Body schema: application/json
required
object (RequestManualPayoutDto)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

Disputes

List disputes

Retrieve dispute/chargeback history with optional filters.

Authorizations:
bearer
path Parameters
storeId
required
string

Responses

Get dispute with evidence

Retrieve a specific dispute with all submitted evidence.

Authorizations:
bearer
path Parameters
storeId
required
string
disputeId
required
string

Responses

Response samples

Content type
application/json
{ }

Submit dispute evidence

Submit evidence to contest a dispute/chargeback.

Authorizations:
bearer
path Parameters
storeId
required
string
disputeId
required
string
Request Body schema: application/json
required
object (CreateDisputeEvidenceDto)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

Accept dispute

Accept/concede the dispute to the customer.

Authorizations:
bearer
path Parameters
storeId
required
string
disputeId
required
string

Responses

Response samples

Content type
application/json
{ }

Canva Integration (store)

Open a Canva editor seeded with the given media item

Authorizations:
bearer
path Parameters
storeId
required
string
mediaId
required
string

Responses

Search

Global search

Search across products, orders, customers, collections, pages, navigation, and settings

Authorizations:
bearerbearer
path Parameters
storeId
required
string
query Parameters
q
required
string
Example: q=coconut

Search query string

types
Array of strings
Items Enum: "products" "orders" "customers" "collections" "pages"
Example: types=products&types=customers

Resource types to search

limit
number [ 1 .. 20 ]
Default: 5

Results limit per type

Responses

Response samples

Content type
application/json
{
  • "results": { },
  • "navigation": [
    ],
  • "settings": [
    ],
  • "total": 0,
  • "query": "string",
  • "executedIn": 0
}

StorefrontEvents

StorefrontEventsController_ingestEvent_v1

path Parameters
storeId
required
string
header Parameters
user-agent
required
string
referer
required
string
x-forwarded-for
required
string
Request Body schema: application/json
required
object (IngestEventDto)

Responses

Request samples

Content type
application/json
{ }

StorefrontEventsController_ingestEventsBatch_v1

path Parameters
storeId
required
string
header Parameters
user-agent
required
string
referer
required
string
x-forwarded-for
required
string
Request Body schema: application/json
required
object (BatchIngestDto)

Responses

Request samples

Content type
application/json
{ }

StorefrontEventsController_getSession_v1

path Parameters
storeId
required
string
header Parameters
user-agent
required
string
referer
required
string
x-forwarded-for
required
string
Request Body schema: application/json
required
object (GetSessionDto)

Responses

Request samples

Content type
application/json
{ }

StorefrontEventsController_getActiveVisitors_v1

path Parameters
storeId
required
string

Responses

Storefront - API Key Validation

Validate a publishable API key

Validates a publishable key (pk_live_* or pk_test_*) and returns the associated storeId

Request Body schema: application/json
required
key
required
string

The publishable API key to validate

Responses

Request samples

Content type
application/json
{
  • "key": "pk_live_abc123..."
}

Response samples

Content type
application/json
{
  • "valid": true,
  • "storeId": "b8adcdc8-9238-4168-90f8-77b2d14c211c",
  • "type": "PUBLISHABLE",
  • "environment": "LIVE"
}

Storefront - Cart & Checkout

Get or create cart

path Parameters
storeId
required
string
query Parameters
cartId
string

Responses

Get specific cart by ID

Authorizations:
None
path Parameters
storeId
required
string
cartId
required
string

Responses

Add item to cart (guest)

path Parameters
storeId
required
string
query Parameters
cartId
string
Request Body schema: application/json
required
variantId
required
string
quantity
required
number [ 1 .. 100 ]
customAttributes
object

Custom attributes for the cart item

Responses

Request samples

Content type
application/json
{
  • "variantId": "variant_uuid_here",
  • "quantity": 2,
  • "customAttributes": {
    }
}

Add item to cart (authenticated)

Authorizations:
None
path Parameters
storeId
required
string
cartId
required
string
Request Body schema: application/json
required
variantId
required
string
quantity
required
number [ 1 .. 100 ]
customAttributes
object

Custom attributes for the cart item

Responses

Request samples

Content type
application/json
{
  • "variantId": "variant_uuid_here",
  • "quantity": 2,
  • "customAttributes": {
    }
}

Update cart item quantity

path Parameters
storeId
required
string
itemId
required
string
query Parameters
cartId
required
string
Request Body schema: application/json
required
quantity
required
number [ 0 .. 100 ]

Responses

Request samples

Content type
application/json
{
  • "quantity": 5
}

Remove item from cart

path Parameters
storeId
required
string
itemId
required
string
query Parameters
cartId
required
string

Responses

Clear cart

path Parameters
storeId
required
string
query Parameters
cartId
required
string

Responses

Link checkout to logged-in customer

Associates a guest checkout with the current customer account and syncs email/phone

Authorizations:
None
path Parameters
storeId
required
string
checkoutId
required
string

Responses

Complete checkout (authenticated customer)

Authorizations:
None
path Parameters
storeId
required
string
checkoutId
required
string
Request Body schema: application/json
required
paymentMethodId
required
string
paymentIntentId
string

Responses

Request samples

Content type
application/json
{
  • "paymentMethodId": "stripe",
  • "paymentIntentId": "pi_1234567890"
}

Create payment session for checkout (public)

Initialize a new payment session for guest or logged-in checkout. Returns clientSecret for Stripe.

path Parameters
storeId
required
string
Request Body schema: application/json
required
checkoutId
required
string

Checkout ID

amount
required
number

Payment amount

currency
required
string

Currency code (ISO 4217)

paymentMethod
string
Enum: "credit_card" "promptpay" "bank_transfer"

Payment method (defaults to credit_card)

customerEmail
string

Customer email

metadata
object

Additional metadata

Responses

Request samples

Content type
application/json
{
  • "checkoutId": "550e8400-e29b-41d4-a716-446655440000",
  • "amount": 1500,
  • "currency": "THB",
  • "paymentMethod": "credit_card",
  • "customerEmail": "[email protected]",
  • "metadata": { }
}

Get payment session status (public)

path Parameters
storeId
required
string
sessionId
required
string

Responses

Create PayPal order for checkout

Creates a PayPal order that can be approved by the buyer

path Parameters
storeId
required
string
checkoutId
required
string

Responses

Capture PayPal order after buyer approval

Captures the payment and completes the checkout

path Parameters
storeId
required
string
checkoutId
required
string

Responses

Metaobjects

List taxonomy attribute definitions used by category-assigned products

Authorizations:
bearerNone
path Parameters
storeId
required
string

Responses

List products that use this taxonomy attribute

Authorizations:
bearerNone
path Parameters
storeId
required
string
handle
required
string

Responses

Get taxonomy attribute detail with category assignments

Authorizations:
bearerNone
path Parameters
storeId
required
string
handle
required
string

Responses

Get metaobject definition by type

Authorizations:
bearerNone
path Parameters
storeId
required
string
type
required
string

Responses

List all metaobject definitions

Authorizations:
bearerNone
path Parameters
storeId
required
string

Responses

Create new metaobject definition

Authorizations:
bearerbearer
path Parameters
storeId
required
string
Request Body schema: application/json
required
object (CreateMetaobjectDefinitionDto)

Responses

Request samples

Content type
application/json
{ }

Get metaobject definition by ID

Authorizations:
bearerNone
path Parameters
storeId
required
string
id
required
string

Responses

Update metaobject definition (partial)

Authorizations:
bearerbearer
path Parameters
storeId
required
string
id
required
string
Request Body schema: application/json
required
object (UpdateMetaobjectDefinitionDto)

Responses

Request samples

Content type
application/json
{ }

Update metaobject definition (full)

Authorizations:
bearerbearer
path Parameters
storeId
required
string
id
required
string
Request Body schema: application/json
required
object (UpdateMetaobjectDefinitionDto)

Responses

Request samples

Content type
application/json
{ }

Delete metaobject definition

Authorizations:
bearerbearer
path Parameters
storeId
required
string
id
required
string

Responses

Add field to metaobject definition

Authorizations:
bearerbearer
path Parameters
storeId
required
string
id
required
string
Request Body schema: application/json
required
object (CreateMetaobjectFieldDto)

Responses

Request samples

Content type
application/json
{ }

Update field in metaobject definition

Authorizations:
bearerbearer
path Parameters
storeId
required
string
id
required
string
fieldId
required
string
Request Body schema: application/json
required
object (UpdateMetaobjectFieldDto)

Responses

Request samples

Content type
application/json
{ }

Delete field from metaobject definition

Authorizations:
bearerbearer
path Parameters
storeId
required
string
id
required
string
fieldId
required
string

Responses

Reorder fields in metaobject definition

Authorizations:
bearerbearer
path Parameters
storeId
required
string
id
required
string
Request Body schema: application/json
required
object (ReorderFieldsDto)

Responses

Request samples

Content type
application/json
{ }

List all entries across all definitions

Authorizations:
bearerNone
path Parameters
storeId
required
string

Responses

List entries for a metaobject by type

Authorizations:
bearerNone
path Parameters
storeId
required
string
type
required
string

Responses

Create entry for a metaobject by type

Authorizations:
bearerbearer
path Parameters
storeId
required
string
type
required
string
Request Body schema: application/json
required
object (CreateMetaobjectEntryDto)

Responses

Request samples

Content type
application/json
{ }

Get entry by type and entry ID

Authorizations:
bearerNone
path Parameters
storeId
required
string
type
required
string
entryId
required
string

Responses

Update entry by type

Authorizations:
bearerbearer
path Parameters
storeId
required
string
type
required
string
entryId
required
string
Request Body schema: application/json
required
object (UpdateMetaobjectEntryDto)

Responses

Request samples

Content type
application/json
{ }

Delete entry by type

Authorizations:
bearerbearer
path Parameters
storeId
required
string
type
required
string
entryId
required
string

Responses

Get resources that reference this entry (by type)

Authorizations:
bearerNone
path Parameters
storeId
required
string
type
required
string
entryId
required
string

Responses

List all entries for a metaobject definition

Authorizations:
bearerNone
path Parameters
storeId
required
string
id
required
string

Responses

Create new entry for a metaobject definition

Authorizations:
bearerbearer
path Parameters
storeId
required
string
id
required
string
Request Body schema: application/json
required
object (CreateMetaobjectEntryDto)

Responses

Request samples

Content type
application/json
{ }

Get entry by ID

Authorizations:
bearerNone
path Parameters
storeId
required
string
id
required
string
entryId
required
string

Responses

Update entry

Authorizations:
bearerbearer
path Parameters
storeId
required
string
id
required
string
entryId
required
string
Request Body schema: application/json
required
object (UpdateMetaobjectEntryDto)

Responses

Request samples

Content type
application/json
{ }

Delete entry

Authorizations:
bearerbearer
path Parameters
storeId
required
string
id
required
string
entryId
required
string

Responses

Get resources that reference this entry

Authorizations:
bearerNone
path Parameters
storeId
required
string
id
required
string
entryId
required
string

Responses

StorefrontGraphql

StorefrontGraphqlController_graphql_v1

Responses

CustomerSegmentsOperations

CustomerSegmentsOperationsController_recalculateRfm_v1

Authorizations:
bearer
path Parameters
storeId
required
string

Responses

CustomerSegmentsOperationsController_refreshSegment_v1

Authorizations:
bearer
path Parameters
storeId
required
string
id
required
string

Responses

CustomerSegmentsOperationsController_archiveSegment_v1

Authorizations:
bearer
path Parameters
storeId
required
string
id
required
string

Responses

CustomerSegmentsOperationsController_restoreSegment_v1

Authorizations:
bearer
path Parameters
storeId
required
string
id
required
string

Responses

CustomerSegmentsOperationsController_duplicateSegment_v1

Authorizations:
bearer
path Parameters
storeId
required
string
id
required
string
Request Body schema: application/json
required
object (SegmentDuplicateDto)

Responses

Request samples

Content type
application/json
{ }

CustomerSegmentsOperationsController_exportCustomers_v1

Authorizations:
bearer
path Parameters
storeId
required
string
Request Body schema: application/json
required
object (SegmentExportDto)

Responses

Request samples

Content type
application/json
{ }

CustomerSegmentsOperationsController_exportSegment_v1

Authorizations:
bearer
path Parameters
storeId
required
string
id
required
string
Request Body schema: application/json
required
object (SegmentExportDto)

Responses

Request samples

Content type
application/json
{ }

CustomerSegmentsOperationsController_bulkEmailSegment_v1

Authorizations:
bearer
path Parameters
storeId
required
string
id
required
string
Request Body schema: application/json
required
object (BulkSegmentActionDto)

Responses

Request samples

Content type
application/json
{ }

CustomerSegmentsOperationsController_bulkSmsSegment_v1

Authorizations:
bearer
path Parameters
storeId
required
string
id
required
string
Request Body schema: application/json
required
object (BulkSegmentActionDto)

Responses

Request samples

Content type
application/json
{ }

CustomerSegmentsOperationsController_bulkAddTags_v1

Authorizations:
bearer
path Parameters
storeId
required
string
id
required
string
Request Body schema: application/json
required
object (SegmentTagsDto)

Responses

Request samples

Content type
application/json
{ }

CustomerSegmentsOperationsController_bulkRemoveTags_v1

Authorizations:
bearer
path Parameters
storeId
required
string
id
required
string
Request Body schema: application/json
required
object (SegmentTagsDto)

Responses

Request samples

Content type
application/json
{ }

CustomerSegmentsOperationsController_bulkApplyDiscount_v1

Authorizations:
bearer
path Parameters
storeId
required
string
id
required
string
Request Body schema: application/json
required
object (SegmentDiscountDto)

Responses

Request samples

Content type
application/json
{ }

CustomerSegmentsOperationsController_getAISuggestions_v1

Authorizations:
None
path Parameters
storeId
required
string
id
required
string

Responses