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

Dassault Systèmes orders API

This section defines the operations related to orders, including the creation, management, and fulfillment of orders.It provides a comprehensive overview of the order lifecycle, from initial request to final delivery.The operations in this section are designed to support the efficient and effective management of orders, ensuring that customers receive their products or services in a timely and satisfactory manner.The following operations are included in this section:* Searching Orders* Getting Order Details

Dassault Systèmes orders API is one of 12 APIs that Dassault Systèmes 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 and API documentation.

This API exposes 2 operations across 2 paths, and defines 37 schemas. It is described by OpenAPI 3.1.1, at version 0.10.0.

Requests are made against 5 base URLs: https://apigw-prd.3ds.com, https://apigw-ppt.3ds.com, https://apigw-qal.3ds.com, https://apigw-ptd.3ds.com, https://apigw-ppd.3ds.com.

2 operations 2 paths 37 schemas 1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.1
API Version
0.10.0
Base URL
https://apigw-prd.3ds.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Dassault Systèmes orders API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-API-Key (ApiKeyAuth). By default, every request must be authenticated.

Paths & Operations 2

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

orders 2

This section defines the operations related to orders, including the creation, management, and fulfillment of orders. It provides a comprehensive overview of the order lifecycle,…

POST
/order/api4partners/v0/orders/search
Search Orders using various filters
searchOrders 2 params body → 200400401403429
GET
/order/api4partners/v0/orders/{id}
Get Order details
getOrderDetails 1 param → 200400401403404429

Schemas 37

The contract defines 37 schemas that model the data the API accepts and returns. The most detailed are order_sub_line (25 properties), order_line (8 properties), orders_search_req (7 properties), transaction (4 properties). Each schema is shown below with its type and property counts.

installed_base_number
string
A unique identifier for the installed base, representing the total number of software licenses that have been issued to a Final Customer. The Installed Base Nu…
error
array
An array containing one or more error objects identified during the request processing. Each object provides detailed information about a specific type of erro…
429_too_many_requests
object
Too Many Requests
1 property 1 required
order_type
string
Specifies the classification of the order based on its nature, purpose, or contractual arrangement. This helps identify whether the order involves a new purcha…
order_get_data
array
List of orders retrieved during the search operation.
orders_search_req
object
7 properties
4xx_get_orders
object
Response body returned when the order details request fails.
3 properties 3 required
403_basic_forbidden
object
Access Forbidden.
1 property 1 required
billto_sales_representative
string
Name of the sales representative person from the Bill To site.
transaction_type
string
Order type (one of: PO, RN).
date_time_from
string
This property represents a timestamp in UTC format, following the ISO 8601 standard. All date-time values must be provided in Coordinated Universal Time (UTC).…
info
object
Metadata section of the response providing execution status and result summary.
3 properties 2 required
creation_datetime
string
UTC timestamp when the order was created in the system. Format: ISO 8601 UTC (e.g., 2025-05-21T14:30:00Z)
order_sub_line
object
Details of License Charge Breakdown. It is also interchangably called as Sub-Line Item.
25 properties
business_unit
object
Details of the sales business unit.
3 properties 3 required
order_revenue_type
string
200_post_orders_search
object
Response body returned upon a successful order search request.
3 properties 2 required
200_get_orders
object
Response body returned upon a successful order details request.
3 properties 2 required
booking_datetime
string
UTC timestamp when the order was approved by the Finance Department. Format: ISO 8601 UTC (e.g., 2025-05-30T14:30:00Z)
ds_offering
string
Dassault Systèmes offering Type
currency
string
Three-letter ISO 4217 currency code representing the transaction currency. Must be exactly 3 uppercase alphabetic characters (e.g., USD for US Dollar, EUR for…
transaction
object
Transactional details of the order.
4 properties
billto_po_reference
string
Identifier of the order as recorded in the Bill To site's ordering system. If available, this reference will also appear on the Dassault Systèmes invoice.
400_post_orders_search
object
Response body returned when the order search request fails.
3 properties 3 required
online_instance_seat_id
string
Unique identifier assigned to a 3DEXPERIENCE platform instance. It is used to identify a specific instance of the platform, which can be accessed through the c…
recurring_charge_billing_cycle
string
Identifies how often invoices are sent for ALC and ASC licenses. In the event of prorating (to an anniversary date, in the first month, or in the first quarter…
sub_order_type
string
sub Order Type
product_type
string
Type of the product.
local_time_zone
string
Time zone abbreviation used by the sales business unit.
online_consent_status
string
Status of the online consent request sent to the designated contact.
legal_entity
object
4 properties 3 required
orders_search_data
array
List of orders retrieved during the search operation.
order_line
object
Details of License Charge Condition. This object is also interchangably called as Line Item.
8 properties
401_basic_unauthorized
object
Unauthorized
1 property 1 required
ds_received_po_date
string
Date when the order was received by Dassault Systèmes, in ISO 8601 format (YYYY-MM-DD).
order_processing_status
string
Current processing status of the order.
date_time_to
string
This property represents a timestamp in UTC format, following the ISO 8601 standard. All date-time values must be provided in Coordinated Universal Time (UTC).…

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

dassault-orders-api-openapi.yml Raw ↑

Other APIs Dassault Systèmes publishes across the network.

3DEXPERIENCE Manufacturing Web Services
3DEXPERIENCE CAD Collaboration Web Services
3DEXPERIENCE Manufacturing Process Web Services
3DEXPERIENCE Project Task Web Services
3DEXPERIENCE Issue Web Services
API4Partners
Dassault Systèmes accreditations API
Dassault Systèmes apikeys API
Dassault Systèmes leads-opportunities API
Dassault Systèmes portfolio-items API
Dassault Systèmes price-lists API
Where this information came from

This is an independent, third-party profile of Dassault Systèmes 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.