Skip to main content
GET
/
v1
/
admin
/
partners
/
brands
/
{id}
/
detail
Get partner brand detail with products and sales
curl --request GET \
  --url http://localhost:3000/v1/admin/partners/brands/{id}/detail
{
  "partner_brand": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "brand_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "company_name": "<string>",
    "contact_email": "jsmith@example.com",
    "contact_phone": "<string>",
    "business_type": "<string>",
    "company_logo_url": "<string>",
    "website_url": "<string>",
    "return_address_line1": "<string>",
    "return_address_line2": "<string>",
    "return_city": "<string>",
    "return_state": "<string>",
    "return_postal_code": "<string>",
    "return_country_code": "<string>",
    "payout_method": "ach",
    "approval_status": "pending",
    "approved_at": "2023-11-07T05:31:56Z",
    "rejection_reason": "<string>",
    "default_commission_rate_ambient": 123,
    "default_commission_rate_cold": 123,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "products": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "image_url": "<string>",
      "selling_price": 123,
      "temperature_zone": "<string>",
      "is_active": true,
      "commission_rate": 123,
      "partner_wholesale_price": 123,
      "partner_pricing_model": "<string>"
    }
  ],
  "sales_summary": {
    "total_units_sold": 123,
    "total_revenue": 123,
    "total_commission": 123,
    "total_net_to_partner": 123
  }
}

Path Parameters

id
string<uuid>
required

Response

Partner brand detail with products and sales

partner_brand
object
required
products
object[]
required
sales_summary
object
required