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 Public Buyer Onboarding API

The Public Buyer Onboarding API from Opply — 23 operation(s) for public buyer onboarding.

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

Tagged areas include Public Buyer Onboarding. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 24 operations across 23 paths, and defines 32 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.

24 operations 23 paths 32 schemas 2 DELETE11 GET4 PATCH7 POST

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 Public Buyer Onboarding 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 24

Across 23 paths, the API surfaces 24 operations — 2 DELETE, 11 GET, 4 PATCH, 7 POST. Each is listed below with its method, path, parameters, and response codes.

Public Buyer Onboarding 24
GET
/api/v1/buyer-onboarding/public/buyers/{uuid}/
Get buyer onboarding details
api_v1_buyer_onboarding_public_buyers_retrieve 1 param → 200404
GET
/api/v1/buyer-onboarding/public/buyers/{uuid}/account-details/
Get account details
api_v1_buyer_onboarding_public_buyers_account_details_retrieve 1 param → 200404
POST
/api/v1/buyer-onboarding/public/buyers/{uuid}/account-details/create/
Create account details
api_v1_buyer_onboarding_public_buyers_account_details_create_create 1 param body → 201400404
PATCH
/api/v1/buyer-onboarding/public/buyers/{uuid}/account-details/update/
Update account details
api_v1_buyer_onboarding_public_buyers_account_details_update_partial_update 1 param body → 200400404
GET
/api/v1/buyer-onboarding/public/buyers/{uuid}/delivery-addresses/
Get delivery addresses
api_v1_buyer_onboarding_public_buyers_delivery_addresses_list 3 params → 200
DELETE
/api/v1/buyer-onboarding/public/buyers/{uuid}/delivery-addresses/{address_uuid}/delete/
Delete delivery address
api_v1_buyer_onboarding_public_buyers_delivery_addresses_delete_destroy 2 params → 204404
PATCH
/api/v1/buyer-onboarding/public/buyers/{uuid}/delivery-addresses/{address_uuid}/update/
Update delivery address
api_v1_buyer_onboarding_public_buyers_delivery_addresses_update_partial_update 2 params body → 200400404
POST
/api/v1/buyer-onboarding/public/buyers/{uuid}/delivery-addresses/create/
Create delivery address
api_v1_buyer_onboarding_public_buyers_delivery_addresses_create_create 1 param body → 201400
GET
/api/v1/buyer-onboarding/public/buyers/{uuid}/delivery-details/
Get delivery details
api_v1_buyer_onboarding_public_buyers_delivery_details_retrieve 1 param → 200404
POST
/api/v1/buyer-onboarding/public/buyers/{uuid}/delivery-details/create/
Create delivery details
api_v1_buyer_onboarding_public_buyers_delivery_details_create_create 1 param body → 201400404
PATCH
/api/v1/buyer-onboarding/public/buyers/{uuid}/delivery-details/update/
Update delivery details
api_v1_buyer_onboarding_public_buyers_delivery_details_update_partial_update 1 param body → 200400404
GET
/api/v1/buyer-onboarding/public/buyers/{uuid}/delivery-emails/
Get or update delivery emails
api_v1_buyer_onboarding_public_buyers_delivery_emails_list 3 params → 200400
POST
/api/v1/buyer-onboarding/public/buyers/{uuid}/delivery-emails/
Get or update delivery emails
api_v1_buyer_onboarding_public_buyers_delivery_emails_create 3 params body → 200400
GET
/api/v1/buyer-onboarding/public/buyers/{uuid}/documents/
List documents
api_v1_buyer_onboarding_public_buyers_documents_list 3 params → 200
DELETE
/api/v1/buyer-onboarding/public/buyers/{uuid}/documents/{document_uuid}/delete/
Delete document
api_v1_buyer_onboarding_public_buyers_documents_delete_destroy 2 params → 204404
POST
/api/v1/buyer-onboarding/public/buyers/{uuid}/documents/upload/
Upload document
api_v1_buyer_onboarding_public_buyers_documents_upload_create 1 param body → 201400
GET
/api/v1/buyer-onboarding/public/buyers/{uuid}/phases/
Get onboarding phases
api_v1_buyer_onboarding_public_buyers_phases_list 3 params → 200404
GET
/api/v1/buyer-onboarding/public/buyers/{uuid}/steps/
List buyer onboarding steps
api_v1_buyer_onboarding_public_buyers_steps_list 5 params → 200404
GET
/api/v1/buyer-onboarding/public/buyers/{uuid}/steps/{step_id}/
Get buyer onboarding step
api_v1_buyer_onboarding_public_buyers_steps_retrieve 2 params → 200404
GET
/api/v1/buyer-onboarding/public/buyers/{uuid}/suppliers/
List suppliers
api_v1_buyer_onboarding_public_buyers_suppliers_list 3 params → 200404
GET
/api/v1/buyer-onboarding/public/buyers/{uuid}/suppliers/{supplier_id}/
Get supplier details
api_v1_buyer_onboarding_public_buyers_suppliers_retrieve 2 params → 200404
PATCH
/api/v1/buyer-onboarding/public/buyers/{uuid}/suppliers/{supplier_id}/update/
Update supplier
api_v1_buyer_onboarding_public_buyers_suppliers_update_partial_update 2 params body → 200400404
POST
/api/v1/buyer-onboarding/public/buyers/{uuid}/suppliers/complete/
Mark supplier section as complete
api_v1_buyer_onboarding_public_buyers_suppliers_complete_create 1 param body → 200404
POST
/api/v1/buyer-onboarding/public/buyers/{uuid}/suppliers/create/
Create supplier
api_v1_buyer_onboarding_public_buyers_suppliers_create_create 1 param body → 201400404

Schemas 32

The contract defines 32 schemas that model the data the API accepts and returns. The most detailed are BuyerOnboardingDeliveryAddress (30 properties), PatchedBuyerOnboardingDeliveryAddress (30 properties), BuyerOnboardingDetail (19 properties), BuyerOnboardingStep (15 properties). Each schema is shown below with its type and property counts.

BuyerOnboardingDocument
object
Serializer for BuyerOnboardingDocument model.
6 properties 5 required
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…
PriorityEnum
string
high - High medium - Medium low - Low
PaginatedBuyerOnboardingDocumentList
object
4 properties 2 required
PatchedDeliveryDetails
object
Serializer for delivery details.
15 properties
BuyerOnboardingStep
object
Serializer for buyer onboarding step with template information.
15 properties 11 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…
DeliveryEmailList
object
Serializer for handling create/update/delete operations on a list of delivery emails. Accepts a list of delivery email objects and handles validation, creation…
1 property 1 required
AccountDetail
object
Serializer for account details with country-specific validation. Supports DUNS field and AccountEmail management. UK buyers require: companyname, vatnumber, co…
13 properties 9 required
PaginatedSupplierList
object
4 properties 2 required
CountryTypeEnum
string
EU - Eu GB - Gb Other - Other
DeliveryEmail
object
Serializer for DeliveryEmail model.
5 properties 5 required
DeliveryLocationTypeEnum
string
warehouse - Warehouse factory - Factory distributioncenter - Distribution Center retaillocation - Retail Location other - Other
AddressTypeEnum
string
billingaddress - Billing address deliveryaddress - Delivery address dispatchaddress - Dispatch address companyaddress - Company address
BuyerOnboardingCountry
string
us - United States uk - United Kingdom
BuyerOnboardingDetail
object
Detailed serializer for buyer onboarding. Includes all related information. For self-onboarded buyers (buyeronboarding.company is set), the name / email fields…
19 properties 18 required
PatchedBuyerOnboardingDeliveryAddress
object
Serializer for BuyerOnboardingDeliveryAddress model. Includes all BaseAddress fields plus delivery-specific fields.
30 properties
DeliveryDetails
object
Serializer for delivery details.
15 properties 5 required
AccessRequirementsEnum
string
deliveryappointment - Delivery appointment requirement insidedelivery - Inside delivery Required liftgate - Lift gate required
PaginatedBuyerOnboardingStepList
object
4 properties 2 required
PaginatedOnboardingStepTemplateList
object
4 properties 2 required
PaginatedDeliveryEmailList
object
4 properties 2 required
BlankEnum
BuyerOnboardingDeliveryAddress
object
Serializer for BuyerOnboardingDeliveryAddress model. Includes all BaseAddress fields plus delivery-specific fields.
30 properties 5 required
OnboardingStepTemplate
object
Serializer for onboarding step template.
6 properties 4 required
PhaseEnum
string
phase1 - Phase 1 phase2 - Phase 2 phase3 - Phase 3 phase4 - Phase 4
Supplier
object
Serializer for supplier information. Only includes fields that are actively used in the public buyer onboarding form. Other model fields are kept for backward…
15 properties 5 required
PatchedSupplier
object
Serializer for supplier information. Only includes fields that are actively used in the public buyer onboarding form. Other model fields are kept for backward…
15 properties
PaginatedBuyerOnboardingDeliveryAddressList
object
4 properties 2 required
AccountEmail
object
Serializer for AccountEmail model.
5 properties 5 required
PatchedAccountDetail
object
Serializer for account details with country-specific validation. Supports DUNS field and AccountEmail management. UK buyers require: companyname, vatnumber, co…
13 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

opply-public-buyer-onboarding-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 Public Buyer Onboarding 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.