Integrations

Category: Admin Base URL: /admin/integrations Authentication: Required Routes: 7 routes documented

Overview#

This section documents 7 API routes for integrations.

⚠️ 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#

Method	Endpoint	Description
GET	`/admin/integrations/github/repos`	No description
POST	`/admin/integrations/providers/:provider/app-config`	No description
POST	`/admin/integrations/providers/:provider/authorize`	No description
GET	`/admin/integrations/providers/:provider/callback`	No description
GET	`/admin/integrations/vercel/projects`	No description
GET	`/admin/integrations/vercel/teams`	No description
GET	`/admin/oauth/clients`	No description
POST	`/admin/oauth/clients`	No description

GET Admin Integrations Github Repos#

Endpoint: GET /admin/integrations/github/repos Authentication: Admin (Required)

Response#

Success:

{
  repos,
}

Example Request#

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

POST Admin Integrations Providers :provider App-config#

Endpoint: POST /admin/integrations/providers/:provider/app-config Authentication: Admin (Required)

URL Parameters#

Parameter	Type	Required	Description
`provider`	string	Yes	Provider identifier

Request Body#

Field	Type	Required
`client_id`	string	Yes
`client_secret`	string	Yes
`scopes`	array	No
`callback_url`	unknown	Yes
`description`	string	No
`environment`	enum(development, staging, production)	No

Response#

Success:

{
  success,
}

Error (400):

{
  success,
  error,
}

Example Request#

curl -X POST 'https://your-store.omnicart.cc/admin/integrations/providers/:provider/app-config' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

POST Admin Integrations Providers :provider Authorize#

Endpoint: POST /admin/integrations/providers/:provider/authorize Authentication: Admin (Required)

URL Parameters#

Parameter	Type	Required	Description
`provider`	string	Yes	Provider identifier

Request Body#

Field	Type	Required
`environment`	enum(development, staging, production)	No
`scope`	array	No
`extra_params`	record	No
`metadata`	record	No
`identifier`	string	No
`store_id`	string	No
`account_id`	string	No
`redirect`	string	No

Response#

Success:

{
  success,
  url,
  state,
}

Error (400):

{
  success,
  error,
}

Error (400):

{
  success,
  error,
}

Error (400):

{
  success,
  error,
}

Error (400):

{
  success,
  error,
}

Error (500):

{
  success,
  error,
}

Example Request#

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

GET Admin Integrations Providers :provider Callback#

Endpoint: GET /admin/integrations/providers/:provider/callback Authentication: Admin (Required)

URL Parameters#

Parameter	Type	Required	Description
`provider`	string	Yes	Provider identifier

Response#

Error (400):

{
  success,
  error,
}

Error (400):

{
  success,
  error,
}

Error (400):

{
  success,
  error,
}

Error (400):

{
  success,
  error,
}

Error (400):

{
  success,
  error,
}

Example Request#

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

GET Admin Integrations Vercel Projects#

Endpoint: GET /admin/integrations/vercel/projects Authentication: Admin (Required)

Response#

Success:

{
  projects,
}

Example Request#

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

GET Admin Integrations Vercel Teams#

Endpoint: GET /admin/integrations/vercel/teams Authentication: Admin (Required)

Response#

Success:

{
  teams,
  user,
}

Example Request#

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

GET Admin Oauth Clients#

Endpoint: GET /admin/oauth/clients Authentication: Admin (Required)

Response#

Success:

{
  clients,
}

Example Request#

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

POST Admin Oauth Clients#

Endpoint: POST /admin/oauth/clients Authentication: Admin (Required)

Request Body#

Field	Type	Required
`name`	string	Yes
`description`	string	No
`scopes`	array	No
`metadata`	record	No

Response#

Success (201):

{
  client_id,
  client_secret,
  scopes,
}

Error (400):

{
  error,
  details,
}

Error (400):

{
  error,
  message,
}

Error (500):

{
  error,
  message,
}

Example Request#

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