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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Opply

Opply Agreements API

The Agreements API from Opply — 10 operation(s) for agreements.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 14 operations across 10 paths, and defines 35 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.

14 operations 10 paths 35 schemas 2 DELETE6 GET1 PATCH4 POST1 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 Agreements 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 14

Across 10 paths, the API surfaces 14 operations — 2 DELETE, 6 GET, 1 PATCH, 4 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Agreements 14
GET
/api/v1/agreements/brand/
List all agreements for the buyer's company
api_v1_agreements_brand_list 7 params → 200401403
GET
/api/v1/agreements/brand/{uuid}/
Retrieve a specific agreement
api_v1_agreements_brand_retrieve 1 param → 200401403404
POST
/api/v1/agreements/brand/{uuid}/place-order/
Place an order from an agreement
api_v1_agreements_brand_place_order_create 1 param body → 201400404
GET
/api/v1/agreements/brand/aggregate/
Aggregate agreement totals across the filtered set in full precision
api_v1_agreements_brand_aggregate_retrieve 10 params → 200400403
GET
/api/v1/agreements/merchant-of-record/
List all agreements for the merchant of record company
api_v1_agreements_merchant_of_record_list 11 params → 200401403
POST
/api/v1/agreements/merchant-of-record/
Create a new agreement
api_v1_agreements_merchant_of_record_create body → 201400
GET
/api/v1/agreements/merchant-of-record/{uuid}/
Retrieve a specific agreement
api_v1_agreements_merchant_of_record_retrieve 1 param → 200401403404
PUT
/api/v1/agreements/merchant-of-record/{uuid}/
Merchant of Record endpoints for Agreements
api_v1_agreements_merchant_of_record_update 1 param body → 200
PATCH
/api/v1/agreements/merchant-of-record/{uuid}/
Merchant of Record endpoints for Agreements
api_v1_agreements_merchant_of_record_partial_update 1 param body → 200
DELETE
/api/v1/agreements/merchant-of-record/{uuid}/
Merchant of Record endpoints for Agreements
api_v1_agreements_merchant_of_record_destroy 1 param → 204
POST
/api/v1/agreements/merchant-of-record/{uuid}/line-item/{line_item_uuid}/documents/
Upload a document for an agreement line item
api_v1_agreements_merchant_of_record_line_item_documents_create 2 params body → 201400403404
DELETE
/api/v1/agreements/merchant-of-record/{uuid}/line-item/{line_item_uuid}/documents/{document_uuid}/
Delete a document for an agreement line item
api_v1_agreements_merchant_of_record_line_item_documents_destroy 3 params → 204400403404
GET
/api/v1/agreements/merchant-of-record/{uuid}/orders/
List orders placed against this agreement
api_v1_agreements_merchant_of_record_orders_list 3 params → 200401404
POST
/api/v1/agreements/merchant-of-record/{uuid}/place-order/
Place an order from a contract (agreement)
api_v1_agreements_merchant_of_record_place_order_create 1 param body → 201400404

Schemas 35

The contract defines 35 schemas that model the data the API accepts and returns. The most detailed are MerchantOfRecordAgreementDetails (34 properties), MerchantOfRecordAgreementLineItem (24 properties), MerchantOfRecordAgreementCreate (23 properties), BuyerAgreementDetails (22 properties). Each schema is shown below with its type and property counts.

LifecycleStateEnum
string
initializing - Initializing confirmed - Confirmed canceled - Cancelled pendingmerchantofrecordapproval - Pending Merchant of Record Approval orderreceived - Or…
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…
PaginatedBuyerAgreementListList
object
4 properties 2 required
PaginatedMerchantOfRecordAgreementLinkedOrderList
object
4 properties 2 required
DeliveryStateEnum
string
initializing - Initializing notstarted - Not Started pendingdispatch - Pending Dispatch intransit - In Transit delivered - Delivered freightownershippending -…
AvailableCurrenciesEnum
string
EUR - EUR GBP - GBP USD - USD
BuyerAgreementLineItem
object
17 properties 13 required
AgreementOrderResponse
object
1 property 1 required
AgreementLineItemDocumentCategoryEnum
string
specsheet - Spec Sheet signedagreement - Signed Agreement
NullEnum
PaymentProviderEnum
string
stripe - Stripe two - Two direct - Direct
DeliveryAddressResponse
object
12 properties 1 required
MerchantOfRecordAgreementCreate
object
23 properties 10 required
CatalogItemSummary
object
Compact read-only summary of a BuyerItem or SupplierItem for embedding on order / agreement line-item read serializers. A plain Serializer (not ModelSerializer…
5 properties 5 required
MerchantOfRecordAgreementOrderResponse
object
1 property 1 required
BuyerAgreementAggregateResult
object
5 properties 5 required
AgreementOrderLineItem
object
2 properties 2 required
MerchantOfRecordAgreementLinkedOrder
object
Lightweight row for the contract detail's Linked Orders table.
5 properties 3 required
MerchantOfRecordAgreementLineItemCreate
object
14 properties 4 required
MerchantOfRecordAgreementList
object
8 properties 8 required
AppOrderPaymentTermsEnum
string
paybeforedispatch - Pay Before Dispatch payafterdispatch - Pay After Dispatch payon28thsecondmonthafterdispatch - Pay on 28th second month after dispatch payen…
MerchantOfRecordAgreementDetails
object
34 properties 26 required
AgreementLineItemDocument
object
3 properties 3 required
PayoutTermsEnum
string
payoutbeforedispatch - Payout Before Dispatch payoutafterdispatch - Payout After Dispatch
MerchantOfRecordAgreementLineItem
object
24 properties 19 required
PatchedMerchantOfRecordAgreementList
object
8 properties
BuyerAgreementDetails
object
22 properties 19 required
PaginatedMerchantOfRecordAgreementListList
object
4 properties 2 required
AgreementSummary
object
Serializer for agreement summary metrics.
3 properties 3 required
MerchantOfRecordAgreementOrderCreate
object
Place an order from a contract as the merchant of record. Mirrors the buyer AgreementOrderCreateSerializer (delivery date + address + per-line quantities), wit…
5 properties 3 required
AgreementLineItemDocumentUpload
object
2 properties 2 required
BlankEnum
BuyerAgreementList
object
16 properties 14 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…
AgreementOrderCreate
object
4 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

opply-agreements-api-openapi.yml Raw ↑

Other APIs Opply publishes across the network.

Opply Activity Feed API
AE Profile APIs.io
Opply Admin panel API
AE Profile APIs.io
Opply Agents API
AE Profile APIs.io
Opply api API
AE Profile APIs.io
Opply App Orders API
AE Profile APIs.io
Opply Brain API
AE Profile APIs.io
Opply Brands API
AE Profile APIs.io
Opply Buyer Documents API
AE Profile APIs.io
Opply Buyer Financial Documents API
AE Profile APIs.io
Opply Buyer Onboarding API
AE Profile APIs.io
Opply Buyer self-onboarding API
AE Profile APIs.io
Opply Buyers API
AE Profile APIs.io
#Agreements
← Back to O APIs
API Details
ID
opply:opply-agreements-api
Base URL
https://api.opply.com
Docs
https://opply.com/
Provider
Opply
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=opply-agreements-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/opply-agreements-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

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