Brands Products

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

Overview#

This section documents 13 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:

{
  brands,
  count,
  offset,
  limit,
}

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#

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

{
  brand,
}

Error (400):

{
  message,
  error,
}

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:

{
  brand,
}

Error (404):

{
  message,
  error,
}

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#

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:

{
  brand,
}

Error (400):

{
  message,
  error,
}

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

{
  id,
  deleted,
}

Error (400):

{
  message,
  error,
}

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:

{
  avatars,
  count,
}

Error (400):

{
  message,
  error,
}

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#

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

{
  avatar,
}

Error (400):

{
  message,
  error,
}

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:

{
  avatar,
}

Error (404):

{
  message,
  error,
}

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#

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:

{
  avatar,
}

Error (400):

{
  message,
  error,
}

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

{
  id,
  deleted,
}

Error (400):

{
  message,
  error,
}

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:

{
  module_enabled,
  product_id,
  currency_code,
  locations,
}

Also returns:

{
  module_enabled,
  product_id,
  currency_code,
  locations,
}

Also returns:

{
  module_enabled,
  product_id,
  currency_code,
  locations,
}

Also returns:

{
  module_enabled,
  product_id,
  currency_code,
  locations,
}

Error (404):

{
  module_enabled,
  product_id,
  currency_code,
  locations,
  message,
}

Error (404):

{
  module_enabled,
  product_id,
  currency_code,
  locations,
  message,
  error,
}

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#

Response#

Success (200):

{
  policy,
}

Error (400):

{
  message,
}

Error (400):

{
  message,
  issues,
}

Error (500):

{
  message,
  error,
}

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#

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

{
  product,
  message,
}

Error (400):

{
  message,
}

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:

{
  sections,
}

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#

Response#

Success:

{
  section,
}

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:

{
  section,
}

Error (404):

{
  message,
}

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#

Response#

Success:

{
  section,
}

Error (404):

{
  message,
}

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:

{
  success,
}

Error (404):

{
  message,
}

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 Sku-aliases#

Endpoint: GET /admin/products/:id/sku-aliases Authentication: Admin (Required)

Description#

GET /admin/products/[id]/sku-aliases Product-scoped read of warehouse SKU aliases. Resolves the product's variant SKUs server-side and returns the aliases grouped by variant so the admin widget can render "what warehouse SKUs map to this product?" without firing one request per variant. The join is by omni_sku (= variant SKU) in application code — there is no module link between warehouse_sku_alias and product/variant, matching how the service's findByMedusaSku already works. Query params: - stock_location_id: optional; scope aliases to a single location. Omitted = all locations (each enriched with location_name via Modules.STOCK_LOCATION). Response: { product_id, variants: [{ variant_id, sku, title, aliases: [...] }], total_aliases }

URL Parameters#

Response#

Success:

{
  product_id,
  variants,
  total_aliases,
}

Error (500):

{
  error,
}

Example Request#

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

{
  module_enabled,
  product_id,
  variant_id,
  summary,
  locations,
  records,
}

Also returns:

{
  module_enabled,
  product_id,
  variant_id,
  summary,
  locations,
  records,
}

Also returns:

{
  module_enabled,
  product_id,
  variant_id,
  summary,
  currency_code,
  locations,
  records,
}

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'

GET Admin Products :id Variants :variant_id Sellability#

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

URL Parameters#

Response#

Success:

{
  variant_id,
  sku,
  manage_inventory,
  available,
  broken,
  for_sale,
  actions_enabled,
}

Error (404):

{
  error,
}

Example Request#

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

POST Admin Products :id Variants :variant_id Sellability#

Endpoint: POST /admin/products/:id/variants/:variant_id/sellability Authentication: Admin (Required)

URL Parameters#

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#

Error (400):

{
  error,
}

Error (503):

{
  error,
  hint,
}

Error (404):

{
  error,
}

Error (500):

{
  error,
}

Example Request#

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

GET Admin Products :id Variants :variant_id Storefront-availability#

Endpoint: GET /admin/products/:id/variants/:variant_id/storefront-availability Authentication: Admin (Required)

URL Parameters#

Response#

Success:

{
  variant_id,
  sku,
  storefront_out_of_stock,
}

Error (404):

{
  error,
}

Example Request#

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

POST Admin Products :id Variants :variant_id Storefront-availability#

Endpoint: POST /admin/products/:id/variants/:variant_id/storefront-availability Authentication: Admin (Required)

URL Parameters#

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:

{
  variant_id,
  sku,
  storefront_out_of_stock,
}

Error (400):

{
  error,
}

Error (404):

{
  error,
}

Error (500):

{
  error,
}

Example Request#

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