Partners Commissions

Category: Admin Base URL: /admin/partners Authentication: Required Routes: 17 routes documented

Overview#

This section documents 17 API routes for partners commissions.

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

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

Response#

Success:

{
  partners,
  count,
  limit,
  offset,
}

Example Request#

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

GET Admin Partners :id#

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

Description#

GET /admin/partners/:id - Retrieve partner details

URL Parameters#

Response#

Success:

{
  partner,
}

Example Request#

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

PATCH Admin Partners :id#

Endpoint: PATCH /admin/partners/:id Authentication: Admin (Required)

Description#

PATCH /admin/partners/:id - Update partner details

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:

{
  partner,
}

Error (404):

{
  message,
}

Error (400):

{
  message,
}

Error (500):

{
  message,
  detail,
}

Example Request#

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

POST Admin Partners :id Offers#

Endpoint: POST /admin/partners/:id/offers 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 (201):

{
  partner_offer,
  offer,
}

Error (400):

{
  message,
}

Error (409):

{
  message,
}

Error (404):

{
  message,
}

Error (500):

{
  message,
  detail,
}

Example Request#

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

DELETE Admin Partners :id Offers :partnerOfferId#

Endpoint: DELETE /admin/partners/:id/offers/:partnerOfferId Authentication: Admin (Required)

URL Parameters#

Response#

Error (404):

{
  message,
}

Example Request#

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

GET Admin Partners Commissions#

Endpoint: GET /admin/partners/commissions Authentication: Admin (Required)

Response#

Success:

{
  commissions,
  count,
  limit,
  offset,
  stats,
}

Example Request#

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

GET Admin Partners Commissions :id#

Endpoint: GET /admin/partners/commissions/:id Authentication: Admin (Required)

URL Parameters#

Response#

Success:

{
  commission,
}

Example Request#

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

POST Admin Partners Commissions :id Approve#

Endpoint: POST /admin/partners/commissions/:id/approve 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:

{
  commission,
}

Example Request#

curl -X POST 'https://your-store.omnicart.cc/admin/partners/commissions/:id/approve' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

POST Admin Partners Commissions :id Decline#

Endpoint: POST /admin/partners/commissions/:id/decline 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:

{
  commission,
}

Example Request#

curl -X POST 'https://your-store.omnicart.cc/admin/partners/commissions/:id/decline' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

PATCH Admin Partners Commissions :id Notes#

Endpoint: PATCH /admin/partners/commissions/:id/notes 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:

{
  commission,
}

Error (400):

{
  message,
}

Example Request#

curl -X PATCH 'https://your-store.omnicart.cc/admin/partners/commissions/:id/notes' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

POST Admin Partners Commissions Bulk Approve#

Endpoint: POST /admin/partners/commissions/bulk/approve Authentication: Admin (Required)

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

{
  message,
}

Example Request#

curl -X POST 'https://your-store.omnicart.cc/admin/partners/commissions/bulk/approve' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

POST Admin Partners Commissions Bulk Decline#

Endpoint: POST /admin/partners/commissions/bulk/decline Authentication: Admin (Required)

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

{
  message,
}

Example Request#

curl -X POST 'https://your-store.omnicart.cc/admin/partners/commissions/bulk/decline' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

POST Admin Partners Commissions Bulk Mark-paid#

Endpoint: POST /admin/partners/commissions/bulk/mark-paid Authentication: Admin (Required)

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

{
  message,
}

Example Request#

curl -X POST 'https://your-store.omnicart.cc/admin/partners/commissions/bulk/mark-paid' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

GET Admin Partners Offers#

Endpoint: GET /admin/partners/offers Authentication: Admin (Required)

Response#

Success:

{
  offers,
  count,
  limit,
  offset,
}

Example Request#

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

POST Admin Partners Offers#

Endpoint: POST /admin/partners/offers Authentication: Admin (Required)

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

{
  offer,
}

Error (400):

{
  message,
}

Error (500):

{
  message,
  detail,
}

Example Request#

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

GET Admin Partners Offers :id#

Endpoint: GET /admin/partners/offers/:id Authentication: Admin (Required)

URL Parameters#

Response#

Error (404):

{
  message,
}

Example Request#

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

PATCH Admin Partners Offers :id Manage#

Endpoint: PATCH /admin/partners/offers/:id/manage 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 (404):

{
  message,
}

Error (500):

{
  message,
  detail,
}

Example Request#

curl -X PATCH 'https://your-store.omnicart.cc/admin/partners/offers/:id/manage' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

GET Admin Partners Reports Attribution#

Endpoint: GET /admin/partners/reports/attribution Authentication: Admin (Required)

Response#

Success:

{
  summary,
}

Example Request#

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

GET Admin Partners Reports Summary#

Endpoint: GET /admin/partners/reports/summary Authentication: Admin (Required)

Response#

Success:

{
  summary,
}

Example Request#

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