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 Companies API

The Companies API from Opply — 27 operation(s) for companies.

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

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

This API exposes 43 operations across 27 paths, and defines 68 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.

43 operations 27 paths 68 schemas 5 DELETE16 GET7 PATCH13 POST2 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 Companies 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 43

Across 27 paths, the API surfaces 43 operations — 5 DELETE, 16 GET, 7 PATCH, 13 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Companies 43
GET
/api/v1/companies/documents/
api_v1_companies_documents_list 2 params → 200
POST
/api/v1/companies/documents/
api_v1_companies_documents_create body → 201
GET
/api/v1/companies/documents/{uuid}/
api_v1_companies_documents_retrieve 1 param → 200
DELETE
/api/v1/companies/documents/{uuid}/
api_v1_companies_documents_destroy 1 param → 204
POST
/api/v1/companies/documents/{uuid}/create-resumable-upload-session/
Request a resumable file upload URL
api_v1_companies_documents_create_resumable_upload_session_create 1 param body → 200
POST
/api/v1/companies/documents/{uuid}/upload-complete/
Set an upload as done
api_v1_companies_documents_upload_complete_create 1 param body → 200
GET
/api/v1/companies/merchant-of-record-brands/
List brands associated with Merchant of Record
api_v1_companies_merchant_of_record_brands_list 3 params → 200
POST
/api/v1/companies/merchant-of-record-buyers/
Create a new buyer/brand
api_v1_companies_merchant_of_record_buyers_create body → 201
GET
/api/v1/companies/merchant-of-record-buyers/{uuid}/
Get buyer/brand details
api_v1_companies_merchant_of_record_buyers_retrieve 1 param → 200
PATCH
/api/v1/companies/merchant-of-record-buyers/{uuid}/
Update buyer/brand details
api_v1_companies_merchant_of_record_buyers_partial_update 1 param body → 200
GET
/api/v1/companies/merchant-of-record-buyers/{uuid}/compliance-documents/
List compliance documents held by this buyer
api_v1_companies_merchant_of_record_buyers_compliance_documents_list 3 params → 200
POST
/api/v1/companies/merchant-of-record-buyers/{uuid}/connect-allianz/
Connect buyer to Allianz
api_v1_companies_merchant_of_record_buyers_connect_allianz_create 1 param body → 200400
GET
/api/v1/companies/merchant-of-record-buyers/{uuid}/financial-documents/
List financial documents uploaded by this buyer
api_v1_companies_merchant_of_record_buyers_financial_documents_list 3 params → 200
GET
/api/v1/companies/merchant-of-record-buyers/{uuid}/onboarding-suppliers/
Manage Buyer/Brand details for Merchant of Record
api_v1_companies_merchant_of_record_buyers_onboarding_suppliers_retrieve 1 param → 200
GET
/api/v1/companies/merchant-of-record-buyers/{uuid}/suppliers/
Get suppliers for a buyer
api_v1_companies_merchant_of_record_buyers_suppliers_list 3 params → 200
POST
/api/v1/companies/merchant-of-record-buyers/{uuid}/users/
Add a user to a buyer/brand
api_v1_companies_merchant_of_record_buyers_users_create 1 param body → 201400403404
GET
/api/v1/companies/merchant-of-record-company-addresses/
List company addresses by company UUID
api_v1_companies_merchant_of_record_company_addresses_list 4 params → 200
POST
/api/v1/companies/merchant-of-record-company-addresses/
Create a new company address for a given company UUID
api_v1_companies_merchant_of_record_company_addresses_create body → 201
PUT
/api/v1/companies/merchant-of-record-company-addresses/{uuid}/
Manage company addresses filtered by Merchant of Record
api_v1_companies_merchant_of_record_company_addresses_update 1 param body → 200
PATCH
/api/v1/companies/merchant-of-record-company-addresses/{uuid}/
Manage company addresses filtered by Merchant of Record
api_v1_companies_merchant_of_record_company_addresses_partial_update 1 param body → 200
DELETE
/api/v1/companies/merchant-of-record-company-addresses/{uuid}/
Manage company addresses filtered by Merchant of Record
api_v1_companies_merchant_of_record_company_addresses_destroy 1 param → 204
GET
/api/v1/companies/merchant-of-record-suppliers/
List suppliers associated with Merchant of Record
api_v1_companies_merchant_of_record_suppliers_list 3 params → 200
GET
/api/v1/companies/merchant-of-record-suppliers/{uuid}/
Get supplier basic information
api_v1_companies_merchant_of_record_suppliers_retrieve 1 param → 200
POST
/api/v1/companies/merchant-of-record-suppliers/{uuid}/add-buyer/
Add buyer to supplier
api_v1_companies_merchant_of_record_suppliers_add_buyer_create 1 param body → 201
GET
/api/v1/companies/merchant-of-record-suppliers/{uuid}/buyer-payment-terms/
Get buyer-supplier payment terms
api_v1_companies_merchant_of_record_suppliers_buyer_payment_terms_retrieve 2 params → 200204
POST
/api/v1/companies/merchant-of-record-suppliers/{uuid}/buyer-payment-terms/
Create buyer-supplier payment terms
api_v1_companies_merchant_of_record_suppliers_buyer_payment_terms_create 1 param body → 201400
PATCH
/api/v1/companies/merchant-of-record-suppliers/{uuid}/buyer-payment-terms/
Update buyer-supplier payment terms
api_v1_companies_merchant_of_record_suppliers_buyer_payment_terms_partial_update 1 param body → 200404
DELETE
/api/v1/companies/merchant-of-record-suppliers/{uuid}/buyer-payment-terms/
Delete buyer-supplier payment terms
api_v1_companies_merchant_of_record_suppliers_buyer_payment_terms_destroy 2 params → 204404
GET
/api/v1/companies/merchant-of-record-suppliers/{uuid}/buyers/
Get buyers for supplier
api_v1_companies_merchant_of_record_suppliers_buyers_list 3 params → 200
GET
/api/v1/companies/merchant-of-record-suppliers/{uuid}/contacts/
List supplier contacts
api_v1_companies_merchant_of_record_suppliers_contacts_list 3 params → 200
POST
/api/v1/companies/merchant-of-record-suppliers/{uuid}/contacts/
Create supplier contact
api_v1_companies_merchant_of_record_suppliers_contacts_create 1 param body → 201400
PUT
/api/v1/companies/merchant-of-record-suppliers/{uuid}/contacts/{contact_uuid}/
Replace supplier contact
api_v1_companies_merchant_of_record_suppliers_contacts_update 2 params body → 200400404
PATCH
/api/v1/companies/merchant-of-record-suppliers/{uuid}/contacts/{contact_uuid}/
Partially update supplier contact
api_v1_companies_merchant_of_record_suppliers_contacts_partial_update 2 params body → 200400404
DELETE
/api/v1/companies/merchant-of-record-suppliers/{uuid}/contacts/{contact_uuid}/
Delete supplier contact
api_v1_companies_merchant_of_record_suppliers_contacts_destroy 2 params → 204404
GET
/api/v1/companies/merchant-of-record-suppliers/{uuid}/payout-details/
Get supplier payout details
api_v1_companies_merchant_of_record_suppliers_payout_details_retrieve 1 param → 200404
POST
/api/v1/companies/merchant-of-record-suppliers/{uuid}/payout-details/
Create supplier payout details
api_v1_companies_merchant_of_record_suppliers_payout_details_create 1 param body → 201400
PATCH
/api/v1/companies/merchant-of-record-suppliers/{uuid}/payout-details/
Update supplier payout details
api_v1_companies_merchant_of_record_suppliers_payout_details_partial_update 1 param body → 200404
DELETE
/api/v1/companies/merchant-of-record-suppliers/{uuid}/payout-details/
Delete supplier payout details
api_v1_companies_merchant_of_record_suppliers_payout_details_destroy 1 param → 204
POST
/api/v1/companies/merchant-of-record-suppliers/{uuid}/remove-buyer/
Remove buyer from supplier
api_v1_companies_merchant_of_record_suppliers_remove_buyer_create 1 param body → 200
GET
/api/v1/companies/merchant-of-record-suppliers/{uuid}/sites/
List supplier sites
api_v1_companies_merchant_of_record_suppliers_sites_list 3 params → 200
POST
/api/v1/companies/merchant-of-record-suppliers/{uuid}/sites/
Create supplier site
api_v1_companies_merchant_of_record_suppliers_sites_create 1 param body → 201400
PATCH
/api/v1/companies/merchant-of-record-suppliers/{uuid}/update/
Update supplier payout information
api_v1_companies_merchant_of_record_suppliers_update_partial_update 1 param body → 200
PATCH
/api/v1/companies/merchant-of-record-suppliers/{uuid}/update-buyers/
Update supplier buyers
api_v1_companies_merchant_of_record_suppliers_update_buyers_partial_update 1 param body → 200

Schemas 68

The contract defines 68 schemas that model the data the API accepts and returns. The most detailed are CreateCompanyAddress (32 properties), CompanyAddress (31 properties), PatchedCompanyAddress (31 properties), PatchedSupplierPayoutDetails (20 properties). Each schema is shown below with its type and property counts.

GoogleUpload
object
4 properties 3 required
ProductTypeEnum
string
confectsnacks - Confectionery & Snacks convfood - Convenience Food breadcereals - Bread & Cereals saucesspices - Sauces & Spices spreads - Spreads tea - Tea co…
PatchedSupplierUpdateBuyers
object
Serializer for updating the entire list of buyers for a supplier.
1 property
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…
DocumentLifecycleStatusEnum
string
valid - Valid expired - Expired expiringsoon - Expiring Soon renewed - Renewed
BuyerSupplierPaymentTerms
object
7 properties 6 required
MerchantOfRecordSupplierSiteCreate
object
1 property 1 required
MoRBuyerCreate
object
Serializer for creating a new Buyer (Brand) company by MoR users. Creates the company, user, address, and employee atomically.
16 properties 5 required
CompanyAddress
object
31 properties 5 required
DocumentType
object
Shared serializer for the DocumentType taxonomy (buyer, supplier, Opply documents).
3 properties 2 required
SupplierAddBuyer
object
Serializer for adding a buyer to a supplier by creating a referral relationship.
1 property 1 required
MerchantOfRecordBuyerDetail
object
Detailed serializer for buyer/brand information for MoR users
18 properties 6 required
MerchantOfRecordSupplier
object
8 properties 3 required
SupplierTypeEnum
string
producer - Producer manufacturer - Manufacturer broker - Broker other - Other notapplicable - N/A
GoogleUploadResponse
object
2 properties 2 required
CompanyDocumentCategory
string
ingredientslist - Ingredients List other - Other
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…
BuyerFinancialDocumentTypeEnum
string
managementaccounts - Management Accounts auditedaccounts - Audited Accounts balancesheet - Balance Sheet profitandloss - Profit and Loss cashflowforecast - Cas…
PaginatedMoRBuyerComplianceDocumentList
object
4 properties 2 required
PaginatedBuyerSupplierList
object
4 properties 2 required
PaginatedSupplierBuyerList
object
4 properties 2 required
URL
object
1 property 1 required
CountryTypeEnum
string
EU - Eu GB - Gb Other - Other
MoRBuyerAddressCreate
object
Serializer for nested address creation within buyer creation.
9 properties 4 required
PatchedSupplierContact
object
9 properties
PatchedMerchantOfRecordSupplierUpdate
object
Serializer for updating supplier payout terms, days, DUNS, supplier type, and lead time
5 properties
MerchantOfRecordCompany
object
7 properties 4 required
PaginatedSupplierSiteList
object
4 properties 2 required
TwoBuyerConfigUpdate
object
5 properties
GoogleUploadComplete
object
1 property 1 required
AddressTypeEnum
string
billingaddress - Billing address deliveryaddress - Delivery address dispatchaddress - Dispatch address companyaddress - Company address
AppOrderPaymentTermsEnum
string
paybeforedispatch - Pay Before Dispatch payafterdispatch - Pay After Dispatch payon28thsecondmonthafterdispatch - Pay on 28th second month after dispatch payen…
CompanyDocument
object
4 properties 2 required
PatchedSupplierPayoutDetails
object
20 properties
PaginatedBuyerFinancialDocumentList
object
4 properties 2 required
PaginatedMerchantOfRecordCompanyList
object
4 properties 2 required
SupplierContactCategoryEnum
string
orders - Orders logistics - Logistics and Supply Chain finance - Finance other - Other
AccountTypeEnum
string
checking - Checking savings - Savings
USStateEnum
string
AL - Alabama AK - Alaska AZ - Arizona AR - Arkansas CA - California CO - Colorado CT - Connecticut DE - Delaware FL - Florida GA - Georgia HI - Hawaii ID - Ida…
SupplierBuyer
object
Serializer for buyer information associated with a supplier through referrals. Includes payment terms if a BuyerSupplierPaymentTerms record exists for this pai…
6 properties 6 required
BuyerSupplierPaymentTermsCreate
object
7 properties 6 required
BuyerSupplier
object
Serializer for suppliers associated with a buyer. Includes payment terms if a BuyerSupplierPaymentTerms record exists for this pair.
7 properties 5 required
SupplierPayoutDetails
object
20 properties 11 required
MoRBuyerComplianceDocument
object
Read shape for the MoR's view of a buyer's compliance documents. Same fields as the buyer-facing serializer (minus the write-only upload fields) plus the agent…
19 properties 19 required
PatchedBuyerSupplierPaymentTermsCreate
object
7 properties
PaginatedCompanyDocumentList
object
4 properties 2 required
PatchedCompanyAddress
object
31 properties
MoRBuyerUserResponse
object
Response shape for POST /merchant-of-record-buyers/{uuid}/users/.
5 properties 5 required
ComplianceDocumentTypeEnum
string
SALESTAXEXEMPTION - Sales Tax Exemption OTHER - Other
PatchedMoRBuyerUpdate
object
Serializer for updating an existing Buyer (Brand) company by MoR users. User email is NOT editable after creation.
15 properties
MoRBuyerUserCreate
object
Serializer for adding an additional user to an existing Buyer (Brand) company by MoR users. Follows the MoR provisioning paradigm (same as MoRBuyerCreateSerial…
4 properties 3 required
SupplierPayoutTermsEnum
string
payoutbeforedispatch - Payout Before Dispatch payoutafterdispatch - Payout After Dispatch
SupplierSite
object
3 properties 3 required
PaginatedSupplierContactList
object
4 properties 2 required
MoRBuyerAddressUpdate
object
Serializer for nested address updates. Country cannot be changed.
8 properties
CompanyTypeEnum
string
brand - Brand supplier - Supplier merchantofrecord - Merchant of Record
MoRBuyerDetailResponse
object
Response serializer for buyer details after create/update. Returns comprehensive buyer information.
17 properties 5 required
BlankEnum
SupplierRemoveBuyer
object
Serializer for removing a buyer from a supplier.
1 property 1 required
AllianzConnect
object
Serializer for connecting a buyer company to an Allianz company record.
2 properties 1 required
TwoBuyerConfig
object
5 properties
PaginatedCompanyAddressList
object
4 properties 2 required
BuyerFinancialDocument
object
Read serializer returned for list/create responses.
14 properties 14 required
CreateCompanyAddress
object
32 properties 6 required
_ComplianceExtractionDetail
object
Structured certificate detail captured by the onboarding extraction agent (buyeronboarding.ExtractedComplianceDocument). Read-only nested payload — present onl…
10 properties 10 required
BankingCountryTypeEnum
string
US - Us GB - Gb CA - Ca AT - At BE - Be CY - Cy DE - De EE - Ee ES - Es FI - Fi FR - Fr GR - Gr IE - Ie IT - It LT - Lt LU - Lu LV - Lv MT - Mt NL - Nl PT - Pt…
SupplierContact
object
9 properties 6 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

opply-companies-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 Brands API
Opply Buyer Documents API
Opply Buyer Financial Documents API
Opply Buyer Onboarding API
Opply Buyer self-onboarding API
Where this information came from

This is an independent, third-party profile of Opply Companies 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.