Other

Category: Public Base URL: / Authentication: Mixed Routes: 14 routes documented

Overview#

This section documents 14 API routes for other.

Quick Reference#

GET Root#

Endpoint: GET / Authentication: Public (Optional)

Description#

GET / - Redirect root path to /app (admin dashboard) This ensures that accessing the root URL automatically redirects users to the admin dashboard at /app

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

OPTIONS Arteriorestore Config.json#

Endpoint: OPTIONS /arteriorestore/config.json Authentication: Public (Optional)

Description#

GET /arteriorestore/config.json Runtime config for the funnel page at arteriorestore.com/order. Keeps the Stripe publishable key and the region id OUT of the committed page source, so swapping from prevail's sandbox account to BRB's own is a heroku config:set, not a redeploy of the storefront. Everything returned here is PUBLIC by design — a Stripe publishable key and a OmniCart publishable API key are both meant to ship to browsers. Never add the secret key or anything else server-only to this payload. The region is looked up rather than hardcoded so a reseeded environment doesn't silently serve a stale id (which surfaces as "Missing required pricing context" and no prices rendering).

Response#

Error (404):

{
  error,
}

Example Request#

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

GET Arteriorestore Config.json#

Endpoint: GET /arteriorestore/config.json Authentication: Public (Optional)

Response#

Success:

{
  regionId,
  stripePublishableKey,
  paymentEnabled,
}

Error (404):

{
  error,
}

Example Request#

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

OPTIONS Arteriorestore Order-summary :id#

Endpoint: OPTIONS /arteriorestore/order-summary/:id Authentication: Public (Optional)

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 OPTIONS 'https://your-store.omnicart.cc/arteriorestore/order-summary/:id' \
  -H 'Content-Type: application/json'

GET Arteriorestore Order-summary :id#

Endpoint: GET /arteriorestore/order-summary/:id Authentication: Public (Optional)

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/arteriorestore/order-summary/:id' \
  -H 'Content-Type: application/json'

POST Auth Demo-magic-link#

Endpoint: POST /auth/demo-magic-link Authentication: Public (Optional)

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:

{
  token,
}

Error (400):

{
  error,
}

Error (503):

{
  error,
}

Error (401):

{
  error,
}

Error (401):

{
  error,
}

Error (403):

{
  error,
}

Error (401):

{
  error,
}

Error (503):

{
  error,
}

Error (403):

{
  error,
}

Error (403):

{
  error,
}

Error (403):

{
  error,
}

Example Request#

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

POST Auth Store-sso#

Endpoint: POST /auth/store-sso Authentication: Public (Optional)

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:

{
  token,
}

Error (400):

{
  error,
}

Error (503):

{
  error,
}

Error (401):

{
  error,
}

Error (403):

{
  error,
}

Error (401):

{
  error,
}

Error (401):

{
  error,
}

Error (403):

{
  error,
}

Error (403):

{
  error,
}

Example Request#

curl -X POST 'https://your-store.omnicart.cc/auth/store-sso' \
  -H 'Content-Type: application/json'

GET Health#

Endpoint: GET /health Authentication: Public (Optional)

Response#

Success:

{
  status,
  version,
  commit,
  built_at,
  node_env,
  time,
}

Example Request#

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

POST Hooks Payment Stripe#

Endpoint: POST /hooks/payment/stripe Authentication: Public (Optional)

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

{
  received,
  skipped,
  reason,
  eventId,
  eventType,
}

Also returns (200):

{
  received,
  skipped,
  reason,
  eventId,
  eventType,
  sessionId,
}

Also returns (200):

{
  received,
  skipped,
  reason,
  eventId,
  eventType,
  sessionId,
}

Error (400):

{
  error,
  hint,
}

Example Request#

curl -X POST 'https://your-store.omnicart.cc/hooks/payment/stripe' \
  -H 'Content-Type: application/json'

POST Hooks Payment Stripe_stripe#

Endpoint: POST /hooks/payment/stripe_stripe Authentication: Public (Optional)

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

{
  received,
  skipped,
  reason,
  eventId,
  eventType,
}

Also returns (200):

{
  received,
  skipped,
  reason,
  eventId,
  eventType,
  sessionId,
  sessionStatus,
}

Also returns (200):

{
  received,
  skipped,
  reason,
  eventId,
  eventType,
  sessionId,
  sessionStatus,
}

Also returns (200):

{
  received,
  skipped,
  reason,
  eventId,
  eventType,
  sessionId,
}

Also returns (200):

{
  received,
  eventId,
  eventType,
}

Error (400):

{
  error,
}

Example Request#

curl -X POST 'https://your-store.omnicart.cc/hooks/payment/stripe_stripe' \
  -H 'Content-Type: application/json'

GET Hooks Pipeline-health#

Endpoint: GET /hooks/pipeline-health Authentication: Public (Optional)

Description#

// GET /hooks/pipeline-health - Run the order-pipeline health checks and alert on failures. Web-dyno entry point for an external pinger, so alerting survives a dead worker scheduler.

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/hooks/pipeline-health' \
  -H 'Content-Type: application/json'

POST Hooks Pipeline-health#

Endpoint: POST /hooks/pipeline-health Authentication: Public (Optional)

Description#

// POST /hooks/pipeline-health - Same as GET; accepts POST so pingers that only issue POSTs work unchanged.

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#

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/hooks/pipeline-health' \
  -H 'Content-Type: application/json'

POST Internal Evidence Canonical-receipt V1#

Endpoint: POST /internal/evidence/canonical-receipt/v1 Authentication: Public (Optional)

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

Example Request#

curl -X POST 'https://your-store.omnicart.cc/internal/evidence/canonical-receipt/v1' \
  -H 'Content-Type: application/json'

POST Internal Evidence Purchase#

Endpoint: POST /internal/evidence/purchase Authentication: Public (Optional)

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

Example Request#

curl -X POST 'https://your-store.omnicart.cc/internal/evidence/purchase' \
  -H 'Content-Type: application/json'

POST Internal Evidence Refund#

Endpoint: POST /internal/evidence/refund Authentication: Public (Optional)

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

Example Request#

curl -X POST 'https://your-store.omnicart.cc/internal/evidence/refund' \
  -H 'Content-Type: application/json'

GET Internal Evidence Safety#

Endpoint: GET /internal/evidence/safety Authentication: Public (Optional)

Response#

Success:

{
  ready,
  test_mode,
  scope,
  release,
}

Also returns:

{
  error,
}

Example Request#

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

POST Internal Evidence Status#

Endpoint: POST /internal/evidence/status Authentication: Public (Optional)

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

Example Request#

curl -X POST 'https://your-store.omnicart.cc/internal/evidence/status' \
  -H 'Content-Type: application/json'