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

The Orders API from Opply — 21 operation(s) for orders.

Opply Orders 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. The published artifact set on APIs.io includes an OpenAPI specification.

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

28 operations 21 paths 67 schemas 2 DELETE18 GET1 PATCH6 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 Orders 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 28

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

Orders 28
GET
/api/v1/orders/brand/
List of orders
api_v1_orders_brand_list 9 params → 200
POST
/api/v1/orders/brand/
api_v1_orders_brand_create body → 201
GET
/api/v1/orders/brand/{order_uuid}/
Retrieve details of an orders for a brand
api_v1_orders_brand_retrieve 1 param → 200
POST
/api/v1/orders/brand/{order_uuid}/confirm-delivered/
api_v1_orders_brand_confirm_delivered_create 1 param body → 200
GET
/api/v1/orders/brand/{order_uuid}/disputes/
Endpoints for Order Disputes for Brand
api_v1_orders_brand_disputes_list 3 params → 200
POST
/api/v1/orders/brand/{order_uuid}/disputes/
Endpoints for Order Disputes for Brand
api_v1_orders_brand_disputes_create 1 param body → 201
GET
/api/v1/orders/brand/{order_uuid}/disputes/{dispute_uuid}/
Endpoints for Order Disputes for Brand
api_v1_orders_brand_disputes_retrieve 2 params → 200
PUT
/api/v1/orders/brand/{order_uuid}/disputes/{dispute_uuid}/
Endpoints for Order Disputes for Brand
api_v1_orders_brand_disputes_update 2 params body → 200
PATCH
/api/v1/orders/brand/{order_uuid}/disputes/{dispute_uuid}/
Endpoints for Order Disputes for Brand
api_v1_orders_brand_disputes_partial_update 2 params body → 200
DELETE
/api/v1/orders/brand/{order_uuid}/disputes/{dispute_uuid}/
Endpoints for Order Disputes for Brand
api_v1_orders_brand_disputes_destroy 2 params → 204
GET
/api/v1/orders/brand/{order_uuid}/goods-receipt/pdf/
api_v1_orders_brand_goods_receipt_pdf_retrieve 1 param → 200
GET
/api/v1/orders/brand/{order_uuid}/invoice/
Note that this endpoint is a tad broken, the currency field doesn't return a 3 character ISO code (GBP for example) for currency, instead it returns the currency symbol, (£ for example)
api_v1_orders_brand_invoice_retrieve 1 param → 200
GET
/api/v1/orders/brand/{order_uuid}/invoice/pdf/
api_v1_orders_brand_invoice_pdf_retrieve 1 param → 200
GET
/api/v1/orders/brand/{order_uuid}/vat-invoice/
api_v1_orders_brand_vat_invoice_retrieve 1 param → 200
GET
/api/v1/orders/brand/{order_uuid}/vat-invoice/pdf/
Returns commission invoice as pdfurl, combined Admin and commission invoice as pdfurlmerged.
api_v1_orders_brand_vat_invoice_pdf_retrieve 1 param → 200
POST
/api/v1/orders/brand/basket-volumes/
Returns all prices for basket divided by supplier
api_v1_orders_brand_basket_volumes_create body → 200
GET
/api/v1/orders/supplier/
List of orders
api_v1_orders_supplier_list 9 params → 200
GET
/api/v1/orders/supplier/{order_uuid}/
Retrieve details of an orders for a supplier
api_v1_orders_supplier_retrieve 1 param → 200
POST
/api/v1/orders/supplier/{order_uuid}/confirm-dispatch/
api_v1_orders_supplier_confirm_dispatch_create 1 param body → 200
GET
/api/v1/orders/supplier/{order_uuid}/documents/
api_v1_orders_supplier_documents_list 3 params → 200
POST
/api/v1/orders/supplier/{order_uuid}/documents/
api_v1_orders_supplier_documents_create 1 param body → 201
GET
/api/v1/orders/supplier/{order_uuid}/documents/{uuid}/
api_v1_orders_supplier_documents_retrieve 2 params → 200
DELETE
/api/v1/orders/supplier/{order_uuid}/documents/{uuid}/
api_v1_orders_supplier_documents_destroy 2 params → 204
GET
/api/v1/orders/supplier/{order_uuid}/purchase-order/
api_v1_orders_supplier_purchase_order_retrieve 1 param → 200
GET
/api/v1/orders/supplier/{order_uuid}/purchase-order/pdf/
api_v1_orders_supplier_purchase_order_pdf_retrieve 1 param → 200
GET
/api/v1/orders/supplier/{order_uuid}/vat-invoice/
api_v1_orders_supplier_vat_invoice_retrieve 1 param → 200
GET
/api/v1/orders/supplier/{order_uuid}/vat-invoice/pdf/
Returns commission invoice as pdfurl.
api_v1_orders_supplier_vat_invoice_pdf_retrieve 1 param → 200
GET
/api/v1/orders/supplier/dashboard-orders/
Returns pending dispatch orders for Supplier's dashboard.
api_v1_orders_supplier_dashboard_orders_list 3 params → 200

Schemas 67

The contract defines 67 schemas that model the data the API accepts and returns. The most detailed are QuoteOrderDetail (103 properties), OrderDetail (48 properties), Order (35 properties), CompanyAddress (31 properties). Each schema is shown below with its type and property counts.

QuoteState
string
available - available ordered - ordered expired - expired declined - declined pendingpayment - pendingpayment proceeded - proceeded contractcreated - Contract…
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…
OrderDetail
object
48 properties 33 required
QuoteDescriptionBlock
object
2 properties 2 required
FrequencyEnum
string
weekly - Weekly monthly - Monthly quarterly - Quarterly annually - Annually
OrderConfirmDispatched
object
4 properties 3 required
IngredientsForQuote
object
3 properties 3 required
CompanyAddress
object
31 properties 5 required
BasketResponse
object
2 properties 2 required
PaginatedDashboardOrdersList
object
4 properties 2 required
Fees
object
2 properties 1 required
OrderDocumentCategory
string
uploadedbyadmin - Uploaded By Admin uploadedbysupplier - Uploaded By Supplier
PaginatedOrderDisputeList
object
4 properties 2 required
NullEnum
VatInvoiceSupplierResponse
object
1 property 1 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…
PurchaseOrderCompanyInfo
object
3 properties 3 required
SamplesFeedbackEnum
string
ingredientquality - Ingredient Quality quoteprice - Quote Price suppliercommunication - Supplier Communication qualitynotasexpected - Quality Not As Expected t…
PaymentTermsEnum
string
inadvance - In Advance ondispatch - On Dispatch 7daysafterdispatch - Days After Dispatch 7 14daysafterdispatch - Days After Dispatch 14 30daysafterdispatch - D…
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…
OrderCategory
string
regular - Regular
DeliveryAddressResponse
object
12 properties 1 required
OrderConfirmDelivered
object
4 properties 2 required
PurchaseOrderShipping
object
7 properties 7 required
BankAccount
object
8 properties 2 required
CountryTypeEnum
string
EU - Eu GB - Gb Other - Other
OrderDisputeRequest
object
3 properties 3 required
PaymentScenarioEnum
string
inadvance - In Advance ondispatch - On Dispatch
PricesRetrieve
object
29 properties 26 required
PaginatedOrderDocumentList
object
4 properties 2 required
AddressTypeEnum
string
billingaddress - Billing address deliveryaddress - Delivery address dispatchaddress - Dispatch address companyaddress - Company address
AllCurrencies
string
BND - BND QAR - QAR BUK - BUK LVR - LVR ZRN - ZRN SRD - SRD STD - STD BGL - BGL BOB - BOB CUC - CUC DEM - DEM SOS - SOS BOL - BOL BRZ - BRZ BWP - BWP MKN - MKN…
OurAddress
object
9 properties 9 required
IncotermsEnum
string
deliverydutypaid - deliverydutypaid deliverydutyunpaid - deliverydutyunpaid costinsuranceandfreight - costinsuranceandfreight carriageandinsurancepaidto - carr…
BasketPrices
object
11 properties 11 required
PatchedOrderDispute
object
3 properties
PaginatedOrderList
object
4 properties 2 required
OrderState
string
checkout - Checkout confirmed - confirmed pendingpayment - pendingpayment canceled - canceled awaitingapproval - awaitingapproval onhold - onhold placed - plac…
OrderCreateSwagger
object
1 property 1 required
ShipmentStatusEnum
string
pendingdispatch - pendingdispatch dispatched - Dispatched delivered - Delivered
BrandVatInvoiceData
object
17 properties 17 required
OrderDispute
object
3 properties 3 required
PaymentDetailsInvoice
object
3 properties 3 required
ProductDetails
object
9 properties 6 required
QuoteOrderDetail
object
103 properties 43 required
QuoteCategory
string
nonrecurring - Non Recurring recurring - Recurring purchaserequestquote - Purchase Request Quote
PaymentMethod
string
card - Card banktransfer - Bank Transfer PAY30 - Kriya 30 PAY30EOFM - Kriya Next Month
Currencies
string
EUR - EUR USD - USD GBP - GBP CAD - CAD
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
BankTransfer
object
3 properties 2 required
GoodsReceiptPDFUrl
object
1 property 1 required
BlankEnum
BrandInvoice
object
16 properties 15 required
KriyaStatusEnum
string
Draft - Draft Submitted - Submitted ReadyToAdvance - Ready To Advance Advanced - Advanced Repaid - Repaid Due - Due Overdue - Overdue Closed - Closed Cancelled…
PDFUrl
object
1 property 1 required
PurchaseOrder
object
12 properties 12 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…
Order
object
35 properties 24 required
DashboardOrders
object
5 properties 4 required
VirtualBankTransfer
object
3 properties 3 required
VatInvoiceResponse
object
2 properties 2 required
PaymentStatusEnum
string
paid - paid paymentupcoming - paymentupcoming paymentprocessing - paymentprocessing paymentdue - paymentdue
SectionSupplier
object
5 properties 4 required
BasketDiscountSwagger
object
1 property 1 required
OrderDocument
object
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

opply-orders-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 Orders 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.