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 Order Management Contracts API

The Order Management Contracts API from Opply — 3 operation(s) for order management contracts.

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

Tagged areas include Order Management Contracts. The published artifact set on APIs.io includes an OpenAPI specification.

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

7 operations 3 paths 14 schemas 1 DELETE3 GET1 PATCH1 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 Order Management Contracts 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 7

Across 3 paths, the API surfaces 7 operations — 1 DELETE, 3 GET, 1 PATCH, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Order Management Contracts 7
GET
/api/v1/order-management-contracts/buyer/current/
Get the buyer's currently active Order Management Contract
api_v1_order_management_contracts_buyer_current_retrieve → 200401
GET
/api/v1/order-management-contracts/merchant-of-record/
List all order management contracts for the merchant of record company
api_v1_order_management_contracts_merchant_of_record_list 5 params → 200401403
POST
/api/v1/order-management-contracts/merchant-of-record/
Create a new order management contract
api_v1_order_management_contracts_merchant_of_record_create body → 201400
GET
/api/v1/order-management-contracts/merchant-of-record/{uuid}/
Retrieve a specific order management contract
api_v1_order_management_contracts_merchant_of_record_retrieve 1 param → 200401403404
PUT
/api/v1/order-management-contracts/merchant-of-record/{uuid}/
Update an order management contract
api_v1_order_management_contracts_merchant_of_record_update 1 param body → 200400403404
PATCH
/api/v1/order-management-contracts/merchant-of-record/{uuid}/
Partially update an order management contract
api_v1_order_management_contracts_merchant_of_record_partial_update 1 param body → 200400403404
DELETE
/api/v1/order-management-contracts/merchant-of-record/{uuid}/
Merchant of Record endpoints for Order Management Contracts
api_v1_order_management_contracts_merchant_of_record_destroy 1 param → 204

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are OrderManagementContractDetail (16 properties), OrderManagementContractList (13 properties), BuyerOrderManagementContractActiveData (10 properties), OrderManagementContractCreate (8 properties). Each schema is shown below with its type and property counts.

BuyerCurrentOrderManagementContractStateEnum
string
active - Active empty - Empty
BuyerCurrentOrderManagementContract
object
Wraps the active OMC with a state discriminator so the FE can render an empty card when the buyer has no current contract.
2 properties 2 required
OrderManagementContractCreate
object
8 properties 5 required
OrderManagementContractUpdate
object
7 properties 2 required
BuyerOrderManagementContractActiveData
object
Active Order Management Contract data shaped for the contracts page card. All money is emitted as integer cents. The FE mapper divides by 100 to render major u…
10 properties 10 required
CompanyNameAndId
object
3 properties 3 required
PaginatedOrderManagementContractListList
object
4 properties 2 required
AvailableCurrenciesEnum
string
EUR - EUR GBP - GBP USD - USD
OrderManagementContractDetail
object
16 properties 14 required
OrderManagementContractServiceFeeCreate
object
Write serializer for service fees - no uuid needed on create/update
2 properties 2 required
OrderManagementContractServiceFee
object
Read serializer for service fees - includes uuid for identification
3 properties 1 required
OrderManagementContractList
object
13 properties 11 required
PatchedOrderManagementContractUpdate
object
7 properties
ServiceFeeTypeEnum
string
ordermanagementonly - Order Management Only ordermanagementwithpaymentsupport - Order Management with Payment Support

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

opply-order-management-contracts-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 Order Management Contracts 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.