How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Opply Brands API

The Brands API from Opply — 24 operation(s) for brands.

Opply Brands API is one of 47 APIs that Opply publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Brands. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 32 operations across 24 paths, and defines 53 schemas. It is described by OpenAPI 3.0.3, at version 0.0.0.

Requests are made against the base URL https://api.opply.com.

32 operations 24 paths 53 schemas 1 DELETE14 GET3 PATCH11 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
0.0.0
Base URL
https://api.opply.com
Authentication
API Key, API Key
Resource Areas
1

Authentication & Security 2

Opply Brands API declares 2 security schemes for authenticating requests. An API key is passed in the cookie as sessionid (cookieAuth). An API key is passed in the header as Authorization (tokenAuth).

  • tokenAuth — Token-based authentication with required prefix "Token"

Paths & Operations 32

Across 24 paths, the API surfaces 32 operations — 1 DELETE, 14 GET, 3 PATCH, 11 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Brands 32
GET
/api/v1/companies/accessible/me/
List companies the current user can act on
api_v1_companies_accessible_me_retrieve → 200
GET
/api/v1/companies/addresses/
Company address endpoints
api_v1_companies_addresses_list 3 params → 200
POST
/api/v1/companies/addresses/
Company address endpoints
api_v1_companies_addresses_create body → 201
GET
/api/v1/companies/addresses/{id}/
Company address endpoints
api_v1_companies_addresses_retrieve 1 param → 200
PUT
/api/v1/companies/addresses/{id}/
Company address endpoints
api_v1_companies_addresses_update 1 param body → 200
PATCH
/api/v1/companies/addresses/{id}/
Company address endpoints
api_v1_companies_addresses_partial_update 1 param body → 200
DELETE
/api/v1/companies/addresses/{id}/
Company address endpoints
api_v1_companies_addresses_destroy 1 param → 204
GET
/api/v1/companies/brands/
api_v1_companies_brands_list 2 params → 200
GET
/api/v1/companies/brands/{brand_uuid}/my-suppliers/
api_v1_companies_brands_my_suppliers_list 5 params → 200
GET
/api/v1/companies/brands/{brand_uuid}/my-suppliers/{referred_company__uuid}/
api_v1_companies_brands_my_suppliers_retrieve 2 params → 200
GET
/api/v1/companies/brands/{uuid}/
api_v1_companies_brands_retrieve 1 param → 200
PUT
/api/v1/companies/brands/{uuid}/
api_v1_companies_brands_update 1 param body → 200
PATCH
/api/v1/companies/brands/{uuid}/
api_v1_companies_brands_partial_update 1 param body → 200
POST
/api/v1/companies/brands/acknowledge-marketplace-terms-and-conditions/
Acknowledge marketplace T&Cs for the current brand company.
api_v1_companies_brands_acknowledge_marketplace_terms_and_conditions_create → 200
GET
/api/v1/companies/brands/dashboard/count/
Dashboard counts for Brands.
api_v1_companies_brands_dashboard_count_retrieve → 200
GET
/api/v1/companies/brands/mor-kyb-status/
api_v1_companies_brands_mor_kyb_status_retrieve → 200
GET
/api/v1/companies/info/
Basic info of a company
api_v1_companies_info_retrieve → 200
POST
/api/v1/companies/invite-company/
Send company invite endpoint
api_v1_companies_invite_company_create body → 201
POST
/api/v1/companies/me/finish-onboarding/
Mark the current company's buyer onboarding as complete
api_v1_companies_me_finish_onboarding_create → 200409
POST
/api/v1/companies/onboarding/brand/
api_v1_companies_onboarding_brand_create body → 200
GET
/api/v1/inquiries/{inquiry_uuid}/quotes/brand/
api_v1_inquiries_quotes_brand_list 4 params → 200
GET
/api/v1/inquiries/{inquiry_uuid}/quotes/brand/{uuid}/
Retrieve details of a quote for a brand
api_v1_inquiries_quotes_brand_retrieve 2 params → 200
PUT
/api/v1/inquiries/{inquiry_uuid}/quotes/brand/{uuid}/
Endpoint for manage quote samples
api_v1_inquiries_quotes_brand_update 2 params body → 200
PATCH
/api/v1/inquiries/{inquiry_uuid}/quotes/brand/{uuid}/
api_v1_inquiries_quotes_brand_partial_update 2 params body → 200
POST
/api/v1/inquiries/{inquiry_uuid}/quotes/brand/{uuid}/cancel-purchase-request/
Endpoint to cancel purchase request for a contract for Buyer.
api_v1_inquiries_quotes_brand_cancel_purchase_request_create 2 params → 204
GET
/api/v1/inquiries/{inquiry_uuid}/quotes/brand/{uuid}/channel/
api_v1_inquiries_quotes_brand_channel_retrieve 2 params → 200
POST
/api/v1/inquiries/{inquiry_uuid}/quotes/brand/{uuid}/decline/
api_v1_inquiries_quotes_brand_decline_create 2 params → 200
POST
/api/v1/inquiries/{inquiry_uuid}/quotes/brand/{uuid}/extend-contract/
Endpoint to request contract extension for Buyer.
api_v1_inquiries_quotes_brand_extend_contract_create 2 params body → 204
POST
/api/v1/inquiries/{inquiry_uuid}/quotes/brand/{uuid}/mark-contract-proceeded/
api_v1_inquiries_quotes_brand_mark_contract_proceeded_create 2 params → 204
POST
/api/v1/inquiries/{inquiry_uuid}/quotes/brand/{uuid}/mark-proceeded/
api_v1_inquiries_quotes_brand_mark_proceeded_create 2 params → 204
POST
/api/v1/inquiries/{inquiry_uuid}/quotes/brand/{uuid}/request-update/
Request update to expired quote https://app.clickup.com/t/8695a05f2
api_v1_inquiries_quotes_brand_request_update_create 2 params → 200403
GET
/api/v1/inquiries/{inquiry_uuid}/quotes/brand/purchase_request_quote/
Retrieve the quote for a purchase inquiry taking its UUID
api_v1_inquiries_quotes_brand_purchase_request_quote_list 4 params → 200

Schemas 53

The contract defines 53 schemas that model the data the API accepts and returns. The most detailed are QuoteRetrieve (116 properties), QuoteDetail (101 properties), CompanyInfo (39 properties), PatchedCompanyAddress (31 properties). Each schema is shown below with its type and property counts.

ActivityTypeEnum
string
producer - Producer distributor - Distributor importerexporter - Importer / Exporter wholesaler - Wholesaler foodmanufacturer - Manufacturer of Finished Food P…
ProductTypeEnum
string
confectsnacks - Confectionery & Snacks convfood - Convenience Food breadcereals - Bread & Cereals saucesspices - Sauces & Spices spreads - Spreads tea - Tea co…
MarketplaceTcStatusEnum
string
acknowledged - Acknowledged pendingbanner - Pending (Banner) pendingblocking - Pending (Blocking)
QuoteState
string
available - available ordered - ordered expired - expired declined - declined pendingpayment - pendingpayment proceeded - proceeded contractcreated - Contract…
Country
string
AF - Afghanistan AX - Åland Islands AL - Albania DZ - Algeria AS - American Samoa AD - Andorra AO - Angola AI - Anguilla AQ - Antarctica AG - Antigua and Barbu…
QuoteDescriptionBlock
object
2 properties 2 required
BrandOnboarding
object
14 properties 6 required
FrequencyEnum
string
weekly - Weekly monthly - Monthly quarterly - Quarterly annually - Annually
IngredientsForQuote
object
3 properties 3 required
Company
object
23 properties 9 required
CompanyAddress
object
31 properties 5 required
QuoteExtension
object
1 property
UserAuthToken
object
1 property 1 required
NullEnum
PhoneCountryCodeEnum
string
+376 - +376 +971 - +971 +93 - +93 +1268 - +1268 +1264 - +1264 +355 - +355 +374 - +374 +244 - +244 +672 - +672 +54 - +54 +1684 - +1684 +43 - +43 +61 - +61 +297…
SamplesFeedbackEnum
string
ingredientquality - Ingredient Quality quoteprice - Quote Price suppliercommunication - Supplier Communication qualitynotasexpected - Quality Not As Expected t…
PaymentTermsEnum
string
inadvance - In Advance ondispatch - On Dispatch 7daysafterdispatch - Days After Dispatch 7 14daysafterdispatch - Days After Dispatch 14 30daysafterdispatch - D…
QuoteDetail
object
101 properties 42 required
QuoteRetrieve
object
116 properties 54 required
PatchedCompany
object
23 properties
SectionSupplierCountryEnum
string
AF - AF AX - AX AL - AL DZ - DZ AS - AS AD - AD AO - AO AI - AI AQ - AQ AG - AG AR - AR AM - AM AW - AW AU - AU AT - AT AZ - AZ BS - BS BH - BH BD - BD BB - BB…
DeliveryAddressResponse
object
12 properties 1 required
QuoteDeclined
object
2 properties 1 required
CompanyOnboardingStateEnum
string
inprogress - In progress active - Active
ExistingSuppliersList
object
12 properties 12 required
CountryTypeEnum
string
EU - Eu GB - Gb Other - Other
PaymentScenarioEnum
string
inadvance - In Advance ondispatch - On Dispatch
PricesRetrieve
object
29 properties 26 required
AddressTypeEnum
string
billingaddress - Billing address deliveryaddress - Delivery address dispatchaddress - Dispatch address companyaddress - Company address
KYBVerificationStatusResponseStatusEnum
string
Not started - Not started Started - Started In Review - In Review Completed - Completed
IncotermsEnum
string
deliverydutypaid - deliverydutypaid deliverydutyunpaid - deliverydutyunpaid costinsuranceandfreight - costinsuranceandfreight carriageandinsurancepaidto - carr…
PaginatedQuoteRetrieveList
object
4 properties 2 required
PatchedBrandQuoteUpdate
object
12 properties
ChannelUUID
object
1 property 1 required
PaginatedQuoteDetailList
object
4 properties 2 required
MorKYBDetails
object
1 property 1 required
BrandQuoteUpdate
object
12 properties
PaginatedCompanyList
object
4 properties 2 required
QuoteCategory
string
nonrecurring - Non Recurring recurring - Recurring purchaserequestquote - Purchase Request Quote
PatchedCompanyAddress
object
31 properties
Currencies
string
EUR - EUR USD - USD GBP - GBP CAD - CAD
SelectedPriceOptionEnum
string
total - total unit - unit
SamplesStatusEnum
string
available - Available requested - Requested sent - Sent received - Received accepted - Accepted rejected - Rejected declined - Declined
QuoteDeclineReason
string
pricing - pricing deliverydate - deliverydate incorrectquantities - incorrectquantities samplequality - samplequality specificationnotmet - specificationnotmet…
CompanyTypeEnum
string
brand - Brand supplier - Supplier merchantofrecord - Merchant of Record
BrandDashboardCount
object
1 property 1 required
BlankEnum
CompanyInfo
object
39 properties 20 required
UnitOfMeasurementEnum
string
fl oz - Fluid Ounces g - Grams mg - milligrams gals - Gallons kg - Kilograms L - Liters tons - Metric Tons oz - Ounces lbs - Pounds pcs - Pieces pt - Pints ml…
PaginatedCompanyAddressList
object
4 properties 2 required
PaginatedExistingSuppliersListList
object
4 properties 2 required
SectionSupplier
object
5 properties 4 required
CompanyInvite
object
7 properties 7 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

opply-brands-api-openapi.yml Raw ↑

Other APIs Opply publishes across the network.

Opply Activity Feed API
Opply Admin panel API
Opply Agents API
Opply Agreements API
Opply api API
Opply App Orders API
Opply Brain API
Opply Buyer Documents API
Opply Buyer Financial Documents API
Opply Buyer Onboarding API
Opply Buyer self-onboarding API
Opply Buyers API
Where this information came from

This is an independent, third-party profile of Opply Brands API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.