Other

Category: Store Base URL: /store/analytics Authentication: Mixed Routes: 21 routes documented

Overview

This section documents 21 API routes for other.

Quick Reference

GET Store Analytics Config

Endpoint: GET /store/analytics/config Authentication: Customer (Optional)

Description

GET /store/analytics/config Returns analytics configuration for frontend SDK initialization Only exposes public-safe credentials (appId, trackingDomain) Never exposes API keys or secrets

Response

Success:

// Response structure (to be documented)

Example Request

curl -X GET 'https://your-store.omnicart.cc/store/analytics/config' \
  -H 'Content-Type: application/json'

POST Store Attentive Opt-in

Endpoint: POST /store/attentive/opt-in Authentication: Customer (Optional)

Description

POST /store/attentive/opt-in Explicit SMS opt-in when customer checks the "Get 10% off" checkbox. This is the ONLY place Attentive sync should happen during checkout. Returns the phone that was synced so frontend can track it and avoid duplicates.

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/store/attentive/opt-in' \
  -H 'Content-Type: application/json'

GET Store Bundle-products :id

Endpoint: GET /store/bundle-products/:id Authentication: Customer (Optional)

URL Parameters

Response

Success:

// Response structure (to be documented)

Example Request

curl -X GET 'https://your-store.omnicart.cc/store/bundle-products/:id' \
  -H 'Content-Type: application/json'

GET Store Custom

Endpoint: GET /store/custom Authentication: Customer (Optional)

Response

Success:

// Response structure (to be documented)

Example Request

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

POST Store Flow-builder Accept

Endpoint: POST /store/flow-builder/accept Authentication: Customer (Optional)

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/store/flow-builder/accept' \
  -H 'Content-Type: application/json'

GET Store Flow-builder Button :buttonId

Endpoint: GET /store/flow-builder/button/:buttonId Authentication: Customer (Optional)

Description

// GET /store/flow-builder/button/:buttonId - Get button details

URL Parameters

Response

Success:

// Response structure (to be documented)

Example Request

curl -X GET 'https://your-store.omnicart.cc/store/flow-builder/button/:buttonId' \
  -H 'Content-Type: application/json'

POST Store Flow-builder Decline

Endpoint: POST /store/flow-builder/decline Authentication: Customer (Optional)

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/store/flow-builder/decline' \
  -H 'Content-Type: application/json'

POST Store Flow-builder Init

Endpoint: POST /store/flow-builder/init Authentication: Customer (Optional)

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/store/flow-builder/init' \
  -H 'Content-Type: application/json'

POST Store Flow-builder Init-with-order

Endpoint: POST /store/flow-builder/init-with-order Authentication: Customer (Optional)

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/store/flow-builder/init-with-order' \
  -H 'Content-Type: application/json'

GET Store Flow-builder Receipt

Endpoint: GET /store/flow-builder/receipt Authentication: Customer (Optional)

Description

// GET /store/flow-builder/receipt - Get receipt for current session

Response

Success:

// Response structure (to be documented)

Example Request

curl -X GET 'https://your-store.omnicart.cc/store/flow-builder/receipt' \
  -H 'Content-Type: application/json'

GET Store Membership Status

Endpoint: GET /store/membership/status Authentication: Customer (Optional)

Description

GET /store/membership/status?order_id= Returns FLP/TRN membership credentials stored in order metadata. Used by the storefront checkout-success page to display the password.

Response

Success:

// Response structure (to be documented)

Example Request

curl -X GET 'https://your-store.omnicart.cc/store/membership/status' \
  -H 'Content-Type: application/json'

POST Store Oauth Token

Endpoint: POST /store/oauth/token Authentication: Customer (Optional)

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/store/oauth/token' \
  -H 'Content-Type: application/json'

POST Store Payment-intent Update-amount

Endpoint: POST /store/payment-intent/update-amount Authentication: Customer (Optional)

Description

POST /store/payment-intent/update-amount Updates a Stripe PaymentIntent's amount without changing the clientSecret. This allows updating the cart total (e.g., after tax/shipping calculation) without remounting Stripe Elements and losing user input. Critical for Express Checkout flows (Apple Pay/Google Pay) where we need to update the amount based on shipping address changes (tax calculation). Uses custom StripeProviderService which extends the platform's Stripe provider with additional methods for PaymentIntent updates. Stripe allows updating PaymentIntent amounts as long as the status is 'requires_payment_method', 'requires_confirmation', or 'requires_action'.

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/store/payment-intent/update-amount' \
  -H 'Content-Type: application/json'

GET Store Payment-methods :account_holder_id

Endpoint: GET /store/payment-methods/:account_holder_id Authentication: Customer (Optional)

URL Parameters

Response

Success:

// Response structure (to be documented)

Example Request

curl -X GET 'https://your-store.omnicart.cc/store/payment-methods/:account_holder_id' \
  -H 'Content-Type: application/json'

GET Store Payment-sessions

Endpoint: GET /store/payment-sessions Authentication: Customer (Optional)

Description

GET /store/payment-sessions List payment sessions for a collection with filters

Response

Success:

// Response structure (to be documented)

Example Request

curl -X GET 'https://your-store.omnicart.cc/store/payment-sessions' \
  -H 'Content-Type: application/json'

DELETE Store Payment-sessions

Endpoint: DELETE /store/payment-sessions Authentication: Customer (Optional)

Description

DELETE /store/payment-sessions Delete specific payment sessions with retry logic

Response

Success:

// Response structure (to be documented)

Example Request

curl -X DELETE 'https://your-store.omnicart.cc/store/payment-sessions' \
  -H 'Content-Type: application/json'

POST Store Payment Confirm-with-token

Endpoint: POST /store/payment/confirm-with-token Authentication: Customer (Optional)

Description

POST /store/payment/confirm-with-token Stripe's recommended two-step confirmation flow for one-page checkouts: 1. Client creates ConfirmationToken (contains payment method + billing details) 2. Server creates PaymentIntent with FINAL amount (after tax calculation) 3. Server confirms payment using ConfirmationToken This avoids updating PaymentIntent amounts which can cause Elements to remount. Reference: https://docs.stripe.com/payments/accept-a-payment-deferred

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/store/payment/confirm-with-token' \
  -H 'Content-Type: application/json'

GET Store Products :id Pdp-sections

Endpoint: GET /store/products/:id/pdp-sections Authentication: Customer (Optional)

Description

GET /store/products/:id/pdp-sections Get visible PDP sections for a product (storefront) Reads from product.metadata.pdp_sections

URL Parameters

Response

Success:

// Response structure (to be documented)

Example Request

curl -X GET 'https://your-store.omnicart.cc/store/products/:id/pdp-sections' \
  -H 'Content-Type: application/json'

GET Store Products :id Reviews

Endpoint: GET /store/products/:id/reviews Authentication: Customer (Optional)

URL Parameters

Response

Success:

// Response structure (to be documented)

Example Request

curl -X GET 'https://your-store.omnicart.cc/store/products/:id/reviews' \
  -H 'Content-Type: application/json'

POST Store Products :id Track-view

Endpoint: POST /store/products/:id/track-view Authentication: Customer (Optional)

Description

POST /store/products/:id/track-view Storefront product-page view emitter. Publishes a product.viewed event onto the platform event bus; the existing attentive-product-viewed subscriber listens for it and pushes the "Product Viewed" custom event to Attentive. Why this route exists: product.viewed is NOT a built-in platform event. It only fires when this endpoint is hit, typically once per product page mount on the storefront. The Attentive subscriber maintains its own 5-minute in-memory dedup per (product, customer) pair, so rapid page refreshes / re-mounts won't flood Attentive.

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/store/products/:id/track-view' \
  -H 'Content-Type: application/json'

POST Store Reviews

Endpoint: POST /store/reviews Authentication: Customer (Optional)

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/store/reviews' \
  -H 'Content-Type: application/json'

GET Store Sites By-domain

Endpoint: GET /store/sites/by-domain Authentication: Customer (Optional)

Response

Success:

// Response structure (to be documented)

Example Request

curl -X GET 'https://your-store.omnicart.cc/store/sites/by-domain' \
  -H 'Content-Type: application/json'