Other

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

Overview

This section documents 86 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

// Request body structure (to be documented)

Response

Success:

// Response structure (to be documented)

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:

// Response structure (to be documented)

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:

// Response structure (to be documented)

Example Request

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

POST Admin Bundled-products

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

Request Body

// Request body structure (to be documented)

Response

Success:

// Response structure (to be documented)

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:

// Response structure (to be documented)

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

Success:

// Response structure (to be documented)

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

// Request body structure (to be documented)

Response

Success:

// Response structure (to be documented)

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:

// Response structure (to be documented)

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 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:

// Response structure (to be documented)

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:

// Response structure (to be documented)

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

// Request body structure (to be documented)

Response

Success:

// Response structure (to be documented)

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 Custom

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

Response

Success:

// Response structure (to be documented)

Example Request

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

GET Admin Extensions

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

Response

Success:

// Response structure (to be documented)

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:

// Response structure (to be documented)

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

// Request body structure (to be documented)

Response

Success:

// Response structure (to be documented)

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:

// Response structure (to be documented)

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:

// Response structure (to be documented)

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

Success:

// Response structure (to be documented)

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:

// Response structure (to be documented)

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

// Request body structure (to be documented)

Response

Success:

// Response structure (to be documented)

Example Request

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

GET Admin Funnels

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

Response

Success:

// Response structure (to be documented)

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

// Request body structure (to be documented)

Response

Success:

// Response structure (to be documented)

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:

// Response structure (to be documented)

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

// Request body structure (to be documented)

Response

Success:

// Response structure (to be documented)

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:

// Response structure (to be documented)

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:

// Response structure (to be documented)

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:

// Response structure (to be documented)

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

// Request body structure (to be documented)

Response

Success:

// Response structure (to be documented)

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:

// Response structure (to be documented)

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

// Request body structure (to be documented)

Response

Success:

// Response structure (to be documented)

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

// Request body structure (to be documented)

Response

Success:

// Response structure (to be documented)

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:

// Response structure (to be documented)

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

// Request body structure (to be documented)

Response

Success:

// Response structure (to be documented)

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 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

// Request body structure (to be documented)

Response

Success:

// Response structure (to be documented)

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

// Request body structure (to be documented)

Response

Success:

// Response structure (to be documented)

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:

// Response structure (to be documented)

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:

// Response structure (to be documented)

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:

// Response structure (to be documented)

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:

// Response structure (to be documented)

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

// Request body structure (to be documented)

Response

Success:

// Response structure (to be documented)

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:

// Response structure (to be documented)

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:

// Response structure (to be documented)

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:

// Response structure (to be documented)

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:

// Response structure (to be documented)

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

// Request body structure (to be documented)

Response

Success:

// Response structure (to be documented)

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:

// Response structure (to be documented)

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:

// Response structure (to be documented)

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:

// Response structure (to be documented)

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:

// Response structure (to be documented)

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:

// Response structure (to be documented)

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

// Request body structure (to be documented)

Response

Success:

// Response structure (to be documented)

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:

// Response structure (to be documented)

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

// Request body structure (to be documented)

Response

Success:

// Response structure (to be documented)

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:

// Response structure (to be documented)

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:

// Response structure (to be documented)

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:

// Response structure (to be documented)

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

// Request body structure (to be documented)

Response

Success:

// Response structure (to be documented)

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:

// Response structure (to be documented)

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:

// Response structure (to be documented)

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

// Request body structure (to be documented)

Response

Success:

// Response structure (to be documented)

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:

// Response structure (to be documented)

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

// Request body structure (to be documented)

Response

Success:

// Response structure (to be documented)

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

// Request body structure (to be documented)

Response

Success:

// Response structure (to be documented)

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:

// Response structure (to be documented)

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:

// Response structure (to be documented)

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:

// Response structure (to be documented)

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

Success:

// Response structure (to be documented)

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

// Request body structure (to be documented)

Response

Success:

// Response structure (to be documented)

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

// Request body structure (to be documented)

Response

Success:

// Response structure (to be documented)

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:

// Response structure (to be documented)

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

// Request body structure (to be documented)

Response

Success:

// Response structure (to be documented)

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:

// Response structure (to be documented)

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

Success:

// Response structure (to be documented)

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

// Request body structure (to be documented)

Response

Success:

// Response structure (to be documented)

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

// Request body structure (to be documented)

Response

Success:

// Response structure (to be documented)

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

// Request body structure (to be documented)

Response

Success:

// Response structure (to be documented)

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

Success:

// Response structure (to be documented)

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

// Request body structure (to be documented)

Response

Success:

// Response structure (to be documented)

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

Success:

// Response structure (to be documented)

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

// Request body structure (to be documented)

Response

Success:

// Response structure (to be documented)

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:

// Response structure (to be documented)

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

// Request body structure (to be documented)

Response

Success:

// Response structure (to be documented)

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:

// Response structure (to be documented)

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

Success:

// Response structure (to be documented)

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:

// Response structure (to be documented)

Example Request

curl -X GET 'https://your-store.omnicart.cc/admin/me' \
  -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:

// Response structure (to be documented)

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

// Request body structure (to be documented)

Response

Success:

// Response structure (to be documented)

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

// Request body structure (to be documented)

Response

Success:

// Response structure (to be documented)

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:

// Response structure (to be documented)

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 Rule-attribute-options :rule_type

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

URL Parameters

Response

Success:

// Response structure (to be documented)

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 Purchase-orders

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

Response

Success:

// Response structure (to be documented)

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

// Request body structure (to be documented)

Response

Success:

// Response structure (to be documented)

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 Reviews

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

Response

Success:

// Response structure (to be documented)

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

// Request body structure (to be documented)

Response

Success:

// Response structure (to be documented)

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

Success:

// Response structure (to be documented)

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

Success:

// Response structure (to be documented)

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

Success:

// Response structure (to be documented)

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

// Request body structure (to be documented)

Response

Success:

// Response structure (to be documented)

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

GET /admin/send/email-templates List all email templates with optional filtering

Response

Success:

// Response structure (to be documented)

Example Request

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

POST Admin Send Email-templates

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

Description

POST /admin/send/email-templates Create a new email template

Request Body

// Request body structure (to be documented)

Response

Success:

// Response structure (to be documented)

Example Request

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

GET Admin Send Email-templates :id

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

Description

GET /admin/send/email-templates/:id Get a specific email template

URL Parameters

Response

Success:

// Response structure (to be documented)

Example Request

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

PUT Admin Send Email-templates :id

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

Description

PUT /admin/send/email-templates/:id Update an email template

URL Parameters

Request Body

// Request body structure (to be documented)

Response

Success:

// Response structure (to be documented)

Example Request

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

DELETE Admin Send Email-templates :id

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

Description

DELETE /admin/send/email-templates/:id Delete an email template (soft delete)

URL Parameters

Response

Success:

// Response structure (to be documented)

Example Request

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

POST Admin Send Email-templates :id Preview

Endpoint: POST /admin/send/email-templates/:id/preview Authentication: Admin (Required)

Description

POST /admin/send/email-templates/:id/preview Preview an email template with sample or custom data

URL Parameters

Request Body

// Request body structure (to be documented)

Response

Success:

// Response structure (to be documented)

Example Request

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

POST Admin Send Email-templates :id Render

Endpoint: POST /admin/send/email-templates/:id/render Authentication: Admin (Required)

Description

POST /admin/send/email-templates/:id/render Render an email template with sample data

URL Parameters

Request Body

// Request body structure (to be documented)

Response

Success:

// Response structure (to be documented)

Example Request

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

POST Admin Send Email-templates Validate

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

Description

POST /admin/send/email-templates/validate Validate email template syntax without saving

Request Body

// Request body structure (to be documented)

Response

Success:

// Response structure (to be documented)

Example Request

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

GET Admin Site-types

Endpoint: GET /admin/site-types Authentication: Admin (Required)

Response

Success:

// Response structure (to be documented)

Example Request

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

POST Admin Site-types

Endpoint: POST /admin/site-types Authentication: Admin (Required)

Request Body

// Request body structure (to be documented)

Response

Success:

// Response structure (to be documented)

Example Request

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

GET Admin Site-types :id

Endpoint: GET /admin/site-types/:id Authentication: Admin (Required)

URL Parameters

Response

Success:

// Response structure (to be documented)

Example Request

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

PATCH Admin Site-types :id

Endpoint: PATCH /admin/site-types/:id Authentication: Admin (Required)

URL Parameters

Request Body

// Request body structure (to be documented)

Response

Success:

// Response structure (to be documented)

Example Request

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

DELETE Admin Site-types :id

Endpoint: DELETE /admin/site-types/:id Authentication: Admin (Required)

URL Parameters

Response

Success:

// Response structure (to be documented)

Example Request

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

GET Admin Ultracart

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

Description

GET /admin/ultracart Get UltraCart module status and statistics

Response

Success:

// Response structure (to be documented)

Example Request

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

POST Admin Ultracart

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

Description

POST /admin/ultracart Manually sync an order to UltraCart (respects modification window) Body: { orderId: string }

Request Body

// Request body structure (to be documented)

Response

Success:

// Response structure (to be documented)

Example Request

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

POST Admin Ultracart Force-sync

Endpoint: POST /admin/ultracart/force-sync Authentication: Admin (Required)

Request Body

// Request body structure (to be documented)

Response

Success:

// Response structure (to be documented)

Example Request

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

GET Admin Ultracart Modification-window

Endpoint: GET /admin/ultracart/modification-window Authentication: Admin (Required)

Response

Success:

// Response structure (to be documented)

Example Request

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

POST Admin Ultracart Modification-window

Endpoint: POST /admin/ultracart/modification-window Authentication: Admin (Required)

Description

POST /admin/ultracart/modification-window Reset modification window for an order (extends sync delay) Body: { orderId: string }

Request Body

// Request body structure (to be documented)

Response

Success:

// Response structure (to be documented)

Example Request

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

GET Admin Ultracart Scheduled

Endpoint: GET /admin/ultracart/scheduled Authentication: Admin (Required)

Response

Success:

// Response structure (to be documented)

Example Request

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

POST Admin Ultracart Scheduled

Endpoint: POST /admin/ultracart/scheduled Authentication: Admin (Required)

Description

POST /admin/ultracart/scheduled Manually trigger processing of scheduled syncs

Request Body

// Request body structure (to be documented)

Response

Success:

// Response structure (to be documented)

Example Request

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

GET Admin Ultracart Stats

Endpoint: GET /admin/ultracart/stats Authentication: Admin (Required)

Response

Success:

// Response structure (to be documented)

Example Request

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

GET Admin Vibe

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

Description

GET /admin/vibe/* Serve Vibe SDK static files from vibe-static/ directory Note: This route handles both /admin/vibe and /admin/vibe/* paths by extracting the path from the request URL.

Response

Success:

// Response structure (to be documented)

Example Request

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

GET Admin Vibesdk Config :siteId

Endpoint: GET /admin/vibesdk/config/:siteId Authentication: Admin (Required)

Description

GET /admin/vibesdk/config/:siteId Get VibeSDK configuration for a specific site Returns configuration needed to initialize the embedded VibeSDK

URL Parameters

Response

Success:

// Response structure (to be documented)

Example Request

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

POST Admin Vibesdk Proxy

Endpoint: POST /admin/vibesdk/proxy Authentication: Admin (Required)

Description

POST /admin/vibesdk/proxy Proxy requests to VibeSDK with our GitHub credentials This allows the embedded VibeSDK to access our GitHub repos through our backend authentication

Request Body

// Request body structure (to be documented)

Response

Success:

// Response structure (to be documented)

Example Request

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

GET Admin Vibesdk Sso-token

Endpoint: GET /admin/vibesdk/sso-token Authentication: Admin (Required)

Description

GET /admin/vibesdk/sso-token?siteId=... Returns a short-lived JWT for embedded VibeSDK sessions.

Response

Success:

// Response structure (to be documented)

Example Request

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

POST Admin Vibesdk Validate-sso

Endpoint: POST /admin/vibesdk/validate-sso Authentication: Admin (Required)

Description

POST /admin/vibesdk/validate-sso Validates SSO tokens from embedded VibeSDK sessions. Called by VibeSDK worker to verify authentication tokens. Expected header: Authorization: Bearer {ssoToken} Returns user data for VibeSDK session creation.

Request Body

// Request body structure (to be documented)

Response

Success:

// Response structure (to be documented)

Example Request

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

GET Admin Webhook-logs

Endpoint: GET /admin/webhook-logs Authentication: Admin (Required)

Description

GET /admin/webhook-logs List all webhook logs with filtering and pagination Query params: - provider: Filter by provider (stripe, paypal, nmi, etc.) - event_type: Filter by event type - status: Filter by status (received, processing, success, failed, skipped) - order_id: Filter by order ID - payment_id: Filter by payment ID - from_date: Filter from date (ISO string) - to_date: Filter to date (ISO string) - limit: Number of results (default 50) - offset: Pagination offset (default 0)

Response

Success:

// Response structure (to be documented)

Example Request

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

GET Admin Webhook-logs :id

Endpoint: GET /admin/webhook-logs/:id Authentication: Admin (Required)

Description

GET /admin/webhook-logs/:id Get a single webhook log by ID with full details

URL Parameters

Response

Success:

// Response structure (to be documented)

Example Request

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

DELETE Admin Webhook-logs :id

Endpoint: DELETE /admin/webhook-logs/:id Authentication: Admin (Required)

Description

DELETE /admin/webhook-logs/:id Delete a webhook log (for cleanup purposes)

URL Parameters

Response

Success:

// Response structure (to be documented)

Example Request

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

POST Admin Webhook-logs Cleanup

Endpoint: POST /admin/webhook-logs/cleanup Authentication: Admin (Required)

Description

POST /admin/webhook-logs/cleanup Cleanup old webhook logs Body: - days_to_keep: Number of days to keep logs (default 30)

Request Body

// Request body structure (to be documented)

Response

Success:

// Response structure (to be documented)

Example Request

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

GET Admin Webhook-logs Providers

Endpoint: GET /admin/webhook-logs/providers Authentication: Admin (Required)

Description

GET /admin/webhook-logs/providers Get list of unique providers that have sent webhooks

Response

Success:

// Response structure (to be documented)

Example Request

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

GET Admin Webhook-logs Stats

Endpoint: GET /admin/webhook-logs/stats Authentication: Admin (Required)

Description

GET /admin/webhook-logs/stats Get webhook statistics and analytics Query params: - provider: Filter by provider - from_date: Filter from date (ISO string) - to_date: Filter to date (ISO string)

Response

Success:

// Response structure (to be documented)

Example Request

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