APIs for the Order domain (3.0.7)

Download OpenAPI specification:Download

License: Dassault Systèmes 2025

This API provides a set of endpoints for managing orders that includes searching orders and retrieving order details.

apikeys

This section defines the operations related to API keys .

Current API key management still requires some interaction with Dassault Systèmes Information System (IS) team. This process will likely be updated in the future to provide more autonomy and reactivity on partner side.

Below is the description of the process when a partner is onboarded on APIForPartners program :

Dassault Systèmes IS team will initialize an API key and communicate it to partner Admin through a secured channel :
- Recommendation is to use a 1-1 discussion between Partner Admin and Dassault Systèmes IS person in charge within the dedicated 3DSwym Community
- Do NOT use email or any unsecured communication channel or with wider audience
Partner Admin will then use this initial APIKEY value to authenticate and generate a new API key using the API
Partner admin will communicate back (within same secured channel) to Dassault Systèmes IS person in charge the hashed_key attributed from the API (NOT the API key itself)
- The Hash operation is NOT reversible, so Dassault Systèmes will NOT have knowledge about partner API key.
- Partner Admin must store securely the generated API key (same level of confidentiality as a password)
Dassault Systèmes IS team will update API Gateway configuration with the new API key (in practice with the hash value provided) and inform Partner when it is ready to use.
Partner can then use this newly generated APIKEY to interact with all the available APIs.

For the case of revocation and request of a new API key, steps 2 to 5 have to be followed.

Generate a new API key

Main (production) server

https://apigw-prd.3ds.com/order/api4partners/v0/apikeys

Server for development by Partners (Non Production)

https://apigw-ppt.3ds.com/order/api4partners/v0/apikeys

Server for Quality Assurance Testing (Non Production)

https://apigw-qal.3ds.com/order/api4partners/v0/apikeys

Server for preprod validation (Non Production)

https://apigw-ptd.3ds.com/order/api4partners/v0/apikeys

Server for postprod validation (Non Production)

https://apigw-ppd.3ds.com/order/api4partners/v0/apikeys

Generate a new API key and its hash.

Authorizations:

API Key: ApiKeyAuth

Responses

Response samples

200
401
403
429

Content type

application/json

{"hashed_key": "$2b$12$8tcF4MTIDcup3WEo8fFSieGIYEnp/DTLHSTivUCcW2II/VVwRI9Qm",
"api_key": "5839bcfabb9e0d20f889f366dbfbbe2973c152cfbe91fae728a9f7e662ce1a2d"
}

Orders

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:

Search Orders
Retrieve Order Details

Note: The Read Orders API does not support retrieval of Purchase Order created for SOLIDWORKS CLOUD before 2020 July 20th.

Search Orders Deprecated

Main (production) server

https://apigw-prd.3ds.com/order/api4partners/v0/orders/search

Server for development by Partners (Non Production)

https://apigw-ppt.3ds.com/order/api4partners/v0/orders/search

Server for Quality Assurance Testing (Non Production)

https://apigw-qal.3ds.com/order/api4partners/v0/orders/search

Server for preprod validation (Non Production)

https://apigw-ptd.3ds.com/order/api4partners/v0/orders/search

Server for postprod validation (Non Production)

https://apigw-ppd.3ds.com/order/api4partners/v0/orders/search

Deprecated – v0. This endpoint will be removed in a future release as per our Partners API Lifecycle policy.

Use /order/api4partners/v1/orders/search instead.

Searches for orders based on various filter criteria such as creation date, booking date, last modified date, and more. Supports pagination through skip and top query parameters.

Authorizations:

API Key: ApiKeyAuth

query Parameters

skip	integer >= 0 Default: 0 The number of records to skip in the result set. Use this for paginating through results. Defaults to 0 if not specified. For example, `skip=20` will skip the first 20 records.
top	integer [ 1 .. 100 ] Default: 10 The maximum number of records to return in the response. Use this to limit the size of the result set. Defaults to 10 if not specified. For example, `top=10` will return up to 10 records starting from the position defined by `skip`.

Request Body schema: application/json
required

A JSON object specifying filter criteria for retrieving matching orders.

The request must include at least one of the following sub-objects:

creationDateTime
bookingDateTime
lastUpdateDateTime
installedBaseNumber
onlineInstanceSeatId
billToPoReferences

These will be combined using an AND operator if more than one is provided.

Any of

required

creation_datetime_req (object) or creation_datetime_req (object)

Returns orders created within a specified time range, using the Creation timestamp. The maximum time window allowed for the search is 7 days (calculated time to time). Including this tag prompts the system to perform validations and automatically compute the from or to timestamp if either is missing. Omitting this tag means the system will skip these validations and will not perform any implicit computation of the from or to values.

booking_datetime_req (object) or booking_datetime_req (object)

Returns orders booked within a specified time range, using the Booking timestamp. The maximum time window allowed for the search is 7 days (calculated time to time). The Booking timestamp refers to the date and time when the order was approved by the Finance Department. Including this tag prompts the system to perform validations and automatically compute the from or to timestamp if either is missing. Omitting this tag means the system will skip these validations and will not perform any implicit computation of the from or to values.

lastupdate_datetime_req (object) or lastupdate_datetime_req (object)

Indicates the timestamp of the most recent update to the order. The maximum time window allowed for the search is 3 days (calculated time to time). This field is automatically set to the current timestamp whenever the order is modified. Omitting this tag means the system will skip these validations and will not perform any implicit computation of the from or to values.

installedBaseNumber

string <= 40 characters

Example: "LN00012345678"

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 Number is used to determine the Final Customer's maintenance and support obligations, as well as to calculate the cost of future upgrades or renewals. This is used to track the Final Customer's software licenses and maintenance history.

onlineInstanceSeatId

string <= 15 characters

Example: "R1122334455667"

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 cloud. This identifier is also referred to as the Online Instance ID. Additionally, it is also used as the Seat ID to identify a user's access to the instance. The Seat ID is used to manage user licenses, authenticate users, and track user activity within the instance. The Online Instance ID/Seat ID is a combination of letters and numbers.

billToPoReferences

Array of strings non-empty [ items <= 60 characters ]

Example: ["390830"]

List of partner order references.

transactionType

string

Enum	Description
PO	Purchase Order
RN	Renewal Notification

Example: "PO"

Order type (one of: PO, RN).

If left unspecified, records of both transaction types will be included in the response.

Responses

Request samples

Payload

Content type

application/json

Example

Search Orders using single criterion

This example demonstrates how to search for orders using the creationDateTime criterion. If the to value is not provided under creationDateTime, it is implicitly set to either 7 days after the from timestamp or the current time—whichever is earlier.

This JSON payload retrieves all orders created between 01-April-2025 1:30 AM UTC and 08-April-2025 1:30 AM UTC.

{"creationDateTime": {"from": "2025-04-01T01:30:00Z"
}
}

Response samples

200
400
401
403
429

Content type

application/json

Example

Sample successful basic Search for orders

Sample successful basic search for orders with only 1 result.

{"data": [{"transaction": {"id": "PO_A123456789",
"type": "PO",
"status": "Sent to DSx.Finance",
"description": "XYZ Company Order 50 products"
},
"creationDateTime": "2024-05-21T14:30:00Z",
"dsReceivedPoDate": "2024-05-21",
"bookingDateTime": "2024-05-29T18:00:00Z",
"lastUpdateDateTime": "2024-05-21T14:40:00Z",
"currency": "USD",
"onlineConsentStatus": "Not Applicable",
"billToSalesRepresentative": "DOE, Jane",
"billToPoReference": "EXAMPLE-CORP-20250518",
"billToSite": {"id": "100012345678901",
"name": "Example Corporation",
"localName": "示例公司",
"locationId": 1
},
"soldToSite": {"id": "200012345678901",
"name": "Foobar Inc",
"localName": "फ़ूबार इंक",
"locationId": 2
},
"businessUnit": {"id": "BU001",
"name": "Corporate Sales Unit A",
"localTimezone": "CET"
}
}
],
"info": {"success": true,
"statusCode": 200,
"estimatedSearchCount": 1
}
}

Get Order details Deprecated

Main (production) server

https://apigw-prd.3ds.com/order/api4partners/v0/orders/{id}

Server for development by Partners (Non Production)

https://apigw-ppt.3ds.com/order/api4partners/v0/orders/{id}

Server for Quality Assurance Testing (Non Production)

https://apigw-qal.3ds.com/order/api4partners/v0/orders/{id}

Server for preprod validation (Non Production)

https://apigw-ptd.3ds.com/order/api4partners/v0/orders/{id}

Server for postprod validation (Non Production)

https://apigw-ppd.3ds.com/order/api4partners/v0/orders/{id}

Deprecated – v0. This endpoint will be removed in a future release as per our Partners API Lifecycle policy.

Use /order/api4partners/v1/orders/{id} instead.

Retrieves complete details of an order given its Dassault Systèmes reference.

Authorizations:

API Key: ApiKeyAuth

path Parameters

id

required

string

Example: PO_000123456789

Dassault Systèmes order reference identifier

Responses

Response samples

Content type

application/json

Example of response for order details with line and subLine

{"data": [{"transaction": {"id": "PO_A123456789",
"type": "PO",
"status": "Sent to DSx.Finance",
"description": "XYZ Company Order 50 products"
},
"businessUnit": {"id": "BU001",
"name": "Corporate Sales Unit A",
"localTimezone": "CET"
},
"billToSite": {"id": "100012345678901",
"name": "Example Corporation",
"localName": "示例公司",
"locationId": 1
},
"billToContact": "DOE, Jini",
"soldToSite": {"id": "200012345678901",
"name": "Foobar Inc",
"localName": "फ़ूबार इंक",
"locationId": 2
},
"creationDateTime": "2024-05-21T14:30:00Z",
"dsReceivedPoDate": "2024-05-21",
"bookingDateTime": "2024-05-29T18:00:00Z",
"lastUpdateDateTime": "2024-05-21T14:40:00Z",
"currency": "USD",
"onlineConsentStatus": "Not Applicable",
"billToSalesRepresentative": "DOE, Jane",
"billToPoReference": "EXAMPLE-CORP-20250518",
"agreement": {"type": "General VAR Agreement",
"reference": "Enterprise License Agreement Q2 2024"
},
"sboNumber": "ABC0012345",
"customerRequestedArrivalDate": "2025-05-31",
"dsSalesRepresentative": "DOE, John",
"isMultiYear": false,
"hasExitClause": false,
"recurringChargeBillingCycle": "Calendar Year",
"opportunity": "A1B2-C3D4E5",
"paymentTerms": "Net Date of Invoice + 60 days",
"licenseChargeConditions": [{"sequenceNumber": 1,
"lineGroup": "SBL0001234567",
"onlineInstanceSeatId": "R1122334455667",
"orderType": "Stop - Transform",
"usageScope": "GEO EMEA",
"promotion": {"id": "PAO0000111",
"name": "3DEXPERIENCE for small and medium business",
"combination": "Collaborative Design & Engineering Learning @Home"
},
"waiver": {"endDate": "2025-09-15"
},
"licenseChargeBreakdown": [{"sequenceNumber": 1,
"installedBaseNumber": "LN00012345678",
"subOrderType": "New License",
"revenueType": "ALC",
"portfolio": "CATIA",
"release": "3DEXPERIENCE R2025x",
"product": {"trigram": "ABC",
"type": "Named User",
"number": "1AB-ABC",
"name": "Generic Product Standard with Cloud Services",
"dsOffering": "Licensed Program"
},
"quantity": 2,
"unitListPrice": 1000,
"totalListPrice": 2000,
"billToNetAmount": 1309.25,
"billToAnnualAmount": 1309.25,
"billToDiscountPercentage": 39.97,
"billToMarginPercentage": 39.97,
"maximumCustomerNetAmount": 2181,
"maximumCustomerAnnualAmount": 2181,
"minimumCustomerDiscountPercentage": 15.17,
"startDate": "2025-06-01",
"endDate": "2026-05-31",
"duration": 2,
"calculatedStartDate": "2025-06-01",
"calculatedEndDate": "2026-05-31",
"yearNumber": 1,
"coupon": {"name": "10% off on Installation Fee",
"discountPercentage": 10
},
"inflation": {"date": "2025-07-01",
"ratio": 1.025,
"exception": "Capping To Price List"
}
}
]
}
]
}
],
"info": {"success": true,
"statusCode": 200,
"estimatedSearchCount": 1
}
}

Search Orders

Main (production) server

https://apigw-prd.3ds.com/order/api4partners/v1/orders/search

Server for development by Partners (Non Production)

https://apigw-ppt.3ds.com/order/api4partners/v1/orders/search

Server for Quality Assurance Testing (Non Production)

https://apigw-qal.3ds.com/order/api4partners/v1/orders/search

Server for preprod validation (Non Production)

https://apigw-ptd.3ds.com/order/api4partners/v1/orders/search

Server for postprod validation (Non Production)

https://apigw-ppd.3ds.com/order/api4partners/v1/orders/search

Searches for orders based on various filter criteria such as creation date, booking date, last modified date, and more. Supports pagination through skip and top query parameters.

Authorizations:

API Key: ApiKeyAuth

query Parameters

skip	integer >= 0 Default: 0 The number of records to skip in the result set. Use this for paginating through results. Defaults to 0 if not specified. For example, `skip=20` will skip the first 20 records.
top	integer [ 1 .. 100 ] Default: 10 The maximum number of records to return in the response. Use this to limit the size of the result set. Defaults to 10 if not specified. For example, `top=10` will return up to 10 records starting from the position defined by `skip`.

Request Body schema: application/json
required

A JSON object specifying filter criteria for retrieving matching orders.

The request must include at least one of the following sub-objects:

creationDateTime
bookingDateTime
lastUpdateDateTime
installedBaseNumber
onlineInstanceSeatId
billToPoReferences

These will be combined using an AND operator if more than one is provided.

Any of

required

creation_datetime_req (object) or creation_datetime_req (object)

Returns orders created within a specified time range, using the Creation timestamp. The maximum time window allowed for the search is 7 days (calculated time to time). Including this tag prompts the system to perform validations and automatically compute the from or to timestamp if either is missing. Omitting this tag means the system will skip these validations and will not perform any implicit computation of the from or to values.

booking_datetime_req (object) or booking_datetime_req (object)

Returns orders booked within a specified time range, using the Booking timestamp. The maximum time window allowed for the search is 7 days (calculated time to time). The Booking timestamp refers to the date and time when the order was approved by the Finance Department. Including this tag prompts the system to perform validations and automatically compute the from or to timestamp if either is missing. Omitting this tag means the system will skip these validations and will not perform any implicit computation of the from or to values.

lastupdate_datetime_req (object) or lastupdate_datetime_req (object)

Indicates the timestamp of the most recent update to the order. The maximum time window allowed for the search is 3 days (calculated time to time). This field is automatically set to the current timestamp whenever the order is modified. Omitting this tag means the system will skip these validations and will not perform any implicit computation of the from or to values.

installedBaseNumber

string <= 40 characters

Example: "LN00012345678"

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 Number is used to determine the Final Customer's maintenance and support obligations, as well as to calculate the cost of future upgrades or renewals. This is used to track the Final Customer's software licenses and maintenance history.

onlineInstanceSeatId

string <= 15 characters

Example: "R1122334455667"

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 cloud. This identifier is also referred to as the Online Instance ID. Additionally, it is also used as the Seat ID to identify a user's access to the instance. The Seat ID is used to manage user licenses, authenticate users, and track user activity within the instance. The Online Instance ID/Seat ID is a combination of letters and numbers.

billToPoReferences

Array of strings non-empty [ items <= 60 characters ]

Example: ["390830"]

List of partner order references.

transactionType

string

Enum	Description
PO	Purchase Order
RN	Renewal Notification

Example: "PO"

Order type (one of: PO, RN).

If left unspecified, records of both transaction types will be included in the response.

Responses

Request samples

Payload

Content type

application/json

Example

Search Orders using single criterion

This example demonstrates how to search for orders using the creationDateTime criterion. If the to value is not provided under creationDateTime, it is implicitly set to either 7 days after the from timestamp or the current time—whichever is earlier.

This JSON payload retrieves all orders created between 01-April-2025 1:30 AM UTC and 08-April-2025 1:30 AM UTC.

{"creationDateTime": {"from": "2025-04-01T01:30:00Z"
}
}

Response samples

200
400
401
403
429

Content type

application/json

Example

Sample successful basic Search for orders

Sample successful basic search for orders with only 1 result.

{"data": [{"transaction": {"id": "PO_A123456789",
"type": "PO",
"status": "PRC",
"description": "XYZ Company Order 50 products"
},
"creationDateTime": "2024-05-21T14:30:00Z",
"dsReceivedPoDate": "2024-05-21",
"bookingDateTime": "2024-05-29T18:00:00Z",
"lastUpdateDateTime": "2024-05-21T14:40:00Z",
"currency": "USD",
"onlineConsentStatus": "X",
"billToSalesRepresentative": "DOE, Jane",
"billToPoReference": "EXAMPLE-CORP-20250518",
"billToSite": {"id": "100012345678901",
"name": "Example Corporation",
"localName": "示例公司",
"locationId": 1
},
"soldToSite": {"id": "200012345678901",
"name": "Foobar Inc",
"localName": "फ़ूबार इंक",
"locationId": 2
},
"businessUnit": {"id": "BU001",
"name": "Corporate Sales Unit A",
"localTimezone": "CET"
}
}
],
"info": {"success": true,
"statusCode": 200,
"estimatedSearchCount": 1
}
}

Get Order details

Main (production) server

https://apigw-prd.3ds.com/order/api4partners/v1/orders/{id}

Server for development by Partners (Non Production)

https://apigw-ppt.3ds.com/order/api4partners/v1/orders/{id}

Server for Quality Assurance Testing (Non Production)

https://apigw-qal.3ds.com/order/api4partners/v1/orders/{id}

Server for preprod validation (Non Production)

https://apigw-ptd.3ds.com/order/api4partners/v1/orders/{id}

Server for postprod validation (Non Production)

https://apigw-ppd.3ds.com/order/api4partners/v1/orders/{id}

Retrieves complete details of an order given its Dassault Systèmes reference.

Authorizations:

API Key: ApiKeyAuth

path Parameters

id

required

string

Example: PO_000123456789

Dassault Systèmes order reference identifier

Responses

Response samples

Content type

application/json

Example of response for order details with line and subLine

{"data": [{"transaction": {"id": "PO_A123456789",
"type": "PO",
"status": "PRC",
"description": "XYZ Company Order 50 products"
},
"businessUnit": {"id": "BU001",
"name": "Corporate Sales Unit A",
"localTimezone": "CET"
},
"billToSite": {"id": "100012345678901",
"name": "Example Corporation",
"localName": "示例公司",
"locationId": 1
},
"billToContact": "DOE, Jini",
"soldToSite": {"id": "200012345678901",
"name": "Foobar Inc",
"localName": "फ़ूबार इंक",
"locationId": 2
},
"creationDateTime": "2024-05-21T14:30:00Z",
"dsReceivedPoDate": "2024-05-21",
"bookingDateTime": "2024-05-29T18:00:00Z",
"lastUpdateDateTime": "2024-05-21T14:40:00Z",
"currency": "USD",
"onlineConsentStatus": "X",
"billToSalesRepresentative": "DOE, Jane",
"billToPoReference": "EXAMPLE-CORP-20250518",
"agreement": {"type": "General VAR Agreement",
"reference": "Enterprise License Agreement Q2 2024"
},
"sboNumber": "ABC0012345",
"customerRequestedArrivalDate": "2025-05-31",
"dsSalesRepresentative": "DOE, John",
"isMultiYear": false,
"hasExitClause": false,
"recurringChargeBillingCycle": "ANN360",
"opportunityId": "A1B2-C3D4E5",
"paymentTerms": "Net Date of Invoice + 60 days",
"licenseChargeConditions": [{"sequenceNumber": 1,
"lineGroup": "SBL0001234567",
"onlineInstanceSeatId": "R1122334455667",
"orderType": "STOI",
"usageScope": "GEO EMEA",
"promotion": {"id": "PAO0000111",
"name": "3DEXPERIENCE for small and medium business",
"combination": "Collaborative Design & Engineering Learning @Home"
},
"waiver": {"endDate": "2025-09-15"
},
"licenseChargeBreakdown": [{"sequenceNumber": 1,
"installedBaseNumber": "LN00012345678",
"subOrderType": "NEW",
"revenueType": "ALC",
"portfolio": "CATIA",
"release": "3DEXPERIENCE R2025x",
"product": {"trigram": "ABC",
"type": "NU",
"number": "1AB-ABC",
"name": "Generic Product Standard with Cloud Services",
"dsOffering": "LIC"
},
"quantity": 2,
"unitListPrice": 1000,
"totalListPrice": 2000,
"distributorNetAmount": 1930,
"distributorAnnualAmount": 1930,
"distributorDiscountPercentage": 30.5,
"distributorMaximumMarginPercentage": 10.5,
"customerMaximumNetAmount": 1958.95,
"customerMaximumAnnualAmount": 1958.95,
"customerMinimumDiscountPercentage": 10.5,
"startDate": "2025-06-01",
"endDate": "2026-05-31",
"duration": 2,
"calculatedStartDate": "2025-06-01",
"calculatedEndDate": "2026-05-31",
"yearNumber": 1,
"coupon": {"name": "10% off on Installation Fee",
"discountPercentage": 10
},
"inflation": {"date": "2025-07-01",
"ratio": 1.04,
"exception": "CAPL"
}
}
]
}
]
}
],
"info": {"success": true,
"statusCode": 200,
"estimatedSearchCount": 1
}
}

Price-Lists

This section defines the operations related to Price Lists.

Retrieve Price Lists

Get Price Lists

Main (production) server

https://apigw-prd.3ds.com/order/api4partners/v0/price-lists/search

Server for development by Partners (Non Production)

https://apigw-ppt.3ds.com/order/api4partners/v0/price-lists/search

Server for Quality Assurance Testing (Non Production)

https://apigw-qal.3ds.com/order/api4partners/v0/price-lists/search

Server for preprod validation (Non Production)

https://apigw-ptd.3ds.com/order/api4partners/v0/price-lists/search

Server for postprod validation (Non Production)

https://apigw-ppd.3ds.com/order/api4partners/v0/price-lists/search

Retrieves the Price Lists for the authenticated user.

Authorizations:

API Key: ApiKeyAuth

Responses

Response samples

200
401
403
429

Content type

application/json

Example

Successful price list search

Example of a successful price list search request that returns multiple price lists for different countries.

{"data": [{"countryCode": "BLZ",
"countryName": "Belize",
"priceLists": [{"id": 9,
"name": "LATAM South Price List",
"currency": "USD",
"hasFuturePriceList": false,
"effectiveDate": null
}
]
},
{"countryCode": "CAN",
"countryName": "Canada",
"priceLists": [{"id": 3,
"name": "Canada Price List",
"currency": "CAD",
"hasFuturePriceList": false,
"effectiveDate": "2025-09-12"
}
]
},
{"countryCode": "HND",
"countryName": "Honduras",
"priceLists": [{"id": 9,
"name": "LATAM South Price List",
"currency": "USD",
"hasFuturePriceList": false,
"effectiveDate": null
}
]
}
],
"info": {"success": true,
"statusCode": 200,
"estimatedSearchCount": 3
}
}

Products

This section defines the operations related to Products:

Retrieve Portfolios and Industry Process Experiences
Retrieve Products from Portfolio or Industry Process Experience
Retrieve Package or Offer content
Retrieve Price List of Portfolio or Industry Process Experience

Get Portfolio / IPE Accreditations Deprecated

Main (production) server

https://apigw-prd.3ds.com/order/api4partners/v0/accreditations/search

Server for development by Partners (Non Production)

https://apigw-ppt.3ds.com/order/api4partners/v0/accreditations/search

Server for Quality Assurance Testing (Non Production)

https://apigw-qal.3ds.com/order/api4partners/v0/accreditations/search

Server for preprod validation (Non Production)

https://apigw-ptd.3ds.com/order/api4partners/v0/accreditations/search

Server for postprod validation (Non Production)

https://apigw-ppd.3ds.com/order/api4partners/v0/accreditations/search

Deprecated – v0. This endpoint will be removed in a future release as per our Partners API Lifecycle policy.

Use /order/api4partners/v1/accreditations/search instead.

Retrieves accreditations associated with the authenticated user. Supports pagination with skip and top parameters.

Authorizations:

API Key: ApiKeyAuth

query Parameters

skip	integer >= 0 Default: 0 Number of items to skip in the search results.
top	integer [ 1 .. 100 ] Default: 100 Example: top=100 Maximum number of items to retrieve in search results.

Responses

Response samples

200
400
401
403
429

Content type

application/json

Example

Successful accreditation search example

Example of a successful accreditation search request that returns multiple results, demonstrating top matches.

{"data": [{"id": "PRTF008",
"name": "Support & Services Offering",
"accreditationType": "Portfolio"
},
{"id": "PRTF063",
"name": "Public Cloud 3DEXPERIENCE WORKS",
"accreditationType": "Portfolio"
},
{"id": "IPE00041462",
"name": "18-Sub-system Level Structural Validation",
"accreditationType": "Industry Process Experience",
"deploymentType": "On Premise",
"industrySolutionExperience": {"id": "ISE00005355",
"name": "Co-Design to Target"
},
"solutionRelease": {"id": "REL00000055",
"name": "3DEXPERIENCE R2025x"
},
"industry": {"id": "IND000005",
"name": "Aerospace & Defense"
}
}
],
"info": {"success": true,
"statusCode": 200,
"estimatedSearchCount": 3
}
}

Get Product Prices

Main (production) server

https://apigw-prd.3ds.com/order/api4partners/v0/product-price-list/search

Server for development by Partners (Non Production)

https://apigw-ppt.3ds.com/order/api4partners/v0/product-price-list/search

Server for Quality Assurance Testing (Non Production)

https://apigw-qal.3ds.com/order/api4partners/v0/product-price-list/search

Server for preprod validation (Non Production)

https://apigw-ptd.3ds.com/order/api4partners/v0/product-price-list/search

Server for postprod validation (Non Production)

https://apigw-ppd.3ds.com/order/api4partners/v0/product-price-list/search

Retrieves the List Price, Partner Discount, First Year Discount (if applicable), and computed partner prices for all Products and Migration Paths associated with a given Portfolio or Industry Process Experience (IPE).

The API applies the same logic used by DSx.Client Order for:

Selecting the latest valid release of a product
Retrieving revenue types
Fetching Price List values
Applying Partner Margins
Calculating Partner Prices and First Year Discount Prices
Enforcing accreditation checks
Pagination based on Product Number ordering (ascending)

Pagination: Sorting is based on ascending productNumber, with pagination controlled by skip and top.

Disclaimer: Prices in the API response are as per standard discount of distribution agreement. Additional adjustments (tiering, Footprint premium..) are not factored in.

Authorizations:

API Key: ApiKeyAuth

query Parameters

skip	integer >= 0 Default: 0 Number of product records to skip. Used for pagination.
top	integer [ 1 .. 100 ] Default: 100 Number of product records to return.

Request Body schema: application/json
required

Request body containing details about:

Portfolio vs. Industry Process Experience (accreditationType)
Portfolio/IPE ID (accreditationId)
Price List ID (priceListId)
Optional status for current or future price list (priceListStatus)

The system:

Performs accreditation checks
Retrieves Products + Migration Paths
Selects latest release
Fetches prices and margins
Computes partner and first-year discount prices
Applies pagination on productNumber (ascending)

accreditationType

required

string <= 1 characters

Enum	Description
R	Portfolio. The portfolio to which the product being ordered belongs. This field identifies the specific product family or category to which the ordered product belongs. For example, a product might belong to a portfolio such as "CATIA", "ENOVIA", or "SIMULIA".
I	Industry Process Experience. A Dassault Systèmes offering designed to correspond to the business process used by a team in the context of the solution. Delivered through the 3DEXPERIENCE platform, Industry Process Experiences (IPEs) are composed of Roles. When combined, they make up Industry Solution Experiences.

Example: "I"

Category of accreditation.

accreditationId

required

string <= 15 characters

Example: "PRTF136"

Portfolio ID or IPE ID. Must consist of uppercase letters and numbers. Format will be validated.

priceListId

required

integer <= 2 characters

Example: "17"

Price List ID. Must contain only numbers.

priceListStatus

string <= 1 characters

Default: "C"

Enum	Description
C	Current
F	Future

Example: "F"

Indicates which price list should be considered.

Not provided or 'C' returns current prices
'F' returns future prices

Responses

Request samples

Payload

Content type

application/json

{"accreditationType": "R",
"accreditationId": "PRTF136",
"priceListId": 17,
"priceListStatus": "C"
}

Response samples

Content type

application/json

Example

Product without First Year Discount

{"data": [{"number": "5CC-MD2",
"prices": [{"revenueType": "PLC",
"dsListPrice": 21770,
"distributorDiscountPercentage": 25,
"distributorPrice": 16327.5
},
{"revenueType": "ALC",
"dsListPrice": 21770,
"distributorDiscountPercentage": 25,
"distributorPrice": 16327.5
}
]
}
],
"info": {"success": true,
"statusCode": 200,
"estimatedSearchCount": 1
}
}

Get Products

Main (production) server

https://apigw-prd.3ds.com/order/api4partners/v0/product-information/search

Server for development by Partners (Non Production)

https://apigw-ppt.3ds.com/order/api4partners/v0/product-information/search

Server for Quality Assurance Testing (Non Production)

https://apigw-qal.3ds.com/order/api4partners/v0/product-information/search

Server for preprod validation (Non Production)

https://apigw-ptd.3ds.com/order/api4partners/v0/product-information/search

Server for postprod validation (Non Production)

https://apigw-ppd.3ds.com/order/api4partners/v0/product-information/search

Returns detailed product information for all Products and Migration Paths associated with a given accredited Portfolio or Industry Process Experience (IPE).

For each product or migration path, the API retrieves:

Product Number, Trigram, Product Type
Default Support Level
Licensing Scheme
DS Offering
Remote Access flag
Extended Enterprise User flag
Release-specific information (Release Name, Product Name)
Portfolio Name
Pre-Requisite (if configured)
Availability status

Pagination: Sorting is based on ascending productNumber, with pagination controlled by skip and top.

Authorizations:

API Key: ApiKeyAuth

query Parameters

skip	integer >= 0 Default: 0 Number of product records to skip. Used for pagination.
top	integer [ 1 .. 100 ] Default: 100 Number of product records to return.

Request Body schema: application/json
required

Request body specifying accreditation type and ID.

accreditationType
accreditationId

accreditationType

required

string <= 1 characters

Enum	Description
R	Portfolio. The portfolio to which the product being ordered belongs. This field identifies the specific product family or category to which the ordered product belongs. For example, a product might belong to a portfolio such as "CATIA", "ENOVIA", or "SIMULIA".
I	Industry Process Experience. A Dassault Systèmes offering designed to correspond to the business process used by a team in the context of the solution. Delivered through the 3DEXPERIENCE platform, Industry Process Experiences (IPEs) are composed of Roles. When combined, they make up Industry Solution Experiences.

Example: "I"

Category of accreditation.

accreditationId

required

string <= 15 characters

Example: "IPE0000XXX"

Portfolio ID or IPE ID. Must consist of uppercase letters and numbers. Format and accreditation will be validated.

Responses

Request samples

Payload

Content type

application/json

{"accreditationType": "R",
"accreditationId": "PRTF00XX"
}

Response samples

Content type

application/json

Example

Example response for a Package

{"data": [{"number": "6NB-PCS-OC",
"trigram": "PCS-OC",
"type": "P",
"defaultSupportLevel": "A",
"licensingScheme": "NAM",
"dsOffering": "ONL",
"remoteAccess": true,
"extendedEnterpriseUser": true,
"release": "3DEXPERIENCE R2025x",
"name": "Collaborative Business & Industry Innovator",
"prerequisite": "",
"availabilityStatus": 1,
"portfolio": "Public Cloud Governance/Lifecycle"
},
{"number": "6NB-PCS-OC",
"trigram": "PCS-OC",
"type": "P",
"defaultSupportLevel": "A",
"licensingScheme": "NAM",
"dsOffering": "ONL",
"remoteAccess": true,
"extendedEnterpriseUser": true,
"release": "3DEXPERIENCE R2023x",
"name": "Collaborative Business & Industry Innovator",
"prerequisite": "",
"availabilityStatus": 1,
"portfolio": "Public Cloud Governance/Lifecycle"
}
],
"info": {"success": true,
"statusCode": 200,
"estimatedSearchCount": 1
}
}

Get Package / Offer Content

Main (production) server

https://apigw-prd.3ds.com/order/api4partners/v0/package-offer-content/search

Server for development by Partners (Non Production)

https://apigw-ppt.3ds.com/order/api4partners/v0/package-offer-content/search

Server for Quality Assurance Testing (Non Production)

https://apigw-qal.3ds.com/order/api4partners/v0/package-offer-content/search

Server for preprod validation (Non Production)

https://apigw-ptd.3ds.com/order/api4partners/v0/package-offer-content/search

Server for postprod validation (Non Production)

https://apigw-ppd.3ds.com/order/api4partners/v0/package-offer-content/search

Retrieves the commercial content of a Package or Offer for the given release.

Authorizations:

API Key: ApiKeyAuth

query Parameters

skip	integer >= 0 Default: 0 Number of product records to skip. Used for pagination.
top	integer [ 1 .. 10 ] Default: 10 Number of product records to return.

Request Body schema: application/json
required

Request body specifying Product Number and Release Name.

number
release

number required	string <= 20 characters Example: "6NB-XXX-YY" Product Number of the item
release required	string <= 50 characters Example: "3DEXPERIENCE R2025x" Release name of the package/offer

Responses

Request samples

Payload

Content type

application/json

{"number": "5CB-DIC-EDU",
"release": "V5-6R2025"
}

Response samples

Content type

application/json

{"data": [{"number": "6NP-IFW-OC",
"portfolio": "Public Cloud 3DEXPERIENCE Platform",
"release": "3DEXPERIENCE R2026x",
"quantity": 1
},
{"number": "6NP-CSV-OC",
"portfolio": "Public Cloud Governance/Lifecycle",
"release": "3DEXPERIENCE R2026x",
"quantity": 1
}
],
"info": {"success": true,
"statusCode": 200,
"estimatedSearchCount": 2
}
}

Get Portfolio / IPE Accreditations

Main (production) server

https://apigw-prd.3ds.com/order/api4partners/v1/accreditations/search

Server for development by Partners (Non Production)

https://apigw-ppt.3ds.com/order/api4partners/v1/accreditations/search

Server for Quality Assurance Testing (Non Production)

https://apigw-qal.3ds.com/order/api4partners/v1/accreditations/search

Server for preprod validation (Non Production)

https://apigw-ptd.3ds.com/order/api4partners/v1/accreditations/search

Server for postprod validation (Non Production)

https://apigw-ppd.3ds.com/order/api4partners/v1/accreditations/search

Retrieves accreditations associated with the authenticated user. Supports pagination with skip and top parameters.

Authorizations:

API Key: ApiKeyAuth

query Parameters

skip	integer >= 0 Default: 0 Number of items to skip in the search results.
top	integer [ 1 .. 100 ] Default: 100 Example: top=100 Maximum number of items to retrieve in search results.

Responses

Response samples

200
400
401
403
429

Content type

application/json

Example

Successful accreditation search example

Example of a successful accreditation search request that returns multiple results, demonstrating top matches.

{"data": [{"id": "PRTF008",
"name": "Support & Services Offering",
"accreditationType": "R"
},
{"id": "PRTF063",
"name": "Public Cloud 3DEXPERIENCE WORKS",
"accreditationType": "R"
},
{"id": "IPE00041462",
"name": "18-Sub-system Level Structural Validation",
"accreditationType": "I",
"deploymentType": "4",
"industrySolutionExperience": {"id": "ISE00005355",
"name": "Co-Design to Target"
},
"solutionRelease": {"id": "REL00000055",
"name": "3DEXPERIENCE R2025x"
},
"industry": {"id": "IND000005",
"name": "Aerospace & Defense"
}
}
],
"info": {"success": true,
"statusCode": 200,
"estimatedSearchCount": 3
}
}

Schemas

date_time_from

string <date-time>

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). The timestamp must not be set in the future. If not provided, the system will automatically calculate it by subtracting the maximum number of days specified for the time range defined for the parent search criteria.

"2024-05-21T14:30:00Z"

date_time_to

string <date-time>

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). If the from timestamp is specified, this value must be later than from. If not provided, the system will automatically calculate this value by adding the maximum number of days specified for the time range defined for the parent search criteria.

"2024-05-22T14:30:00Z"

creation_datetime_req

Any of

from

required

string <date-time>

Example: "2024-05-21T14:30:00Z"

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). The timestamp must not be set in the future. If not provided, the system will automatically calculate it by subtracting the maximum number of days specified for the time range defined for the parent search criteria.

to

string <date-time>

Example: "2024-05-22T14:30:00Z"

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). If the from timestamp is specified, this value must be later than from. If not provided, the system will automatically calculate this value by adding the maximum number of days specified for the time range defined for the parent search criteria.

{"from": "2024-05-21T14:30:00Z",
"to": "2024-05-22T14:30:00Z"
}

booking_datetime_req

Any of

from

required

string <date-time>

Example: "2024-05-21T14:30:00Z"

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). The timestamp must not be set in the future. If not provided, the system will automatically calculate it by subtracting the maximum number of days specified for the time range defined for the parent search criteria.

to

string <date-time>

Example: "2024-05-22T14:30:00Z"

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). If the from timestamp is specified, this value must be later than from. If not provided, the system will automatically calculate this value by adding the maximum number of days specified for the time range defined for the parent search criteria.

{"from": "2024-05-21T14:30:00Z",
"to": "2024-05-22T14:30:00Z"
}

lastupdate_datetime_req

Any of

from

required

string <date-time>

Example: "2024-05-21T14:30:00Z"

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). The timestamp must not be set in the future. If not provided, the system will automatically calculate it by subtracting the maximum number of days specified for the time range defined for the parent search criteria.

to

string <date-time>

Example: "2024-05-22T14:30:00Z"

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). If the from timestamp is specified, this value must be later than from. If not provided, the system will automatically calculate this value by adding the maximum number of days specified for the time range defined for the parent search criteria.

{"from": "2024-05-21T14:30:00Z",
"to": "2024-05-22T14:30:00Z"
}

installed_base_number

string <= 40 characters

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 Number is used to determine the Final Customer's maintenance and support obligations, as well as to calculate the cost of future upgrades or renewals. This is used to track the Final Customer's software licenses and maintenance history.

"LN00012345678"

online_instance_seat_id

string <= 15 characters

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 cloud. This identifier is also referred to as the Online Instance ID. Additionally, it is also used as the Seat ID to identify a user's access to the instance. The Seat ID is used to manage user licenses, authenticate users, and track user activity within the instance. The Online Instance ID/Seat ID is a combination of letters and numbers.

"R1122334455667"

billto_po_references_req

Array (non-empty)

string <= 60 characters

Must be a string with a maximum length of 60 characters.

["390830"
]

transaction_type

string

Enum	Description
PO	Purchase Order
RN	Renewal Notification

Order type (one of: PO, RN).

"PO"

order_processing_status_deprecated_v0

string

Enum	Description
Cancelled	The order has been cancelled and is no longer valid.
Claim to be Managed	The order is being claimed by a different entity for management.
Consent Refused	The Final Customer has refused to provide consent for the order.
Discarded	The order has been discarded and is no longer valid.

… 20 more

Current processing status of the order.

"Sales Approved"

transaction_deprecated_v0

id

string <= 13 characters

Example: "PO_A123456789"

Unique identifier of the order. Can represent a Purchase Order or a Renewal Notification.

type

string

Enum	Description
PO	Purchase Order
RN	Renewal Notification

Example: "PO"

Order type (one of: PO, RN).

status

string

Deprecated

Enum	Description
Cancelled	The order has been cancelled and is no longer valid.
Claim to be Managed	The order is being claimed by a different entity for management.
Consent Refused	The Final Customer has refused to provide consent for the order.
Discarded	The order has been discarded and is no longer valid.

… 20 more

Example: "Sales Approved"

Current processing status of the order.

description

string <= 30 characters

Example: "XYZ Company Order 50 products"

Short description given to the Purchase Order / Renewal Notification.

{"id": "PO_A123456789",
"type": "PO",
"status": "Sales Approved",
"description": "XYZ Company Order 50 products"
}

local_time_zone

string

Enum	Description
ACST	Australian Central Standard Time
AEST	Australian Eastern Standard Time
AKST	Alaska Time (US)
ASK	Alaska Time

… 24 more

Time zone abbreviation used by the sales business unit.

"CET"

business_unit

id

required

string = 5 characters

Example: "BU001"

Unique identifier of the sales business unit.

name

required

string <= 25 characters

Example: "Corporate Sales Unit A"

Name of the sales business unit.

localTimezone

required

string

Enum	Description
ACST	Australian Central Standard Time
AEST	Australian Eastern Standard Time
AKST	Alaska Time (US)
ASK	Alaska Time

… 24 more

Example: "CET"

Time zone abbreviation used by the sales business unit.

{"id": "BU001",
"name": "Corporate Sales Unit A",
"localTimezone": "CET"
}

legal_entity

id required	string <= 15 characters Example: "100012345678901" A unique identifier for the company. The value will be within the Legal Entity Family.
name required	string <= 120 characters Example: "Example Corporation" The registered name of the company in English.
localName	string <= 120 characters Example: "示例公司" The registered name of the company in the local language.
locationId required	integer [ 1 .. 999 ] Example: "2" A unique identifier representing the company's location. Must be an integer between 1 and 999.

{"id": "100012345678901",
"name": "Example Corporation",
"localName": "示例公司",
"locationId": 2
}

creation_datetime

string <date-time>

UTC timestamp when the order was created in the system.

Format: ISO 8601 UTC (e.g., 2025-05-21T14:30:00Z)

"2025-05-21T14:30:00Z"

ds_received_po_date

string <date>

Date when the order was received by Dassault Systèmes, in ISO 8601 format (YYYY-MM-DD).

"2025-05-21"

booking_datetime

string <date-time>

UTC timestamp when the order was approved by the Finance Department.

Format: ISO 8601 UTC (e.g., 2025-05-30T14:30:00Z)

"2025-05-29T18:00:00Z"

lastupdate_datetime

string <date-time>

UTC timestamp of the most recent update to the order. This timestamp indicates the exact moment when the order was last modified. It is crucial for tracking changes and ensuring data consistency.

Format: ISO 8601 UTC (e.g., 2025-05-21T14:40:00Z)

"2025-05-21T14:40:00Z"

currency

string = 3 characters ^[A-Z]{3}$

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 Euro, INR for Indian Ruppee).

"USD"

online_consent_status_deprecated_v0

string

Default: ""

Enum	Description
Accepted	The online consent request has been successfully accepted by the designated contact.
Expired	The online consent request has expired and is no longer valid.
Not Applicable	The online consent request is not applicable to the current situation or context.
Not Requested	The online consent request has not been sent to the designated contact.

… 2 more

Status of the online consent request sent to the designated contact.

"Accepted"

billto_sales_representative

string

Name of the sales representative person from the Bill To site.

"DOE, Jane"

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.

"EXAMPLE-CORP-20250518"

orders_search_data_deprecated_v0

Array

required

object

Deprecated

Transactional details of the order.

required

object

Details of the sales business unit.

required

object

Legal entity to which Dassault Systèmes will issue the invoice (Bill To).

required

object

Legal entity of the company that is the Final Customer of Dassault Systèmes products (Sold To).

creationDateTime

required

string <date-time>

Example: "2025-05-21T14:30:00Z"

UTC timestamp when the order was created in the system.

Format: ISO 8601 UTC (e.g., 2025-05-21T14:30:00Z)

dsReceivedPoDate

string <date>

Example: "2025-05-21"

Date when the order was received by Dassault Systèmes, in ISO 8601 format (YYYY-MM-DD).

bookingDateTime

string <date-time>

Example: "2025-05-29T18:00:00Z"

UTC timestamp when the order was approved by the Finance Department.

Format: ISO 8601 UTC (e.g., 2025-05-30T14:30:00Z)

lastUpdateDateTime

string <date-time>

Example: "2025-05-21T14:40:00Z"

UTC timestamp of the most recent update to the order. This timestamp indicates the exact moment when the order was last modified. It is crucial for tracking changes and ensuring data consistency.

Format: ISO 8601 UTC (e.g., 2025-05-21T14:40:00Z)

currency

required

string = 3 characters ^[A-Z]{3}$

Example: "USD"

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 Euro, INR for Indian Ruppee).

onlineConsentStatus

string

Deprecated

Enum	Description
Accepted	The online consent request has been successfully accepted by the designated contact.
Expired	The online consent request has expired and is no longer valid.
Not Applicable	The online consent request is not applicable to the current situation or context.
Not Requested	The online consent request has not been sent to the designated contact.

… 2 more

Example: "Accepted"

Status of the online consent request sent to the designated contact.

billToSalesRepresentative

string

Example: "DOE, Jane"

Name of the sales representative person from the Bill To site.

billToPoReference

string

Example: "EXAMPLE-CORP-20250518"

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.

[{"transaction": {"id": "PO_A123456789",
"type": "PO",
"status": "Sales Approved",
"description": "XYZ Company Order 50 products"
},
"businessUnit": {"id": "BU001",
"name": "Corporate Sales Unit A",
"localTimezone": "CET"
},
"billToSite": {"id": "100012345678901",
"name": "Example Corporation",
"localName": "示例公司",
"locationId": 2
},
"soldToSite": {"id": "100012345678901",
"name": "Example Corporation",
"localName": "示例公司",
"locationId": 2
},
"creationDateTime": "2025-05-21T14:30:00Z",
"dsReceivedPoDate": "2025-05-21",
"bookingDateTime": "2025-05-29T18:00:00Z",
"lastUpdateDateTime": "2025-05-21T14:40:00Z",
"currency": "USD",
"onlineConsentStatus": "Accepted",
"billToSalesRepresentative": "DOE, Jane",
"billToPoReference": "EXAMPLE-CORP-20250518"
}
]

info

success required	boolean Indicates whether the API request was executed successfully.
statusCode required	integer HTTP status code corresponding to the response.
estimatedSearchCount	integer Estimated number of results matching the search criteria.

{"success": true,
"statusCode": 0,
"estimatedSearchCount": 0
}

error

Array

type required	string Enum: "errors:3dx:invalidRequest" "errors:3dx:authenticationGenericError" "errors:3dx:resourceNotFound" "errors:3dx:internalServerError" A URI identifying the specific type of error. This allows API consumers to programmatically recognize and handle the error appropriately. The URI follows the format: `errors:<domain>:<error_type>` Example values include: `errors:3dx:invalidRequest` `errors:3dx:authenticationGenericError` `errors:3dx:resourceNotFound` `errors:3dx:internalServerError`
title required	string A user-friendly error message, typically localized (NLS-supported), describing the general nature of the error.
	Array of objects A list of individual validation or processing errors related to the request. Useful when multiple issues are detected at once.

[{"type": "errors:3dx:invalidRequest",
"title": "string",
"errors": [{"detail": "string",
"pointer": "string"
}
]
}
]

401_basic_unauthorized

message

required

string

{"message": "string"
}

403_basic_forbidden

message

required

string

{"message": "string"
}

429_too_many_requests

message

required

string

{"message": "string"
}

recurring_charge_billing_cycle_deprecated_v0

string

Enum	Description
Calendar Month	bill recurring license charges through the end of the current calendar month and for full month periods thereafter (or until indicated anniversary date if earlier)
Calendar Quarter	bill recurring license charges through the end of the current calendar quarter and for full 3 month periods thereafter (or until indicated anniversary date if earlier)
Calendar Semester	bill recurring license charges through the end of the current semester and for full 6 month periods thereafter (or until indicated anniversary date if earlier)
Calendar Year	bill recurring license charges through the end of the current calendar year and for full 12 month periods thereafter (or until indicated anniversary date if earlier)

… 6 more

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) or cancellation and refund or overpayment, the prorate calculation is based on 30 day months.

"Calendar Year"

order_type_deprecated_v0

string

Enum	Description
New	A fresh order that does not involve any migration, renewal, or upgrade.
Renewal	Extending an existing license.
Migration - Standard	A standard migration from another platform.
Evaluation License	License issued temporarily for evaluation purposes.

… 28 more

Specifies the classification of the order based on its nature, purpose, or contractual arrangement. This helps identify whether the order involves a new purchase, renewal, upgrade, transfer, suspension, migration, evaluation, or any other business scenario. Each value represents a predefined business process or transaction type that impacts how the order is handled and processed. For a complete list of supported values, refer to the enum section.

"Stop - Transform"

sub_order_type_deprecated_v0

string

Enum	Description
Change of Channel	Changing customer coverage from direct to indirect or vice versa.
Change of VAR	Changing the Value-Added Reseller (VAR) for an existing order.
EPP Training	Training related to EPP (Enterprise Productivity Portfolio).
Evaluation License	License issued temporarily for evaluation purposes.

… 17 more

Sub Order Type

"New License"

order_revenue_type_deprecated_v0

string

Enum	Description
ALC	Annual License Charge
ASC	Annual Service Charge
ELC	Evaluation Licence Charge
PLC	Primary License Charge

… 16 more

Revenue Type defines the classification of a financial transaction within enterprise licensing and sales systems. It standardizes how revenue is recognized, billed, and managed. Used in order processing, financial reporting, and compliance.

"ALC"

release_name

string <= 50 characters

Release Name identifies a specific version of a software

"3DEXPERIENCE R2025x"

product_trigram

string <= 10 characters

The trigram code for the product.

"PCS_OC"

product_type_deprecated_v0

string

Enum	Description
Add-On	An additional feature or component that enhances the functionality of a product.
Auxiliary	A supplementary product or service that supports the primary product.
Casual Named User	A type of user license that allows for occasional or infrequent use of a product.
Configuration	A specific setup or arrangement of a product's features or components.

… 11 more

Type of the product.

"Named User"

product_number

string <= 20 characters

Product Number is a unique alphanumeric identifier assigned to a specific software product, license, or service within an enterprise portfolio. It serves as the primary key during Order Processing. Used in purchase orders, quotes, and invoices to specify the exact item being transacted.

"6NB-XXX-YY"

product_name

string <= 200 characters

The name of the product. This field specifies the title or label of the product.

"Generic Product Standard with Cloud Services"

ds_offering_deprecated_v0

string

Enum	Description
Auxiliary	Non software items i.e hardware, peripherals, or anything else that is not software.
Licensed Program	On premises software.
Not Applicable	Items that are not governed by the CLOSA at all.
Online Services	Cloud based services.

… 2 more

Dassault Systèmes offering Type

"Licensed Program"

billto_net_amount

number <float>

The actual amount payable by the Bill To Site for the selected product.

This field represents the total cost of the product or service, including any applicable taxes, fees, or discounts.

UI Label: Distributor Net Amt

Note: Numeric values may include additional trailing decimal places due to serialization behavior of the underlying platform. The business-defined precision for this field is 2 decimal places. Digits beyond this precision are non-significant and should be ignored.

1930

billto_annual_amount

number <float>

The total amount payable by the Bill To Site for the full year.

This field represents the annual cost of the product or service, taking into account any usage periods that are not a full year.

Note that there may be a difference between Bill To Net Amount and Bill To Annual Amount when the product is not purchased for a full year of usage.

UI Label: Distributor Annual Amt

Note: Numeric values may include additional trailing decimal places due to serialization behavior of the underlying platform. The business-defined precision for this field is 2 decimal places. Digits beyond this precision are non-significant and should be ignored.

1930

billto_discount_percentage

number <float>

The discount percentage applicable to the Total List Price.

This field represents the percentage reduction in the total list price, as a decimal value (e.g. 39.50000000000000 represents 39.5%).

UI Label: Distributor Discount %

Note: Numeric values may include additional trailing decimal places due to serialization behavior of the underlying platform. The business-defined precision for this field is 10 decimal places. Digits beyond this precision are non-significant and should be ignored.

39.5

billto_margin_percentage

number <float>

The percentage difference between the discount price offered by Dassault Systèmes and the Partner Bill To Site.

This field represents the margin earned by the Partner Bill To Site, calculated as a percentage of the discount price.

Note: This field is pre-filled according to the percentage value set inside the Distributor Discount Model section of the GVA Agreement.

Additionally, note that this field is related to Bill to Discount Percentage, which represents the percentage reduction in the Total List Price.

UI Label: Distributor Max Margin %

Note: Numeric values may include additional trailing decimal places due to serialization behavior of the underlying platform. The business-defined precision for this field is 10 decimal places. Digits beyond this precision are non-significant and should be ignored.

15.97

max_customer_net_amount

number <float>

The actual amount payable by the Final Customer Site for the selected product.

This field represents the maximum net amount that the Final Customer Site is responsible for paying, taking into account any applicable discounts or fees.

UI Label: Cust. Max Net Amt

Note: Numeric values may include additional trailing decimal places due to serialization behavior of the underlying platform. The business-defined precision for this field is 2 decimal places. Digits beyond this precision are non-significant and should be ignored.

1958.95

max_customer_annual_amount

number <float>

The total amount payable by the Final Customer Site for the full year.

This field represents the annual cost of the product or service, taking into account any usage periods that are not a full year.

Note that there may be a difference between Maximum Customer Net Amount and Maximum Customer Annual Amount when the product is not purchased for a full year of usage.

UI Label: Cust. Max Annual Amt

Note: Numeric values may include additional trailing decimal places due to serialization behavior of the underlying platform. The business-defined precision for this field is 2 decimal places. Digits beyond this precision are non-significant and should be ignored.

2050

min_customer_discount_percentage

number <float>

The minimum discount percentage that the Partner Bill To Site offers to the Final Customer for the selected product.

This field represents the lowest percentage discount that the Partner Bill To Site is willing to offer to the Final Customer, as a decimal value (e.g. 0.5 represents 0.5%).

UI Label: Cust. Min Discount %

Note: Numeric values may include additional trailing decimal places due to serialization behavior of the underlying platform. The business-defined precision for this field is 10 decimal places. Digits beyond this precision are non-significant and should be ignored.

13.97

inflation_exception_deprecated_v0

string

Enum: "Capping To Price List" "No Price Increase" "No Cap. Lower than Price List"

Any exception applied while calculating the inflated amount.

"Capping To Price List"

order_sub_line_deprecated_v0

sequenceNumber

integer [ 1 .. 999 ]

Example: "1"

The sequence number used to identify the license charge breakdown item. It is an integer autogenerated by system, between 1 and 999.

installedBaseNumber

string <= 40 characters

Example: "LN00012345678"

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 Number is used to determine the Final Customer's maintenance and support obligations, as well as to calculate the cost of future upgrades or renewals. This is used to track the Final Customer's software licenses and maintenance history.

subOrderType

string

Deprecated

Enum	Description
Change of Channel	Changing customer coverage from direct to indirect or vice versa.
Change of VAR	Changing the Value-Added Reseller (VAR) for an existing order.
EPP Training	Training related to EPP (Enterprise Productivity Portfolio).
Evaluation License	License issued temporarily for evaluation purposes.

… 17 more

Example: "New License"

Sub Order Type

revenueType

string

Deprecated

Enum	Description
ALC	Annual License Charge
ASC	Annual Service Charge
ELC	Evaluation Licence Charge
PLC	Primary License Charge

… 16 more

Example: "ALC"

Revenue Type defines the classification of a financial transaction within enterprise licensing and sales systems. It standardizes how revenue is recognized, billed, and managed. Used in order processing, financial reporting, and compliance.

portfolio

string <= 50 characters

Example: "CATIA"

The portfolio to which the product being ordered belongs. This field identifies the specific product family or category to which the ordered product belongs. For example, a product might belong to a portfolio such as "CATIA", "ENOVIA", or "SIMULIA".

release

string <= 50 characters

Example: "3DEXPERIENCE R2025x"

The name of the product release being ordered. This field identifies the specific version of the product to which the ordered product belongs. For example, a product might belong to a release such as "3DEXPERIENCE R2025x", "SOLIDWORKS 2025", or "V5-6R2025".

object

This field identifies the specific product that is being ordered.

quantity

integer >= 1

Example: "2"

The quantity of the product being ordered.

unitListPrice

number <float>

Example: "1000"

The price listed by the Finance Department for the product being ordered.

This field represents the standard price of a single unit of the product, as approved by the Finance Department.

totalListPrice

number <float>

Example: "2000"

The total price of the product licenses, calculated by multiplying the Unit List Price and the Quantity.

This field represents the total cost of the product licenses, taking into account the number of units purchased.

billToNetAmount

number <float>

Deprecated

Example: "1930"

The actual amount payable by the Bill To Site for the selected product.

This field represents the total cost of the product or service, including any applicable taxes, fees, or discounts.

UI Label: Distributor Net Amt

Note: Numeric values may include additional trailing decimal places due to serialization behavior of the underlying platform. The business-defined precision for this field is 2 decimal places. Digits beyond this precision are non-significant and should be ignored.

billToAnnualAmount

number <float>

Deprecated

Example: "1930"

The total amount payable by the Bill To Site for the full year.

This field represents the annual cost of the product or service, taking into account any usage periods that are not a full year.

Note that there may be a difference between Bill To Net Amount and Bill To Annual Amount when the product is not purchased for a full year of usage.

UI Label: Distributor Annual Amt

Note: Numeric values may include additional trailing decimal places due to serialization behavior of the underlying platform. The business-defined precision for this field is 2 decimal places. Digits beyond this precision are non-significant and should be ignored.

billToDiscountPercentage

number <float>

Deprecated

Example: "39.5"

The discount percentage applicable to the Total List Price.

This field represents the percentage reduction in the total list price, as a decimal value (e.g. 39.50000000000000 represents 39.5%).

UI Label: Distributor Discount %

Note: Numeric values may include additional trailing decimal places due to serialization behavior of the underlying platform. The business-defined precision for this field is 10 decimal places. Digits beyond this precision are non-significant and should be ignored.

billToMarginPercentage

number <float>

Deprecated

Example: "15.97"

The percentage difference between the discount price offered by Dassault Systèmes and the Partner Bill To Site.

This field represents the margin earned by the Partner Bill To Site, calculated as a percentage of the discount price.

Note: This field is pre-filled according to the percentage value set inside the Distributor Discount Model section of the GVA Agreement.

Additionally, note that this field is related to Bill to Discount Percentage, which represents the percentage reduction in the Total List Price.

UI Label: Distributor Max Margin %

Note: Numeric values may include additional trailing decimal places due to serialization behavior of the underlying platform. The business-defined precision for this field is 10 decimal places. Digits beyond this precision are non-significant and should be ignored.

maximumCustomerNetAmount

number <float>

Deprecated

Example: "1958.95"

The actual amount payable by the Final Customer Site for the selected product.

This field represents the maximum net amount that the Final Customer Site is responsible for paying, taking into account any applicable discounts or fees.

UI Label: Cust. Max Net Amt

Note: Numeric values may include additional trailing decimal places due to serialization behavior of the underlying platform. The business-defined precision for this field is 2 decimal places. Digits beyond this precision are non-significant and should be ignored.

maximumCustomerAnnualAmount

number <float>

Deprecated

Example: "2050"

The total amount payable by the Final Customer Site for the full year.

This field represents the annual cost of the product or service, taking into account any usage periods that are not a full year.

Note that there may be a difference between Maximum Customer Net Amount and Maximum Customer Annual Amount when the product is not purchased for a full year of usage.

UI Label: Cust. Max Annual Amt

Note: Numeric values may include additional trailing decimal places due to serialization behavior of the underlying platform. The business-defined precision for this field is 2 decimal places. Digits beyond this precision are non-significant and should be ignored.

minimumCustomerDiscountPercentage

number <float>

Deprecated

Example: "13.97"

The minimum discount percentage that the Partner Bill To Site offers to the Final Customer for the selected product.

This field represents the lowest percentage discount that the Partner Bill To Site is willing to offer to the Final Customer, as a decimal value (e.g. 0.5 represents 0.5%).

UI Label: Cust. Min Discount %

Note: Numeric values may include additional trailing decimal places due to serialization behavior of the underlying platform. The business-defined precision for this field is 10 decimal places. Digits beyond this precision are non-significant and should be ignored.

startDate

string <date>

Example: "2025-06-01"

The start date of the product or service, in ISO 8601 format (YYYY-MM-DD).

endDate

string

Example: "2026-05-31"

The end date of the product or service, in ISO 8601 format (YYYY-MM-DD).

duration

integer

Example: "2"

The duration for which the product or service is intended to be used.

The unit of duration depends on the Revenue Type:

If Revenue Type is ALC (Annual License Charge), then the duration is measured in years. For example, a duration of 2 represents 2 years.
If Revenue Type is QLC (Quarterly License Charge), then the duration is measured in quarters. For example, a duration of 2 represents 2 quarters.

calculatedStartDate

string <date>

Example: "2025-06-01"

This field is automatically calculated by the system. Format: ISO 8601 format (YYYY-MM-DD).

It is based on one of the following dates:

The user-entered Start Date
The CRAD (Customer Requested Arrival Date)
The Finance Approved date of the order

calculatedEndDate

string <date>

Example: "2026-06-30"

This field is automatically calculated by the system. Format: ISO 8601 format (YYYY-MM-DD).

It is based on one of the following values:

First Year Co-Terminus: The end date of the first year of the contract.
End date of the Duration calculated from 'calculatedStartDate' or entered by the user

yearNumber

integer

Example: "1"

This field represents the product usage Year Number for multi-year orders.

It is used to identify the specific year of a multi-year contract.

object

Details of the discount coupon applied to the final price.

object

Details about the inflation rate applied to the price of the product. The inflation occurs when it is the case of product renewals.

{"sequenceNumber": 1,
"installedBaseNumber": "LN00012345678",
"subOrderType": "New License",
"revenueType": "ALC",
"portfolio": "CATIA",
"release": "3DEXPERIENCE R2025x",
"product": {"trigram": "PCS_OC",
"type": "Named User",
"number": "6NB-XXX-YY",
"name": "Generic Product Standard with Cloud Services",
"dsOffering": "Licensed Program"
},
"quantity": 2,
"unitListPrice": 1000,
"totalListPrice": 2000,
"billToNetAmount": 1930,
"billToAnnualAmount": 1930,
"billToDiscountPercentage": 39.5,
"billToMarginPercentage": 15.97,
"maximumCustomerNetAmount": 1958.95,
"maximumCustomerAnnualAmount": 2050,
"minimumCustomerDiscountPercentage": 13.97,
"startDate": "2025-06-01",
"endDate": "2026-05-31",
"duration": 2,
"calculatedStartDate": "2025-06-01",
"calculatedEndDate": "2026-06-30",
"yearNumber": 1,
"coupon": {"name": "10% off on Installation Fee",
"discountPercentage": 10
},
"inflation": {"date": "2025-07-01",
"ratio": 1.025,
"exception": "Capping To Price List"
}
}

order_line_deprecated_v0

sequenceNumber

integer [ 1 .. 999 ]

Example: "1"

The sequence number used to identify the line item. It is an integer autogenerated by system, between 1 and 999.

lineGroup

string <= 15 characters

Example: "SBL0001234567"

Unique identifier of license charge condition. This is used to group together the Installed Base sub-lines.

onlineInstanceSeatId

string <= 15 characters

Example: "R1122334455667"

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 cloud. This identifier is also referred to as the Online Instance ID. Additionally, it is also used as the Seat ID to identify a user's access to the instance. The Seat ID is used to manage user licenses, authenticate users, and track user activity within the instance. The Online Instance ID/Seat ID is a combination of letters and numbers.

orderType

string

Deprecated

Enum	Description
New	A fresh order that does not involve any migration, renewal, or upgrade.
Renewal	Extending an existing license.
Migration - Standard	A standard migration from another platform.
Evaluation License	License issued temporarily for evaluation purposes.

… 28 more

Example: "Stop - Transform"

Specifies the classification of the order based on its nature, purpose, or contractual arrangement. This helps identify whether the order involves a new purchase, renewal, upgrade, transfer, suspension, migration, evaluation, or any other business scenario. Each value represents a predefined business process or transaction type that impacts how the order is handled and processed. For a complete list of supported values, refer to the enum section.

usageScope

string <= 80 characters

Example: "GEO EMEA"

Defines the geographical or territorial scope in which the product can be used, as specified in the associated agreement details. This may refer to a region (e.g., GEO) or a specific country.

object

Promotion information. This object contains information about the promotion applied to the order. The promotion object contains information about the promotion, including its name, ID, and combination of one or more products.

object or object

Waiver information for the license charge. It can be either of duration or endDate.

Array of objects

{"sequenceNumber": 1,
"lineGroup": "SBL0001234567",
"onlineInstanceSeatId": "R1122334455667",
"orderType": "Stop - Transform",
"usageScope": "GEO EMEA",
"promotion": {"id": "PAO0000111",
"name": "3DEXPERIENCE for small and medium business",
"combination": "Collaborative Design & Engineering Learning @Home"
},
"waiver": {"duration": 1,
"endDate": "2025-05-30"
},
"licenseChargeBreakdown": [{"sequenceNumber": 1,
"installedBaseNumber": "LN00012345678",
"subOrderType": "New License",
"revenueType": "ALC",
"portfolio": "CATIA",
"release": "3DEXPERIENCE R2025x",
"product": {"trigram": "PCS_OC",
"type": "Named User",
"number": "6NB-XXX-YY",
"name": "Generic Product Standard with Cloud Services",
"dsOffering": "Licensed Program"
},
"quantity": 2,
"unitListPrice": 1000,
"totalListPrice": 2000,
"billToNetAmount": 1930,
"billToAnnualAmount": 1930,
"billToDiscountPercentage": 39.5,
"billToMarginPercentage": 15.97,
"maximumCustomerNetAmount": 1958.95,
"maximumCustomerAnnualAmount": 2050,
"minimumCustomerDiscountPercentage": 13.97,
"startDate": "2025-06-01",
"endDate": "2026-05-31",
"duration": 2,
"calculatedStartDate": "2025-06-01",
"calculatedEndDate": "2026-06-30",
"yearNumber": 1,
"coupon": {"name": "10% off on Installation Fee",
"discountPercentage": 10
},
"inflation": {"date": "2025-07-01",
"ratio": 1.025,
"exception": "Capping To Price List"
}
}
]
}

order_get_data_deprecated_v0

Array

required

object

Deprecated

Transactional details of the order.

required

object

Details of the sales business unit.

required

object

Legal entity to which Dassault Systèmes will issue the invoice (Bill To).

required

object

Legal entity of the company that is the Final Customer of Dassault Systèmes products (Sold To).

required

object

Contains details about the license agreement associated with the licenses being ordered in the Purchase Order (PO).

billToContact

string

Full name of the contact person at the Bill To site (billing entity) who is responsible for the order. This contact person is the primary point of communication for billing-related inquiries and transactions. Format-LASTNAME, Firstname (e.g., DOE, John).

creationDateTime

required

string <date-time>

Example: "2025-05-21T14:30:00Z"

UTC timestamp when the order was created in the system.

Format: ISO 8601 UTC (e.g., 2025-05-21T14:30:00Z)

dsReceivedPoDate

string <date>

Example: "2025-05-21"

Date when the order was received by Dassault Systèmes, in ISO 8601 format (YYYY-MM-DD).

bookingDateTime

string <date-time>

Example: "2025-05-29T18:00:00Z"

UTC timestamp when the order was approved by the Finance Department.

Format: ISO 8601 UTC (e.g., 2025-05-30T14:30:00Z)

lastUpdateDateTime

string <date-time>

Example: "2025-05-21T14:40:00Z"

UTC timestamp of the most recent update to the order. This timestamp indicates the exact moment when the order was last modified. It is crucial for tracking changes and ensuring data consistency.

Format: ISO 8601 UTC (e.g., 2025-05-21T14:40:00Z)

currency

required

string = 3 characters ^[A-Z]{3}$

Example: "USD"

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 Euro, INR for Indian Ruppee).

onlineConsentStatus

string

Deprecated

Enum	Description
Accepted	The online consent request has been successfully accepted by the designated contact.
Expired	The online consent request has expired and is no longer valid.
Not Applicable	The online consent request is not applicable to the current situation or context.
Not Requested	The online consent request has not been sent to the designated contact.

… 2 more

Example: "Accepted"

Status of the online consent request sent to the designated contact.

billToSalesRepresentative

string

Example: "DOE, Jane"

Name of the sales representative person from the Bill To site.

billToPoReference

string

Example: "EXAMPLE-CORP-20250518"

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.

sboNumber

string <= 10 characters

Example: "ABC0012345"

Unique identifier of the Special Bid Offer (SBO) that served as the basis for creating the order. Typically used to track and reference special pricing or offer conditions.

customerRequestedArrivalDate

string <date>

Example: "2025-05-31"

Customer Requested Arrival Date (CRAD) indicates the date by which the Final Customer requests delivery of the DS Licenses and Support Order.

Note: CRAD is a non-binding request. While DS will make reasonable efforts to meet this date, it does not constitute a contractual commitment.

Orders can still receive 'Finance Approved' status, media can be 'Shipped', and license keys can be issued and marked as 'Completed' irrespective of the CRAD.
The Support Start Date in the Installed Base will never begin before the CRAD.
Format: ISO 8601 format (YYYY-MM-DD)
License keys will remain inactive until the Support Start Date.

dsSalesRepresentative

string

Example: "DOE, John"

Full name of the Dassault Systèmes (DS) sales representative responsible for the order.

Format: LASTNAME, Firstname (e.g., DOE, John)

isMultiYear

boolean

Example: "true"

Indicates whether the order is part of a Multi-Year deal (i.e., duration longer than one year), applicable for revenue types such as YxC or AxC.

hasExitClause

boolean

Example: "true"

Indicates whether the agreement includes an exit clause requiring the Final Customer to pay early termination fees if they end the rental before the completion of the multi-year engagement.

recurringChargeBillingCycle

string

Deprecated

Enum	Description
Calendar Month	bill recurring license charges through the end of the current calendar month and for full month periods thereafter (or until indicated anniversary date if earlier)
Calendar Quarter	bill recurring license charges through the end of the current calendar quarter and for full 3 month periods thereafter (or until indicated anniversary date if earlier)
Calendar Semester	bill recurring license charges through the end of the current semester and for full 6 month periods thereafter (or until indicated anniversary date if earlier)
Calendar Year	bill recurring license charges through the end of the current calendar year and for full 12 month periods thereafter (or until indicated anniversary date if earlier)

… 6 more

Example: "Calendar Year"

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) or cancellation and refund or overpayment, the prorate calculation is based on 30 day months.

opportunity

string

Deprecated

Example: "A1B2-C3D4E5"

Deprecated – v0. This property is renamed to opportunityId.

Use /order/api4partners/v1/orders/search instead.

Unique identifier for the sales opportunity as recorded in the My Sales Pipeline system. This value helps link the order to its originating sales activity.

paymentTerms

string <= 50 characters

Example: "Net Date of Invoice + 60 days"

Payment terms for the order, as provided by the Finance Department. Specifies the agreed period within which the payment must be made.

Array of objects

A list of conditions that determine when the license is charged for the order. These conditions specify the circumstances under which the license fee is applied, such as:

The number of users or seats that are licensed.
The type of license or subscription being purchased.
Any waiver given on the license or subscription.
Any additional features or services that are included with the license.

The license charge conditions are used to calculate the total cost of the license and to ensure that the correct pricing is applied.

[{"transaction": {"id": "PO_A123456789",
"type": "PO",
"status": "Sales Approved",
"description": "XYZ Company Order 50 products"
},
"businessUnit": {"id": "BU001",
"name": "Corporate Sales Unit A",
"localTimezone": "CET"
},
"billToSite": {"id": "100012345678901",
"name": "Example Corporation",
"localName": "示例公司",
"locationId": 2
},
"soldToSite": {"id": "100012345678901",
"name": "Example Corporation",
"localName": "示例公司",
"locationId": 2
},
"agreement": {"type": "General VAR Agreement",
"reference": "Enterprise License Agreement Q2 2024"
},
"billToContact": "string",
"creationDateTime": "2025-05-21T14:30:00Z",
"dsReceivedPoDate": "2025-05-21",
"bookingDateTime": "2025-05-29T18:00:00Z",
"lastUpdateDateTime": "2025-05-21T14:40:00Z",
"currency": "USD",
"onlineConsentStatus": "Accepted",
"billToSalesRepresentative": "DOE, Jane",
"billToPoReference": "EXAMPLE-CORP-20250518",
"sboNumber": "ABC0012345",
"customerRequestedArrivalDate": "2025-05-31",
"dsSalesRepresentative": "DOE, John",
"isMultiYear": true,
"hasExitClause": true,
"recurringChargeBillingCycle": "Calendar Year",
"opportunity": "A1B2-C3D4E5",
"paymentTerms": "Net Date of Invoice + 60 days",
"licenseChargeConditions": [{"sequenceNumber": 1,
"lineGroup": "SBL0001234567",
"onlineInstanceSeatId": "R1122334455667",
"orderType": "Stop - Transform",
"usageScope": "GEO EMEA",
"promotion": {"id": "PAO0000111",
"name": "3DEXPERIENCE for small and medium business",
"combination": "Collaborative Design & Engineering Learning @Home"
},
"waiver": {"duration": 1,
"endDate": "2025-05-30"
},
"licenseChargeBreakdown": [{"sequenceNumber": 1,
"installedBaseNumber": "LN00012345678",
"subOrderType": "New License",
"revenueType": "ALC",
"portfolio": "CATIA",
"release": "3DEXPERIENCE R2025x",
"product": {"trigram": "PCS_OC",
"type": "Named User",
"number": "6NB-XXX-YY",
"name": "Generic Product Standard with Cloud Services",
"dsOffering": "Licensed Program"
},
"quantity": 2,
"unitListPrice": 1000,
"totalListPrice": 2000,
"billToNetAmount": 1930,
"billToAnnualAmount": 1930,
"billToDiscountPercentage": 39.5,
"billToMarginPercentage": 15.97,
"maximumCustomerNetAmount": 1958.95,
"maximumCustomerAnnualAmount": 2050,
"minimumCustomerDiscountPercentage": 13.97,
"startDate": "2025-06-01",
"endDate": "2026-05-31",
"duration": 2,
"calculatedStartDate": "2025-06-01",
"calculatedEndDate": "2026-06-30",
"yearNumber": 1,
"coupon": {"name": "10% off on Installation Fee",
"discountPercentage": 10
},
"inflation": {"date": "2025-07-01",
"ratio": 1.025,
"exception": "Capping To Price List"
}
}
]
}
]
}
]

4xx_get_orders

data required	Array of any <= 0 items Example: [] Always an empty array in case of error responses.
required	object Metadata section of the response providing execution status and result summary.
required	Array of objects An array containing one or more error objects identified during the request processing. Each object provides detailed information about a specific type of error encountered.

{"data": [ ],
"info": {"success": true,
"statusCode": 0,
"estimatedSearchCount": 0
},
"error": [{"type": "errors:3dx:invalidRequest",
"title": "string",
"errors": [{"detail": "string",
"pointer": "string"
}
]
}
]
}

country_code

string

ISO3 Code (3 capital letters code) of the country

"FRA"

country_name

string

Country Location

"France"

price-lists_search_data

Array

countryCode	string Example: "FRA" ISO3 Code (3 capital letters code) of the country
countryName	string Example: "France" Country Location
	Array of objects

[{"countryCode": "FRA",
"countryName": "France",
"priceLists": [{"id": 9,
"name": "EMEA Price List",
"currency": "USD",
"hasFuturePriceList": true,
"effectiveDate": "2025-09-09"
}
]
}
]

accreditation_type_deprecated_v0

string

Enum	Description
Industry Process Experience	A Dassault Systèmes offering designed to correspond to the business process used by a team in the context of the solution. Delivered through the 3DEXPERIENCE platform, Industry Process Experiences (IPEs) are composed of Roles. When combined, they make up Industry Solution Experiences.
Portfolio	The portfolio to which the product being ordered belongs. This field identifies the specific product family or category to which the ordered product belongs. For example, a product might belong to a portfolio such as "CATIA", "ENOVIA", or "SIMULIA".

Category of accreditation.

"Industry Process Experience"

deployment_type_deprecated_v0

string

Enum	Description
On Premise	On-premise refers to a computing infrastructure (either bare metal or virtual machines) that is deployed and maintained within the organization's own data centers or facilities. It is not shared with other organizations, providing the highest level of control and security.
Public Cloud	On-Cloud refers to products or solutions that are designed, developed, and delivered directly on cloud infrastructure rather than on traditional on-premises systems.

Solution deployment environment.

"On Premise"

accreditations_search_data_deprecated_v0

Array

id

required

string

Examples: "IPE00034863" "PRTF119"

name

required

string

Examples: "04-Continuous Product Development" "Public Cloud 3D Design"

accreditationType

required

string

Deprecated

Enum	Description
Industry Process Experience	A Dassault Systèmes offering designed to correspond to the business process used by a team in the context of the solution. Delivered through the 3DEXPERIENCE platform, Industry Process Experiences (IPEs) are composed of Roles. When combined, they make up Industry Solution Experiences.
Portfolio	The portfolio to which the product being ordered belongs. This field identifies the specific product family or category to which the ordered product belongs. For example, a product might belong to a portfolio such as "CATIA", "ENOVIA", or "SIMULIA".

Category of accreditation.

deploymentType

string

Deprecated

Enum	Description
On Premise	On-premise refers to a computing infrastructure (either bare metal or virtual machines) that is deployed and maintained within the organization's own data centers or facilities. It is not shared with other organizations, providing the highest level of control and security.
Public Cloud	On-Cloud refers to products or solutions that are designed, developed, and delivered directly on cloud infrastructure rather than on traditional on-premises systems.

Solution deployment environment.

object

A Dassault Systèmes industry-specific offering designed to help companies innovate and achieve their performance objectives by addressing specific business challenges, Delivered through the 3DEXPERIENCE platform, an Industry Solution Experience is comprised of Industry Process Experiences.

object

A Release is a group of iterations that results in the completion of a valuable deliverable on the project.

object

Industry is a wide business industrial domain, marketed by Dassault Systèmes as an industry.

[{"id": "IPE00034863",
"name": "04-Continuous Product Development",
"accreditationType": "Industry Process Experience",
"deploymentType": "On Premise",
"industrySolutionExperience": {"id": "ISE00004588",
"name": "Engineered to Fly"
},
"solutionRelease": {"id": "REL00000051",
"name": "3DEXPERIENCE R2024x"
},
"industry": {"id": "IND000005",
"name": "Aerospace & Defense"
}
}
]

accreditation_type

string <= 1 characters

Enum	Description
R	Portfolio. The portfolio to which the product being ordered belongs. This field identifies the specific product family or category to which the ordered product belongs. For example, a product might belong to a portfolio such as "CATIA", "ENOVIA", or "SIMULIA".
I	Industry Process Experience. A Dassault Systèmes offering designed to correspond to the business process used by a team in the context of the solution. Delivered through the 3DEXPERIENCE platform, Industry Process Experiences (IPEs) are composed of Roles. When combined, they make up Industry Solution Experiences.

Category of accreditation.

"I"

order_revenue_type

string

Enum	Description
ALC	Annual License Charge
ASC	Annual Service Charge
ELC	Evaluation License Charge
PLC	Primary License Charge

… 16 more

Revenue Type defines the classification of a financial transaction within enterprise licensing and sales systems. It standardizes how revenue is recognized, billed, and managed. Used in order processing, financial reporting, and compliance.

"ALC"

product_price_list_data

Array

number required	string <= 20 characters Example: "6NB-XXX-YY" Product Number of the item
required	Array of objects Array of revenue types and computed prices

[{"number": "6NB-XXX-YY",
"prices": [{"revenueType": "ALC",
"dsListPrice": 21770,
"distributorDiscountPercentage": 25,
"distributorPrice": 16327.5,
"firstYearDiscountPercentage": 45,
"firstYearDiscountPrice": 495
}
]
}
]

4xx_post_product_price_list

data required	Array of any <= 0 items Example: [] Always an empty array in case of error responses.
required	object Metadata section of the response providing execution status and result summary.
required	Array of objects An array containing one or more error objects identified during the request processing. Each object provides detailed information about a specific type of error encountered.

{"data": [ ],
"info": {"success": true,
"statusCode": 0,
"estimatedSearchCount": 0
},
"error": [{"type": "errors:3dx:invalidRequest",
"title": "string",
"errors": [{"detail": "string",
"pointer": "string"
}
]
}
]
}

product_type

string

Enum	Description
A	Add-On. An additional feature or component that enhances the functionality of a product.
H	Auxiliary. A supplementary product or service that supports the primary product.
CS	Casual Named User. A type of user license that allows for occasional or infrequent use of a product.
C	Configuration. A specific setup or arrangement of a product's features or components.

… 11 more

Type of the product.

"NU"

default_support_level

string

Enum	Description
A	Advantage
B	To be completed
N	None
S	Secure

… 2 more

Default Support Level

"A"

licensing_scheme

string

Enum	Description
ADD	Add-On
BEU	BusinessExperience-UsageBased
CAS	Casual Named User
CB	Credit Based

… 21 more

Licensing Scheme code

"NAM"

ds_offering

string

Enum	Description
PCK	Packaged Offering. A bundled offering that combines licensed programs and online services.
LIC	Licensed Program. On-premises software.
NA	Not Applicable. Items that are not governed by the CLOSA.
ONL	Online Services. Cloud-based services.

… 2 more

Dassault Systèmes offering Type.

"ONL"

availability_status

integer

Enum	Description
1	General Availability
2	Limited Availability
3	Controlled Availability
4	Partner

… 3 more

Availability enumeration (1 to 7)

1

portfolio_name

string <= 50 characters

The portfolio to which the product belongs. This field identifies the specific product family or category to which the product belongs. For example, a product might belong to a portfolio such as "CATIA", "ENOVIA" or "SIMULIA".

"CATIA"

portfolio_information_data

Array

number

string <= 20 characters

Example: "6NB-XXX-YY"

Product Number of the item

trigram

string <= 10 characters

Example: "PCS_OC"

The trigram code for the product.

type

string

Enum	Description
A	Add-On. An additional feature or component that enhances the functionality of a product.
H	Auxiliary. A supplementary product or service that supports the primary product.
CS	Casual Named User. A type of user license that allows for occasional or infrequent use of a product.
C	Configuration. A specific setup or arrangement of a product's features or components.

… 11 more

Example: "NU"

Type of the product.

defaultSupportLevel

string

Enum	Description
A	Advantage
B	To be completed
N	None
S	Secure

… 2 more

Example: "A"

Default Support Level

licensingScheme

string

Enum	Description
ADD	Add-On
BEU	BusinessExperience-UsageBased
CAS	Casual Named User
CB	Credit Based

… 21 more

Example: "NAM"

Licensing Scheme code

dsOffering

string

Enum	Description
PCK	Packaged Offering. A bundled offering that combines licensed programs and online services.
LIC	Licensed Program. On-premises software.
NA	Not Applicable. Items that are not governed by the CLOSA.
ONL	Online Services. Cloud-based services.

… 2 more

Example: "ONL"

Dassault Systèmes offering Type.

remoteAccess

boolean

Example: "true"

extendedEnterpriseUser

boolean

Example: "true"

release

string <= 50 characters

Example: "3DEXPERIENCE R2025x"

Latest commercially available Product release name.

name

string <= 200 characters

Example: "Generic Product Standard with Cloud Services"

The name of the product. This field specifies the title or label of the product.

prerequisite

string

Example: ""

Release-dependent commercial prerequisite

availabilityStatus

integer

Enum	Description
1	General Availability
2	Limited Availability
3	Controlled Availability
4	Partner

… 3 more

Example: "1"

Availability enumeration (1 to 7)

portfolio

string <= 50 characters

Example: "CATIA"

The portfolio to which the product belongs. This field identifies the specific product family or category to which the product belongs. For example, a product might belong to a portfolio such as "CATIA", "ENOVIA" or "SIMULIA".

[{"number": "6NB-XXX-YY",
"trigram": "PCS_OC",
"type": "NU",
"defaultSupportLevel": "A",
"licensingScheme": "NAM",
"dsOffering": "ONL",
"remoteAccess": true,
"extendedEnterpriseUser": true,
"release": "3DEXPERIENCE R2025x",
"name": "Generic Product Standard with Cloud Services",
"prerequisite": "",
"availabilityStatus": 1,
"portfolio": "CATIA"
}
]

4xx_post_portfolio_information

data required	Array of any <= 0 items Example: [] Always an empty array in case of error responses.
required	object Metadata section of the response providing execution status and result summary.
required	Array of objects An array containing one or more error objects identified during the request processing. Each object provides detailed information about a specific type of error encountered.

{"data": [ ],
"info": {"success": true,
"statusCode": 0,
"estimatedSearchCount": 0
},
"error": [{"type": "errors:3dx:invalidRequest",
"title": "string",
"errors": [{"detail": "string",
"pointer": "string"
}
]
}
]
}

package_offer_content_data

Array

number required	string <= 20 characters Example: "6NB-XXX-YY" Product Number of the item
portfolio required	string <= 50 characters Example: "CATIA" The portfolio to which the product belongs. This field identifies the specific product family or category to which the product belongs. For example, a product might belong to a portfolio such as "CATIA", "ENOVIA" or "SIMULIA".
release required	string <= 50 characters Example: "3DEXPERIENCE R2025x" Release Name identifies a specific version of a software
quantity required	integer Example: "1" Quantity of item in the package/offer

[{"number": "6NB-XXX-YY",
"portfolio": "CATIA",
"release": "3DEXPERIENCE R2025x",
"quantity": 1
}
]

4xx_post_package_offer_content

data required	Array of any <= 0 items Example: [] Always an empty array in case of error responses.
required	object Metadata section of the response providing execution status and result summary.
required	Array of objects An array containing one or more error objects identified during the request processing. Each object provides detailed information about a specific type of error encountered.

{"data": [ ],
"info": {"success": true,
"statusCode": 0,
"estimatedSearchCount": 0
},
"error": [{"type": "errors:3dx:invalidRequest",
"title": "string",
"errors": [{"detail": "string",
"pointer": "string"
}
]
}
]
}

order_processing_status

string

Enum	Description
CAN	Cancelled. The order has been cancelled and is no longer valid.
RECY	Claim to be Managed. The order is being claimed by a different entity for management.
CRFU	Consent Refused. The Final Customer has refused to provide consent for the order.
CCD	Discarded. The order has been discarded and is no longer valid.

… 21 more

Current processing status of the order.

"APPS"

transaction

id

string <= 13 characters

Example: "PO_A123456789"

Unique identifier of the order. Can represent a Purchase Order or a Renewal Notification.

type

string

Enum	Description
PO	Purchase Order
RN	Renewal Notification

Example: "PO"

Order type (one of: PO, RN).

status

string

Enum	Description
CAN	Cancelled. The order has been cancelled and is no longer valid.
RECY	Claim to be Managed. The order is being claimed by a different entity for management.
CRFU	Consent Refused. The Final Customer has refused to provide consent for the order.
CCD	Discarded. The order has been discarded and is no longer valid.

… 21 more

Example: "APPS"

Current processing status of the order.

description

string <= 30 characters

Example: "XYZ Company Order 50 products"

Short description given to the Purchase Order / Renewal Notification.

{"id": "PO_A123456789",
"type": "PO",
"status": "APPS",
"description": "XYZ Company Order 50 products"
}

online_consent_status

string

Default: ""

Enum	Description
A	Accepted. The online consent request has been successfully accepted by the designated contact.
T	Expired. The online consent request has expired and is no longer valid.
X	Not Applicable. The online consent request is not applicable to the current situation or context.
N	Not Requested. The online consent request has not been sent to the designated contact.

… 2 more

Status of the online consent request sent to the designated contact.

"A"

orders_search_data

Array

required

object

Transactional details of the order.

required

object

Details of the sales business unit.

required

object

Legal entity to which Dassault Systèmes will issue the invoice (Bill To).

required

object

Legal entity of the company that is the Final Customer of Dassault Systèmes products (Sold To).

creationDateTime

required

string <date-time>

Example: "2025-05-21T14:30:00Z"

UTC timestamp when the order was created in the system.

Format: ISO 8601 UTC (e.g., 2025-05-21T14:30:00Z)

dsReceivedPoDate

string <date>

Example: "2025-05-21"

Date when the order was received by Dassault Systèmes, in ISO 8601 format (YYYY-MM-DD).

bookingDateTime

string <date-time>

Example: "2025-05-29T18:00:00Z"

UTC timestamp when the order was approved by the Finance Department.

Format: ISO 8601 UTC (e.g., 2025-05-30T14:30:00Z)

lastUpdateDateTime

string <date-time>

Example: "2025-05-21T14:40:00Z"

UTC timestamp of the most recent update to the order. This timestamp indicates the exact moment when the order was last modified. It is crucial for tracking changes and ensuring data consistency.

Format: ISO 8601 UTC (e.g., 2025-05-21T14:40:00Z)

currency

required

string = 3 characters ^[A-Z]{3}$

Example: "USD"

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 Euro, INR for Indian Ruppee).

onlineConsentStatus

string

Enum	Description
A	Accepted. The online consent request has been successfully accepted by the designated contact.
T	Expired. The online consent request has expired and is no longer valid.
X	Not Applicable. The online consent request is not applicable to the current situation or context.
N	Not Requested. The online consent request has not been sent to the designated contact.

… 2 more

Example: "A"

Status of the online consent request sent to the designated contact.

billToSalesRepresentative

string

Example: "DOE, Jane"

Name of the sales representative person from the Bill To site.

billToPoReference

string

Example: "EXAMPLE-CORP-20250518"

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.

[{"transaction": {"id": "PO_A123456789",
"type": "PO",
"status": "APPS",
"description": "XYZ Company Order 50 products"
},
"businessUnit": {"id": "BU001",
"name": "Corporate Sales Unit A",
"localTimezone": "CET"
},
"billToSite": {"id": "100012345678901",
"name": "Example Corporation",
"localName": "示例公司",
"locationId": 2
},
"soldToSite": {"id": "100012345678901",
"name": "Example Corporation",
"localName": "示例公司",
"locationId": 2
},
"creationDateTime": "2025-05-21T14:30:00Z",
"dsReceivedPoDate": "2025-05-21",
"bookingDateTime": "2025-05-29T18:00:00Z",
"lastUpdateDateTime": "2025-05-21T14:40:00Z",
"currency": "USD",
"onlineConsentStatus": "A",
"billToSalesRepresentative": "DOE, Jane",
"billToPoReference": "EXAMPLE-CORP-20250518"
}
]

recurring_charge_billing_cycle

string

Enum	Description
MON360	Calendar Month. Bill recurring license charges through the end of the current calendar month and for full-month periods thereafter (or until the indicated anniversary date if earlier)
QUA360	Calendar Quarter. Bill recurring license charges through the end of the current calendar quarter and for full-3-month periods thereafter (or until the indicated anniversary date if earlier)
BIANN360	Calendar Semester. Bill recurring license charges through the end of the current semester and for full-6-month periods thereafter (or until the indicated anniversary date if earlier)
ANN360	Calendar Year. Bill recurring license charges through the end of the current calendar year and for full-12-month periods thereafter (or until the indicated anniversary date if earlier)

… 6 more

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) or cancellation and refund or overpayment, the prorate calculation is based on 30 day months.

"ANN360"

order_type

string

Enum	Description
NEW	New. A fresh order that does not involve any migration, renewal, or upgrade.
RENW	Renewal. Extending an existing license.
UPGR	Migration - Standard. A standard replacement or upgrade of existing licenses.
EVAL	Evaluation License. License issued temporarily for evaluation purposes.

… 27 more

Specifies the classification of the order based on its nature, purpose, or contractual arrangement. This helps identify whether the order involves a new purchase, renewal, upgrade, transfer, suspension, migration, evaluation, or any other business scenario. Each value represents a predefined business process or transaction type that impacts how the order is handled and processed. For a complete list of supported values, refer to the enum section.

"STOI"

sub_order_type

string

Enum	Description
CCHN	Change of Channel. Changing customer coverage from direct to indirect or vice versa.
CVAR	Change of VAR. Changing the Value-Added Reseller (VAR) for an existing order.
EPP	TEP Training. A training order covered under Training Experience Program that provides participants with a structured, hands‑on learning experience covering the features and best‑practice use of the product portfolio.
EVAL	Evaluation License. License issued temporarily for evaluation purposes.

… 17 more

Sub Order Type

"NEW"

distributor_net_amount

number <float>

The actual amount payable by the Bill To Site for the selected product.

This field represents the total cost of the product or service, including any applicable fees, or discounts.

Note: Numeric values may include additional trailing decimal places due to serialization behavior of the underlying platform. The business-defined precision for this field is 2 decimal places. Digits beyond this precision are non-significant and should be ignored.

1930

distributor_annual_amount

number <float>

The total amount payable by the Bill To Site for the full year.

This field represents the annual cost of the product or service, taking into account any usage periods that are not a full year.

Note that there may be a difference between Distributor Net Amount and Distributor Annual Amount when the product is not purchased for a full year of usage.

Note: Numeric values may include additional trailing decimal places due to serialization behavior of the underlying platform. The business-defined precision for this field is 2 decimal places. Digits beyond this precision are non-significant and should be ignored.

1930

distributor_discount_percentage

number <float>

The discount percentage applicable to the Total List Price.

This field represents the percentage reduction in the total list price, as a decimal value (e.g. 39.50000000000000 represents 39.5%).

Note: Numeric values may include additional trailing decimal places due to serialization behavior of the underlying platform. The business-defined precision for this field is 10 decimal places. Digits beyond this precision are non-significant and should be ignored.

39.5

distributor_max_margin_percentage

number <float>

The percentage difference between the discount price offered by Dassault Systèmes and the Partner Bill To Site.

This field represents the margin earned by the Partner Bill To Site, calculated as a percentage of the discount price.

This field is pre-filled according to the percentage value set inside the Distributor Discount Model section of the GVA Agreement.

Additionally, note that this field is related to Distributor Discount Percentage, which represents the percentage reduction in the Total List Price.

Note: Numeric values may include additional trailing decimal places due to serialization behavior of the underlying platform. The business-defined precision for this field is 10 decimal places. Digits beyond this precision are non-significant and should be ignored.

1.5

customer_max_net_amount

number <float>

The actual amount payable by the Final Customer Site for the selected product.

This field represents the maximum net amount that the Final Customer Site is responsible for paying, taking into account any applicable discounts or fees.

Note: Numeric values may include additional trailing decimal places due to serialization behavior of the underlying platform. The business-defined precision for this field is 2 decimal places. Digits beyond this precision are non-significant and should be ignored.

1958.95

customer_max_annual_amount

number <float>

The total amount payable by the Final Customer Site for the full year.

This field represents the annual cost of the product or service, taking into account any usage periods that are not a full year.

Note that there may be a difference between Customer Maximum Net Amount and Customer Maximum Annual Amount when the product is not purchased for a full year of usage.

Note: Numeric values may include additional trailing decimal places due to serialization behavior of the underlying platform. The business-defined precision for this field is 2 decimal places. Digits beyond this precision are non-significant and should be ignored.

1958.95

customer_min_discount_percentage

number <float>

The minimum discount percentage that the Partner Bill To Site offers to the Final Customer for the selected product.

This field represents the lowest percentage discount that the Partner Bill To Site is willing to offer to the Final Customer, as a decimal value (e.g. 13.97000000000000 represents 13.97%)..

Note: Numeric values may include additional trailing decimal places due to serialization behavior of the underlying platform. The business-defined precision for this field is 10 decimal places. Digits beyond this precision are non-significant and should be ignored.

13.97

inflation_exception

string

Enum	Description
CAPL	Capping to Price List
NPI	No Price Increase
NCLP	No Cap. Lower than Price List
NPIE	No Exception

… 2 more

Any exception applied while calculating the inflated amount.

"CAPL"

order_sub_line

sequenceNumber

integer [ 1 .. 999 ]

Example: "1"

The sequence number used to identify the license charge breakdown item. It is an integer autogenerated by system, between 1 and 999.

installedBaseNumber

string <= 40 characters

Example: "LN00012345678"

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 Number is used to determine the Final Customer's maintenance and support obligations, as well as to calculate the cost of future upgrades or renewals. This is used to track the Final Customer's software licenses and maintenance history.

subOrderType

string

Enum	Description
CCHN	Change of Channel. Changing customer coverage from direct to indirect or vice versa.
CVAR	Change of VAR. Changing the Value-Added Reseller (VAR) for an existing order.
EPP	TEP Training. A training order covered under Training Experience Program that provides participants with a structured, hands‑on learning experience covering the features and best‑practice use of the product portfolio.
EVAL	Evaluation License. License issued temporarily for evaluation purposes.

… 17 more

Example: "NEW"

Sub Order Type

revenueType

string

Enum	Description
ALC	Annual License Charge
ASC	Annual Service Charge
ELC	Evaluation License Charge
PLC	Primary License Charge

… 16 more

Example: "ALC"

Revenue Type defines the classification of a financial transaction within enterprise licensing and sales systems. It standardizes how revenue is recognized, billed, and managed. Used in order processing, financial reporting, and compliance.

portfolio

string <= 50 characters

Example: "CATIA"

The portfolio to which the product being ordered belongs. This field identifies the specific product family or category to which the ordered product belongs. For example, a product might belong to a portfolio such as "CATIA", "ENOVIA", or "SIMULIA".

release

string <= 50 characters

Example: "3DEXPERIENCE R2025x"

The name of the product release being ordered. This field identifies the specific version of the product to which the ordered product belongs. For example, a product might belong to a release such as "3DEXPERIENCE R2025x", "SOLIDWORKS 2025", or "V5-6R2025".

object

This field identifies the specific product that is being ordered.

quantity

integer >= 1

Example: "2"

The quantity of the product being ordered.

unitListPrice

number <float>

Example: "1000"

The price listed by the Finance Department for the product being ordered.

This field represents the standard price of a single unit of the product, as approved by the Finance Department.

totalListPrice

number <float>

Example: "2000"

The total price of the product licenses, calculated by multiplying the Unit List Price and the Quantity.

This field represents the total cost of the product licenses, taking into account the number of units purchased.

distributorNetAmount

number <float>

Example: "1930"

The actual amount payable by the Bill To Site for the selected product.

This field represents the total cost of the product or service, including any applicable fees, or discounts.

Note: Numeric values may include additional trailing decimal places due to serialization behavior of the underlying platform. The business-defined precision for this field is 2 decimal places. Digits beyond this precision are non-significant and should be ignored.

distributorAnnualAmount

number <float>

Example: "1930"

The total amount payable by the Bill To Site for the full year.

This field represents the annual cost of the product or service, taking into account any usage periods that are not a full year.

Note that there may be a difference between Distributor Net Amount and Distributor Annual Amount when the product is not purchased for a full year of usage.

Note: Numeric values may include additional trailing decimal places due to serialization behavior of the underlying platform. The business-defined precision for this field is 2 decimal places. Digits beyond this precision are non-significant and should be ignored.

distributorDiscountPercentage

number <float>

Example: "39.5"

The discount percentage applicable to the Total List Price.

This field represents the percentage reduction in the total list price, as a decimal value (e.g. 39.50000000000000 represents 39.5%).

Note: Numeric values may include additional trailing decimal places due to serialization behavior of the underlying platform. The business-defined precision for this field is 10 decimal places. Digits beyond this precision are non-significant and should be ignored.

distributorMaximumMarginPercentage

number <float>

Example: "1.5"

The percentage difference between the discount price offered by Dassault Systèmes and the Partner Bill To Site.

This field represents the margin earned by the Partner Bill To Site, calculated as a percentage of the discount price.

This field is pre-filled according to the percentage value set inside the Distributor Discount Model section of the GVA Agreement.

Additionally, note that this field is related to Distributor Discount Percentage, which represents the percentage reduction in the Total List Price.

Note: Numeric values may include additional trailing decimal places due to serialization behavior of the underlying platform. The business-defined precision for this field is 10 decimal places. Digits beyond this precision are non-significant and should be ignored.

customerMaximumNetAmount

number <float>

Example: "1958.95"

The actual amount payable by the Final Customer Site for the selected product.

This field represents the maximum net amount that the Final Customer Site is responsible for paying, taking into account any applicable discounts or fees.

Note: Numeric values may include additional trailing decimal places due to serialization behavior of the underlying platform. The business-defined precision for this field is 2 decimal places. Digits beyond this precision are non-significant and should be ignored.

customerMaximumAnnualAmount

number <float>

Example: "1958.95"

The total amount payable by the Final Customer Site for the full year.

This field represents the annual cost of the product or service, taking into account any usage periods that are not a full year.

Note that there may be a difference between Customer Maximum Net Amount and Customer Maximum Annual Amount when the product is not purchased for a full year of usage.

Note: Numeric values may include additional trailing decimal places due to serialization behavior of the underlying platform. The business-defined precision for this field is 2 decimal places. Digits beyond this precision are non-significant and should be ignored.

customerMinimumDiscountPercentage

number <float>

Example: "13.97"

The minimum discount percentage that the Partner Bill To Site offers to the Final Customer for the selected product.

This field represents the lowest percentage discount that the Partner Bill To Site is willing to offer to the Final Customer, as a decimal value (e.g. 13.97000000000000 represents 13.97%)..

Note: Numeric values may include additional trailing decimal places due to serialization behavior of the underlying platform. The business-defined precision for this field is 10 decimal places. Digits beyond this precision are non-significant and should be ignored.

startDate

string <date>

Example: "2025-06-01"

The start date of the product or service, in ISO 8601 format (YYYY-MM-DD).

endDate

string

Example: "2026-05-31"

The end date of the product or service, in ISO 8601 format (YYYY-MM-DD).

duration

integer

Example: "2"

The duration for which the product or service is intended to be used.

The unit of duration depends on the Revenue Type:

If Revenue Type is ALC (Annual License Charge), then the duration is measured in years. For example, a duration of 2 represents 2 years.
If Revenue Type is QLC (Quarterly License Charge), then the duration is measured in quarters. For example, a duration of 2 represents 2 quarters.

calculatedStartDate

string <date>

Example: "2025-06-01"

This field is automatically calculated by the system. Format: ISO 8601 format (YYYY-MM-DD).

It is based on one of the following dates:

The user-entered Start Date
The CRAD (Customer Requested Arrival Date)
The Finance Approved date of the order

calculatedEndDate

string <date>

Example: "2026-06-30"

This field is automatically calculated by the system. Format: ISO 8601 format (YYYY-MM-DD).

It is based on one of the following values:

First Year Co-Terminus: The end date of the first year of the contract.
End date of the Duration calculated from 'calculatedStartDate' or entered by the user

yearNumber

integer

Example: "1"

This field represents the product usage Year Number for multi-year orders.

It is used to identify the specific year of a multi-year contract.

object

Details of the discount coupon applied to the final price.

object

Details about the inflation rate applied to the price of the product. The inflation occurs when it is the case of product renewals.

{"sequenceNumber": 1,
"installedBaseNumber": "LN00012345678",
"subOrderType": "NEW",
"revenueType": "ALC",
"portfolio": "CATIA",
"release": "3DEXPERIENCE R2025x",
"product": {"trigram": "PCS_OC",
"type": "NU",
"number": "6NB-XXX-YY",
"name": "Generic Product Standard with Cloud Services",
"dsOffering": "ONL"
},
"quantity": 2,
"unitListPrice": 1000,
"totalListPrice": 2000,
"distributorNetAmount": 1930,
"distributorAnnualAmount": 1930,
"distributorDiscountPercentage": 39.5,
"distributorMaximumMarginPercentage": 1.5,
"customerMaximumNetAmount": 1958.95,
"customerMaximumAnnualAmount": 1958.95,
"customerMinimumDiscountPercentage": 13.97,
"startDate": "2025-06-01",
"endDate": "2026-05-31",
"duration": 2,
"calculatedStartDate": "2025-06-01",
"calculatedEndDate": "2026-06-30",
"yearNumber": 1,
"coupon": {"name": "10% off on Installation Fee",
"discountPercentage": 10
},
"inflation": {"date": "2025-07-01",
"ratio": 1.04,
"exception": "CAPL"
}
}

order_line

sequenceNumber

integer [ 1 .. 999 ]

Example: "1"

The sequence number used to identify the line item. It is an integer autogenerated by system, between 1 and 999.

lineGroup

string <= 15 characters

Example: "SBL0001234567"

Identifier for the license charge condition. This is used to group together the Installed Base sub-lines.

onlineInstanceSeatId

string <= 15 characters

Example: "R1122334455667"

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 cloud. This identifier is also referred to as the Online Instance ID. Additionally, it is also used as the Seat ID to identify a user's access to the instance. The Seat ID is used to manage user licenses, authenticate users, and track user activity within the instance. The Online Instance ID/Seat ID is a combination of letters and numbers.

orderType

string

Enum	Description
NEW	New. A fresh order that does not involve any migration, renewal, or upgrade.
RENW	Renewal. Extending an existing license.
UPGR	Migration - Standard. A standard replacement or upgrade of existing licenses.
EVAL	Evaluation License. License issued temporarily for evaluation purposes.

… 27 more

Example: "STOI"

Specifies the classification of the order based on its nature, purpose, or contractual arrangement. This helps identify whether the order involves a new purchase, renewal, upgrade, transfer, suspension, migration, evaluation, or any other business scenario. Each value represents a predefined business process or transaction type that impacts how the order is handled and processed. For a complete list of supported values, refer to the enum section.

usageScope

string <= 80 characters

Example: "GEO EMEA"

Defines the geographical or territorial scope in which the product can be used, as specified in the associated agreement details. This may refer to a region (e.g., GEO) or a specific country.

object

Promotion information. This object contains information about the promotion applied to the order. The promotion object contains information about the promotion, including its name, ID, and combination of one or more products.

object or object

Waiver information for the license charge. It can be either of duration or endDate.

Array of objects

{"sequenceNumber": 1,
"lineGroup": "SBL0001234567",
"onlineInstanceSeatId": "R1122334455667",
"orderType": "STOI",
"usageScope": "GEO EMEA",
"promotion": {"id": "PAO0000111",
"name": "3DEXPERIENCE for small and medium business",
"combination": "Collaborative Design & Engineering Learning @Home"
},
"waiver": {"duration": 1,
"endDate": "2025-05-30"
},
"licenseChargeBreakdown": [{"sequenceNumber": 1,
"installedBaseNumber": "LN00012345678",
"subOrderType": "NEW",
"revenueType": "ALC",
"portfolio": "CATIA",
"release": "3DEXPERIENCE R2025x",
"product": {"trigram": "PCS_OC",
"type": "NU",
"number": "6NB-XXX-YY",
"name": "Generic Product Standard with Cloud Services",
"dsOffering": "ONL"
},
"quantity": 2,
"unitListPrice": 1000,
"totalListPrice": 2000,
"distributorNetAmount": 1930,
"distributorAnnualAmount": 1930,
"distributorDiscountPercentage": 39.5,
"distributorMaximumMarginPercentage": 1.5,
"customerMaximumNetAmount": 1958.95,
"customerMaximumAnnualAmount": 1958.95,
"customerMinimumDiscountPercentage": 13.97,
"startDate": "2025-06-01",
"endDate": "2026-05-31",
"duration": 2,
"calculatedStartDate": "2025-06-01",
"calculatedEndDate": "2026-06-30",
"yearNumber": 1,
"coupon": {"name": "10% off on Installation Fee",
"discountPercentage": 10
},
"inflation": {"date": "2025-07-01",
"ratio": 1.04,
"exception": "CAPL"
}
}
]
}

order_get_data

Array

required

object

Transactional details of the order.

required

object

Details of the sales business unit.

required

object

Legal entity to which Dassault Systèmes will issue the invoice (Bill To).

required

object

Legal entity of the company that is the Final Customer of Dassault Systèmes products (Sold To).

required

object

Contains details about the license agreement associated with the licenses being ordered in the Purchase Order (PO).

billToContact

string

Full name of the contact person at the Bill To site (billing entity) who is responsible for the order. This contact person is the primary point of communication for billing-related inquiries and transactions. Format-LASTNAME, Firstname (e.g., DOE, John).

creationDateTime

required

string <date-time>

Example: "2025-05-21T14:30:00Z"

UTC timestamp when the order was created in the system.

Format: ISO 8601 UTC (e.g., 2025-05-21T14:30:00Z)

dsReceivedPoDate

string <date>

Example: "2025-05-21"

Date when the order was received by Dassault Systèmes, in ISO 8601 format (YYYY-MM-DD).

bookingDateTime

string <date-time>

Example: "2025-05-29T18:00:00Z"

UTC timestamp when the order was approved by the Finance Department.

Format: ISO 8601 UTC (e.g., 2025-05-30T14:30:00Z)

lastUpdateDateTime

string <date-time>

Example: "2025-05-21T14:40:00Z"

UTC timestamp of the most recent update to the order. This timestamp indicates the exact moment when the order was last modified. It is crucial for tracking changes and ensuring data consistency.

Format: ISO 8601 UTC (e.g., 2025-05-21T14:40:00Z)

currency

required

string = 3 characters ^[A-Z]{3}$

Example: "USD"

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 Euro, INR for Indian Ruppee).

onlineConsentStatus

string

Enum	Description
A	Accepted. The online consent request has been successfully accepted by the designated contact.
T	Expired. The online consent request has expired and is no longer valid.
X	Not Applicable. The online consent request is not applicable to the current situation or context.
N	Not Requested. The online consent request has not been sent to the designated contact.

… 2 more

Example: "A"

Status of the online consent request sent to the designated contact.

billToSalesRepresentative

string

Example: "DOE, Jane"

Name of the sales representative person from the Bill To site.

billToPoReference

string

Example: "EXAMPLE-CORP-20250518"

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.

sboNumber

string <= 10 characters

Example: "ABC0012345"

Unique identifier of the Special Bid Offer (SBO) that served as the basis for creating the order. Typically used to track and reference special pricing or offer conditions.

customerRequestedArrivalDate

string <date>

Example: "2025-05-31"

Customer Requested Arrival Date (CRAD) indicates the date by which the Final Customer requests delivery of the DS Licenses and Support Order.

Note: CRAD is a non-binding request. While DS will make reasonable efforts to meet this date, it does not constitute a contractual commitment.

Orders can still receive 'Finance Approved' status, media can be 'Shipped', and license keys can be issued and marked as 'Completed' irrespective of the CRAD.
The Support Start Date in the Installed Base will never begin before the CRAD.
Format: ISO 8601 format (YYYY-MM-DD)
License keys will remain inactive until the Support Start Date.

dsSalesRepresentative

string

Example: "DOE, John"

Full name of the Dassault Systèmes (DS) sales representative responsible for the order.

Format: LASTNAME, Firstname (e.g., DOE, John)

isMultiYear

boolean

Example: "true"

Indicates whether the order is part of a Multi-Year deal (i.e., duration longer than one year), applicable for revenue types such as YxC or AxC.

hasExitClause

boolean

Example: "true"

Indicates whether the agreement includes an exit clause requiring the Final Customer to pay early termination fees if they end the rental before the completion of the multi-year engagement.

recurringChargeBillingCycle

string

Enum	Description
MON360	Calendar Month. Bill recurring license charges through the end of the current calendar month and for full-month periods thereafter (or until the indicated anniversary date if earlier)
QUA360	Calendar Quarter. Bill recurring license charges through the end of the current calendar quarter and for full-3-month periods thereafter (or until the indicated anniversary date if earlier)
BIANN360	Calendar Semester. Bill recurring license charges through the end of the current semester and for full-6-month periods thereafter (or until the indicated anniversary date if earlier)
ANN360	Calendar Year. Bill recurring license charges through the end of the current calendar year and for full-12-month periods thereafter (or until the indicated anniversary date if earlier)

… 6 more

Example: "ANN360"

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) or cancellation and refund or overpayment, the prorate calculation is based on 30 day months.

opportunityId

string

Example: "A1B2-C3D4E5"

Unique identifier for the sales opportunity as recorded in the My Sales Pipeline system. This value helps link the order to its originating sales activity.

paymentTerms

string <= 50 characters

Example: "Net Date of Invoice + 60 days"

Payment terms for the order, as provided by the Finance Department. Specifies the agreed period within which the payment must be made.

Array of objects

A list of conditions that determine when the license is charged for the order. These conditions specify the circumstances under which the license fee is applied, such as:

The number of users or seats that are licensed.
The type of license or subscription being purchased.
Any waiver given on the license or subscription.
Any additional features or services that are included with the license.

The license charge conditions are used to calculate the total cost of the license and to ensure that the correct pricing is applied.

[{"transaction": {"id": "PO_A123456789",
"type": "PO",
"status": "APPS",
"description": "XYZ Company Order 50 products"
},
"businessUnit": {"id": "BU001",
"name": "Corporate Sales Unit A",
"localTimezone": "CET"
},
"billToSite": {"id": "100012345678901",
"name": "Example Corporation",
"localName": "示例公司",
"locationId": 2
},
"soldToSite": {"id": "100012345678901",
"name": "Example Corporation",
"localName": "示例公司",
"locationId": 2
},
"agreement": {"type": "General VAR Agreement",
"reference": "Enterprise License Agreement Q2 2024"
},
"billToContact": "string",
"creationDateTime": "2025-05-21T14:30:00Z",
"dsReceivedPoDate": "2025-05-21",
"bookingDateTime": "2025-05-29T18:00:00Z",
"lastUpdateDateTime": "2025-05-21T14:40:00Z",
"currency": "USD",
"onlineConsentStatus": "A",
"billToSalesRepresentative": "DOE, Jane",
"billToPoReference": "EXAMPLE-CORP-20250518",
"sboNumber": "ABC0012345",
"customerRequestedArrivalDate": "2025-05-31",
"dsSalesRepresentative": "DOE, John",
"isMultiYear": true,
"hasExitClause": true,
"recurringChargeBillingCycle": "ANN360",
"opportunityId": "A1B2-C3D4E5",
"paymentTerms": "Net Date of Invoice + 60 days",
"licenseChargeConditions": [{"sequenceNumber": 1,
"lineGroup": "SBL0001234567",
"onlineInstanceSeatId": "R1122334455667",
"orderType": "STOI",
"usageScope": "GEO EMEA",
"promotion": {"id": "PAO0000111",
"name": "3DEXPERIENCE for small and medium business",
"combination": "Collaborative Design & Engineering Learning @Home"
},
"waiver": {"duration": 1,
"endDate": "2025-05-30"
},
"licenseChargeBreakdown": [{"sequenceNumber": 1,
"installedBaseNumber": "LN00012345678",
"subOrderType": "NEW",
"revenueType": "ALC",
"portfolio": "CATIA",
"release": "3DEXPERIENCE R2025x",
"product": {"trigram": "PCS_OC",
"type": "NU",
"number": "6NB-XXX-YY",
"name": "Generic Product Standard with Cloud Services",
"dsOffering": "ONL"
},
"quantity": 2,
"unitListPrice": 1000,
"totalListPrice": 2000,
"distributorNetAmount": 1930,
"distributorAnnualAmount": 1930,
"distributorDiscountPercentage": 39.5,
"distributorMaximumMarginPercentage": 1.5,
"customerMaximumNetAmount": 1958.95,
"customerMaximumAnnualAmount": 1958.95,
"customerMinimumDiscountPercentage": 13.97,
"startDate": "2025-06-01",
"endDate": "2026-05-31",
"duration": 2,
"calculatedStartDate": "2025-06-01",
"calculatedEndDate": "2026-06-30",
"yearNumber": 1,
"coupon": {"name": "10% off on Installation Fee",
"discountPercentage": 10
},
"inflation": {"date": "2025-07-01",
"ratio": 1.04,
"exception": "CAPL"
}
}
]
}
]
}
]

deployment_type

string

Enum	Description
1	Public Cloud. Solution delivered on the 3DS Public Cloud platform (SaaS offering hosted and managed by Dassault Systèmes).
2	Private Cloud. Solution hosted in a cloud environment dedicated to a single customer, providing exclusive resources and optional security/configuration controls.
4	On‑Premise. Solution installed and run in the customer’s own data‑center (bare‑metal or virtual machines), giving full control and maximum security.
5	Mixed. A hybrid deployment that combines cloud (public or private) and on‑premise components within the same offering.

Solution deployment environment.

"1"

accreditations_search_data

Array

id

required

string

Examples: "IPE00034863" "PRTF119"

name

required

string

Examples: "04-Continuous Product Development" "Public Cloud 3D Design"

accreditationType

required

string <= 1 characters

Enum	Description
R	Portfolio. The portfolio to which the product being ordered belongs. This field identifies the specific product family or category to which the ordered product belongs. For example, a product might belong to a portfolio such as "CATIA", "ENOVIA", or "SIMULIA".
I	Industry Process Experience. A Dassault Systèmes offering designed to correspond to the business process used by a team in the context of the solution. Delivered through the 3DEXPERIENCE platform, Industry Process Experiences (IPEs) are composed of Roles. When combined, they make up Industry Solution Experiences.

Example: "I"

Category of accreditation.

deploymentType

string

Enum	Description
1	Public Cloud. Solution delivered on the 3DS Public Cloud platform (SaaS offering hosted and managed by Dassault Systèmes).
2	Private Cloud. Solution hosted in a cloud environment dedicated to a single customer, providing exclusive resources and optional security/configuration controls.
4	On‑Premise. Solution installed and run in the customer’s own data‑center (bare‑metal or virtual machines), giving full control and maximum security.
5	Mixed. A hybrid deployment that combines cloud (public or private) and on‑premise components within the same offering.

Solution deployment environment.

object

A Dassault Systèmes industry-specific offering designed to help companies innovate and achieve their performance objectives by addressing specific business challenges, Delivered through the 3DEXPERIENCE platform, an Industry Solution Experience is comprised of Industry Process Experiences.

object

A Release is a group of iterations that results in the completion of a valuable deliverable on the project.

object

Industry is a wide business industrial domain, marketed by Dassault Systèmes as an industry.

[{"id": "IPE00034863",
"name": "04-Continuous Product Development",
"accreditationType": "I",
"deploymentType": "1",
"industrySolutionExperience": {"id": "ISE00004588",
"name": "Engineered to Fly"
},
"solutionRelease": {"id": "REL00000051",
"name": "3DEXPERIENCE R2024x"
},
"industry": {"id": "IND000005",
"name": "Aerospace & Defense"
}
}
]

APIs for the Order domain (3.0.7)

apikeys

Generate a new API key

Authorizations:

Responses

Response samples

Orders

Search Orders Deprecated

Authorizations:

query Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get Order details Deprecated

Authorizations:

path Parameters

Responses

Response samples

Search Orders

Authorizations:

query Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get Order details

Authorizations:

path Parameters

Responses

Response samples

Price-Lists

Get Price Lists

Authorizations:

Responses

Response samples

Products

Get Portfolio / IPE Accreditations Deprecated

Authorizations:

query Parameters

Responses

Response samples

Get Product Prices

Authorizations:

query Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get Products

Authorizations:

query Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get Package / Offer Content

Authorizations:

query Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get Portfolio / IPE Accreditations

Authorizations:

query Parameters

Responses

Response samples

Schemas

date_time_from

date_time_to

creation_datetime_req

booking_datetime_req

lastupdate_datetime_req

installed_base_number

online_instance_seat_id

billto_po_references_req

transaction_type

order_processing_status_deprecated_v0

transaction_deprecated_v0

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required