# 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

| Method | Endpoint | Description |
|--------|----------|-------------|
| GET | `/admin/partners` | No description |
| GET | `/admin/partners/:id` | GET /admin/partners/:id - Retrieve partner details |
| PATCH | `/admin/partners/:id` | PATCH /admin/partners/:id - Update partner details |
| POST | `/admin/partners/:id/offers` | No description |
| DELETE | `/admin/partners/:id/offers/:partnerOfferId` | No description |
| GET | `/admin/partners/commissions` | No description |
| GET | `/admin/partners/commissions/:id` | No description |
| POST | `/admin/partners/commissions/:id/approve` | No description |
| POST | `/admin/partners/commissions/:id/decline` | No description |
| PATCH | `/admin/partners/commissions/:id/notes` | No description |
| POST | `/admin/partners/commissions/bulk/approve` | No description |
| POST | `/admin/partners/commissions/bulk/decline` | No description |
| POST | `/admin/partners/commissions/bulk/mark-paid` | No description |
| GET | `/admin/partners/offers` | No description |
| POST | `/admin/partners/offers` | No description |
| GET | `/admin/partners/offers/:id` | No description |
| PATCH | `/admin/partners/offers/:id/manage` | No description |
| GET | `/admin/partners/reports/attribution` | No description |
| GET | `/admin/partners/reports/summary` | No description |

---

## GET Admin Partners

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

### Response

**Success:**
```typescript
{
  partners,
  count,
  limit,
  offset,
}
```

### Example Request

```bash
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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Id identifier |

### Response

**Success:**
```typescript
{
  partner,
}
```

### Example Request

```bash
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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Id identifier |

### 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:**
```typescript
{
  partner,
}
```

**Error (404):**
```typescript
{
  message,
}
```
**Error (400):**
```typescript
{
  message,
}
```
**Error (500):**
```typescript
{
  message,
  detail,
}
```

### Example Request

```bash
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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Id identifier |

### 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):**
```typescript
{
  partner_offer,
  offer,
}
```

**Error (400):**
```typescript
{
  message,
}
```
**Error (409):**
```typescript
{
  message,
}
```
**Error (404):**
```typescript
{
  message,
}
```
**Error (500):**
```typescript
{
  message,
  detail,
}
```

### Example Request

```bash
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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Id identifier |
| `partnerOfferId` | string | Yes | PartnerOfferId identifier |

### Response

**Error (404):**
```typescript
{
  message,
}
```

### Example Request

```bash
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:**
```typescript
{
  commissions,
  count,
  limit,
  offset,
  stats,
}
```

### Example Request

```bash
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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Id identifier |

### Response

**Success:**
```typescript
{
  commission,
}
```

### Example Request

```bash
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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Id identifier |

### 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:**
```typescript
{
  commission,
}
```

### Example Request

```bash
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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Id identifier |

### 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:**
```typescript
{
  commission,
}
```

### Example Request

```bash
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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Id identifier |

### 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:**
```typescript
{
  commission,
}
```

**Error (400):**
```typescript
{
  message,
}
```

### Example Request

```bash
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):**
```typescript
{
  message,
}
```

### Example Request

```bash
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):**
```typescript
{
  message,
}
```

### Example Request

```bash
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):**
```typescript
{
  message,
}
```

### Example Request

```bash
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:**
```typescript
{
  offers,
  count,
  limit,
  offset,
}
```

### Example Request

```bash
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):**
```typescript
{
  offer,
}
```

**Error (400):**
```typescript
{
  message,
}
```
**Error (500):**
```typescript
{
  message,
  detail,
}
```

### Example Request

```bash
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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Id identifier |

### Response

**Error (404):**
```typescript
{
  message,
}
```

### Example Request

```bash
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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Id identifier |

### 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):**
```typescript
{
  message,
}
```
**Error (500):**
```typescript
{
  message,
  detail,
}
```

### Example Request

```bash
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:**
```typescript
{
  summary,
}
```

### Example Request

```bash
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:**
```typescript
{
  summary,
}
```

### Example Request

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

---