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

The App Orders API from Opply — 126 operation(s) for app orders.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

This API exposes 130 operations across 126 paths, and defines 222 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.

130 operations 126 paths 222 schemas 3 DELETE69 GET7 PATCH48 POST3 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 App 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 130

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

App Orders 130
GET
/api/v1/app-orders/admin/
App Orders admin endpoints
api_v1_app_orders_admin_list 2 params → 200
GET
/api/v1/app-orders/admin/{uuid}/
App Orders admin endpoints
api_v1_app_orders_admin_retrieve 1 param → 200
POST
/api/v1/app-orders/admin/{uuid}/create-order-event/
Endpoint to add order event for app order
api_v1_app_orders_admin_create_order_event_create 1 param body → 201
GET
/api/v1/app-orders/admin/{uuid}/documents/
Endpoint to list documents for an app order
api_v1_app_orders_admin_documents_list 3 params → 200
DELETE
/api/v1/app-orders/admin/{uuid}/documents/{document_uuid}/
Endpoint to delete a specific document
api_v1_app_orders_admin_documents_destroy 2 params → 204
PUT
/api/v1/app-orders/admin/{uuid}/edit/
Endpoint to edit order prices for supplier
api_v1_app_orders_admin_edit_update 1 param body → 200
POST
/api/v1/app-orders/admin/{uuid}/mark-order-as-paid/
Endpoint to mark order as paid
api_v1_app_orders_admin_mark_order_as_paid_create 1 param → 200400500
POST
/api/v1/app-orders/admin/{uuid}/mark-order-as-paid-out-to-supplier/
Endpoint to mark order as paid out to supplier
api_v1_app_orders_admin_mark_order_as_paid_out_to_supplier_create 1 param → 200
GET
/api/v1/app-orders/admin/{uuid}/order-events/
Endpoint to get order events
api_v1_app_orders_admin_order_events_list 3 params → 200
GET
/api/v1/app-orders/admin/{uuid}/pricing/
Endpoint to get order prices for Buyer
api_v1_app_orders_admin_pricing_retrieve 1 param → 200
POST
/api/v1/app-orders/admin/{uuid}/upload-document/
Endpoint to upload a document for an app order
api_v1_app_orders_admin_upload_document_create 1 param body → 201
GET
/api/v1/app-orders/brand/
List all buyer orders
api_v1_app_orders_brand_list 12 params → 200
GET
/api/v1/app-orders/brand/{uuid}/
Brand endpoints for App Orders
api_v1_app_orders_brand_retrieve 1 param → 200
POST
/api/v1/app-orders/brand/{uuid}/client-notified-as-paid/
Buyer notifies order as paid
api_v1_app_orders_brand_client_notified_as_paid_create 1 param body → 204400
GET
/api/v1/app-orders/brand/{uuid}/invoice-url/
Returns the invoice URL or PDF
api_v1_app_orders_brand_invoice_url_retrieve 1 param → 200400404
POST
/api/v1/app-orders/brand/{uuid}/mark-as-delivered/
Buyer mark an order as delivered
api_v1_app_orders_brand_mark_as_delivered_create 1 param → 200400
POST
/api/v1/app-orders/brand/{uuid}/mark-as-picked-up/
Mark order as picked up (buyer path)
api_v1_app_orders_brand_mark_as_picked_up_create 1 param body → 200400
GET
/api/v1/app-orders/brand/{uuid}/order-activities/
List order activities
api_v1_app_orders_brand_order_activities_list 3 params → 200
GET
/api/v1/app-orders/brand/{uuid}/purchase-order/pdf/
Generate and retrieve the purchase order PDF for an App Order
api_v1_app_orders_brand_purchase_order_pdf_retrieve 1 param → 200
POST
/api/v1/app-orders/brand/{uuid}/repeat-spot-order/
Repeat an app spot order
api_v1_app_orders_brand_repeat_spot_order_create 1 param body → 201400403404
GET
/api/v1/app-orders/brand/activity-statement/
Buyer activity statement with running outstanding balance
api_v1_app_orders_brand_activity_statement_retrieve 2 params → 200
GET
/api/v1/app-orders/brand/aggregate/
Aggregate order totals across the filtered set in full precision
api_v1_app_orders_brand_aggregate_retrieve 19 params → 200400403
GET
/api/v1/app-orders/brand/all-order-activities/
List all order activities
api_v1_app_orders_brand_all_order_activities_list 2 params → 200
GET
/api/v1/app-orders/brand/grouped-statements/
Buyer endpoints for Grouped Statements
api_v1_app_orders_brand_grouped_statements_list 5 params → 200
GET
/api/v1/app-orders/brand/grouped-statements/{uuid}/
Retrieve a buyer grouped statement with nested orders and bank details
api_v1_app_orders_brand_grouped_statements_retrieve 1 param → 200
GET
/api/v1/app-orders/brand/grouped-statements/{uuid}/csv/
Download a buyer grouped statement as an Excel (.xlsx) file
api_v1_app_orders_brand_grouped_statements_csv_retrieve 1 param → 200
GET
/api/v1/app-orders/brand/grouped-statements/{uuid}/invoices/
Download all of a buyer grouped statement's invoices as a .zip
api_v1_app_orders_brand_grouped_statements_invoices_retrieve 1 param → 200
POST
/api/v1/app-orders/brand/grouped-statements/{uuid}/mark-transfer-sent/
Mark a bank transfer as sent
api_v1_app_orders_brand_grouped_statements_mark_transfer_sent_create 1 param → 200400404
GET
/api/v1/app-orders/brand/outstanding-payments-summary/
Buyer outstanding payments summary
api_v1_app_orders_brand_outstanding_payments_summary_retrieve → 200
GET
/api/v1/app-orders/brand/payment-analytics/
Buyer payment analytics
api_v1_app_orders_brand_payment_analytics_retrieve → 200
GET
/api/v1/app-orders/brand/payments/
List buyer payments by provider
api_v1_app_orders_brand_payments_retrieve 7 params → 200204400
GET
/api/v1/app-orders/brand/payments/available-sections/
Available payment sections
api_v1_app_orders_brand_payments_available_sections_retrieve → 200
GET
/api/v1/app-orders/brand/payments/merchant-of-record/
Combined Merchant-of-Record payments listing
api_v1_app_orders_brand_payments_merchant_of_record_retrieve 7 params → 200400
GET
/api/v1/app-orders/brand/payments/service-fees/
List buyer service fee invoices
api_v1_app_orders_brand_payments_service_fees_retrieve 6 params → 200
POST
/api/v1/app-orders/brand/spot-buy-request/
Create a spot buy request
api_v1_app_orders_brand_spot_buy_request_create body → 201400
GET
/api/v1/app-orders/brand/spot-buy-requests/
List pending spot buy requests
api_v1_app_orders_brand_spot_buy_requests_list 2 params → 200
PATCH
/api/v1/app-orders/brand/spot-buy-requests/{spot_buy_request_uuid}/cancel/
Cancel a spot buy request
api_v1_app_orders_brand_spot_buy_requests_cancel_partial_update 1 param body → 200400404
GET
/api/v1/app-orders/brand/statements/{uuid}/
Retrieve a buyer service-fee statement with nested orders and bank details
api_v1_app_orders_brand_statements_retrieve 1 param → 200
POST
/api/v1/app-orders/brand/statements/{uuid}/client-notified-as-paid/
Brand endpoints for Statements
api_v1_app_orders_brand_statements_client_notified_as_paid_create 1 param → 204
GET
/api/v1/app-orders/brand/statements/{uuid}/invoice-pdf/
Get statement invoice PDF URL
api_v1_app_orders_brand_statements_invoice_pdf_retrieve 1 param → 200400404
GET
/api/v1/app-orders/brand/statements/{uuid}/invoice-url/
Get statement invoice URL
api_v1_app_orders_brand_statements_invoice_url_retrieve 1 param → 200400404
GET
/api/v1/app-orders/brand/suppliers/
List suppliers for the buyer
api_v1_app_orders_brand_suppliers_list 4 params → 200
GET
/api/v1/app-orders/brand/two-credit-information/
Get Two credit summary
api_v1_app_orders_brand_two_credit_information_retrieve → 200
GET
/api/v1/app-orders/merchant-of-record/
List orders for merchant of record company
api_v1_app_orders_merchant_of_record_list 10 params → 200401403
GET
/api/v1/app-orders/merchant-of-record/{uuid}/
Merchant of Record app order endpoints
api_v1_app_orders_merchant_of_record_retrieve 1 param → 200
POST
/api/v1/app-orders/merchant-of-record/{uuid}/approve/
Approves an app order as merchant of record
api_v1_app_orders_merchant_of_record_approve_create 1 param → 200400
GET
/api/v1/app-orders/merchant-of-record/{uuid}/buyer-purchase-order/pdf/
Generate and retrieve the merchant of record purchase order PDF for an App Order
api_v1_app_orders_merchant_of_record_buyer_purchase_order_pdf_retrieve 1 param → 200
POST
/api/v1/app-orders/merchant-of-record/{uuid}/change-payment-terms/
Change payment terms on a confirmed/forecasted order
api_v1_app_orders_merchant_of_record_change_payment_terms_create 1 param body → 200400
POST
/api/v1/app-orders/merchant-of-record/{uuid}/confirm-shipping-responsibility/
Confirm shipping responsibility (from gathering quotes state)
api_v1_app_orders_merchant_of_record_confirm_shipping_responsibility_create 1 param body → 200400
POST
/api/v1/app-orders/merchant-of-record/{uuid}/create-order-event/
Endpoint to add order event for app order
api_v1_app_orders_merchant_of_record_create_order_event_create 1 param body → 201
GET
/api/v1/app-orders/merchant-of-record/{uuid}/documents/
Endpoint to list documents for an app order uploaded by merchant of record
api_v1_app_orders_merchant_of_record_documents_list 11 params → 200
DELETE
/api/v1/app-orders/merchant-of-record/{uuid}/documents/{document_uuid}/
Delete a document for an order
api_v1_app_orders_merchant_of_record_documents_destroy 2 params → 204400403404
POST
/api/v1/app-orders/merchant-of-record/{uuid}/duplicate/
Duplicate an app order
api_v1_app_orders_merchant_of_record_duplicate_create 1 param → 201400403404
PUT
/api/v1/app-orders/merchant-of-record/{uuid}/edit/
Endpoint to edit all fields for an app order as merchant of record
api_v1_app_orders_merchant_of_record_edit_update 1 param body → 200
POST
/api/v1/app-orders/merchant-of-record/{uuid}/hold/
Place an order on hold
api_v1_app_orders_merchant_of_record_hold_create 1 param body → 200400
GET
/api/v1/app-orders/merchant-of-record/{uuid}/invoice-url/
Returns the invoice URL or PDF
api_v1_app_orders_merchant_of_record_invoice_url_retrieve 1 param → 200400404
POST
/api/v1/app-orders/merchant-of-record/{uuid}/line-item/{line_item_uuid}/ingredient-documents/
Upload a document for an order line item
api_v1_app_orders_merchant_of_record_line_item_ingredient_documents_create 2 params body → 201400403404
DELETE
/api/v1/app-orders/merchant-of-record/{uuid}/line-item/{line_item_uuid}/ingredient-documents/{document_uuid}/
Delete a document for an order line item
api_v1_app_orders_merchant_of_record_line_item_ingredient_documents_destroy 3 params → 204400403404
POST
/api/v1/app-orders/merchant-of-record/{uuid}/mark-as-delivered/
Merchant of record mark an order as delivered on buyer's behalf
api_v1_app_orders_merchant_of_record_mark_as_delivered_create 1 param → 200400
POST
/api/v1/app-orders/merchant-of-record/{uuid}/mark-as-picked-up/
Mark order as picked up (buyer path)
api_v1_app_orders_merchant_of_record_mark_as_picked_up_create 1 param body → 200400
POST
/api/v1/app-orders/merchant-of-record/{uuid}/mark-awaiting-collection-details/
Mark order as awaiting collection details (buyer path)
api_v1_app_orders_merchant_of_record_mark_awaiting_collection_details_create 1 param → 200400
POST
/api/v1/app-orders/merchant-of-record/{uuid}/mark-dispatch-scheduled/
Mark dispatch as scheduled (supplier path)
api_v1_app_orders_merchant_of_record_mark_dispatch_scheduled_create 1 param → 200400
POST
/api/v1/app-orders/merchant-of-record/{uuid}/mark-forecasted/
Mark order as forecasted
api_v1_app_orders_merchant_of_record_mark_forecasted_create 1 param body → 200400
POST
/api/v1/app-orders/merchant-of-record/{uuid}/mark-freight-ownership-pending/
Mark order as freight ownership pending (to be confirmed path)
api_v1_app_orders_merchant_of_record_mark_freight_ownership_pending_create 1 param → 200400
POST
/api/v1/app-orders/merchant-of-record/{uuid}/mark-freight-scheduled/
Mark order as freight scheduled (MoR path)
api_v1_app_orders_merchant_of_record_mark_freight_scheduled_create 1 param body → 200400
POST
/api/v1/app-orders/merchant-of-record/{uuid}/mark-in-transit/
Mark order as in transit
api_v1_app_orders_merchant_of_record_mark_in_transit_create 1 param → 200400
POST
/api/v1/app-orders/merchant-of-record/{uuid}/mark-order-as-paid/
Endpoint to mark order as paid
api_v1_app_orders_merchant_of_record_mark_order_as_paid_create 1 param → 200400500
POST
/api/v1/app-orders/merchant-of-record/{uuid}/mark-order-as-paid-out-to-supplier/
Endpoint to mark order as paid out to supplier
api_v1_app_orders_merchant_of_record_mark_order_as_paid_out_to_supplier_create 1 param → 200
PATCH
/api/v1/app-orders/merchant-of-record/{uuid}/mark-order-dispatched/
Mark order as dispatched
api_v1_app_orders_merchant_of_record_mark_order_dispatched_partial_update 1 param body → 200
POST
/api/v1/app-orders/merchant-of-record/{uuid}/mark-preparing-freight/
Mark order as preparing freight (MoR path)
api_v1_app_orders_merchant_of_record_mark_preparing_freight_create 1 param → 200400
POST
/api/v1/app-orders/merchant-of-record/{uuid}/mark-quotes-confirmed/
Mark freight quotes as confirmed (MoR path)
api_v1_app_orders_merchant_of_record_mark_quotes_confirmed_create 1 param → 200400
POST
/api/v1/app-orders/merchant-of-record/{uuid}/mark-ready-for-pickup/
Mark order as ready for pickup (buyer path)
api_v1_app_orders_merchant_of_record_mark_ready_for_pickup_create 1 param → 200400
POST
/api/v1/app-orders/merchant-of-record/{uuid}/move-lifecycle-intermediate-status/
Move order to intermediate lifecycle status
api_v1_app_orders_merchant_of_record_move_lifecycle_intermediate_status_create 1 param body → 200400
GET
/api/v1/app-orders/merchant-of-record/{uuid}/order-activities/
List order activities
api_v1_app_orders_merchant_of_record_order_activities_list 11 params → 200
PATCH
/api/v1/app-orders/merchant-of-record/{uuid}/order-activities/{activity_uuid}/update/
Update order activity
api_v1_app_orders_merchant_of_record_order_activities_update_partial_update 2 params body → 200
POST
/api/v1/app-orders/merchant-of-record/{uuid}/order-activities/create/
Create an order activity
api_v1_app_orders_merchant_of_record_order_activities_create_create 1 param body → 201
GET
/api/v1/app-orders/merchant-of-record/{uuid}/order-events/
Endpoint to get order events
api_v1_app_orders_merchant_of_record_order_events_list 11 params → 200
POST
/api/v1/app-orders/merchant-of-record/{uuid}/push-to-two/
Push order to Two
api_v1_app_orders_merchant_of_record_push_to_two_create 1 param body → 200400409
POST
/api/v1/app-orders/merchant-of-record/{uuid}/refund/
Process a refund (full or partial) for an order
api_v1_app_orders_merchant_of_record_refund_create 1 param body → 200400
POST
/api/v1/app-orders/merchant-of-record/{uuid}/reject/
Reject an app order as merchant of record
api_v1_app_orders_merchant_of_record_reject_create 1 param → 200400
POST
/api/v1/app-orders/merchant-of-record/{uuid}/service-fee/invoice-sent/
Mark service fee as invoice sent
api_v1_app_orders_merchant_of_record_service_fee_invoice_sent_create 1 param → 200400
POST
/api/v1/app-orders/merchant-of-record/{uuid}/service-fee/paid/
Mark service fee as paid
api_v1_app_orders_merchant_of_record_service_fee_paid_create 1 param → 200400
POST
/api/v1/app-orders/merchant-of-record/{uuid}/start-gathering-quotes/
Start gathering quotes (to be confirmed path)
api_v1_app_orders_merchant_of_record_start_gathering_quotes_create 1 param → 200400
GET
/api/v1/app-orders/merchant-of-record/{uuid}/supplier-purchase-order/pdf/
Generate and retrieve the supplier purchase order PDF for an App Order
api_v1_app_orders_merchant_of_record_supplier_purchase_order_pdf_retrieve 1 param → 200
GET
/api/v1/app-orders/merchant-of-record/{uuid}/two-status/
Get Two order status
api_v1_app_orders_merchant_of_record_two_status_retrieve 1 param → 200404
POST
/api/v1/app-orders/merchant-of-record/{uuid}/unhold/
Remove hold from an order
api_v1_app_orders_merchant_of_record_unhold_create 1 param → 200400
POST
/api/v1/app-orders/merchant-of-record/{uuid}/unmark-forecasted/
Unmark order as forecasted
api_v1_app_orders_merchant_of_record_unmark_forecasted_create 1 param body → 200400
POST
/api/v1/app-orders/merchant-of-record/{uuid}/upload-document/
Endpoint to upload a document for an app order
api_v1_app_orders_merchant_of_record_upload_document_create 1 param body → 201
GET
/api/v1/app-orders/merchant-of-record/{uuid}/zendesk-tickets/
List Zendesk tickets for order
api_v1_app_orders_merchant_of_record_zendesk_tickets_list 11 params → 200
GET
/api/v1/app-orders/merchant-of-record/activity-feed/
MoR order activity feed
api_v1_app_orders_merchant_of_record_activity_feed_list 10 params → 200
GET
/api/v1/app-orders/merchant-of-record/alerts/
List orders currently on hold
api_v1_app_orders_merchant_of_record_alerts_list 11 params → 200401403
GET
/api/v1/app-orders/merchant-of-record/assignable-users/
Get users assignable to tasks in current MoR company
api_v1_app_orders_merchant_of_record_assignable_users_list 10 params → 200401403
GET
/api/v1/app-orders/merchant-of-record/brand-users/
Get users who can be selected as orderedby for orders
api_v1_app_orders_merchant_of_record_brand_users_list 10 params → 200401403
GET
/api/v1/app-orders/merchant-of-record/brand-users-by-company/{company_uuid}/
Get users from a specific brand company
api_v1_app_orders_merchant_of_record_brand_users_by_company_list 11 params → 200401403404
GET
/api/v1/app-orders/merchant-of-record/buyer-balance/{buyer_uuid}/
Get buyer balance details grouped by currency
api_v1_app_orders_merchant_of_record_buyer_balance_list 11 params → 200400403404
GET
/api/v1/app-orders/merchant-of-record/buyer-orders-by-month/
Service-fee orders grouped by dispatch month (per buyer)
api_v1_app_orders_merchant_of_record_buyer_orders_by_month_retrieve 2 params → 200404
GET
/api/v1/app-orders/merchant-of-record/buyers/
List buyers appearing on the MoR's orders
api_v1_app_orders_merchant_of_record_buyers_list 9 params → 200
GET
/api/v1/app-orders/merchant-of-record/buyers/{buyer_uuid}/allianz-credit-information/
Get Allianz credit information for a buyer
api_v1_app_orders_merchant_of_record_buyers_allianz_credit_information_retrieve 1 param → 200403404400
GET
/api/v1/app-orders/merchant-of-record/buyers/{buyer_uuid}/allocated-credit/
Get allocated credit for a buyer
api_v1_app_orders_merchant_of_record_buyers_allocated_credit_retrieve 1 param → 200403404
POST
/api/v1/app-orders/merchant-of-record/buyers/{buyer_uuid}/calculate-credit/
Calculate credit availability for a buyer
api_v1_app_orders_merchant_of_record_buyers_calculate_credit_create 1 param body → 200400403404
GET
/api/v1/app-orders/merchant-of-record/buyers/{buyer_uuid}/two-billing-account/
Get or create Two billing account for a buyer
api_v1_app_orders_merchant_of_record_buyers_two_billing_account_retrieve 1 param → 200403404400
GET
/api/v1/app-orders/merchant-of-record/buyers/{buyer_uuid}/two-credit-information/
Get Two credit information for a buyer
api_v1_app_orders_merchant_of_record_buyers_two_credit_information_retrieve 1 param → 200403404400
GET
/api/v1/app-orders/merchant-of-record/buyers/{buyer_uuid}/two-registration/
Check if a buyer is registered on Two
api_v1_app_orders_merchant_of_record_buyers_two_registration_retrieve 1 param → 200400403404
POST
/api/v1/app-orders/merchant-of-record/create/
Create a new app order
api_v1_app_orders_merchant_of_record_create_create body → 201
GET
/api/v1/app-orders/merchant-of-record/delivery-issue-types/
List all delivery issue types
api_v1_app_orders_merchant_of_record_delivery_issue_types_list 8 params → 200
GET
/api/v1/app-orders/merchant-of-record/grouped-statements/
MoR endpoints for Grouped Statements
api_v1_app_orders_merchant_of_record_grouped_statements_list 9 params → 200
GET
/api/v1/app-orders/merchant-of-record/grouped-statements/{uuid}/
MoR endpoints for Grouped Statements
api_v1_app_orders_merchant_of_record_grouped_statements_retrieve 1 param → 200
PATCH
/api/v1/app-orders/merchant-of-record/grouped-statements/{uuid}/
MoR endpoints for Grouped Statements
api_v1_app_orders_merchant_of_record_grouped_statements_partial_update 1 param body → 200
GET
/api/v1/app-orders/merchant-of-record/line-items/{line_item_uuid}/otif-data/
Get OTIF data for a line item
api_v1_app_orders_merchant_of_record_line_items_otif_data_retrieve 1 param → 200
PUT
/api/v1/app-orders/merchant-of-record/line-items/{line_item_uuid}/otif-data/
Replace OTIF data for a line item
api_v1_app_orders_merchant_of_record_line_items_otif_data_update 1 param body → 200
PATCH
/api/v1/app-orders/merchant-of-record/line-items/{line_item_uuid}/otif-data/
Update OTIF data for a line item
api_v1_app_orders_merchant_of_record_line_items_otif_data_partial_update 1 param body → 200
POST
/api/v1/app-orders/merchant-of-record/payout-status-for-date/
Get payout state for a given due date
api_v1_app_orders_merchant_of_record_payout_status_for_date_create body → 200
GET
/api/v1/app-orders/merchant-of-record/spot-buy-requests/
List spot buy requests for merchant of record
api_v1_app_orders_merchant_of_record_spot_buy_requests_list 11 params → 200401403
PATCH
/api/v1/app-orders/merchant-of-record/spot-buy-requests/{spot_buy_request_uuid}/
Update spot buy request status
api_v1_app_orders_merchant_of_record_spot_buy_requests_partial_update 1 param body → 200400404
GET
/api/v1/app-orders/merchant-of-record/staff-users/
Get staff users in current MoR company
api_v1_app_orders_merchant_of_record_staff_users_list 10 params → 200401403
GET
/api/v1/app-orders/merchant-of-record/statements/
MoR endpoints for Statements
api_v1_app_orders_merchant_of_record_statements_list 6 params → 200
POST
/api/v1/app-orders/merchant-of-record/statements/
MoR endpoints for Statements
api_v1_app_orders_merchant_of_record_statements_create body → 201
GET
/api/v1/app-orders/merchant-of-record/statements/{uuid}/
MoR endpoints for Statements
api_v1_app_orders_merchant_of_record_statements_retrieve 1 param → 200
GET
/api/v1/app-orders/merchant-of-record/statements/{uuid}/invoice-pdf/
Get statement invoice PDF URL
api_v1_app_orders_merchant_of_record_statements_invoice_pdf_retrieve 1 param → 200400404
GET
/api/v1/app-orders/merchant-of-record/statements/{uuid}/invoice-url/
Get statement invoice URL
api_v1_app_orders_merchant_of_record_statements_invoice_url_retrieve 1 param → 200400404
POST
/api/v1/app-orders/merchant-of-record/statements/{uuid}/mark-as-paid/
MoR endpoints for Statements
api_v1_app_orders_merchant_of_record_statements_mark_as_paid_create 1 param → 204
GET
/api/v1/app-orders/merchant-of-record/statements/disabled-months/
MoR endpoints for Statements
api_v1_app_orders_merchant_of_record_statements_disabled_months_retrieve 1 param → 200
GET
/api/v1/app-orders/merchant-of-record/statements/summary/
MoR endpoints for Statements
api_v1_app_orders_merchant_of_record_statements_summary_retrieve 5 params → 200
GET
/api/v1/app-orders/merchant-of-record/statements/unified/
MoR endpoints for Statements
api_v1_app_orders_merchant_of_record_statements_unified_list 9 params → 200
GET
/api/v1/app-orders/merchant-of-record/suppliers/
List suppliers appearing on the MoR's orders
api_v1_app_orders_merchant_of_record_suppliers_list 9 params → 200
POST
/api/v1/app-orders/merchant-of-record/update-two-status/
Two webhook (Svix-signed)
api_v1_app_orders_merchant_of_record_update_two_status_create → 202400401429500
GET
/api/v1/app-orders/supplier/
Supplier endpoints for App Orders
api_v1_app_orders_supplier_list 2 params → 200
GET
/api/v1/app-orders/supplier/{uuid}/
Supplier endpoints for App Orders
api_v1_app_orders_supplier_retrieve 1 param → 200
PATCH
/api/v1/app-orders/supplier/{uuid}/mark-order-dispatched/
Adds Shipping details to an app order & marks it as dispatched
api_v1_app_orders_supplier_mark_order_dispatched_partial_update 1 param body → 200400
GET
/api/v1/app-orders/supplier/{uuid}/purchase-order/pdf/
Generate and retrieve the purchase order PDF for an App Order
api_v1_app_orders_supplier_purchase_order_pdf_retrieve 1 param → 200

Schemas 222

The contract defines 222 schemas that model the data the API accepts and returns. The most detailed are MerchantOfRecordAppOrderDetails (75 properties), PatchedBuyerAppOrderDetails (54 properties), BuyerAppOrderDetails (54 properties), AdminAppOrderDetails (40 properties). Each schema is shown below with its type and property counts.

BuyerAppOrderDocument
object
5 properties 5 required
OrderAdjustmentStatusEnum
string
available - Available pendingapplication - Pending Application applied - Applied void - Void
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…
ProviderBankDetails
object
2 properties 2 required
BuyerActivityStatementCurrency
object
The statement for a single currency, with opening / closing balance.
4 properties 4 required
OtifDataDeliveryIssueTypeNested
object
Nested serializer for delivery issue types in OTIF data.
3 properties 3 required
ServiceFeeMismatch
object
Shape of MerchantOfRecordAppOrderDetailsSerializer.servicefeemismatch (SC-3919). Present only when the order's fee disagrees with its linked OM contract; null…
3 properties 3 required
CreditCalculatorResponse
object
Response serializer for the credit calculator endpoint.
9 properties 8 required
BuyerGroupedStatementDetail
object
16 properties 16 required
OrderLineItemOtifDataEdit
object
Serializer for editing OTIF data within line item updates.
7 properties
AdminAppOrderEventCreate
object
1 property
SupplierAppOrderDetails
object
34 properties 27 required
NullEnum
PaginatedMerchantOfRecordSpotBuyRequestListList
object
4 properties 2 required
CatalogItemDocumentCategoryEnum
string
specsheet - Spec Sheet certificateofanalysis - Certificate of Analysis britishretailconsortium - British Retail Consortium internationalorganisationforstandard…
DisabledMonths
object
Response serializer for the disabled-months endpoint.
1 property 1 required
TwoRegistrationCheckResponse
object
Response serializer for Two registration check.
5 properties 1 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
ServiceFeeInvoiceCreate
object
2 properties 2 required
OrderAdjustmentTypeEnum
string
creditnote - Credit Note debitnote - Debit Note
MerchantOfRecordAppOrderDetails
object
MoR surface — uses the nested serializer that exposes supplierdocumenturl.
75 properties 54 required
CreditCalculatorRequest
object
Request serializer for the credit calculator endpoint.
3 properties
MerchantOfRecordTwoOrderStatus
object
Serializer for checking if an order has already been pushed to Two.
3 properties 1 required
BuyerRepeatSpotOrderRequest
object
Serializer for repeat spot order request information
4 properties 2 required
StaffUser
object
6 properties 6 required
BuyerOutstandingPaymentsSummary
object
Operational view of outstanding payments for the buyer finance page. All monetary values are in cents.
5 properties 5 required
GroupedStatementDetail
object
22 properties 22 required
PatchedSupplierAppOrderDispatch
object
Serializer for marking an order as dispatched with shipping details
4 properties
ExpectedPayoutStateEnum
string
due - Due overdue - Overdue
BuyerAppOrderDetails
object
Buyer surface — uses the nested serializer that hides supplierdocumenturl.
54 properties 46 required
BuyerServiceFeesListing
object
Serializer for the service fees listing response (separate from orders).
3 properties 3 required
OtifDataDeliveryIssueType
object
3 properties 3 required
QualityIssueTypeEnum
string
spoilage - Spoilage notmatchspec - Not Match Spec contamination - Contamination discolouration - Discolouration shelflifeissue - Shelf Life Issue
MerchantOfRecordSpotBuyRequestList
object
Read-only serializer for listing spot buy requests from the MoR perspective.
15 properties 15 required
BuyerAllocatedCreditResponse
object
Response serializer for the buyer allocated credit endpoint.
9 properties 9 required
SupplierPayoutDetails
object
20 properties 11 required
MerchantOfRecordBuyerPurchaseOrderPDFUrl
object
1 property 1 required
MerchantOfRecordAppOrderEvent
object
5 properties 5 required
MerchantOfRecordAppOrderDocument
object
6 properties 4 required
InsufficientCreditReasonEnum
string
exceedseffectiveavailable - Exceeds Effective Available exceedsperorderlimit - Exceeds Per Order Limit
MerchantOfRecordTwoCreditInformation
object
Serializer for Two credit information for MoR endpoints. All monetary values are in cents in the buyer's currency.
8 properties 7 required
ConfirmShippingResponsibility
object
Serializer for confirming shipping responsibility when transitioning from gatheringquotes state.
1 property 1 required
SupplierSite
object
3 properties 3 required
LegacyPayoutStatusEnum
string
TargetStatusEnum
string
orderreceived - Order Received ordersenttosupplier - Order Sent To Supplier orderconfirmingprice - Order Confirming Price
AdminAppOrderEvent
object
7 properties 5 required
BlankEnum
GroupedStatementPatch
object
1 property
BuyerRepeatSpotOrderLineItem
object
2 properties 2 required
PDFUrl
object
1 property 1 required
CompanyNameAndId
object
3 properties 3 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…
BuyerAvailablePaymentSections
object
2 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…
HoldInternalReasonEnum
string
supplierdelay - Supplier delay volumeconfirmation - Volume confirmation creditreview - Credit review documentsrequired - Documents required fraudreview - Fraud…
OrderLineItemOtifData
object
12 properties 5 required
PaginatedGroupedStatementListList
object
4 properties 2 required
LimitCheck
object
Credit limit with sufficiency check for a single provider.
3 properties 3 required
MerchantOfRecordAppOrderLineItemCreate
object
17 properties 3 required
PaginatedStaffUserList
object
4 properties 2 required
CreditLimits
object
Combined credit limits from Two and Allianz APIs.
3 properties 3 required
LegacyPaymentStatusEnum
string
PaginatedBuyerAppOrderListList
object
4 properties 2 required
OrderLineItemDocumentUpload
object
2 properties 2 required
AvailableCurrenciesEnum
string
EUR - EUR GBP - GBP USD - USD
DeliveryStateEnum
string
initializing - Initializing notstarted - Not Started pendingdispatch - Pending Dispatch intransit - In Transit delivered - Delivered freightownershippending -…
OrderOnHoldAlert
object
Serializer for orders on hold alert list.
8 properties 6 required
PaginatedUnifiedStatementListList
object
4 properties 2 required
ZendeskTicket
object
Serializer for Zendesk ticket data from the search API
4 properties 4 required
PayInStateEnum
string
initializing - Initializing notstarted - Not Started due - Due overdue - Overdue awaitingreconciliation - Awaiting Reconciliation paid - Paid refunded - Refund…
BuyerTwoCreditInformation
object
Serializer for buyer's Two credit summary. Monetary values are in cents in the buyer's currency. totalcredit and availableforneworders are null whenever status…
7 properties 7 required
PaginatedBuyerGroupedStatementListList
object
4 properties 2 required
PaginatedMerchantOfRecordOrderActivityList
object
4 properties 2 required
StatementList
object
Statement list representation for service fee invoices.
15 properties 13 required
BuyerOrderLineItem
object
15 properties 10 required
BuyerSpotBuyRequestList
object
Read-only serializer for listing spot buy requests.
10 properties 10 required
BuyerGroupedStatementList
object
14 properties 14 required
MerchantOfRecordAppOrderEdit
object
37 properties
LegacyLifecycleStatusEnum
string
PaginatedBuyerOrderActivityList
object
4 properties 2 required
PaginatedMerchantOfRecordAppOrderDocumentList
object
4 properties 2 required
TwoRecourseCreditLimit
object
Credit limit data for Two recourse credit.
5 properties 5 required
AppOrderPaymentTermsEnum
string
paybeforedispatch - Pay Before Dispatch payafterdispatch - Pay After Dispatch payon28thsecondmonthafterdispatch - Pay on 28th second month after dispatch payen…
PayoutStateEnum
string
initializing - Initializing notstarted - Not Started due - Due overdue - Overdue paid - Paid refunded - Refunded partiallyrefunded - Partially Refunded
AccountTypeEnum
string
checking - Checking savings - Savings
StatementOrder
object
Nested order representation within a statement detail.
12 properties 7 required
PatchedOrderLineItemOtifData
object
12 properties
OrderLineItemOtifDataNested
object
Nested serializer for reading OTIF data within line items.
8 properties 8 required
AllocatedCreditBreakdown
object
Breakdown of allocated credit by order state.
5 properties 5 required
OrderLineItemDocument
object
3 properties 3 required
UnifiedStatementListSourceEnum
string
servicefee - servicefee two - two
BuyerSpotBuyRequest
object
Serializer for creating and reading spot buy requests
10 properties 3 required
BuyerAppOrderListSuppliers
object
Serializer for supplier with uuid, name, and lead time (drives the order-request calendar block).
3 properties 2 required
BuyerOrderActivity
object
Serializer for reading order activities for buyer users.
6 properties 6 required
PatchedGroupedStatementPatch
object
1 property
SupplierPayoutTermsEnum
string
payoutbeforedispatch - Payout Before Dispatch payoutafterdispatch - Payout After Dispatch
SpotBuyLineItem
object
Serializer for line items in spot buy request. unit and price are accepted as free-form strings (kg / cases / etc. for unit; a single value or a range like "10…
5 properties 2 required
SupplierOrderLineItem
object
16 properties 9 required
AdminAppOrderUpdate
object
4 properties 1 required
ProviderAllocatedCreditWithForecast
object
Allocated credit for a provider, including forecasted order total.
3 properties 3 required
BuyerPaymentRowKindEnum
string
order - Order servicefeeinvoice - Service fee invoice
BuyerServiceFeeInvoice
object
Serializer for a service fee invoice in the payments listing (flat, not grouped by month).
11 properties 11 required
PaginatedMerchantOfRecordAppOrderEventList
object
4 properties 2 required
InternalReasonEnum
string
supplierdelay - Supplier delay volumeconfirmation - Volume confirmation creditreview - Credit review documentsrequired - Documents required fraudreview - Fraud…
MerchantOfRecordOrderCompany
object
Minimal company shape (uuid + name) for the MoR orders-list filter dropdowns. Drives the Supplier / Buyer filter options, which must reflect the counterparties…
2 properties 2 required
SpotBuyRequestStatusEnum
string
pending - Pending completed - Completed cancelled - Cancelled
PaginatedAdminAppOrderDocumentList
object
4 properties 2 required
PaymentBucket
object
2 properties 2 required
OutstandingBucket
object
A single per-currency Outstanding money bucket (minor units).
2 properties 2 required
PayoutStateForDateRequest
object
Serializer for payout state lookup request.
1 property 1 required
GroupedStatementStatusEnum
string
due - Due overdue - Overdue awaitingreconciliation - Awaiting Reconciliation paid - Paid cancelled - Cancelled
AdminAppOrderPrice
object
5 properties 3 required
BuyerAppOrderList
object
36 properties 29 required
CreditRiskOwnerEnum
string
two - Two allianz - Allianz opply - Opply
DuplicateOrderResponse
object
Serializer for duplicate order response
1 property 1 required
MerchantOfRecordOrderActivityFeedItem
object
Read-only feed serializer used by the MoR home dashboard's order activity widget. Same fields as MerchantOfRecordOrderActivitySerializer, plus the order identi…
14 properties 14 required
MerchantOfRecordAppOrderCreate
object
Serializer for creating new app orders by merchant of record companies. This serializer handles the creation of app orders with validation to ensure: - Buyer a…
31 properties 7 required
PatchedMerchantOfRecordAppOrderDispatch
object
4 properties
LifecycleStateEnum
string
initializing - Initializing confirmed - Confirmed canceled - Cancelled pendingmerchantofrecordapproval - Pending Merchant of Record Approval orderreceived - Or…
BuyerNestedOrderAdjustment
object
Slim adjustment payload for the buyer-facing inline arrays on order-detail. Used by BuyerAppOrderDetailsSerializer to expose originatingadjustments and applied…
17 properties 17 required
TwoOrganicCreditLimit
object
Credit limit data for Two organic (non-recourse) credit.
8 properties 8 required
MerchantOfRecordAppOrderEventCreate
object
1 property 1 required
TwoOrganicLimitCheck
object
Two organic limit with per-order limit.
4 properties 4 required
PaginatedBuyerBalanceList
object
4 properties 2 required
BuyerServiceFeeOrder
object
Serializer for an individual order nested within a service fee statement entry.
7 properties 7 required
GroupedStatementList
object
18 properties 18 required
StatementSummary
object
Status-count summary over the merged service-fee + Two statement set, plus the per-currency Outstanding money total (Two/grouped only, never summed across curr…
4 properties 4 required
User
object
7 properties 3 required
MerchantOfRecordPushToTwoResponse
object
Serializer for the response when pushing an order to Two.
5 properties 2 required
OutstandingPayment
object
14 properties 14 required
LegacyDeliveryStatusEnum
string
PaginatedAdminAppOrderEventList
object
4 properties 2 required
AppOrderEventTypeEnum
string
markorderaspaidout - Mark order as paid out markaspaid - Mark as paid approvedbymerchantofrecord - Approved by merchant of record rejectedbymerchantofrecord -…
PaymentProviderEnum
string
stripe - Stripe two - Two direct - Direct
BuyerStripePaymentListing
object
Serializer for the Stripe payments order listing response.
3 properties 3 required
PaginatedOrderOnHoldAlertList
object
4 properties 2 required
BuyerBalance
object
4 properties 4 required
PaginatedBuyerSpotBuyRequestListList
object
4 properties 2 required
MerchantOfRecordOrderLineItem
object
28 properties 17 required
AppOrderDocumentType
string
supplierinvoice - Supplier Invoice deliverynote - Delivery Note organic - Organic halal - Halal tradingschedule - Trading Schedule kosher - Kosher certificateo…
DeliveryTracking
object
4 properties 4 required
ServiceTypeEnum
string
ingredientsourcing - Ingredient Sourcing sampling - Sampling other - Other
GroupedStatementOrphanOrder
object
Schema for a single entry in the grouped-statement warnings list. Surfaces dispatched Two orders whose estimated due date matches the statement but whose twoin…
3 properties 3 required
TaskStateEnum
string
todo - To Do done - Done
UnmarkForecasted
object
Serializer for unmarking an order as forecasted, with optional credit risk owner.
1 property
BuyerActivityStatement
object
Buyer activity statement grouped by currency. All monetary values are in integer cents. The cumulative outstanding balance is server-computed from the same sou…
3 properties 3 required
BuyerOrderAggregateResult
object
5 properties 5 required
PatchedMerchantOfRecordOrderActivityUpdate
object
Serializer for updating order activity
1 property
AdminAppOrderDetails
object
40 properties 25 required
BuyerPaymentOrder
object
Serializer for an individual order in the payments listing.
11 properties 11 required
MarkForecasted
object
Serializer for marking an order as forecasted with a target date.
1 property 1 required
PaginatedBuyerOrderActivityWithOrderList
object
4 properties 2 required
PaginatedZendeskTicketList
object
4 properties 2 required
AppOrderDocumentCategory
string
uploadedbyadmin - Uploaded by admin uploadedbysupplier - Uploaded by supplier uploadedbymerchantofrecord - Uploaded by merchant of record uploadedbybuyer - Upl…
AdminOrderLineItem
object
17 properties 14 required
PatchedMerchantOfRecordSpotBuyRequestUpdate
object
Serializer for updating spot buy request status (pending - completed).
1 property
BuyerPaymentAnalytics
object
2 properties 2 required
MerchantOfRecordAppOrderLineItemEdit
object
20 properties 1 required
RefundTypeEnum
string
payin - Pay In payout - Payout
SpotBuySku
object
Serializer for SKUs in spot buy request
2 properties 2 required
MerchantOfRecordSupplierPurchaseOrderPDFUrl
object
1 property 1 required
BuyerOrderActivityWithOrder
object
Serializer for reading order activities with order information for buyer users. Used for the listallorderactivities endpoint.
8 properties 8 required
MerchantOfRecordAppOrderDispatch
object
4 properties 2 required
UnifiedStatementList
object
Flat list row for the unified MoR statements endpoint. Merges the service-fee and Two (grouped) sources into one shape with a source discriminator. Serialized…
17 properties 17 required
BuyerGroupedStatementOrder
object
Order summary nested inside a buyer's grouped statement detail response.
11 properties 11 required
PatchedBuyerAppOrderDetails
object
Buyer surface — uses the nested serializer that hides supplierdocumenturl.
54 properties
MerchantOfRecordTwoBillingAccount
object
Serializer for Two billing account information for MoR endpoints.
5 properties 2 required
RefundCreate
object
5 properties 2 required
SupplierAppOrderList
object
20 properties 17 required
BuyerRepeatSpotOrderResponse
object
Serializer for repeat spot order response information
1 property 1 required
ServiceFeeStatusEnum
string
notstarted - Not Started invoicesent - Invoice Sent paid - Paid
PaginatedBrandUserList
object
4 properties 2 required
AvailablePaymentProvidersEnum
string
stripe - Stripe two - Two direct - Direct
MerchantOfRecordTwoRecourseInformation
object
Serializer for Two recourse information for MoR endpoints
6 properties 6 required
PayoutStateForDateResponse
object
Serializer for payout state lookup response.
2 properties 2 required
AdminAppOrderDocument
object
6 properties 4 required
BuyerClientNotifiedAsPaid
object
1 property
BrandUser
object
3 properties 3 required
AdminOrderLineItemPrices
object
12 properties 8 required
CreditSummary
object
Buyer credit summary under the shared max() envelope. Single backend-computed view of a buyer's credit, from CreditLimitService.summariseforbuyer. Consumed by…
6 properties 6 required
BuyerMarkAsPickedUp
object
Serializer for marking an order as picked up by the buyer.
4 properties 2 required
ConfirmShippingResponsibilityShippingResponsibilityEnum
string
supplier - Supplier buyer - Buyer merchantofrecord - Merchant of Record
PaginatedBuyerAppOrderListSuppliersList
object
4 properties 2 required
ChangePaymentTerms
object
Serializer for changing payment terms on a confirmed/forecasted order.
4 properties
PaginatedAdminAppOrderListList
object
4 properties 2 required
BuyerMerchantOfRecordItem
object
Polymorphic row inside the merged Merchant-of-Record listing. Each row is either a Stripe order (type='order') or a service-fee statement (type='servicefeeinvo…
13 properties 12 required
PaginatedStatementListList
object
4 properties 2 required
AllianzCreditLimit
object
Credit limit data for Allianz/recourse credit.
3 properties 3 required
ReportingUnitsEnum
string
g - Grams kg - Kilograms mg - milligrams long tons - Long Tons short tons - Short Tons metric tons - Metric Tons oz - Ounces lbs - Pounds uk fl oz - UK Fluid O…
AdminLineItemUpdate
object
2 properties 1 required
DeliveryAddressResponse
object
12 properties 1 required
OrderHoldDetails
object
Serializer for displaying hold details on an order.
6 properties 4 required
MerchantOfRecordSpotBuyRequestLineItem
object
A spot-buy line as the MoR sees it, with the resolved buyer material.
5 properties 5 required
BuyerTwoCreditStatusEnum
string
available - Available notconfigured - Not Configured revoked - Revoked apierror - API Error
ShortUser
object
3 properties 2 required
PaymentFilters
object
Serializer for the available filter options.
1 property 1 required
AdminAppOrderList
object
17 properties 9 required
GroupedStatementOrder
object
Order summary nested in a grouped statement detail response. Distinct from StatementOrderSerializer (used by ServiceFeeInvoice), which exposes service-fee subt…
9 properties 9 required
CreditCalculatorLimits
object
All credit limits for the calculator response.
3 properties 3 required
PaginatedMerchantOfRecordOrderActivityFeedItemList
object
4 properties 2 required
MerchantOfRecordInvoiceUrlResponse
object
Serializer for invoice URL response for Stripe and Two
1 property 1 required
BuyerMerchantOfRecordPaymentsListing
object
Combined Merchant-of-Record payments listing — Stripe (MoR) orders and service-fee statements in a single sorted, paginated list. Each item is a polymorphic ro…
4 properties 4 required
MerchantOfRecordOrderActivityCreate
object
Serializer for creating order activities by merchant of record companies.
10 properties 1 required
SpotBuyAttachment
object
2 properties 2 required
StatementDetail
object
Statement detail with nested orders and bank details.
18 properties 15 required
ShippingResponsibilityEnum
string
buyer - Buyer supplier - Supplier unknown - Unknown tobeconfirmed - To Be Confirmed merchantofrecord - Merchant of Record
BankDetail
object
Serializer for a single bank detail entry (label/value pair).
2 properties 2 required
MerchantOfRecordNestedOrderAdjustment
object
MoR variant of the nested order-detail adjustment payload — adds supplierdocumenturl, which the buyer surface must not expose. Subclassing rather than sharing…
18 properties 18 required
PaginatedSupplierAppOrderListList
object
4 properties 2 required
MerchantOfRecordAppOrderLineItemAdd
object
Serializer for adding new line items to an existing order.
17 properties 3 required
CreditLimitStatusEnum
string
available - Available notconnected - Not Connected notconfigured - Not Configured apierror - API Error
ProviderAllocatedCredit
object
Allocated credit for a single payment provider.
2 properties 2 required
BuyerPayableOverdueRef
object
Lean reference to the oldest non-Two overdue payment. Returned alongside the summary so the buyer-app overdue banner can surface a one-click Pay Now CTA — the…
7 properties 7 required
OrderActivityDocument
object
Serializer for order activity documents
3 properties 3 required
OrderActivityCategory
string
confirmingprice - Confirming Price priceconfirmed - Price Confirmed confirmingdeliverydate - Confirming Delivery deliverydateconfirmed - Delivery Confirmed not…
OrderHoldCreate
object
Serializer for creating an order hold.
3 properties 1 required
MerchantOfRecordAppOrderList
object
13 properties 8 required
BuyerActivityStatementEntry
object
One order on the statement, with the cumulative outstanding balance.
6 properties 6 required
PaginatedMerchantOfRecordAppOrderListList
object
4 properties 2 required
MerchantOfRecordOrderActivity
object
Serializer for reading order activities with all fields including internal status and task fields.
12 properties 12 required
MerchantOfRecordAllianzCreditInformation
object
Serializer for Allianz credit information for MoR endpoints
7 properties 7 required
MoveLifecycleIntermediateStatus
object
Serializer for moving order to an intermediate lifecycle status.
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

opply-app-orders-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 Agreements API
AE Profile APIs.io
Opply api 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
#App Orders
← Back to O APIs
API Details
ID
opply:opply-app-orders-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-app-orders-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/opply-app-orders-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 App 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.