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
Virto Commerce

Virto Commerce Order Management API

Document based flexible order management system.

Documentation Provider Profile APIs.io OpenAPI GitHub

Virto Commerce Order Management API is one of 13 APIs that Virto Commerce publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Order Management. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and a GitHub repository.

This API exposes 35 operations across 29 paths, and defines 57 schemas. It is described by OpenAPI 3.0.4, at version v1.

Requests are made against the base URL https://virtostart-demo-admin.govirto.com/api.

35 operations 29 paths 57 schemas 2 DELETE12 GET3 PATCH15 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.4
API Version
v1
Base URL
https://virtostart-demo-admin.govirto.com/api
Authentication
OAuth 2.0, API Key, API Key, HTTP Signature, HTTP Basic
Resource Areas
1

Authentication & Security 5

Virto Commerce Order Management API declares 5 security schemes for authenticating requests. It supports OAuth 2.0 (oauth2) using the password and clientCredentials flows. An API key is passed in the query as api_key (api_key). An API key is passed in the header as api_key (api_key_header). It uses HTTP signature authentication (http-signature). It accepts HTTP basic authentication (basic).

  • oauth2 — OAuth2 Resource Owner Password Grant flow
  • api_key — API Key authentication
  • api_key_header — API Key authentication (alternative via header)
  • http-signature — HTTP Signature authentication using Authorization header
  • basic — Basic authentication using username and password

Paths & Operations 35

Across 29 paths, the API surfaces 35 operations — 2 DELETE, 12 GET, 3 PATCH, 15 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Order Management 35

Document based flexible order management system.

POST
/api/order/customerOrders/search
Search customer orders by given criteria
OrderModule_SearchCustomerOrder body → 200401403
GET
/api/order/customerOrders/number/{number}
Find customer order by number
OrderModule_GetByNumber 2 params → 200401403
GET
/api/order/customerOrders/{id}
Find customer order by id
OrderModule_GetById 2 params → 200401403
PATCH
/api/order/customerOrders/{id}
Partial update for the specified Orde by id
OrderModule_PatcOrder 1 param body → 204401403
GET
/api/order/customerOrders/outer/{outerId}
Find customer order by outer id
OrderModule_GetByOuterId 2 params → 200401403
PUT
/api/order/customerOrders/recalculate
Calculate order totals after changes
OrderModule_CalculateTotals body → 200401403
POST
/api/order/customerOrders/{orderId}/processPayment/{paymentId}
Register customer order payment in external payment system
OrderModule_ProcessOrderPayments 2 params body → 200401403
POST
/api/order/customerOrders/{cartId}
Create new customer order based on shopping cart.
OrderModule_CreateOrderFromCart 1 param → 200401403
POST
/api/order/customerOrders
Add new customer order to system
OrderModule_CreateOrder body → 200401403
PUT
/api/order/customerOrders
Update a existing customer order
OrderModule_UpdateOrder body → 204401403
DELETE
/api/order/customerOrders
Delete a whole customer orders
OrderModule_DeleteOrdersByIds 1 param → 204401403
GET
/api/order/customerOrders/{id}/shipments/new
Get new shipment for specified customer order
OrderModule_GetNewShipment 1 param → 200401403
GET
/api/order/customerOrders/{id}/payments/new
Get new payment for specified customer order
OrderModule_GetNewPayment 1 param → 200401403
GET
/api/order/dashboardStatistics/settings
Get dashboard statistics settings
OrderModule_GetDashboardStatisticsSettingsAsync → 200401403
GET
/api/order/dashboardStatistics
Get a some order statistic information for Commerce manager dashboard
OrderModule_GetDashboardStatisticsAsync 2 params → 200401403
POST
/api/paymentcallback
Payment callback operation used by external payment services to inform post process payment in our system
OrderModule_PostProcessPayment body → 200401403
POST
/api/paymentcallback-raw
Payment callback operation used by external payment services to inform post process payment in our system
OrderModule_PostProcessPaymentRaw → 200401403
POST
/api/paymentcallback-form
Payment callback operation used by external payment services to inform post process payment in our system
OrderModule_PostProcessPaymentForm → 200401403
GET
/api/order/customerOrders/invoice/{orderNumber}
OrderModule_GetInvoicePdf 1 param → 200401403
GET
/api/order/customerOrders/{id}/changes
OrderModule_GetOrderChanges 1 param → 200401403
POST
/api/order/customerOrders/searchChanges
OrderModule_SearchOrderChanges body → 200401403
GET
/api/order/customerOrders/indexed/searchEnabled
OrderModule_GetOrderFullTextSearchEnabled → 200401403
POST
/api/order/customerOrders/indexed/search
OrderModule_SearchCustomerOrderIndexed body → 200401403
POST
/api/order/payments/search
Search order payments by given criteria
OrderModulePayments_SearchOrderPayments body → 200401403
GET
/api/order/payments/{id}
Find order payment by id
OrderModulePayments_GetById 2 params → 200401403
PATCH
/api/order/payments/{id}
Partial update for the specified Payment by id
OrderModulePayments_PatchPayment 1 param body → 204401403
GET
/api/order/payments/outer/{outerId}
Get order payment by outer id
OrderModulePayments_GetByOuterId 2 params → 200401403
POST
/api/order/payments
Create or update order payment
OrderModulePayments_CreatePayment body → 200401403
PUT
/api/order/payments
OrderModulePayments_UpdatePayment body → 200401403
DELETE
/api/order/payments
Delete an order payment
OrderModulePayments_DeleteOrderPaymentsByIds 1 param → 200401403
POST
/api/order/payments/payment/capture
OrderModulePayments_CapturePayment body → 200401403
POST
/api/order/payments/payment/refund
OrderModulePayments_RefundPayment body → 200401403
POST
/api/order/shipments
OrderModuleShipments_UpdateShipment body → 200401403
POST
/api/order/shipments/search
Search shipments by given criteria
OrderModuleShipments_SearchOrderShipments body → 200401403
PATCH
/api/order/shipments/{id}
Partial update for the specified Shipment by id
OrderModuleShipments_PatchShipment 1 param body → 204401403

Schemas 57

The contract defines 57 schemas that model the data the API accepts and returns. The most detailed are CustomerOrder (79 properties), OrderShipment (61 properties), OrderLineItem (61 properties), PaymentIn (52 properties). Each schema is shown below with its type and property counts.

CustomerOrderIndexedSearchCriteria
object
36 properties
Capture
object
28 properties
ShipmentPackage
object
14 properties
CancelledState
string
DynamicPropertyValueType
string
OrderConfigurationItem
object
21 properties
PaymentSearchCriteria
object
30 properties
CustomerOrder
object
79 properties
PaymentCallbackParameters
object
1 property
DashboardMoney
object
2 properties
DynamicPropertyObjectValue
object
8 properties
DynamicObjectProperty
object
17 properties
PaymentMethodType
string
ChangeLogSearchResult
object
2 properties
ShipmentSearchCriteria
object
28 properties
EntryState
string
RefundOrderPaymentRequest
object
7 properties
RefundReasonCode
string
CaptureItem
object
10 properties
SortInfo
object
2 properties
PaymentGatewayTransaction
object
18 properties
CustomerOrderSearchCriteria
object
35 properties
Operation
object
4 properties
SettingValueType
string
OperationLog
object
9 properties
ProcessPaymentRequestResult
object
8 properties
OrderShipmentItem
object
11 properties
PaymentIn
object
52 properties
DashboardStatisticsResult
object
11 properties
PaymentMethodGroupType
string
RefundStatus
string
FeeDetail
object
4 properties
ShippingMethod
object
11 properties
DynamicPropertyName
object
2 properties
SortDirection
string
Refund
object
31 properties
PaymentSearchResult
object
2 properties
CustomerOrderHistorySearchCriteria
object
15 properties
AddressType
string
PaymentMethod
object
27 properties
ObjectSettingEntry
object
20 properties
Discount
object
8 properties
KeyValuePair
object
2 properties
ShipmentSearchResult
object
2 properties
RefundItem
object
10 properties
OrderLineItem
object
61 properties
PaymentStatus
string
LocalizedString
object
1 property
PostProcessPaymentRequestResult
object
8 properties
OrderAddress
object
21 properties
OrderConfigurationItemFile
object
9 properties
CaptureOrderPaymentRequest
object
7 properties
CustomerOrderSearchResult
object
2 properties
BankCardInfo
object
6 properties
OrderShipment
object
61 properties
TaxDetail
object
3 properties
QuarterPeriodMoney
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

virto-commerce-order-management-api-openapi.yml Raw ↑

Other APIs Virto Commerce publishes across the network.

Virto Commerce Catalog API
AE Profile APIs.io
Virto Commerce Companies and Contacts API
AE Profile APIs.io
Virto Commerce Inventory API
AE Profile APIs.io
Virto Commerce Marketing API
AE Profile APIs.io
Virto Commerce Pricing API
AE Profile APIs.io
Virto Commerce Quotes API
AE Profile APIs.io
Virto Commerce Shopping Cart API
AE Profile APIs.io
Virto Commerce Store API
AE Profile APIs.io
Virto Commerce VirtoCommerce Platform API
AE Profile APIs.io
Virto Commerce Webhooks API
AE Profile APIs.io
Virto Commerce Event Bus API
AE Profile APIs.io
Virto Commerce Returns API
AE Profile APIs.io
#Order Management
← Back to V APIs
API Details
ID
virto-commerce:virto-commerce-order-management-api
Base URL
https://virtostart-demo-admin.govirto.com/api
Docs
https://docs.virtocommerce.org/
Provider
Virto Commerce
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=virto-commerce-order-management-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/virto-commerce-order-management-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 Virto Commerce Order Management 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.