Brands Products

Category: Admin Base URL: /admin/brands Authentication: Required Routes: 10 routes documented

Overview

This section documents 10 API routes for brands products.

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

GET Admin Brands

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

Description

GET /admin/brands List all brands with optional filtering and pagination

Response

Success:

// Response structure (to be documented)

Example Request

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

POST Admin Brands

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

Description

POST /admin/brands Create a new brand

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

GET Admin Brands :id

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

Description

GET /admin/brands/:id Retrieve a single brand by ID

URL Parameters

Response

Success:

// Response structure (to be documented)

Example Request

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

POST Admin Brands :id

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

Description

POST /admin/brands/:id Update a brand

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/brands/:id' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

DELETE Admin Brands :id

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

Description

DELETE /admin/brands/:id Delete a brand

URL Parameters

Response

Success:

// Response structure (to be documented)

Example Request

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

GET Admin Brands :id Avatars

Endpoint: GET /admin/brands/:id/avatars Authentication: Admin (Required)

Description

GET /admin/brands/:id/avatars List all customer avatars for a brand

URL Parameters

Response

Success:

// Response structure (to be documented)

Example Request

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

POST Admin Brands :id Avatars

Endpoint: POST /admin/brands/:id/avatars Authentication: Admin (Required)

Description

POST /admin/brands/:id/avatars Create a new customer avatar for a brand

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/brands/:id/avatars' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

GET Admin Brands :id Avatars :avatarId

Endpoint: GET /admin/brands/:id/avatars/:avatarId Authentication: Admin (Required)

Description

GET /admin/brands/:id/avatars/:avatarId Retrieve a single customer avatar by ID

URL Parameters

Response

Success:

// Response structure (to be documented)

Example Request

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

POST Admin Brands :id Avatars :avatarId

Endpoint: POST /admin/brands/:id/avatars/:avatarId Authentication: Admin (Required)

Description

POST /admin/brands/:id/avatars/:avatarId Update a customer avatar

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/brands/:id/avatars/:avatarId' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

DELETE Admin Brands :id Avatars :avatarId

Endpoint: DELETE /admin/brands/:id/avatars/:avatarId Authentication: Admin (Required)

Description

DELETE /admin/brands/:id/avatars/:avatarId Delete a customer avatar

URL Parameters

Response

Success:

// Response structure (to be documented)

Example Request

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

GET Admin Products :id Cogs Locations

Endpoint: GET /admin/products/:id/cogs/locations Authentication: Admin (Required)

URL Parameters

Response

Success:

// Response structure (to be documented)

Example Request

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

POST Admin Products :id Cogs Replenishment-policy

Endpoint: POST /admin/products/:id/cogs/replenishment-policy 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/products/:id/cogs/replenishment-policy' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

POST Admin Products :id Duplicate

Endpoint: POST /admin/products/:id/duplicate Authentication: Admin (Required)

Description

POST /admin/products/:id/duplicate Duplicates a product with all its variants, options, and pricing. The duplicated product is created as a draft with " (Copy)" appended to the title.

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/products/:id/duplicate' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

GET Admin Products :id Pdp-sections

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

Description

GET /admin/products/:id/pdp-sections List all PDP sections for a product (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/admin/products/:id/pdp-sections' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

POST Admin Products :id Pdp-sections

Endpoint: POST /admin/products/:id/pdp-sections Authentication: Admin (Required)

Description

POST /admin/products/:id/pdp-sections Create a new PDP section for a product (stores in product.metadata.pdp_sections)

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/products/:id/pdp-sections' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

GET Admin Products :id Pdp-sections :section_id

Endpoint: GET /admin/products/:id/pdp-sections/:section_id Authentication: Admin (Required)

Description

GET /admin/products/:id/pdp-sections/:section_id Get a specific PDP section (from product.metadata.pdp_sections)

URL Parameters

Response

Success:

// Response structure (to be documented)

Example Request

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

POST Admin Products :id Pdp-sections :section_id

Endpoint: POST /admin/products/:id/pdp-sections/:section_id Authentication: Admin (Required)

Description

POST /admin/products/:id/pdp-sections/:section_id Update a PDP section (in product.metadata.pdp_sections)

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/products/:id/pdp-sections/:section_id' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

DELETE Admin Products :id Pdp-sections :section_id

Endpoint: DELETE /admin/products/:id/pdp-sections/:section_id Authentication: Admin (Required)

Description

DELETE /admin/products/:id/pdp-sections/:section_id Delete a PDP section (from product.metadata.pdp_sections)

URL Parameters

Response

Success:

// Response structure (to be documented)

Example Request

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

GET Admin Products :id Variants :variant_id Cogs

Endpoint: GET /admin/products/:id/variants/:variant_id/cogs Authentication: Admin (Required)

URL Parameters

Response

Success:

// Response structure (to be documented)

Example Request

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