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.
The identity and technical contract details declared by the specification.
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
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
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
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Opply publishes across the network.