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

The Suppliers API from Opply — 41 operation(s) for suppliers.

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

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

This API exposes 67 operations across 41 paths, and defines 96 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.

67 operations 41 paths 96 schemas 5 DELETE22 GET8 PATCH24 POST8 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 Suppliers 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 67

Across 41 paths, the API surfaces 67 operations — 5 DELETE, 22 GET, 8 PATCH, 24 POST, 8 PUT. Each is listed below with its method, path, parameters, and response codes.

Suppliers 67
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/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
GET
/api/v1/companies/mor/onboarding-suppliers/
List all onboarding suppliers
api_v1_companies_mor_onboarding_suppliers_list 2 params → 200
POST
/api/v1/companies/mor/onboarding-suppliers/
Create a new onboarding supplier
api_v1_companies_mor_onboarding_suppliers_create body → 201
GET
/api/v1/companies/mor/onboarding-suppliers/{onboarding_supplier_uuid}/activities/
List onboarding supplier activities
listOnboardingSupplierActivities 2 params → 200
POST
/api/v1/companies/mor/onboarding-suppliers/{onboarding_supplier_uuid}/activities/
Create onboarding supplier activity
createOnboardingSupplierActivity 1 param body → 201
GET
/api/v1/companies/mor/onboarding-suppliers/{uuid}/
Get onboarding supplier details
api_v1_companies_mor_onboarding_suppliers_retrieve 1 param → 200
PUT
/api/v1/companies/mor/onboarding-suppliers/{uuid}/
Update onboarding supplier
api_v1_companies_mor_onboarding_suppliers_update 1 param body → 200
PATCH
/api/v1/companies/mor/onboarding-suppliers/{uuid}/
Update onboarding supplier status
api_v1_companies_mor_onboarding_suppliers_partial_update 1 param body → 200
DELETE
/api/v1/companies/mor/onboarding-suppliers/{uuid}/
Delete onboarding supplier
api_v1_companies_mor_onboarding_suppliers_destroy 1 param → 204400
PATCH
/api/v1/companies/mor/onboarding-suppliers/{uuid}/address/
Partially update onboarding supplier address
api_v1_companies_mor_onboarding_suppliers_address_partial_update 1 param body → 200
POST
/api/v1/companies/mor/onboarding-suppliers/{uuid}/archive/
Archive onboarding supplier
api_v1_companies_mor_onboarding_suppliers_archive_create 1 param body → 200400
GET
/api/v1/companies/mor/onboarding-suppliers/{uuid}/buyers/
Get buyers for onboarding supplier
getOnboardingSupplierBuyers 2 params → 200
GET
/api/v1/companies/mor/onboarding-suppliers/{uuid}/contacts/
List onboarding supplier contacts
api_v1_companies_mor_onboarding_suppliers_contacts_list 2 params → 200
POST
/api/v1/companies/mor/onboarding-suppliers/{uuid}/contacts/
Create onboarding supplier contact
api_v1_companies_mor_onboarding_suppliers_contacts_create 1 param body → 201400
PUT
/api/v1/companies/mor/onboarding-suppliers/{uuid}/contacts/{contact_uuid}/
Replace onboarding supplier contact
api_v1_companies_mor_onboarding_suppliers_contacts_update 2 params body → 200400404
PATCH
/api/v1/companies/mor/onboarding-suppliers/{uuid}/contacts/{contact_uuid}/
Partially update onboarding supplier contact
api_v1_companies_mor_onboarding_suppliers_contacts_partial_update 2 params body → 200400404
DELETE
/api/v1/companies/mor/onboarding-suppliers/{uuid}/contacts/{contact_uuid}/
Delete onboarding supplier contact
api_v1_companies_mor_onboarding_suppliers_contacts_destroy 2 params → 204404
POST
/api/v1/companies/mor/onboarding-suppliers/{uuid}/create-final-supplier/
Create final supplier
createFinalSupplier 1 param body → 201400
GET
/api/v1/companies/mor/onboarding-suppliers/{uuid}/payout-details/
Get onboarding supplier payout details
api_v1_companies_mor_onboarding_suppliers_payout_details_retrieve 1 param → 200404
POST
/api/v1/companies/mor/onboarding-suppliers/{uuid}/payout-details/
Create onboarding supplier payout details
api_v1_companies_mor_onboarding_suppliers_payout_details_create 1 param body → 201400
PUT
/api/v1/companies/mor/onboarding-suppliers/{uuid}/payout-details/
Replace onboarding supplier payout details (full update)
api_v1_companies_mor_onboarding_suppliers_payout_details_update 1 param body → 200400404
PATCH
/api/v1/companies/mor/onboarding-suppliers/{uuid}/payout-details/
Partially update onboarding supplier payout details
api_v1_companies_mor_onboarding_suppliers_payout_details_partial_update 1 param body → 200400404
POST
/api/v1/companies/mor/onboarding-suppliers/{uuid}/unarchive/
Unarchive onboarding supplier
api_v1_companies_mor_onboarding_suppliers_unarchive_create 1 param body → 200400
GET
/api/v1/companies/mor/onboarding-suppliers/staff-users/
Get available staff users
getAvailableStaffUsers 2 params → 200
POST
/api/v1/companies/onboarding/supplier/
api_v1_companies_onboarding_supplier_create body → 200
GET
/api/v1/companies/suppliers/
api_v1_companies_suppliers_list 2 params → 200
GET
/api/v1/companies/suppliers/{supplier_uuid}/catalogues/
api_v1_companies_suppliers_catalogues_list 3 params → 200
POST
/api/v1/companies/suppliers/{supplier_uuid}/catalogues/
api_v1_companies_suppliers_catalogues_create 1 param body → 201
GET
/api/v1/companies/suppliers/{supplier_uuid}/catalogues/{uuid}/
api_v1_companies_suppliers_catalogues_retrieve 2 params → 200
PUT
/api/v1/companies/suppliers/{supplier_uuid}/catalogues/{uuid}/
Update a catalogue for a supplier
api_v1_companies_suppliers_catalogues_update 2 params body → 201
PATCH
/api/v1/companies/suppliers/{supplier_uuid}/catalogues/{uuid}/
api_v1_companies_suppliers_catalogues_partial_update 2 params body → 200
DELETE
/api/v1/companies/suppliers/{supplier_uuid}/catalogues/{uuid}/
api_v1_companies_suppliers_catalogues_destroy 2 params → 204
POST
/api/v1/companies/suppliers/{supplier_uuid}/catalogues/{uuid}/set-file/
Set catalogue file to uploaded google storage file
api_v1_companies_suppliers_catalogues_set_file_create 2 params body → 200
POST
/api/v1/companies/suppliers/{supplier_uuid}/catalogues/create-from-name/
Create a new catalogue from a google storage path
api_v1_companies_suppliers_catalogues_create_from_name_create 1 param body → 200
POST
/api/v1/companies/suppliers/{supplier_uuid}/catalogues/signed-url/
Get Google Cloud Storage temporal signed url
api_v1_companies_suppliers_catalogues_signed_url_create 1 param body → 200
GET
/api/v1/companies/suppliers/{supplier_uuid}/documents/
api_v1_companies_suppliers_documents_list 3 params → 200
POST
/api/v1/companies/suppliers/{supplier_uuid}/documents/
api_v1_companies_suppliers_documents_create 1 param body → 201
GET
/api/v1/companies/suppliers/{supplier_uuid}/documents/{uuid}/
api_v1_companies_suppliers_documents_retrieve 2 params → 200
DELETE
/api/v1/companies/suppliers/{supplier_uuid}/documents/{uuid}/
api_v1_companies_suppliers_documents_destroy 2 params → 204
GET
/api/v1/companies/suppliers/{uuid}/
api_v1_companies_suppliers_retrieve 1 param → 200
PUT
/api/v1/companies/suppliers/{uuid}/
api_v1_companies_suppliers_update 1 param body → 200
PATCH
/api/v1/companies/suppliers/{uuid}/
api_v1_companies_suppliers_partial_update 1 param body → 200
POST
/api/v1/companies/suppliers/{uuid}/approve-kyb/
Set KYB status. WARNING: For QA use only!
api_v1_companies_suppliers_approve_kyb_create 1 param → 200
PUT
/api/v1/companies/suppliers/{uuid}/questionnaire/
api_v1_companies_suppliers_questionnaire_update 1 param body → 200
POST
/api/v1/companies/suppliers/buyer-summary/
Get brand summary for supplier
api_v1_companies_suppliers_buyer_summary_create body → 200
GET
/api/v1/companies/suppliers/dashboard/count/
Dashboard counts for Suppliers.
api_v1_companies_suppliers_dashboard_count_retrieve → 200
POST
/api/v1/companies/suppliers/initialize-onboarding/
api_v1_companies_suppliers_initialize_onboarding_create body → 201
GET
/api/v1/companies/suppliers/questionnaire_submitted/
api_v1_companies_suppliers_questionnaire_submitted_retrieve → 200
GET
/api/v1/inquiries/{inquiry_uuid}/quotes/supplier/
api_v1_inquiries_quotes_supplier_list 4 params → 200
POST
/api/v1/inquiries/{inquiry_uuid}/quotes/supplier/
Create a quote for a supplier
api_v1_inquiries_quotes_supplier_create 1 param body → 201
GET
/api/v1/inquiries/{inquiry_uuid}/quotes/supplier/{uuid}/
Retrieve details of a quote for a supplier
api_v1_inquiries_quotes_supplier_retrieve 2 params → 200
PUT
/api/v1/inquiries/{inquiry_uuid}/quotes/supplier/{uuid}/
Update a quote for a supplier
api_v1_inquiries_quotes_supplier_update 2 params body → 200
PATCH
/api/v1/inquiries/{inquiry_uuid}/quotes/supplier/{uuid}/
Partial update a quote for a supplier
api_v1_inquiries_quotes_supplier_partial_update 2 params body → 200
GET
/api/v1/inquiries/{inquiry_uuid}/quotes/supplier/{uuid}/channel/
api_v1_inquiries_quotes_supplier_channel_retrieve 2 params → 200
POST
/api/v1/inquiries/{inquiry_uuid}/quotes/supplier/{uuid}/mark-contract-confirmed/
api_v1_inquiries_quotes_supplier_mark_contract_confirmed_create 2 params → 204
POST
/api/v1/inquiries/{inquiry_uuid}/quotes/supplier/{uuid}/mark-contract-created/
api_v1_inquiries_quotes_supplier_mark_contract_created_create 2 params → 204
POST
/api/v1/inquiries/{inquiry_uuid}/quotes/supplier/{uuid}/publish/
api_v1_inquiries_quotes_supplier_publish_create 2 params → 204
POST
/api/v1/inquiries/{inquiry_uuid}/quotes/supplier/purchase_request_quote/
Create a quote for a purchase inquiry take its UUID
api_v1_inquiries_quotes_supplier_purchase_request_quote_create 1 param body → 201

Schemas 96

The contract defines 96 schemas that model the data the API accepts and returns. The most detailed are QuoteDetailSupplier (103 properties), QuoteDetailDispatch (103 properties), SupplierQuoteUpdate (57 properties), PatchedSupplierQuoteUpdate (57 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…
MarketplaceTcStatusEnum
string
acknowledged - Acknowledged pendingbanner - Pending (Banner) pendingblocking - Pending (Blocking)
NumOfEmployeesEnum
string
0 - 20 - 0 - 20 21 - 100 - 21 - 100 101 - 500 - 101 - 500 500+ - 500+
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
Company
object
23 properties 9 required
OnboardingSupplierActivity
object
Serializer for OnboardingSupplierActivity
8 properties 7 required
PaginatedQuoteDetailSupplierList
object
4 properties 2 required
NullEnum
CountryTypeEnum
string
EU - Eu GB - Gb Other - Other
StaffUser
object
6 properties 6 required
AddressTypeEnum
string
billingaddress - Billing address deliveryaddress - Delivery address dispatchaddress - Dispatch address companyaddress - Company address
CompanyDocument
object
4 properties 2 required
GoogleStorageSignedUrl
object
3 properties 2 required
PatchedOnboardingSupplierContact
object
9 properties
SupplierDashboardCount
object
5 properties 5 required
RevenueEnum
string
< £1M - < £1M £1M - £5M - £1M - £5M £5M - £10M - £5M - £10M £10M + - £10M +
PaginatedCompanyDocumentList
object
4 properties 2 required
SupplierOnboarding
object
14 properties 7 required
BlankEnum
QuoteForPurchaseInquiryCreate
object
2 properties 2 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…
PaginatedSupplierCompanyList
object
4 properties 2 required
OnboardingSupplierBuyer
object
Serializer for buyer information associated with an onboarding supplier
4 properties 4 required
UploadedProductsCatalogueStatus
string
pending - Pending beingprocessed - Is being processed processed - Processed failed - Failed
PaginatedCompanyAddressList
object
4 properties 2 required
PatchedSupplierQuoteUpdate
object
57 properties
OnboardingSupplierUpdate
object
Serializer for updating OnboardingSupplier status with optional activity message
6 properties
PaginatedOnboardingSupplierActivityList
object
4 properties 2 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…
ProductTypeEnum
string
confectsnacks - Confectionery & Snacks convfood - Convenience Food breadcereals - Bread & Cereals saucesspices - Sauces & Spices spreads - Spreads tea - Tea co…
PaginatedStaffUserList
object
4 properties 2 required
FrequencyEnum
string
weekly - Weekly monthly - Monthly quarterly - Quarterly annually - Annually
CompanyAddress
object
31 properties 5 required
PatchedOnboardingSupplierAddress
object
16 properties
QuoteDetailDispatch
object
103 properties 43 required
BuyerSummaryRequest
object
1 property 1 required
SamplesFeedbackEnum
string
ingredientquality - Ingredient Quality quoteprice - Quote Price suppliercommunication - Supplier Communication qualitynotasexpected - Quality Not As Expected t…
ProductCategoryEnum
string
freshfruitsvegetables - Fresh Fruit & Vegetables nutsseedsdriedfruit - Nuts, Seeds & Dried Fruit herbsspicesseasoning - Herbs, Spices & Seasonings meatfish - M…
BuyerSummaryResponse
object
4 properties 2 required
AnnualTurnoverEnum
string
0 USD - 5m USD - 0 USD - 5m USD 6m USD - 20m USD - 6m USD - 20m USD 21m USD - 100m USD - 21m USD - 100m USD 100m+ USD - 100m+ USD
QuoteCreate
object
55 properties 7 required
OnboardingSupplierActivityCreate
object
Serializer for creating OnboardingSupplierActivity (used when status update with message)
2 properties 1 required
AccountTypeEnum
string
checking - Checking savings - Savings
QuoteCategory
string
nonrecurring - Non Recurring recurring - Recurring purchaserequestquote - Purchase Request Quote
PaginatedOnboardingSupplierListList
object
4 properties 2 required
OnboardingSupplier
object
Serializer for OnboardingSupplier model
35 properties 27 required
CompanyTypeEnum
string
brand - Brand supplier - Supplier merchantofrecord - Merchant of Record
PaginatedOnboardingSupplierBuyerList
object
4 properties 2 required
SectionSupplier
object
5 properties 4 required
PatchedUploadedProductsCatalogue
object
4 properties
OnboardingSupplierContact
object
9 properties 6 required
CompanyInvite
object
7 properties 7 required
DeliveryAddressForSupplier
object
3 properties
PaginatedUploadedProductsCatalogueList
object
4 properties 2 required
QuoteState
string
available - available ordered - ordered expired - expired declined - declined pendingpayment - pendingpayment proceeded - proceeded contractcreated - Contract…
PatchedOnboardingSupplierUpdate
object
Serializer for updating OnboardingSupplier status with optional activity message
6 properties
GoogleStorageSignedUrlResponse
object
1 property 1 required
IngredientsForQuote
object
3 properties 3 required
UserAuthToken
object
1 property 1 required
PaymentTermsEnum
string
inadvance - In Advance ondispatch - On Dispatch 7daysafterdispatch - Days After Dispatch 7 14daysafterdispatch - Days After Dispatch 14 30daysafterdispatch - D…
SupplierQuoteUpdate
object
57 properties 9 required
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…
SupplierQuestionnaire
object
5 properties
InitializeSupplier
object
9 properties 4 required
PaymentScenarioEnum
string
inadvance - In Advance ondispatch - On Dispatch
ChannelUUID
object
1 property 1 required
QuoteDetailSupplier
object
103 properties 43 required
OnboardingSupplierList
object
Lightweight serializer for list views
6 properties 6 required
Currencies
string
EUR - EUR USD - USD GBP - GBP CAD - CAD
PaginatedOnboardingSupplierContactList
object
4 properties 2 required
SelectedPriceOptionEnum
string
total - total unit - unit
SamplesStatusEnum
string
available - Available requested - Requested sent - Sent received - Received accepted - Accepted rejected - Rejected declined - Declined
QuoteDescriptionBlockCreate
object
1 property 1 required
OnboardingSupplierStatus
string
onboardingnotstarted - Onboarding has not started suppliercontacted - Supplier contacted settingupaccount - Setting up account readytotrade - Ready to trade wi…
BuyerSummary
object
Serializer for buyer summary information
2 properties 2 required
MovEnum
string
0 USD - 199 USD - 0 USD - 199 USD 200 USD - 499 USD - 200 USD - 499 USD 500 USD - 2999 USD - 500 USD - 2999 USD 3000+ USD - 3000+ USD
PatchedSupplierCompany
object
23 properties
PatchedOnboardingSupplierPayoutDetails
object
20 properties
AddressContactPhoneCountryCodeEnum
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…
CompanyDocumentCategory
string
ingredientslist - Ingredients List other - Other
FinalSupplierCreate
object
Serializer for creating the final supplier when onboarding is complete. This creates a new User, the Company, and its associated CompanyAddress, and automatica…
12 properties 4 required
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…
SupplierCompany
object
23 properties 10 required
DeliveryAddressResponse
object
12 properties 1 required
CompanyOnboardingStateEnum
string
inprogress - In progress active - Active
UploadedProductsCatalogueStorage
object
1 property 1 required
PricesRetrieve
object
29 properties 26 required
OnboardingSupplierCreate
object
Serializer for creating OnboardingSupplier
7 properties 2 required
IncotermsEnum
string
deliverydutypaid - deliverydutypaid deliverydutyunpaid - deliverydutyunpaid costinsuranceandfreight - costinsuranceandfreight carriageandinsurancepaidto - carr…
SupplierContactCategoryEnum
string
orders - Orders logistics - Logistics and Supply Chain finance - Finance other - Other
PatchedCompanyAddress
object
31 properties
UploadedProductsCatalogue
object
4 properties 2 required
OnboardingSupplierPayoutDetails
object
20 properties 5 required
NumOfSkusEnum
string
0 - 10 - 0 - 10 10 - 100 - 10 - 100 100 - 500 - 100 - 500 500+ - 500+
CompanyInfo
object
39 properties 20 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

opply-suppliers-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 Suppliers 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.