Skip to main content
POST
/
v1
/
partner
/
register
Register as a partner brand
curl --request POST \
  --url http://localhost:3000/v1/partner/register \
  --header 'Content-Type: application/json' \
  --data '
{
  "company_name": "<string>",
  "contact_email": "jsmith@example.com",
  "contact_phone": "<string>",
  "business_type": "manufacturer",
  "return_address_line1": "<string>",
  "return_address_line2": "<string>",
  "return_city": "<string>",
  "return_state": "<string>",
  "return_postal_code": "<string>",
  "return_country_code": "US",
  "company_logo_url": "<string>",
  "website_url": "<string>"
}
'
{
  "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"
  }
}

Body

application/json
company_name
string
required
Minimum string length: 1
contact_email
string<email>
required
contact_phone
string
business_type
enum<string>
Available options:
manufacturer,
distributor,
artisan,
farm,
importer,
other
return_address_line1
string
return_address_line2
string
return_city
string
return_state
string
return_postal_code
string
return_country_code
string
default:US
company_logo_url
string<uri>
website_url
string<uri>

Response

Partner brand created

partner_brand
object
required