Opply Brands API

openapi: 3.0.3
info:
  title: Opply Activity Feed Brands API
  version: 0.0.0
tags:
- name: Brands
paths:
  /api/v1/companies/accessible/me/:
    get:
      operationId: api_v1_companies_accessible_me_retrieve
      description: 'Returns the set of companies the authenticated user can target in API calls.


        - Staff users: marker response indicating "all" — no list is returned.

        - Merchant of Record users: their managed companies plus their own.

        - Brand (buyer) and Supplier users: their own company only.


        Used by the MCP `list_accessible_companies` tool. Also useful for any client

        that needs to render a company-picker scoped to the user''s permissions.'
      summary: List companies the current user can act on
      tags:
      - Brands
      security:
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          description: No response body
  /api/v1/companies/addresses/:
    get:
      operationId: api_v1_companies_addresses_list
      summary: Company address endpoints
      parameters:
      - in: query
        name: address_type
        schema:
          type: string
        description: 'Supported address types: billing_address delivery_address dispatch_address company_address.'
      - name: page
        required: false
        in: query
        description: A page number within the paginated result set.
        schema:
          type: integer
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      tags:
      - Brands
      security:
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedCompanyAddressList'
          description: ''
    post:
      operationId: api_v1_companies_addresses_create
      summary: Company address endpoints
      tags:
      - Brands
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CompanyAddress'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CompanyAddress'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/CompanyAddress'
        required: true
      security:
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompanyAddress'
          description: ''
  /api/v1/companies/addresses/{id}/:
    get:
      operationId: api_v1_companies_addresses_retrieve
      summary: Company address endpoints
      parameters:
      - in: path
        name: id
        schema:
          type: string
        required: true
      tags:
      - Brands
      security:
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompanyAddress'
          description: ''
    put:
      operationId: api_v1_companies_addresses_update
      summary: Company address endpoints
      parameters:
      - in: path
        name: id
        schema:
          type: string
        required: true
      tags:
      - Brands
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CompanyAddress'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CompanyAddress'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/CompanyAddress'
        required: true
      security:
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompanyAddress'
          description: ''
    patch:
      operationId: api_v1_companies_addresses_partial_update
      summary: Company address endpoints
      parameters:
      - in: path
        name: id
        schema:
          type: string
        required: true
      tags:
      - Brands
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedCompanyAddress'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedCompanyAddress'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedCompanyAddress'
      security:
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompanyAddress'
          description: ''
    delete:
      operationId: api_v1_companies_addresses_destroy
      summary: Company address endpoints
      parameters:
      - in: path
        name: id
        schema:
          type: string
        required: true
      tags:
      - Brands
      security:
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '204':
          description: No response body
  /api/v1/companies/brands/:
    get:
      operationId: api_v1_companies_brands_list
      parameters:
      - name: page
        required: false
        in: query
        description: A page number within the paginated result set.
        schema:
          type: integer
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      tags:
      - Brands
      security:
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedCompanyList'
          description: ''
  /api/v1/companies/brands/{brand_uuid}/my-suppliers/:
    get:
      operationId: api_v1_companies_brands_my_suppliers_list
      parameters:
      - in: path
        name: brand_uuid
        schema:
          type: string
        required: true
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - name: page
        required: false
        in: query
        description: A page number within the paginated result set.
        schema:
          type: integer
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      tags:
      - Brands
      security:
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedExistingSuppliersListList'
          description: ''
  /api/v1/companies/brands/{brand_uuid}/my-suppliers/{referred_company__uuid}/:
    get:
      operationId: api_v1_companies_brands_my_suppliers_retrieve
      parameters:
      - in: path
        name: brand_uuid
        schema:
          type: string
        required: true
      - in: path
        name: referred_company__uuid
        schema:
          type: string
        required: true
      tags:
      - Brands
      security:
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExistingSuppliersList'
          description: ''
  /api/v1/companies/brands/{uuid}/:
    get:
      operationId: api_v1_companies_brands_retrieve
      parameters:
      - in: path
        name: uuid
        schema:
          type: string
          format: uuid
        required: true
      tags:
      - Brands
      security:
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Company'
          description: ''
    put:
      operationId: api_v1_companies_brands_update
      parameters:
      - in: path
        name: uuid
        schema:
          type: string
          format: uuid
        required: true
      tags:
      - Brands
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Company'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Company'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Company'
        required: true
      security:
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Company'
          description: ''
    patch:
      operationId: api_v1_companies_brands_partial_update
      parameters:
      - in: path
        name: uuid
        schema:
          type: string
          format: uuid
        required: true
      tags:
      - Brands
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedCompany'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedCompany'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedCompany'
      security:
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Company'
          description: ''
  /api/v1/companies/brands/acknowledge-marketplace-terms-and-conditions/:
    post:
      operationId: api_v1_companies_brands_acknowledge_marketplace_terms_and_conditions_create
      description: 'Acknowledge the current marketplace T&C version for the brand company.


        Acknowledgement mechanics (version stamping, audit row, idempotency,

        backfilled-row upgrade) live in

        ``apps.companies.services.marketplace_terms`` — shared with

        ``CompanyInfoViewSet.finish_onboarding``.'
      summary: Acknowledge marketplace T&Cs for the current brand company.
      tags:
      - Brands
      security:
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompanyInfo'
          description: ''
  /api/v1/companies/brands/dashboard/count/:
    get:
      operationId: api_v1_companies_brands_dashboard_count_retrieve
      summary: Dashboard counts for Brands.
      tags:
      - Brands
      security:
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BrandDashboardCount'
          description: ''
  /api/v1/companies/brands/mor-kyb-status/:
    get:
      operationId: api_v1_companies_brands_mor_kyb_status_retrieve
      tags:
      - Brands
      security:
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MorKYBDetails'
          description: ''
  /api/v1/companies/info/:
    get:
      operationId: api_v1_companies_info_retrieve
      summary: Basic info of a company
      tags:
      - Brands
      security:
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompanyInfo'
          description: ''
  /api/v1/companies/invite-company/:
    post:
      operationId: api_v1_companies_invite_company_create
      summary: Send company invite endpoint
      tags:
      - Brands
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CompanyInvite'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CompanyInvite'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/CompanyInvite'
        required: true
      security:
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompanyInvite'
          description: ''
  /api/v1/companies/me/finish-onboarding/:
    post:
      operationId: api_v1_companies_me_finish_onboarding_create
      description: 'Flips `Company.onboarding_state` from `in_progress` to `active`, unlocking the rest of the buyer app. Idempotent in spirit: a company that is already `active` (or any other non-`in_progress` state) returns 409 so the caller can recover without firing a duplicate side-effect.'
      summary: Mark the current company's buyer onboarding as complete
      tags:
      - Brands
      security:
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompanyInfo'
          description: ''
        '409':
          description: Onboarding is not in progress.
  /api/v1/companies/onboarding/brand/:
    post:
      operationId: api_v1_companies_onboarding_brand_create
      tags:
      - Brands
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BrandOnboarding'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/BrandOnboarding'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/BrandOnboarding'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserAuthToken'
          description: ''
  /api/v1/inquiries/{inquiry_uuid}/quotes/brand/:
    get:
      operationId: api_v1_inquiries_quotes_brand_list
      parameters:
      - in: path
        name: inquiry_uuid
        schema:
          type: string
        required: true
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - name: page
        required: false
        in: query
        description: A page number within the paginated result set.
        schema:
          type: integer
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      tags:
      - Brands
      security:
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedQuoteDetailList'
          description: ''
  /api/v1/inquiries/{inquiry_uuid}/quotes/brand/{uuid}/:
    get:
      operationId: api_v1_inquiries_quotes_brand_retrieve
      summary: Retrieve details of a quote for a brand
      parameters:
      - in: path
        name: inquiry_uuid
        schema:
          type: string
        required: true
      - in: path
        name: uuid
        schema:
          type: string
        required: true
      tags:
      - Brands
      security:
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QuoteDetail'
          description: ''
    put:
      operationId: api_v1_inquiries_quotes_brand_update
      summary: Endpoint for manage quote samples
      parameters:
      - in: path
        name: inquiry_uuid
        schema:
          type: string
        required: true
      - in: path
        name: uuid
        schema:
          type: string
        required: true
      tags:
      - Brands
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BrandQuoteUpdate'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/BrandQuoteUpdate'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/BrandQuoteUpdate'
      security:
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QuoteDetail'
          description: ''
    patch:
      operationId: api_v1_inquiries_quotes_brand_partial_update
      parameters:
      - in: path
        name: inquiry_uuid
        schema:
          type: string
        required: true
      - in: path
        name: uuid
        schema:
          type: string
        required: true
      tags:
      - Brands
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedBrandQuoteUpdate'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedBrandQuoteUpdate'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedBrandQuoteUpdate'
      security:
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BrandQuoteUpdate'
          description: ''
  /api/v1/inquiries/{inquiry_uuid}/quotes/brand/{uuid}/cancel-purchase-request/:
    post:
      operationId: api_v1_inquiries_quotes_brand_cancel_purchase_request_create
      summary: Endpoint to cancel purchase request for a contract for Buyer.
      parameters:
      - in: path
        name: inquiry_uuid
        schema:
          type: string
        required: true
      - in: path
        name: uuid
        schema:
          type: string
        required: true
      tags:
      - Brands
      security:
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '204':
          description: No response body
  /api/v1/inquiries/{inquiry_uuid}/quotes/brand/{uuid}/channel/:
    get:
      operationId: api_v1_inquiries_quotes_brand_channel_retrieve
      parameters:
      - in: path
        name: inquiry_uuid
        schema:
          type: string
        required: true
      - in: path
        name: uuid
        schema:
          type: string
        required: true
      tags:
      - Brands
      security:
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChannelUUID'
          description: ''
  /api/v1/inquiries/{inquiry_uuid}/quotes/brand/{uuid}/decline/:
    post:
      operationId: api_v1_inquiries_quotes_brand_decline_create
      parameters:
      - in: path
        name: inquiry_uuid
        schema:
          type: string
        required: true
      - in: path
        name: uuid
        schema:
          type: string
        required: true
      tags:
      - Brands
      security:
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QuoteDeclined'
          description: ''
  /api/v1/inquiries/{inquiry_uuid}/quotes/brand/{uuid}/extend-contract/:
    post:
      operationId: api_v1_inquiries_quotes_brand_extend_contract_create
      summary: Endpoint to request contract extension for Buyer.
      parameters:
      - in: path
        name: inquiry_uuid
        schema:
          type: string
        required: true
      - in: path
        name: uuid
        schema:
          type: string
        required: true
      tags:
      - Brands
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/QuoteExtension'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/QuoteExtension'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/QuoteExtension'
      security:
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '204':
          description: No response body
  /api/v1/inquiries/{inquiry_uuid}/quotes/brand/{uuid}/mark-contract-proceeded/:
    post:
      operationId: api_v1_inquiries_quotes_brand_mark_contract_proceeded_create
      parameters:
      - in: path
        name: inquiry_uuid
        schema:
          type: string
        required: true
      - in: path
        name: uuid
        schema:
          type: string
        required: true
      tags:
      - Brands
      security:
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '204':
          description: No response body
  /api/v1/inquiries/{inquiry_uuid}/quotes/brand/{uuid}/mark-proceeded/:
    post:
      operationId: api_v1_inquiries_quotes_brand_mark_proceeded_create
      parameters:
      - in: path
        name: inquiry_uuid
        schema:
          type: string
        required: true
      - in: path
        name: uuid
        schema:
          type: string
        required: true
      tags:
      - Brands
      security:
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '204':
          description: No response body
  /api/v1/inquiries/{inquiry_uuid}/quotes/brand/{uuid}/request-update/:
    post:
      operationId: api_v1_inquiries_quotes_brand_request_update_create
      summary: Request update to expired quote https://app.clickup.com/t/8695a05f2
      parameters:
      - in: path
        name: inquiry_uuid
        schema:
          type: string
        required: true
      - in: path
        name: uuid
        schema:
          type: string
        required: true
      tags:
      - Brands
      security:
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          description: No response body
        '403':
          description: No response body
  /api/v1/inquiries/{inquiry_uuid}/quotes/brand/purchase_request_quote/:
    get:
      operationId: api_v1_inquiries_quotes_brand_purchase_request_quote_list
      summary: Retrieve the quote for a purchase inquiry taking its UUID
      parameters:
      - in: path
        name: inquiry_uuid
        schema:
          type: string
        required: true
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - name: page
        required: false
        in: query
        description: A page number within the paginated result set.
        schema:
          type: integer
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      tags:
      - Brands
      security:
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedQuoteRetrieveList'
          description: ''
components:
  schemas:
    ActivityTypeEnum:
      enum:
      - producer
      - distributor
      - importer_exporter
      - wholesaler
      - food_manufacturer
      - beverage_manufacturer
      - raw_mat_manufacturer
      - other
      type: string
      description: '* `producer` - Producer

        * `distributor` - Distributor

        * `importer_exporter` - Importer / Exporter

        * `wholesaler` - Wholesaler

        * `food_manufacturer` - Manufacturer of Finished Food Products

        * `beverage_manufacturer` - Manufacturer of Finished Beverage Products

        * `raw_mat_manufacturer` - Manufacturer of raw materials

        * `other` - Other'
    ProductTypeEnum:
      enum:
      - confect_snacks
      - conv_food
      - bread_cereals
      - sauces_spices
      - spreads
      - tea
      - coffee
      - water
      - carb_drinks
      - alc_drinks
      - juice_drinks
      - energy_drinks
      - cosmetics
      - milk_dairy
      - free_form_alt
      - other
      type: string
      description: '* `confect_snacks` - Confectionery & Snacks

        * `conv_food` - Convenience Food

        * `bread_cereals` - Bread & Cereals

        * `sauces_spices` - Sauces & Spices

        * `spreads` - Spreads

        * `tea` - Tea

        * `coffee` - Coffee

        * `water` - Water

        * `carb_drinks` - Carbonated Drinks

        * `alc_drinks` - Alcoholic Drinks

        * `juice_drinks` - Juice Drinks

        * `energy_drinks` - Energy Drinks

        * `cosmetics` - Cosmetics

        * `milk_dairy` - Milk & Dairy

        * `free_form_alt` - Free Form Alternative

        * `other` - Other'
    MarketplaceTcStatusEnum:
      enum:
      - acknowledged
      - pending_banner
      - pending_blocking
      type: string
      description: '* `acknowledged` - Acknowledged

        * `pending_banner` - Pending (Banner)

        * `pending_blocking` - Pending (Blocking)'
    QuoteState:
      enum:
      - available
      - ordered
      - expired
      - declined
      - pending_payment
      - proceeded
      - contract_created
      - contract_proceeded
      - contract_confirmed
      type: string
      description: '* `available` - available

        * `ordered` - ordered

        * `expired` - expired

        * `declined` - declined

        * `pending_payment` - pending_payment

        * `proceeded` - proceeded

        * `contract_created` - Contract Created

        * `contract_proceeded` - contract_proceeded

        * `contract_confirmed` - contract_confirmed'
    Country:
      enum:
      - AF
      - AX
      - AL
      - DZ
      - AS
      - AD
      - AO
      - AI
      - AQ
      - AG
      - AR
      - AM
      - AW
      - AU
      - AT
      - AZ
      - BS
      - BH
      - BD
      - BB
      - BY
      - BE
      - BZ
      - BJ
      - BM
      - BT
      - BO
      - BQ
      - BA
      - BW
      - BV
      - BR
      - IO
      - BN
      - BG
      - BF
      - BI
      - CV
      - KH
      - CM
      - CA
      - KY
      - CF
      - TD
      - CL
      - CN
      - CX
      - CC
      - CO
      - KM
      - CG
      - CD
      - CK
      - CR
      - CI
      - HR
      - CU
      - CW
      - CY
      - CZ
      - DK
      - DJ
      - DM
      - DO
      - EC
      - EG
      - SV
      - GQ
      - ER
      - EE
      - SZ
      - ET
      - FK
      - FO
      - FJ
      - FI
      - FR
      - GF
      - PF
      - TF
      - GA
      - GM
      - GE
      - DE
      - GH
      - GI
      - GR
      - GL
      - GD
      - GP
      - GU
      - GT
      - GG
      - GN
      - GW
      - GY
      - HT
      - HM
      - VA
      - HN
      - HK
      - HU
      - IS
      - IN
      - ID
      - IR
      - IQ
      - IE
      - IM
      - IL
      - IT
      - JM
      - JP
      - JE
      - JO
      - KZ
      - KE
      - KI
      - KW
      - KG
      - LA
      - LV
      - LB
      - LS
      - LR
      - LY
      - LI
      - LT
      - LU
      - MO
      - MG
      - MW
      - MY
      - MV
      - ML
      - MT
      - MH
      - MQ
      - MR
      - MU
      - YT
      - MX
      - FM
      - MD
      - MC
      - MN
      - ME
      - MS
      - MA
      - MZ
      - MM
      - NA
      - NR
      - NP
      - NL
      - NC
      - NZ
      - NI
      - NE
      - NG
      - NU
      - NF
      - KP
      - MK
      - XI
      - MP
      - 'NO'
      - OM
      - PK
      - PW
      - PS
      - PA
      - PG
      - PY
      - PE
      - PH
      - PN
      - PL
      - PT
      - PR
      - QA
      - RE
      - RO
      - RU
      - RW
      - BL
      - SH
      - KN
      - LC
      - MF
      - PM
      - VC
      - WS
      - SM
      - ST
      - SA
      - SN
      - RS
      - SC
      - SL
      - SG
      - SX
      - SK
      - SI
      - SB
      - SO
      - ZA
      - GS
      - KR
      - SS
      - ES
      - LK
      - SD
      - SR
      - SJ
      - SE
      - CH
      - SY
      - TW
      - TJ
      - TZ
      - TH
      - TL
      - TG
      - TK
      - TO
      - TT
      - TN
      - TR
      - TM
      - TC
      - TV
      - UG
      - UA
      - AE
      - GB
      - UM
      - US
      - UY
      - UZ
      - VU
      - VE
      - VN
      - VG
      - VI
      - WF
      - EH
      - YE
      - ZM
      - ZW
      type: string
      description: '* `AF` - Afghanistan

        * `AX` - Åland Islands

        * `AL` - Albania

        * `DZ` - Algeria

        * `AS` - American Samoa

        * `AD` - Andorra

        * `AO` - Angola

        * `AI` - Anguilla

        * `AQ` - Antarctica

        * `AG` - Antigua and Barbuda

        * `AR` - Argentina

        * `AM` - Armenia

        * `AW` - Aruba

        * `AU` - Australia

        * `AT` - Austria

        * `AZ` - Azerbaijan

        * `BS` - Bahamas

        * `BH` - Bahrain

        * `BD` - Bangladesh

        * `BB` - Barbados

        * `BY` - Belarus

        * `BE` - Belgium

        * `BZ` - Belize

        * `BJ` - Benin

        * `BM` - Bermuda

        * `BT` - Bhutan

        * `BO` - Bolivia

        * `BQ` - Bonaire, Sint Eustatius and Saba

        * `BA` - Bosnia and Herzegovina

        * `BW` - Botswana

        * `BV` - Bouvet Island

        * `BR` - Brazil

        * `IO` - British Indian Ocean Territory

        * `BN` - Brunei

        * `BG` - Bulgaria

        * `BF` - Burkina Faso

        * `BI` - Burundi

        * `CV` - Cabo Verde

        * `KH` - Cambodia

        * `CM` - Cameroon

        * `CA` - Canada

        * `KY` - Cayman Islands

        * `CF` - Central African Republic

        * `TD` - Chad

        * `CL` - Chile

        * `CN` - China

        * `CX` - Christmas Island

        * `CC` - Cocos (Keeling) Islands

        * `CO` - Colombia

        * `KM` - Comoros

        * `CG` - Congo

        * `CD` - Congo (the Democratic Republic of the)

        * `CK` - Cook Islands

        * `CR` - Costa Rica

        * `CI` - Côte d''Ivoire

        * `HR` - Croatia

        * `CU` - Cuba

        * `CW` - Curaçao

        * `CY` - Cyprus

        * `CZ` - Czechia

        * `DK` - Denmark

        * `DJ` - Djibouti

        * `DM` - Dominica

        * `DO` - Dominican Republic

        * `EC` - Ecuador

        * `EG` - Egypt

        * `SV` - El Salvador

        * `GQ` - Equatorial Guinea

        * `ER` - Eritrea

        * `EE` - Estonia

        * `SZ` - Eswatini

        * `ET` - Ethiopia

        * `FK` - Falkland Islands (Malvinas)

        * `FO` - Faroe Islands

        * `FJ` - Fiji

        * `FI` - Finland

        * `FR` - France

        * `GF` - French Guiana

        * `PF` - French Polynesia

        * `TF` - French Southern Territories

        * `GA` - Gabon

        * `GM` - Gambia

        * `GE` - Georgia

        * `DE` - Germany

        * `GH` - Ghana

        * `GI` - Gibraltar

        * `GR` - Greece

        * `GL` - Greenland

        * `GD` - Grenada

        * `GP` - Guadeloupe

        * `GU` - Guam

        * `GT` - Guatemala

        * `GG` - Guernsey

        * `GN` - Guinea

        * `GW` - Guinea-Bissau

        * `GY` - Guyana

        * `HT` - Haiti

        * `HM` - Heard Island and McDonald Islands

        * `VA` - Holy See

        * `HN` - Honduras

        * `HK` - Hong Kong

        * `HU` - Hungary

        * `IS` - Iceland

        * `IN` - India

        * `ID` - Indonesia

        * `IR` - Iran

        * `IQ` - Iraq

        * `IE` - Ireland

        * `IM` - Isle of Man

        * `IL` - Israel

        * `IT` - Italy

        * `JM` - Jamaica

        * `JP` - Japan

        * `JE` - Jersey

        * `JO` - Jordan

        

# --- truncated at 32 KB (123 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/opply/refs/heads/main/openapi/opply-brands-api-openapi.yml