Other

Category: Admin Base URL: /admin/algolia Authentication: Required Routes: 153 routes documented

Overview#

This section documents 153 API routes for other.

⚠️ These endpoints operate on your live store. POST/PUT/DELETE operations here — including sync, push, resync, and cache operations — modify or delete production data, and some trigger downstream effects such as warehouse orders or customer emails. DELETE operations are generally irreversible. Verify IDs and parameters carefully before calling them from scripts.

Quick Reference#

POST Admin Algolia#

Endpoint: POST /admin/algolia Authentication: Admin (Required)

Description#

POST /admin/algolia/index Index data to Algolia (admin only)

Request Body#

This route does not declare a validation schema, so the accepted fields are not derivable from the source. Check the handler before relying on a particular body.

Response#

Success:

{
  success,
  indexed,
  type,
}

Error (503):

{
  error,
}

Error (503):

{
  error,
}

Error (400):

{
  error,
}

Error (400):

{
  error,
}

Example Request#

curl -X POST 'https://your-store.omnicart.cc/admin/algolia' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

DELETE Admin Algolia#

Endpoint: DELETE /admin/algolia Authentication: Admin (Required)

Description#

DELETE /admin/algolia Delete items from Algolia index

Response#

Success:

{
  success,
  deleted,
  type,
}

Error (503):

{
  error,
}

Error (503):

{
  error,
}

Error (400):

{
  error,
}

Error (400):

{
  error,
}

Example Request#

curl -X DELETE 'https://your-store.omnicart.cc/admin/algolia' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

GET Admin Algolia Search#

Endpoint: GET /admin/algolia/search Authentication: Admin (Required)

Description#

GET /admin/algolia/search Search across Algolia indexes for orders, customers, or products

Response#

Success:

{
  results,
  query,
  type,
}

Error (503):

{
  error,
}

Error (503):

{
  error,
}

Error (400):

{
  error,
}

Error (400):

{
  error,
}

Error (500):

{
  error,
}

Example Request#

curl -X GET 'https://your-store.omnicart.cc/admin/algolia/search' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

GET Admin Announcements#

Endpoint: GET /admin/announcements Authentication: Admin (Required)

Description#

Announcements published so far, newest first, plus the types an operator may publish. The type list ships in the same response so the compose form never hard-codes the registry — adding a kind in src/lib/notification-types.ts makes it selectable with no admin rebuild.

Response#

Success:

{
  announcements,
  types,
}

Also returns:

{
  announcements,
  types,
  degraded,
}

Example Request#

curl -X GET 'https://your-store.omnicart.cc/admin/announcements' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

POST Admin Announcements#

Endpoint: POST /admin/announcements Authentication: Admin (Required)

Description#

Publish an announcement: POST /admin/announcements. Body: { type, title, body, external_ref?, source? }. type must be a publishable id from the notification-type registry — the event types are emitted by jobs and are not forgeable here. Delivers one notification per admin, each addressed to that person, so recipients dismiss their own copy without clearing it for anyone else. Repeating a publish with the same external_ref is a 409, which is what makes a retried deploy safe. Returns the announcement as it will read back, plus a delivery block, so a publish that reached nobody is visible instead of silently looking like a success.

Request Body#

This route does not declare a validation schema, so the accepted fields are not derivable from the source. Check the handler before relying on a particular body.

Response#

Success (201):

{
  announcement,
  delivery,
}

Error (409):

{
  message,
}

Error (400):

{
  message,
}

Error (500):

{
  message,
}

Example Request#

curl -X POST 'https://your-store.omnicart.cc/admin/announcements' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

GET Admin Audiences#

Endpoint: GET /admin/audiences Authentication: Admin (Required)

Description#

GET /admin/audiences — list audience definitions across every version. POST /admin/audiences — create a draft definition; pass publish: true to publish it in the same call. Auth follows the existing admin route pattern (src/api/admin/dunning, src/api/admin/renewals): OmniCart's built-in admin authentication guards every /admin/* route — no route-specific auth middleware here.

Response#

Success:

{
  type,
  message,
}

Example Request#

curl -X GET 'https://your-store.omnicart.cc/admin/audiences' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

POST Admin Audiences#

Endpoint: POST /admin/audiences Authentication: Admin (Required)

Request Body#

This route does not declare a validation schema, so the accepted fields are not derivable from the source. Check the handler before relying on a particular body.

Response#

Success:

{
  type,
  message,
}

Also returns (201):

{
  audience_definition,
}

Example Request#

curl -X POST 'https://your-store.omnicart.cc/admin/audiences' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

GET Admin Banner-options#

Endpoint: GET /admin/banner-options Authentication: Admin (Required)

Description#

Choices for the banner editor's two targeting fields. WHY THIS EXISTS --------------- store_handle used to be a free-text box. It is compared literally by the store endpoint, so a typo produced a banner that saved cleanly and then never appeared anywhere, with nothing on screen explaining why — and because the handle is immutable after creation, the fix was delete-and-recreate. Handles come from two places, unioned: 1. BANNER_STORE_HANDLES env — the handles this deployment serves. Set this; it is the only source that works on a tenant with no banners yet. 2. handles already present on banner rows — so an existing deployment is never locked out of its own handle by a missing env var. Sales channels come from the sales-channel module and are the FINE key: a banner with one set shows only on the surface whose publishable key maps to that channel (VNSH's LSS funnel vs its main storefront). Null = all surfaces.

Response#

Success:

{
  preview_base_url,
  store_handles,
  sales_channels,
  handles_unconfigured,
}

Example Request#

curl -X GET 'https://your-store.omnicart.cc/admin/banner-options' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

GET Admin Banners#

Endpoint: GET /admin/banners Authentication: Admin (Required)

Description#

GET /admin/banners?promotion_id=...

Response#

Success:

{
  banners,
}

Example Request#

curl -X GET 'https://your-store.omnicart.cc/admin/banners' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

POST Admin Banners#

Endpoint: POST /admin/banners Authentication: Admin (Required)

Description#

POST /admin/banners

Request Body#

This route does not declare a validation schema, so the accepted fields are not derivable from the source. Check the handler before relying on a particular body.

Response#

Success (201):

{
  banner,
}

Error (400):

{
  message,
}

Error (400):

{
  message,
}

Error (400):

{
  message,
}

Error (400):

{
  message,
}

Error (400):

{
  message,
}

Error (400):

{
  message,
}

Error (500):

{
  message,
}

Example Request#

curl -X POST 'https://your-store.omnicart.cc/admin/banners' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

POST Admin Banners :id#

Endpoint: POST /admin/banners/:id Authentication: Admin (Required)

Description#

POST /admin/banners/:id — partial update.

URL Parameters#

Request Body#

This route does not declare a validation schema, so the accepted fields are not derivable from the source. Check the handler before relying on a particular body.

Response#

Success:

{
  banner,
}

Error (400):

{
  message,
}

Error (404):

{
  message,
}

Error (400):

{
  message,
}

Error (400):

{
  message,
}

Error (400):

{
  message,
}

Error (500):

{
  message,
}

Example Request#

curl -X POST 'https://your-store.omnicart.cc/admin/banners/:id' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

DELETE Admin Banners :id#

Endpoint: DELETE /admin/banners/:id Authentication: Admin (Required)

Description#

DELETE /admin/banners/:id — soft delete.

URL Parameters#

Response#

Success:

{
  id,
  object,
  deleted,
}

Error (500):

{
  message,
}

Example Request#

curl -X DELETE 'https://your-store.omnicart.cc/admin/banners/:id' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

POST Admin Bundled-products#

Endpoint: POST /admin/bundled-products Authentication: Admin (Required)

Request Body#

Response#

Success:

{
  bundled_product,
}

Error (500):

{
  message,
}

Example Request#

curl -X POST 'https://your-store.omnicart.cc/admin/bundled-products' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

GET Admin Bundled-products#

Endpoint: GET /admin/bundled-products Authentication: Admin (Required)

Response#

Success:

{
  bundled_products,
  count,
  limit,
  offset,
}

Example Request#

curl -X GET 'https://your-store.omnicart.cc/admin/bundled-products' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

GET Admin Bundled-products :id#

Endpoint: GET /admin/bundled-products/:id Authentication: Admin (Required)

URL Parameters#

Response#

Error (404):

{
  message,
}

Error (500):

{
  message,
}

Example Request#

curl -X GET 'https://your-store.omnicart.cc/admin/bundled-products/:id' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

PATCH Admin Bundled-products :id#

Endpoint: PATCH /admin/bundled-products/:id Authentication: Admin (Required)

URL Parameters#

Request Body#

Response#

Success:

{
  bundled_product,
}

Error (500):

{
  message,
}

Example Request#

curl -X PATCH 'https://your-store.omnicart.cc/admin/bundled-products/:id' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

DELETE Admin Bundled-products :id#

Endpoint: DELETE /admin/bundled-products/:id Authentication: Admin (Required)

URL Parameters#

Response#

Success:

{
  id,
  deleted,
}

Error (500):

{
  message,
}

Example Request#

curl -X DELETE 'https://your-store.omnicart.cc/admin/bundled-products/:id' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

GET Admin Cancellations#

Endpoint: GET /admin/cancellations Authentication: Admin (Required)

Response#

Success:

{
  type,
  message,
}

Example Request#

curl -X GET 'https://your-store.omnicart.cc/admin/cancellations' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

GET Admin Cancellations :id#

Endpoint: GET /admin/cancellations/:id Authentication: Admin (Required)

URL Parameters#

Response#

Success:

{
  type,
  message,
}

Example Request#

curl -X GET 'https://your-store.omnicart.cc/admin/cancellations/:id' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

POST Admin Cancellations :id Apply-offer#

Endpoint: POST /admin/cancellations/:id/apply-offer Authentication: Admin (Required)

URL Parameters#

Request Body#

This route does not declare a validation schema, so the accepted fields are not derivable from the source. Check the handler before relying on a particular body.

Response#

Success:

{
  type,
  message,
}

Example Request#

curl -X POST 'https://your-store.omnicart.cc/admin/cancellations/:id/apply-offer' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

POST Admin Cancellations :id Finalize#

Endpoint: POST /admin/cancellations/:id/finalize Authentication: Admin (Required)

URL Parameters#

Request Body#

This route does not declare a validation schema, so the accepted fields are not derivable from the source. Check the handler before relying on a particular body.

Response#

Success:

{
  type,
  message,
}

Example Request#

curl -X POST 'https://your-store.omnicart.cc/admin/cancellations/:id/finalize' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

POST Admin Cancellations :id Reason#

Endpoint: POST /admin/cancellations/:id/reason Authentication: Admin (Required)

URL Parameters#

Request Body#

This route does not declare a validation schema, so the accepted fields are not derivable from the source. Check the handler before relying on a particular body.

Response#

Success:

{
  type,
  message,
}

Example Request#

curl -X POST 'https://your-store.omnicart.cc/admin/cancellations/:id/reason' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

GET Admin Carts#

Endpoint: GET /admin/carts Authentication: Admin (Required)

Description#

GET /admin/carts?customer_id={id} Returns carts for a given customer for use in Admin UI widgets

Response#

Success:

{
  carts,
}

Error (400):

{
  message,
}

Error (500):

{
  message,
  error,
}

Example Request#

curl -X GET 'https://your-store.omnicart.cc/admin/carts' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

GET Admin Cogs Settings#

Endpoint: GET /admin/cogs/settings Authentication: Admin (Required)

Response#

Success:

{
  module_enabled,
  settings,
}

Error (400):

{
  message,
}

Example Request#

curl -X GET 'https://your-store.omnicart.cc/admin/cogs/settings' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

POST Admin Cogs Settings#

Endpoint: POST /admin/cogs/settings Authentication: Admin (Required)

Request Body#

Response#

Success:

{
  module_enabled,
  settings,
}

Error (400):

{
  message,
}

Error (400):

{
  message,
  issues,
}

Example Request#

curl -X POST 'https://your-store.omnicart.cc/admin/cogs/settings' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

GET Admin Content-page-options#

Endpoint: GET /admin/content-page-options Authentication: Admin (Required)

Description#

Choices for the content-page editor. WHY THIS EXISTS --------------- Same reason as /admin/banner-options: store_handle is compared literally by the store endpoint, so a free-text typo produces a page that saves cleanly and then never appears, with nothing on screen explaining why. Handles come from three places, unioned: 1. CONTENT_PAGE_STORE_HANDLES env, when set. 2. BANNER_STORE_HANDLES env — the same list of storefronts this deployment serves. Reused rather than duplicated so a tenant that has already configured banners does not have to configure this too. 3. handles already present on content_page rows — so an existing deployment is never locked out of its own handle by a missing env var.

Response#

Success:

{
  preview_base_url,
  store_handles,
  handles_unconfigured,
}

Example Request#

curl -X GET 'https://your-store.omnicart.cc/admin/content-page-options' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

GET Admin Content-page-settings#

Endpoint: GET /admin/content-page-settings Authentication: Admin (Required)

Description#

GET /admin/content-page-settings?store_handle=vnsh

Response#

Success:

{
  content_page_settings,
}

Error (400):

{
  message,
}

Example Request#

curl -X GET 'https://your-store.omnicart.cc/admin/content-page-settings' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

POST Admin Content-page-settings#

Endpoint: POST /admin/content-page-settings Authentication: Admin (Required)

Description#

POST /admin/content-page-settings

Request Body#

This route does not declare a validation schema, so the accepted fields are not derivable from the source. Check the handler before relying on a particular body.

Response#

Success:

{
  content_page_settings,
}

Error (400):

{
  message,
}

Error (500):

{
  message,
}

Example Request#

curl -X POST 'https://your-store.omnicart.cc/admin/content-page-settings' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

GET Admin Content-pages#

Endpoint: GET /admin/content-pages Authentication: Admin (Required)

Description#

GET /admin/content-pages?store_handle=vnsh

Response#

Success:

{
  content_pages,
}

Example Request#

curl -X GET 'https://your-store.omnicart.cc/admin/content-pages' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

POST Admin Content-pages#

Endpoint: POST /admin/content-pages Authentication: Admin (Required)

Description#

POST /admin/content-pages

Request Body#

This route does not declare a validation schema, so the accepted fields are not derivable from the source. Check the handler before relying on a particular body.

Response#

Success (201):

{
  content_page,
}

Error (400):

{
  message,
}

Error (400):

{
  message,
}

Error (409):

{
  message,
}

Error (500):

{
  message,
}

Example Request#

curl -X POST 'https://your-store.omnicart.cc/admin/content-pages' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

PATCH Admin Content-pages :id#

Endpoint: PATCH /admin/content-pages/:id Authentication: Admin (Required)

Description#

PATCH /admin/content-pages/:id — partial update. store_handle is deliberately absent: moving a page between storefronts would move its URL out from under whatever links to it, and the slug is unique per handle so the move can also collide. Delete and recreate instead.

URL Parameters#

Request Body#

This route does not declare a validation schema, so the accepted fields are not derivable from the source. Check the handler before relying on a particular body.

Response#

Success:

{
  content_page,
}

Error (404):

{
  message,
}

Error (400):

{
  message,
}

Error (400):

{
  message,
}

Error (409):

{
  message,
}

Error (500):

{
  message,
}

Example Request#

curl -X PATCH 'https://your-store.omnicart.cc/admin/content-pages/:id' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

DELETE Admin Content-pages :id#

Endpoint: DELETE /admin/content-pages/:id Authentication: Admin (Required)

Description#

DELETE /admin/content-pages/:id — soft delete.

URL Parameters#

Response#

Success:

{
  id,
  object,
  deleted,
}

Error (500):

{
  message,
}

Example Request#

curl -X DELETE 'https://your-store.omnicart.cc/admin/content-pages/:id' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

GET Admin Custom#

Endpoint: GET /admin/custom Authentication: Admin (Required)

Response#

The handler does not return an object literal, so the response shape is not derivable from the source.

Example Request#

curl -X GET 'https://your-store.omnicart.cc/admin/custom' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

GET Admin Customers :id Notes#

Endpoint: GET /admin/customers/:id/notes Authentication: Admin (Required)

Description#

GET /admin/customers/:id/notes Returns all notes for a customer

URL Parameters#

Response#

Success:

{
  notes,
}

Error (500):

{
  error,
  message,
}

Example Request#

curl -X GET 'https://your-store.omnicart.cc/admin/customers/:id/notes' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

POST Admin Customers :id Notes#

Endpoint: POST /admin/customers/:id/notes Authentication: Admin (Required)

Description#

POST /admin/customers/:id/notes Add a new note to a customer Body: { content: string, tag?: "Called" | "Email" | "Issue" | "Shipping" | "Refund" | null }

URL Parameters#

Request Body#

This route does not declare a validation schema, so the accepted fields are not derivable from the source. Check the handler before relying on a particular body.

Response#

Success:

{
  note,
  notes,
}

Error (500):

{
  error,
  message,
}

Example Request#

curl -X POST 'https://your-store.omnicart.cc/admin/customers/:id/notes' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

DELETE Admin Customers :id Notes :noteId#

Endpoint: DELETE /admin/customers/:id/notes/:noteId Authentication: Admin (Required)

Description#

DELETE /admin/customers/:id/notes/:noteId Delete a specific note from a customer

URL Parameters#

Response#

Success:

{
  success,
  notes,
}

Error (404):

{
  error,
  message,
}

Error (500):

{
  error,
  message,
}

Example Request#

curl -X DELETE 'https://your-store.omnicart.cc/admin/customers/:id/notes/:noteId' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

PUT Admin Customers :id Notes :noteId#

Endpoint: PUT /admin/customers/:id/notes/:noteId Authentication: Admin (Required)

Description#

PUT /admin/customers/:id/notes/:noteId Update a specific note (content and tag; author and created_at are preserved) Body: { content: string, tag?: "Called" | "Email" | "Issue" | "Shipping" | "Refund" | null }

URL Parameters#

Request Body#

This route does not declare a validation schema, so the accepted fields are not derivable from the source. Check the handler before relying on a particular body.

Response#

Success:

{
  note,
  notes,
}

Error (404):

{
  error,
  message,
}

Error (500):

{
  error,
  message,
}

Example Request#

curl -X PUT 'https://your-store.omnicart.cc/admin/customers/:id/notes/:noteId' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

POST Admin Demo-magic-link#

Endpoint: POST /admin/demo-magic-link Authentication: Admin (Required)

Request Body#

This route does not declare a validation schema, so the accepted fields are not derivable from the source. Check the handler before relying on a particular body.

Response#

Success:

{
  url,
  token,
  landingPath,
  expiresInSeconds,
}

Error (503):

{
  error,
}

Example Request#

curl -X POST 'https://your-store.omnicart.cc/admin/demo-magic-link' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

GET Admin Disputes#

Endpoint: GET /admin/disputes Authentication: Admin (Required)

Description#

GET /admin/disputes List locally-mirrored Stripe disputes. Backs the order-page dispute banner (?order_id=...) and gives ops a queryable view of open chargebacks and their evidence deadlines (?open=true). Query params: - order_id / payment_id — scope to one order or payment - open=true — only disputes that currently block refunds - limit / offset — pagination (default 50)

Response#

Success:

{
  disputes,
  count,
  limit,
  offset,
}

Example Request#

curl -X GET 'https://your-store.omnicart.cc/admin/disputes' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

POST Admin Disputes :id Accept#

Endpoint: POST /admin/disputes/:id/accept Authentication: Admin (Required)

Description#

POST /admin/disputes/:id/accept Concede the dispute: the customer keeps the funds via the chargeback. This is FINAL — Stripe closes the dispute as lost and the money is gone, so the UI confirms before calling this. :id is the LOCAL payment_dispute record id (pdis_...). Actions are routed by the record's provider — only Stripe is implemented; other providers get a clean 400 instead of a silent no-op.

URL Parameters#

Request Body#

This route does not declare a validation schema, so the accepted fields are not derivable from the source. Check the handler before relying on a particular body.

Response#

Success:

{
  type,
  message,
}

Also returns:

{
  dispute,
}

Error (404):

{
  type,
  message,
}

Error (400):

{
  type,
  message,
}

Error (400):

{
  type,
  message,
}

Example Request#

curl -X POST 'https://your-store.omnicart.cc/admin/disputes/:id/accept' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

POST Admin Disputes :id Evidence#

Endpoint: POST /admin/disputes/:id/evidence Authentication: Admin (Required)

URL Parameters#

Request Body#

This route does not declare a validation schema, so the accepted fields are not derivable from the source. Check the handler before relying on a particular body.

Response#

Success:

{
  submitted,
  evidence_field_count,
  dispute,
}

Also returns:

{
  type,
  message,
}

Error (404):

{
  type,
  message,
}

Error (400):

{
  type,
  message,
}

Error (400):

{
  type,
  message,
}

Error (400):

{
  type,
  message,
}

Error (400):

{
  type,
  message,
}

Error (400):

{
  type,
  message,
}

Error (400):

{
  type,
  message,
}

Error (400):

{
  type,
  message,
}

Error (400):

{
  type,
  message,
}

Error (400):

{
  type,
  message,
}

Error (400):

{
  type,
  message,
}

Example Request#

curl -X POST 'https://your-store.omnicart.cc/admin/disputes/:id/evidence' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

POST Admin Draft-orders :id Payment-link#

Endpoint: POST /admin/draft-orders/:id/payment-link Authentication: Admin (Required)

Description#

Create (or reuse) the payment link for a draft order and optionally send it. Body: - channel — "none" (create only), "sms", or "email". Default "none". - to — override recipient. Defaults to the draft's phone (sms) or email. - expires_in_hours — link lifetime, 1..720. Default 72. - regenerate — mint a new cart even if the current link is still valid. Responds 200 with { url, cart_id, expires_at, warnings, delivery }. warnings lists non-fatal problems replaying the draft onto the cart — shipping or promotion codes that could not be applied. delivery.status is "sent", "failed", or "skipped" (channel "none"); a failed SEND still returns 200 because the link itself exists and can be copied from the admin. 404 when the order does not exist, 409 when it is not a draft order, 422 when the draft has no line item that can be placed on a cart.

URL Parameters#

Request Body#

Response#

Success (200):

{
  url,
  cart_id,
  expires_at,
  reused,
  skipped_items,
  warnings,
  delivery,
}

Also returns:

{
  type,
  message,
}

Example Request#

curl -X POST 'https://your-store.omnicart.cc/admin/draft-orders/:id/payment-link' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

GET Admin Draft-orders :id Payment-link#

Endpoint: GET /admin/draft-orders/:id/payment-link Authentication: Admin (Required)

Description#

Read the draft order's stored payment link plus the live state of its cart. Responds 200 with { payment_link, cart }. payment_link is null when no link was ever created. cart carries completed_at so the admin can tell a link that is still open from one the customer already paid, and expired reflects the stored expiry against the current time. 404 when the order does not exist, 409 when it is not a draft order.

URL Parameters#

Response#

Success (200):

{
  payment_link,
  cart,
}

Also returns (200):

{
  payment_link,
  cart,
}

Error (404):

{
  type,
  message,
}

Error (409):

{
  type,
  message,
}

Example Request#

curl -X GET 'https://your-store.omnicart.cc/admin/draft-orders/:id/payment-link' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

GET Admin Dunning#

Endpoint: GET /admin/dunning Authentication: Admin (Required)

Response#

Success:

{
  type,
  message,
}

Example Request#

curl -X GET 'https://your-store.omnicart.cc/admin/dunning' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

GET Admin Dunning :id#

Endpoint: GET /admin/dunning/:id Authentication: Admin (Required)

URL Parameters#

Response#

Success:

{
  type,
  message,
}

Example Request#

curl -X GET 'https://your-store.omnicart.cc/admin/dunning/:id' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

POST Admin Dunning :id Mark-recovered#

Endpoint: POST /admin/dunning/:id/mark-recovered Authentication: Admin (Required)

URL Parameters#

Request Body#

This route does not declare a validation schema, so the accepted fields are not derivable from the source. Check the handler before relying on a particular body.

Response#

Success:

{
  type,
  message,
}

Example Request#

curl -X POST 'https://your-store.omnicart.cc/admin/dunning/:id/mark-recovered' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

POST Admin Dunning :id Mark-unrecovered#

Endpoint: POST /admin/dunning/:id/mark-unrecovered Authentication: Admin (Required)

URL Parameters#

Request Body#

This route does not declare a validation schema, so the accepted fields are not derivable from the source. Check the handler before relying on a particular body.

Response#

Success:

{
  type,
  message,
}

Example Request#

curl -X POST 'https://your-store.omnicart.cc/admin/dunning/:id/mark-unrecovered' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

POST Admin Dunning :id Retry-now#

Endpoint: POST /admin/dunning/:id/retry-now Authentication: Admin (Required)

URL Parameters#

Request Body#

This route does not declare a validation schema, so the accepted fields are not derivable from the source. Check the handler before relying on a particular body.

Response#

Success:

{
  type,
  message,
}

Example Request#

curl -X POST 'https://your-store.omnicart.cc/admin/dunning/:id/retry-now' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

POST Admin Dunning :id Retry-schedule#

Endpoint: POST /admin/dunning/:id/retry-schedule Authentication: Admin (Required)

URL Parameters#

Request Body#

This route does not declare a validation schema, so the accepted fields are not derivable from the source. Check the handler before relying on a particular body.

Response#

Success:

{
  type,
  message,
}

Example Request#

curl -X POST 'https://your-store.omnicart.cc/admin/dunning/:id/retry-schedule' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

GET Admin Extensions#

Endpoint: GET /admin/extensions Authentication: Admin (Required)

Response#

Success:

{
  extensions,
  count,
}

Also returns:

{
  message,
  code,
}

Example Request#

curl -X GET 'https://your-store.omnicart.cc/admin/extensions' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

GET Admin Extensions :id#

Endpoint: GET /admin/extensions/:id Authentication: Admin (Required)

URL Parameters#

Response#

Success:

{
  extension,
}

Also returns:

{
  message,
  code,
}

Example Request#

curl -X GET 'https://your-store.omnicart.cc/admin/extensions/:id' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

POST Admin Extensions :id Toggle#

Endpoint: POST /admin/extensions/:id/toggle Authentication: Admin (Required)

URL Parameters#

Request Body#

This route does not declare a validation schema, so the accepted fields are not derivable from the source. Check the handler before relying on a particular body.

Response#

Success:

{
  extension,
}

Also returns:

{
  message,
  code,
}

Example Request#

curl -X POST 'https://your-store.omnicart.cc/admin/extensions/:id/toggle' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

GET Admin Extensions Check-enabled#

Endpoint: GET /admin/extensions/check-enabled Authentication: Admin (Required)

Description#

GET /admin/extensions/check-enabled?module=marketing Check if a specific module is enabled

Response#

Success:

{
  enabled,
  module,
}

Error (400):

{
  enabled,
  message,
}

Error (500):

{
  enabled,
  message,
}

Example Request#

curl -X GET 'https://your-store.omnicart.cc/admin/extensions/check-enabled' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

GET Admin Extensions Check :name#

Endpoint: GET /admin/extensions/check/:name Authentication: Admin (Required)

Description#

Check if an extension is enabled GET /admin/extensions/check/:name

URL Parameters#

Response#

Success:

{
  enabled,
}

Error (400):

{
  message,
  enabled,
}

Error (500):

{
  message,
  enabled,
}

Example Request#

curl -X GET 'https://your-store.omnicart.cc/admin/extensions/check/:name' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

GET Admin Free-shipping-report#

Endpoint: GET /admin/free-shipping-report Authentication: Admin (Required)

Response#

Error (400):

{
  message,
}

Example Request#

curl -X GET 'https://your-store.omnicart.cc/admin/free-shipping-report' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

GET Admin Free-shipping-threshold#

Endpoint: GET /admin/free-shipping-threshold Authentication: Admin (Required)

Response#

Success:

{
  shipping_option_id,
  shipping_option_name,
  threshold,
  operator,
}

Also returns:

{
  shipping_option_id,
  threshold,
}

Example Request#

curl -X GET 'https://your-store.omnicart.cc/admin/free-shipping-threshold' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

POST Admin Free-shipping-threshold#

Endpoint: POST /admin/free-shipping-threshold Authentication: Admin (Required)

Description#

// Update the free-shipping threshold by surgically updating the item_total price rule value(s).

Request Body#

This route does not declare a validation schema, so the accepted fields are not derivable from the source. Check the handler before relying on a particular body.

Response#

Success:

{
  threshold,
  updated_rules,
}

Error (400):

{
  message,
}

Error (404):

{
  message,
}

Example Request#

curl -X POST 'https://your-store.omnicart.cc/admin/free-shipping-threshold' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

POST Admin Funnel-carts :id Line-items#

Endpoint: POST /admin/funnel-carts/:id/line-items Authentication: Admin (Required)

URL Parameters#

Request Body#

This route does not declare a validation schema, so the accepted fields are not derivable from the source. Check the handler before relying on a particular body.

Response#

Success:

{
  cart,
}

Example Request#

curl -X POST 'https://your-store.omnicart.cc/admin/funnel-carts/:id/line-items' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

GET Admin Funnels#

Endpoint: GET /admin/funnels Authentication: Admin (Required)

Response#

Error (500):

{
  message,
  error,
}

Example Request#

curl -X GET 'https://your-store.omnicart.cc/admin/funnels' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

POST Admin Funnels#

Endpoint: POST /admin/funnels Authentication: Admin (Required)

Request Body#

This route does not declare a validation schema, so the accepted fields are not derivable from the source. Check the handler before relying on a particular body.

Response#

Success:

{
  funnel,
}

Error (500):

{
  message,
  error,
}

Example Request#

curl -X POST 'https://your-store.omnicart.cc/admin/funnels' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

GET Admin Funnels :id#

Endpoint: GET /admin/funnels/:id Authentication: Admin (Required)

Description#

@swagger /admin/funnels/{id}: get: tags: [Funnels] description: Retrieves a funnel by ID parameters: - in: path name: id required: true schema: type: string responses: 200: description: OK content: application/json: schema: properties: funnel: $ref: "#/components/schemas/Funnel"

URL Parameters#

Response#

Success:

{
  funnel,
}

Error (500):

{
  message,
  error,
}

Example Request#

curl -X GET 'https://your-store.omnicart.cc/admin/funnels/:id' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

POST Admin Funnels :id#

Endpoint: POST /admin/funnels/:id Authentication: Admin (Required)

Description#

@swagger /admin/funnels/{id}: post: tags: [Funnels] description: Updates a funnel by ID parameters: - in: path name: id required: true schema: type: string requestBody: content: application/json: schema: properties: name: type: string description: type: string conversion_goal: type: string status: type: string enum: [draft, active, archived] responses: 200: description: OK content: application/json: schema: properties: funnel: $ref: "#/components/schemas/Funnel"

URL Parameters#

Request Body#

This route does not declare a validation schema, so the accepted fields are not derivable from the source. Check the handler before relying on a particular body.

Response#

Success:

{
  funnel,
}

Error (500):

{
  message,
  error,
}

Example Request#

curl -X POST 'https://your-store.omnicart.cc/admin/funnels/:id' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

DELETE Admin Funnels :id#

Endpoint: DELETE /admin/funnels/:id Authentication: Admin (Required)

Description#

@swagger /admin/funnels/{id}: delete: tags: [Funnels] description: Deletes a funnel by ID parameters: - in: path name: id required: true schema: type: string responses: 200: description: OK

URL Parameters#

Response#

Success:

{
  id,
  deleted,
}

Error (500):

{
  message,
  error,
}

Example Request#

curl -X DELETE 'https://your-store.omnicart.cc/admin/funnels/:id' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

GET Admin Funnels Analytics#

Endpoint: GET /admin/funnels/analytics Authentication: Admin (Required)

Description#

@swagger /admin/funnels/analytics: get: tags: [Funnels] description: Retrieves funnel analytics parameters: - in: query name: funnel_id schema: type: string required: true responses: 200: description: OK content: application/json: schema: properties: analytics: type: object

Response#

Success:

{
  analytics,
}

Error (400):

{
  message,
}

Error (500):

{
  message,
}

Example Request#

curl -X GET 'https://your-store.omnicart.cc/admin/funnels/analytics' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

GET Admin Funnels Pages#

Endpoint: GET /admin/funnels/pages Authentication: Admin (Required)

Description#

@swagger /admin/funnels/pages: get: tags: [Funnels] description: Retrieves funnel pages responses: 200: description: OK content: application/json: schema: properties: pages: type: array

Response#

Success:

{
  pages,
}

Error (400):

{
  message,
}

Error (500):

{
  message,
}

Example Request#

curl -X GET 'https://your-store.omnicart.cc/admin/funnels/pages' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

POST Admin Funnels Pages#

Endpoint: POST /admin/funnels/pages Authentication: Admin (Required)

Description#

@swagger /admin/funnels/pages: post: tags: [Funnels] description: Creates a new funnel page requestBody: content: application/json: schema: required: - title - slug - funnel_id - stage_id properties: title: type: string slug: type: string funnel_id: type: string stage_id: type: string content_id: type: string template: type: string position: type: number responses: 200: description: OK content: application/json: schema: properties: page: $ref: "#/components/schemas/FunnelPage"

Request Body#

This route does not declare a validation schema, so the accepted fields are not derivable from the source. Check the handler before relying on a particular body.

Response#

Success:

{
  page,
}

Error (500):

{
  message,
}

Example Request#

curl -X POST 'https://your-store.omnicart.cc/admin/funnels/pages' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

GET Admin Funnels Stages#

Endpoint: GET /admin/funnels/stages Authentication: Admin (Required)

Description#

@swagger /admin/funnels/stages: get: tags: [Funnels] description: Retrieves funnel stages responses: 200: description: OK content: application/json: schema: properties: stages: type: array

Response#

Success:

{
  stages,
}

Error (400):

{
  message,
}

Error (500):

{
  message,
  stages,
}

Error (500):

{
  message,
  stack,
}

Example Request#

curl -X GET 'https://your-store.omnicart.cc/admin/funnels/stages' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

POST Admin Funnels Stages#

Endpoint: POST /admin/funnels/stages Authentication: Admin (Required)

Description#

@swagger /admin/funnels/stages: post: tags: [Funnels] description: Creates a new funnel stage requestBody: content: application/json: schema: required: - name - funnel_id - position properties: name: type: string description: type: string funnel_id: type: string position: type: number is_entry_point: type: boolean responses: 200: description: OK content: application/json: schema: properties: stage: $ref: "#/components/schemas/FunnelStage"

Request Body#

This route does not declare a validation schema, so the accepted fields are not derivable from the source. Check the handler before relying on a particular body.

Response#

Success:

{
  stage,
}

Error (400):

{
  message,
}

Error (404):

{
  message,
}

Error (500):

{
  message,
}

Example Request#

curl -X POST 'https://your-store.omnicart.cc/admin/funnels/stages' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

PUT Admin Funnels Stages :id#

Endpoint: PUT /admin/funnels/stages/:id Authentication: Admin (Required)

Description#

Update an existing funnel stage

URL Parameters#

Request Body#

This route does not declare a validation schema, so the accepted fields are not derivable from the source. Check the handler before relying on a particular body.

Response#

Success:

{
  stage,
}

Error (400):

{
  message,
}

Error (404):

{
  message,
}

Error (500):

{
  message,
  error,
}

Example Request#

curl -X PUT 'https://your-store.omnicart.cc/admin/funnels/stages/:id' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

DELETE Admin Funnels Stages :id#

Endpoint: DELETE /admin/funnels/stages/:id Authentication: Admin (Required)

Description#

Delete a funnel stage

URL Parameters#

Response#

Success:

{
  id,
  deleted,
}

Error (500):

{
  message,
  error,
}

Example Request#

curl -X DELETE 'https://your-store.omnicart.cc/admin/funnels/stages/:id' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

POST Admin Funnels Stages Reorder#

Endpoint: POST /admin/funnels/stages/reorder Authentication: Admin (Required)

Description#

Reorder funnel stages

Request Body#

This route does not declare a validation schema, so the accepted fields are not derivable from the source. Check the handler before relying on a particular body.

Response#

Success (200):

{
  stages,
}

Error (400):

{
  message,
}

Error (400):

{
  message,
}

Error (500):

{
  message,
  error,
}

Example Request#

curl -X POST 'https://your-store.omnicart.cc/admin/funnels/stages/reorder' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

POST Admin Internal Checkout-context#

Endpoint: POST /admin/internal/checkout-context Authentication: Admin (Required)

Request Body#

Response#

Success:

{
  ok,
  cart_id,
  stamped,
}

Also returns:

{
  ok,
  cart_id,
  stamped,
}

Error (400):

{
  error,
  issues,
}

Error (503):

{
  error,
}

Error (401):

{
  error,
}

Error (401):

{
  error,
}

Error (503):

{
  error,
}

Error (403):

{
  error,
}

Error (404):

{
  error,
}

Error (409):

{
  error,
}

Error (401):

{
  error,
}

Error (503):

{
  error,
}

Example Request#

curl -X POST 'https://your-store.omnicart.cc/admin/internal/checkout-context' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

POST Admin Internal Members#

Endpoint: POST /admin/internal/members Authentication: Admin (Required)

Request Body#

Response#

Error (400):

{
  error,
  issues,
}

Example Request#

curl -X POST 'https://your-store.omnicart.cc/admin/internal/members' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

GET Admin Internal Members#

Endpoint: GET /admin/internal/members Authentication: Admin (Required)

Description#

Snapshot of this store's federated members: every user that holds one of the three standard roles, with its store role. Used by the SysOp reconcile job to detect + heal drift. Users with no standard role are omitted (they're not part of the federation).

Response#

Success:

{
  members,
}

Also returns:

{
  members,
}

Example Request#

curl -X GET 'https://your-store.omnicart.cc/admin/internal/members' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

GET Admin Internal Sales-metrics#

Endpoint: GET /admin/internal/sales-metrics Authentication: Admin (Required)

Response#

Success:

{
  total,
  days,
  meta,
}

Error (400):

{
  message,
  issues,
}

Error (400):

{
  message,
}

Error (400):

{
  message,
}

Error (400):

{
  code,
  message,
  maxDays,
  requestedDays,
}

Error (500):

{
  message,
}

Example Request#

curl -X GET 'https://your-store.omnicart.cc/admin/internal/sales-metrics' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

POST Admin Internal Superplane-cart#

Endpoint: POST /admin/internal/superplane-cart Authentication: Admin (Required)

Request Body#

Response#

Success (200):

{
  cart_id,
  checkout_url,
  customer_id,
  attributed,
}

Error (400):

{
  error,
  issues,
}

Error (422):

{
  error,
}

Error (422):

{
  error,
}

Example Request#

curl -X POST 'https://your-store.omnicart.cc/admin/internal/superplane-cart' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

POST Admin Internal Unified-context#

Endpoint: POST /admin/internal/unified-context Authentication: Admin (Required)

Request Body#

This route does not declare a validation schema, so the accepted fields are not derivable from the source. Check the handler before relying on a particular body.

Response#

Success:

{
  ok,
  cart_id,
  stamped,
}

Error (400):

{
  error,
}

Error (404):

{
  error,
}

Error (409):

{
  error,
}

Example Request#

curl -X POST 'https://your-store.omnicart.cc/admin/internal/unified-context' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

POST Admin Konnektive Outbound-sync :orderId Force#

Endpoint: POST /admin/konnektive/outbound-sync/:orderId/force Authentication: Admin (Required)

Description#

POST /admin/konnektive/outbound-sync/:orderId/force Force immediate sync of an order (bypass modification window) Use cases: - Urgent orders requiring immediate fulfillment - Manual correction after failed sync - Customer service requests @returns Sync result with Konnektive customer ID and order ID

URL Parameters#

Request Body#

This route does not declare a validation schema, so the accepted fields are not derivable from the source. Check the handler before relying on a particular body.

Response#

Success (200):

{
  message,
  result,
}

Error (400):

{
  error,
  message,
  errorCode,
  attempts,
}

Error (500):

{
  error,
  message,
}

Example Request#

curl -X POST 'https://your-store.omnicart.cc/admin/konnektive/outbound-sync/:orderId/force' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

POST Admin Konnektive Outbound-sync :orderId Retry#

Endpoint: POST /admin/konnektive/outbound-sync/:orderId/retry Authentication: Admin (Required)

Description#

POST /admin/konnektive/outbound-sync/:orderId/retry Retry a failed sync for a specific order Use cases: - Recover from transient API errors - Retry after fixing product SKU mappings - Retry after Konnektive service restoration @returns Sync result with success/failure status

URL Parameters#

Request Body#

This route does not declare a validation schema, so the accepted fields are not derivable from the source. Check the handler before relying on a particular body.

Response#

Success (200):

{
  message,
  result,
}

Error (400):

{
  error,
  message,
  errorCode,
  attempts,
}

Error (500):

{
  error,
  message,
}

Example Request#

curl -X POST 'https://your-store.omnicart.cc/admin/konnektive/outbound-sync/:orderId/retry' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

GET Admin Konnektive Outbound-sync :orderId Status#

Endpoint: GET /admin/konnektive/outbound-sync/:orderId/status Authentication: Admin (Required)

Description#

GET /admin/konnektive/outbound-sync/:orderId/status Get sync status for a specific order @returns Sync status including scheduled time, attempts, Konnektive IDs, errors

URL Parameters#

Response#

Success (200):

{
  status,
}

Error (404):

{
  error,
  message,
}

Error (500):

{
  error,
  message,
}

Example Request#

curl -X GET 'https://your-store.omnicart.cc/admin/konnektive/outbound-sync/:orderId/status' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

GET Admin Konnektive Outbound-sync Failed#

Endpoint: GET /admin/konnektive/outbound-sync/failed Authentication: Admin (Required)

Description#

GET /admin/konnektive/outbound-sync/failed List all failed syncs for troubleshooting Query params: - limit: Maximum number of results (default: 50) @returns List of failed sync records with error details

Response#

Success (200):

{
  failedSyncs,
  count,
}

Error (500):

{
  error,
  message,
}

Example Request#

curl -X GET 'https://your-store.omnicart.cc/admin/konnektive/outbound-sync/failed' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

GET Admin Konnektive Outbound-sync Statistics#

Endpoint: GET /admin/konnektive/outbound-sync/statistics Authentication: Admin (Required)

Description#

GET /admin/konnektive/outbound-sync/statistics Get overall sync statistics and metrics Metrics include: - Total syncs by status (scheduled, pending, synced, failed) - Average modifications per order (Flow Builder upsells) - Average sync attempts (retry metrics) @returns Comprehensive sync statistics

Response#

Success (200):

{
  statistics,
}

Error (500):

{
  error,
  message,
}

Example Request#

curl -X GET 'https://your-store.omnicart.cc/admin/konnektive/outbound-sync/statistics' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

GET Admin Konnektive Product-mapping#

Endpoint: GET /admin/konnektive/product-mapping Authentication: Admin (Required)

Description#

GET /admin/konnektive/product-mapping Get all product SKU mappings (OmniCart SKU → Konnektive product_id) @returns Map of OmniCart SKUs to Konnektive product IDs

Response#

Success (200):

{
  mapping,
  count,
}

Error (500):

{
  error,
  message,
}

Example Request#

curl -X GET 'https://your-store.omnicart.cc/admin/konnektive/product-mapping' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

POST Admin Konnektive Product-mapping#

Endpoint: POST /admin/konnektive/product-mapping Authentication: Admin (Required)

Description#

POST /admin/konnektive/product-mapping Add or update product SKU mappings Request body: { "mappings": { "OMNICART_SKU": "KONNEKTIVE_PRODUCT_ID", ... } } @returns Updated mapping

Request Body#

This route does not declare a validation schema, so the accepted fields are not derivable from the source. Check the handler before relying on a particular body.

Response#

Success (200):

{
  message,
  mapping,
  count,
}

Error (400):

{
  error,
  message,
}

Error (500):

{
  error,
  message,
}

Example Request#

curl -X POST 'https://your-store.omnicart.cc/admin/konnektive/product-mapping' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

DELETE Admin Konnektive Product-mapping#

Endpoint: DELETE /admin/konnektive/product-mapping Authentication: Admin (Required)

Description#

DELETE /admin/konnektive/product-mapping Remove product SKU mappings Request body: { "skus": ["OMNICART_SKU1", "OMNICART_SKU2", ...] } @returns Updated mapping

Response#

Success (200):

{
  message,
  removedCount,
  mapping,
  count,
}

Error (400):

{
  error,
  message,
}

Error (500):

{
  error,
  message,
}

Example Request#

curl -X DELETE 'https://your-store.omnicart.cc/admin/konnektive/product-mapping' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

GET Admin Konnektive Products#

Endpoint: GET /admin/konnektive/products Authentication: Admin (Required)

Description#

GET /admin/konnektive/products Fetch Konnektive products from the Konnektive API

Response#

Success (200):

{
  products,
}

Error (503):

{
  error,
}

Error (500):

{
  error,
}

Example Request#

curl -X GET 'https://your-store.omnicart.cc/admin/konnektive/products' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

GET Admin Marketing#

Endpoint: GET /admin/marketing Authentication: Admin (Required)

Response#

Success:

{
  success,
  data,
}

Error (500):

{
  success,
  message,
}

Example Request#

curl -X GET 'https://your-store.omnicart.cc/admin/marketing' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

GET Admin Marketing Ad-sets#

Endpoint: GET /admin/marketing/ad-sets Authentication: Admin (Required)

Description#

// List ad sets

Response#

Success:

{
  success,
  data,
}

Error (400):

{
  success,
  message,
}

Example Request#

curl -X GET 'https://your-store.omnicart.cc/admin/marketing/ad-sets' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

POST Admin Marketing Ad-sets#

Endpoint: POST /admin/marketing/ad-sets Authentication: Admin (Required)

Description#

// Create ad set

Request Body#

Response#

Success (201):

{
  success,
  data,
}

Error (404):

{
  success,
  message,
}

Error (400):

{
  success,
  message,
}

Example Request#

curl -X POST 'https://your-store.omnicart.cc/admin/marketing/ad-sets' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

GET Admin Marketing Ai-insights#

Endpoint: GET /admin/marketing/ai-insights Authentication: Admin (Required)

Response#

Success:

{
  success,
  data,
}

Also returns:

{
  success,
  data,
}

Error (500):

{
  success,
  message,
}

Example Request#

curl -X GET 'https://your-store.omnicart.cc/admin/marketing/ai-insights' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

GET Admin Marketing Analytics-simple#

Endpoint: GET /admin/marketing/analytics-simple Authentication: Admin (Required)

Response#

Success:

{
  platforms,
  totals,
  dateRange,
}

Error (500):

{
  error,
  message,
}

Example Request#

curl -X GET 'https://your-store.omnicart.cc/admin/marketing/analytics-simple' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

GET Admin Marketing Analytics Platforms#

Endpoint: GET /admin/marketing/analytics/platforms Authentication: Admin (Required)

Response#

Success:

{
  success,
  data,
}

Also returns:

{
  success,
  data,
}

Error (500):

{
  success,
  message,
}

Example Request#

curl -X GET 'https://your-store.omnicart.cc/admin/marketing/analytics/platforms' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

GET Admin Marketing Attribution#

Endpoint: GET /admin/marketing/attribution Authentication: Admin (Required)

Response#

Success:

{
  success,
  data,
}

Also returns:

{
  success,
  data,
}

Error (500):

{
  success,
  message,
}

Example Request#

curl -X GET 'https://your-store.omnicart.cc/admin/marketing/attribution' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

GET Admin Marketing Campaigns#

Endpoint: GET /admin/marketing/campaigns Authentication: Admin (Required)

Description#

// List campaigns

Response#

Success:

{
  success,
  data,
  meta,
}

Also returns:

{
  success,
  data,
  meta,
}

Example Request#

curl -X GET 'https://your-store.omnicart.cc/admin/marketing/campaigns' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

POST Admin Marketing Campaigns#

Endpoint: POST /admin/marketing/campaigns Authentication: Admin (Required)

Description#

// Create campaign

Request Body#

Response#

Success (201):

{
  success,
  data,
  message,
}

Example Request#

curl -X POST 'https://your-store.omnicart.cc/admin/marketing/campaigns' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

GET Admin Marketing Campaigns :id#

Endpoint: GET /admin/marketing/campaigns/:id Authentication: Admin (Required)

Description#

// Get campaign by ID

URL Parameters#

Response#

Success:

{
  success,
  data,
}

Also returns:

{
  success,
  data,
}

Example Request#

curl -X GET 'https://your-store.omnicart.cc/admin/marketing/campaigns/:id' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

PATCH Admin Marketing Campaigns :id#

Endpoint: PATCH /admin/marketing/campaigns/:id Authentication: Admin (Required)

Description#

// Update campaign

URL Parameters#

Request Body#

Response#

Success:

{
  success,
  data,
  message,
}

Example Request#

curl -X PATCH 'https://your-store.omnicart.cc/admin/marketing/campaigns/:id' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

DELETE Admin Marketing Campaigns :id#

Endpoint: DELETE /admin/marketing/campaigns/:id Authentication: Admin (Required)

Description#

// Delete campaign

URL Parameters#

Response#

Success:

{
  success,
  message,
  archived,
}

Also returns:

{
  success,
  message,
  deleted,
}

Example Request#

curl -X DELETE 'https://your-store.omnicart.cc/admin/marketing/campaigns/:id' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

GET Admin Marketing Campaigns :id Insights#

Endpoint: GET /admin/marketing/campaigns/:id/insights Authentication: Admin (Required)

Description#

// Get campaign insights

URL Parameters#

Response#

Success:

{
  success,
  data,
}

Error (404):

{
  success,
  message,
}

Error (400):

{
  success,
  message,
}

Example Request#

curl -X GET 'https://your-store.omnicart.cc/admin/marketing/campaigns/:id/insights' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

GET Admin Marketing Clickhouse#

Endpoint: GET /admin/marketing/clickhouse Authentication: Admin (Required)

Description#

// GET /admin/marketing/clickhouse - Get ClickHouse configuration

Response#

Success:

{
  success,
  data,
}

Example Request#

curl -X GET 'https://your-store.omnicart.cc/admin/marketing/clickhouse' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

POST Admin Marketing Clickhouse#

Endpoint: POST /admin/marketing/clickhouse Authentication: Admin (Required)

Description#

// POST /admin/marketing/clickhouse - Save ClickHouse configuration

Request Body#

Response#

Success:

{
  success,
  message,
  data,
}

Example Request#

curl -X POST 'https://your-store.omnicart.cc/admin/marketing/clickhouse' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

DELETE Admin Marketing Clickhouse#

Endpoint: DELETE /admin/marketing/clickhouse Authentication: Admin (Required)

Description#

// DELETE /admin/marketing/clickhouse - Remove ClickHouse configuration

Response#

Success:

{
  success,
  message,
}

Example Request#

curl -X DELETE 'https://your-store.omnicart.cc/admin/marketing/clickhouse' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

GET Admin Marketing Creatives#

Endpoint: GET /admin/marketing/creatives Authentication: Admin (Required)

Description#

// List creatives

Response#

Success:

{
  success,
  data,
}

Error (400):

{
  success,
  message,
}

Example Request#

curl -X GET 'https://your-store.omnicart.cc/admin/marketing/creatives' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

POST Admin Marketing Creatives#

Endpoint: POST /admin/marketing/creatives Authentication: Admin (Required)

Description#

// Create creative

Request Body#

Response#

Success (201):

{
  success,
  data,
}

Error (404):

{
  success,
  message,
}

Error (400):

{
  success,
  message,
}

Example Request#

curl -X POST 'https://your-store.omnicart.cc/admin/marketing/creatives' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

GET Admin Marketing Credentials#

Endpoint: GET /admin/marketing/credentials Authentication: Admin (Required)

Description#

// GET - Get credentials for all platforms

Response#

Success:

{
  success,
  data,
}

Example Request#

curl -X GET 'https://your-store.omnicart.cc/admin/marketing/credentials' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

POST Admin Marketing Credentials#

Endpoint: POST /admin/marketing/credentials Authentication: Admin (Required)

Description#

// POST - Save credentials for a platform

Request Body#

Response#

Success:

{
  success,
  message,
  data,
}

Example Request#

curl -X POST 'https://your-store.omnicart.cc/admin/marketing/credentials' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

PUT Admin Marketing Credentials#

Endpoint: PUT /admin/marketing/credentials Authentication: Admin (Required)

Description#

// PUT - Update credentials for a platform

Request Body#

Response#

Success:

{
  success,
  message,
  data,
}

Example Request#

curl -X PUT 'https://your-store.omnicart.cc/admin/marketing/credentials' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

DELETE Admin Marketing Credentials#

Endpoint: DELETE /admin/marketing/credentials Authentication: Admin (Required)

Description#

// DELETE - Remove credentials for a platform

Response#

Success:

{
  success,
  message,
}

Example Request#

curl -X DELETE 'https://your-store.omnicart.cc/admin/marketing/credentials' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

GET Admin Marketing Customer-journey :customerId#

Endpoint: GET /admin/marketing/customer-journey/:customerId Authentication: Admin (Required)

Description#

// Get customer journey analysis

URL Parameters#

Response#

Success:

{
  success,
  data,
}

Error (404):

{
  success,
  message,
}

Error (400):

{
  success,
  message,
}

Example Request#

curl -X GET 'https://your-store.omnicart.cc/admin/marketing/customer-journey/:customerId' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

GET Admin Marketing Dashboard#

Endpoint: GET /admin/marketing/dashboard Authentication: Admin (Required)

Response#

Success:

{
  metrics,
  platformBreakdown,
  recentCampaigns,
  timeSeriesData,
  dateRange,
}

Example Request#

curl -X GET 'https://your-store.omnicart.cc/admin/marketing/dashboard' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

GET Admin Marketing Paid-acquisition#

Endpoint: GET /admin/marketing/paid-acquisition Authentication: Admin (Required)

Description#

GET /admin/marketing/paid-acquisition Generate paid acquisition operational report with query parameters

Response#

The handler does not return an object literal, so the response shape is not derivable from the source.

Example Request#

curl -X GET 'https://your-store.omnicart.cc/admin/marketing/paid-acquisition' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

POST Admin Marketing Paid-acquisition#

Endpoint: POST /admin/marketing/paid-acquisition Authentication: Admin (Required)

Description#

POST /admin/marketing/paid-acquisition Generate paid acquisition operational report with advanced filtering

Request Body#

Response#

The handler does not return an object literal, so the response shape is not derivable from the source.

Example Request#

curl -X POST 'https://your-store.omnicart.cc/admin/marketing/paid-acquisition' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

POST Admin Marketing Paid-acquisition Export#

Endpoint: POST /admin/marketing/paid-acquisition/export Authentication: Admin (Required)

Description#

POST /admin/marketing/paid-acquisition/export Export paid acquisition operational report in various formats

Request Body#

Response#

Success:

{
  success,
  data,
  meta,
}

Example Request#

curl -X POST 'https://your-store.omnicart.cc/admin/marketing/paid-acquisition/export' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

GET Admin Marketing Paid-acquisition Search#

Endpoint: GET /admin/marketing/paid-acquisition/search Authentication: Admin (Required)

Description#

GET /admin/marketing/paid-acquisition/search Search and filter paid acquisition data with query parameters

Response#

Success:

{
  success,
  data,
  facets,
  meta,
}

Example Request#

curl -X GET 'https://your-store.omnicart.cc/admin/marketing/paid-acquisition/search' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

POST Admin Marketing Paid-acquisition Search#

Endpoint: POST /admin/marketing/paid-acquisition/search Authentication: Admin (Required)

Description#

POST /admin/marketing/paid-acquisition/search Advanced search with complex filtering and faceted search

Request Body#

Response#

Success:

{
  success,
  data,
  facets,
  aggregations,
  meta,
}

Example Request#

curl -X POST 'https://your-store.omnicart.cc/admin/marketing/paid-acquisition/search' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

GET Admin Marketing Platforms#

Endpoint: GET /admin/marketing/platforms Authentication: Admin (Required)

Description#

// Get platform overview

Response#

Success:

{
  success,
  data,
}

Error (400):

{
  success,
  message,
}

Example Request#

curl -X GET 'https://your-store.omnicart.cc/admin/marketing/platforms' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

GET Admin Marketing Simple#

Endpoint: GET /admin/marketing/simple Authentication: Admin (Required)

Response#

Error (500):

{
  error,
  message,
}

Example Request#

curl -X GET 'https://your-store.omnicart.cc/admin/marketing/simple' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

POST Admin Marketing Sync#

Endpoint: POST /admin/marketing/sync Authentication: Admin (Required)

Description#

// Sync campaigns from advertising platforms

Request Body#

Response#

Success:

{
  success,
  data,
  message,
}

Error (400):

{
  success,
  message,
}

Example Request#

curl -X POST 'https://your-store.omnicart.cc/admin/marketing/sync' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

POST Admin Marketing Sync Campaign#

Endpoint: POST /admin/marketing/sync/campaign Authentication: Admin (Required)

Description#

// POST - Trigger campaign sync

Request Body#

Response#

Success:

{
  success,
  message,
  data,
}

Example Request#

curl -X POST 'https://your-store.omnicart.cc/admin/marketing/sync/campaign' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

POST Admin Marketing Sync Incremental#

Endpoint: POST /admin/marketing/sync/incremental Authentication: Admin (Required)

Description#

// POST - Trigger incremental sync

Request Body#

Response#

Success:

{
  success,
  message,
  data,
}

Example Request#

curl -X POST 'https://your-store.omnicart.cc/admin/marketing/sync/incremental' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

GET Admin Marketing Webhooks Facebook#

Endpoint: GET /admin/marketing/webhooks/facebook Authentication: Admin (Required)

Description#

// GET endpoint for webhook verification

Response#

Error (400):

{
  success,
  message,
  errors,
}

Example Request#

curl -X GET 'https://your-store.omnicart.cc/admin/marketing/webhooks/facebook' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

POST Admin Marketing Webhooks Facebook#

Endpoint: POST /admin/marketing/webhooks/facebook Authentication: Admin (Required)

Description#

// POST endpoint for webhook events

Request Body#

Response#

Success (200):

{
  success,
  received,
  processed,
  errors,
}

Example Request#

curl -X POST 'https://your-store.omnicart.cc/admin/marketing/webhooks/facebook' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

HEAD Admin Marketing Webhooks Facebook#

Endpoint: HEAD /admin/marketing/webhooks/facebook Authentication: Admin (Required)

Description#

// Health check endpoint

Response#

The handler does not return an object literal, so the response shape is not derivable from the source.

Example Request#

curl -X HEAD 'https://your-store.omnicart.cc/admin/marketing/webhooks/facebook' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

POST Admin Marketing Webhooks Google#

Endpoint: POST /admin/marketing/webhooks/google Authentication: Admin (Required)

Description#

// POST endpoint for Google Ads webhook events

Request Body#

Response#

Success (200):

{
  success,
  received,
  eventType,
  processed,
}

Also returns (200):

{
  success,
  received,
  error,
}

Example Request#

curl -X POST 'https://your-store.omnicart.cc/admin/marketing/webhooks/google' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

GET Admin Marketing Webhooks Google#

Endpoint: GET /admin/marketing/webhooks/google Authentication: Admin (Required)

Description#

// GET endpoint for webhook verification (if Google implements it)

Response#

Success (200):

{
  status,
  webhook,
}

Example Request#

curl -X GET 'https://your-store.omnicart.cc/admin/marketing/webhooks/google' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

POST Admin Marketing Webhooks Tiktok#

Endpoint: POST /admin/marketing/webhooks/tiktok Authentication: Admin (Required)

Description#

// POST endpoint for TikTok webhook events

Request Body#

Response#

Success (200):

{
  success,
  received,
  event_type,
  processed,
}

Also returns (200):

{
  success,
  received,
  error,
}

Example Request#

curl -X POST 'https://your-store.omnicart.cc/admin/marketing/webhooks/tiktok' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

GET Admin Marketing Webhooks Tiktok#

Endpoint: GET /admin/marketing/webhooks/tiktok Authentication: Admin (Required)

Description#

// GET endpoint for webhook verification

Response#

Success (200):

{
  code,
  message,
}

Also returns (200):

{
  status,
  webhook,
}

Error (401):

{
  code,
  message,
}

Example Request#

curl -X GET 'https://your-store.omnicart.cc/admin/marketing/webhooks/tiktok' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

HEAD Admin Marketing Webhooks Tiktok#

Endpoint: HEAD /admin/marketing/webhooks/tiktok Authentication: Admin (Required)

Description#

// HEAD endpoint for health check

Response#

The handler does not return an object literal, so the response shape is not derivable from the source.

Example Request#

curl -X HEAD 'https://your-store.omnicart.cc/admin/marketing/webhooks/tiktok' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

GET Admin Me#

Endpoint: GET /admin/me Authentication: Admin (Required)

Description#

GET /admin/me Returns the currently logged-in admin user

Response#

Success:

{
  user,
}

Error (500):

{
  error,
  message,
}

Example Request#

curl -X GET 'https://your-store.omnicart.cc/admin/me' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

GET Admin My-stores#

Endpoint: GET /admin/my-stores Authentication: Admin (Required)

Response#

Success:

{
  stores,
}

Also returns:

{
  stores,
}

Also returns:

{
  stores,
}

Also returns:

{
  stores,
}

Also returns:

{
  stores,
}

Example Request#

curl -X GET 'https://your-store.omnicart.cc/admin/my-stores' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

POST Admin My-stores Switch#

Endpoint: POST /admin/my-stores/switch Authentication: Admin (Required)

Request Body#

This route does not declare a validation schema, so the accepted fields are not derivable from the source. Check the handler before relying on a particular body.

Response#

Success:

{
  error,
}

Also returns:

{
  redirectUrl,
  expiresInSeconds,
}

Error (400):

{
  error,
}

Error (503):

{
  error,
}

Error (403):

{
  error,
}

Error (502):

{
  error,
}

Example Request#

curl -X POST 'https://your-store.omnicart.cc/admin/my-stores/switch' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

GET Admin Payment-diagnostics#

Endpoint: GET /admin/payment-diagnostics Authentication: Admin (Required)

Description#

GET /admin/payment-diagnostics Diagnostic endpoint to identify payment session issues

Response#

Success:

{
  ...diagnostics
  summary,
}

Error (400):

{
  message,
}

Error (404):

{
  message,
}

Error (500):

{
  message,
  error,
}

Example Request#

curl -X GET 'https://your-store.omnicart.cc/admin/payment-diagnostics' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

POST Admin Payment-diagnostics#

Endpoint: POST /admin/payment-diagnostics Authentication: Admin (Required)

Description#

POST /admin/payment-diagnostics/cleanup Force cleanup of stale payment sessions

Request Body#

This route does not declare a validation schema, so the accepted fields are not derivable from the source. Check the handler before relying on a particular body.

Response#

Success:

{
  success,
  cleaned,
  failed,
  details,
  duration,
}

Error (400):

{
  message,
}

Error (500):

{
  message,
  error,
}

Example Request#

curl -X POST 'https://your-store.omnicart.cc/admin/payment-diagnostics' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

POST Admin Payments :id Sync-stripe#

Endpoint: POST /admin/payments/:id/sync-stripe Authentication: Admin (Required)

Description#

POST /admin/payments/:id/sync-stripe Syncs payment status from Stripe to OmniCart. Fetches the latest payment intent status including: - Payment status (succeeded, canceled, etc.) - Dispute status (if disputed) - Refund status Updates the payment record metadata with current Stripe status.

URL Parameters#

Request Body#

This route does not declare a validation schema, so the accepted fields are not derivable from the source. Check the handler before relying on a particular body.

Response#

Success (200):

{
  success,
  payment_id,
  stripe_payment_intent,
  status,
  warnings,
  sync_details,
}

Error (404):

{
  type,
  message,
}

Error (400):

{
  type,
  message,
}

Error (400):

{
  type,
  message,
}

Error (500):

{
  type,
  message,
}

Error (400):

{
  type,
  message,
  code,
}

Error (500):

{
  type,
  message,
}

Example Request#

curl -X POST 'https://your-store.omnicart.cc/admin/payments/:id/sync-stripe' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

GET Admin Promotions :id :rule_type#

Endpoint: GET /admin/promotions/:id/:rule_type Authentication: Admin (Required)

URL Parameters#

Response#

Success:

{
  rules,
}

Example Request#

curl -X GET 'https://your-store.omnicart.cc/admin/promotions/:id/:rule_type' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

GET Admin Promotions :id Rule-divergence#

Endpoint: GET /admin/promotions/:id/rule-divergence Authentication: Admin (Required)

URL Parameters#

Response#

The handler does not return an object literal, so the response shape is not derivable from the source.

Example Request#

curl -X GET 'https://your-store.omnicart.cc/admin/promotions/:id/rule-divergence' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

POST Admin Promotions :id Rule-divergence#

Endpoint: POST /admin/promotions/:id/rule-divergence Authentication: Admin (Required)

URL Parameters#

Request Body#

This route does not declare a validation schema, so the accepted fields are not derivable from the source. Check the handler before relying on a particular body.

Response#

Success:

{
  applied,
  mode,
  synced_product_ids,
  synced_products,
  ...serialise(after.promotion, after.divergence, after.missingProducts, after.plan)
}

Example Request#

curl -X POST 'https://your-store.omnicart.cc/admin/promotions/:id/rule-divergence' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

GET Admin Promotions Rule-attribute-options :rule_type#

Endpoint: GET /admin/promotions/rule-attribute-options/:rule_type Authentication: Admin (Required)

URL Parameters#

Response#

Success:

{
  attributes,
}

Example Request#

curl -X GET 'https://your-store.omnicart.cc/admin/promotions/rule-attribute-options/:rule_type' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

GET Admin Promotions Rule-value-options :rule_type :rule_attribute_id#

Endpoint: GET /admin/promotions/rule-value-options/:rule_type/:rule_attribute_id Authentication: Admin (Required)

URL Parameters#

Response#

Success:

{
  values,
  count,
  offset,
  limit,
}

Also returns:

{
  values,
  count,
  estimate_count,
  offset,
  limit,
}

Also returns:

{
  values,
  count,
  offset,
  limit,
}

Example Request#

curl -X GET 'https://your-store.omnicart.cc/admin/promotions/rule-value-options/:rule_type/:rule_attribute_id' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

GET Admin Purchase-orders#

Endpoint: GET /admin/purchase-orders Authentication: Admin (Required)

Response#

Success:

{
  purchase_orders,
  count,
}

Error (400):

{
  message,
}

Error (500):

{
  message,
  error,
}

Example Request#

curl -X GET 'https://your-store.omnicart.cc/admin/purchase-orders' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

POST Admin Purchase-orders#

Endpoint: POST /admin/purchase-orders Authentication: Admin (Required)

Request Body#

Response#

Success (201):

{
  module_enabled,
  purchase_order,
  inventory_costs,
}

Error (400):

{
  message,
}

Error (400):

{
  message,
  issues,
}

Error (400):

{
  message,
}

Error (400):

{
  message,
}

Error (400):

{
  message,
}

Error (500):

{
  message,
  error,
}

Example Request#

curl -X POST 'https://your-store.omnicart.cc/admin/purchase-orders' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

GET Admin Renewals#

Endpoint: GET /admin/renewals Authentication: Admin (Required)

Response#

The handler does not return an object literal, so the response shape is not derivable from the source.

Example Request#

curl -X GET 'https://your-store.omnicart.cc/admin/renewals' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

GET Admin Renewals :id#

Endpoint: GET /admin/renewals/:id Authentication: Admin (Required)

URL Parameters#

Response#

The handler does not return an object literal, so the response shape is not derivable from the source.

Example Request#

curl -X GET 'https://your-store.omnicart.cc/admin/renewals/:id' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

POST Admin Renewals :id Approve-changes#

Endpoint: POST /admin/renewals/:id/approve-changes Authentication: Admin (Required)

URL Parameters#

Request Body#

This route does not declare a validation schema, so the accepted fields are not derivable from the source. Check the handler before relying on a particular body.

Response#

Success:

{
  type,
  message,
}

Example Request#

curl -X POST 'https://your-store.omnicart.cc/admin/renewals/:id/approve-changes' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

POST Admin Renewals :id Force#

Endpoint: POST /admin/renewals/:id/force Authentication: Admin (Required)

URL Parameters#

Request Body#

This route does not declare a validation schema, so the accepted fields are not derivable from the source. Check the handler before relying on a particular body.

Response#

Success:

{
  type,
  message,
}

Example Request#

curl -X POST 'https://your-store.omnicart.cc/admin/renewals/:id/force' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

POST Admin Renewals :id Reject-changes#

Endpoint: POST /admin/renewals/:id/reject-changes Authentication: Admin (Required)

URL Parameters#

Request Body#

This route does not declare a validation schema, so the accepted fields are not derivable from the source. Check the handler before relying on a particular body.

Response#

Success:

{
  type,
  message,
}

Example Request#

curl -X POST 'https://your-store.omnicart.cc/admin/renewals/:id/reject-changes' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

GET Admin Reviews#

Endpoint: GET /admin/reviews Authentication: Admin (Required)

Response#

Success:

{
  reviews,
  count,
  limit,
  offset,
}

Example Request#

curl -X GET 'https://your-store.omnicart.cc/admin/reviews' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

POST Admin Reviews Status#

Endpoint: POST /admin/reviews/status Authentication: Admin (Required)

Request Body#

Response#

The handler does not return an object literal, so the response shape is not derivable from the source.

Example Request#

curl -X POST 'https://your-store.omnicart.cc/admin/reviews/status' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

GET Admin Scheduled-jobs#

Endpoint: GET /admin/scheduled-jobs Authentication: Admin (Required)

Response#

The handler does not return an object literal, so the response shape is not derivable from the source.

Example Request#

curl -X GET 'https://your-store.omnicart.cc/admin/scheduled-jobs' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

GET Admin Scheduled-jobs :name#

Endpoint: GET /admin/scheduled-jobs/:name Authentication: Admin (Required)

URL Parameters#

Response#

Error (400):

{
  error,
}

Example Request#

curl -X GET 'https://your-store.omnicart.cc/admin/scheduled-jobs/:name' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

GET Admin Send#

Endpoint: GET /admin/send Authentication: Admin (Required)

Description#

Parent route for /admin/send This route handles delegation to sub-routes

Response#

Error (404):

{
  error,
}

Example Request#

curl -X GET 'https://your-store.omnicart.cc/admin/send' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

POST Admin Send#

Endpoint: POST /admin/send Authentication: Admin (Required)

Request Body#

This route does not declare a validation schema, so the accepted fields are not derivable from the source. Check the handler before relying on a particular body.

Response#

Error (404):

{
  error,
}

Example Request#

curl -X POST 'https://your-store.omnicart.cc/admin/send' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

GET Admin Send Email-templates#

Endpoint: GET /admin/send/email-templates Authentication: Admin (Required)

Description#