APIs for the Order domain (4.0.0)

Download OpenAPI specification:Download

URL: https://partners.3ds.com/ License: Dassault Systèmes 2025

This API provides a set of endpoints for the ordering domain :

Searching Orders and retrieving Order details.
Searching Price List, accreditated Portfolios, Products or Industry Process Experience
Searching final Customers
Searching & creating Contacts
Creating Order Request (asynchronous operation) and getting details on it (status & id of the created Purchase Order if successful )

Endpoints adhere to the following pattern for URL :

/order/api4partners/{version}/{ressourceName}/[{action} or {id}]

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

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 purchase orders.

The following operations are included in this section:

Searching Orders
Getting Order Details

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

Search Orders

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"

Deployment identifier carried in onlineInstanceSeatId. The same field holds one of two identifier types, depending on the product being ordered:

Online Instance Id - identifies a 3DEXPERIENCE platform instance deployed for the customer (for example R1122334455667). Used for 3DS platform products.
Seat Id - identifies a SolidWorks Standalone or Network licensing seat (for example 5622498). Applies to SolidWorks products regardless of on-cloud or on-premise deployment.

Partners supply a non-empty value when ordering on an existing Online Instance or Seat Id. Leave empty or omit when a new Online Instance or Seat Id will be resolved during batch processing for this request.

The identifier is a combination of letters and numbers (maxLength 15).

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

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

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
}
}

Order Requests

This section defines the asynchronous operations related to order requests. An order request is a temporary placeholder stored in a pending buffer and processed by a scheduled batch job.

The following operations are included in this section:

Create Order Request (asynchronous purchase order creation)
Get Order Request Details (retrieve a single order request)

Create Order Request Beta

Submits a request to create a purchase order.
The incoming payload is validated against the request schema.
When the payload passes validation it is stored in a pending order-request buffer (an intermediate holding area) that will be processed later by a scheduled batch job. A scheduled batch job, which runs periodically, processes the buffered requests one-by-one and attempts to create the purchase orders.

Synchronous validation covers schema and shape only. Date coherence between the effective license line start date and the computed end date is enforced during batch processing. Use Get Order Request to retrieve batchProcessingErrors when processing fails (e.g. API4P_ST2 when the effective start date is greater than the computed end date).

On success, the API returns HTTP 201 Created.

Important Notes :

For now, the scheduled batch job will run twice each hour : every 30 minutes at xx:20 & xx:50.
This scheduling may get updated in the future (during BETA Phase itself or later) depending on feedbacks from Partners and actual impact analysis on DSx.Order ressources.

Authorizations:

API Key: ApiKeyAuth

Request Body schema: application/json
required

Order Request payload
This object represents the JSON body that a client sends to submit a request for a new purchase order.
The service validates the payload and stores it for later batch processing (the actual order is created asynchronously).

License charge date processing

The effective license line start date and end date are resolved from licenseChargeConditions[].startDate, customerRequestedArrivalDate, renewalInformation, and line duration. Date coherence (start date on or before end date) is validated during batch processing, not at synchronous request acceptance. A request may return 200 with status: OPEN even when date values are inconsistent.

See field-level descriptions on licenseChargeConditions[].startDate, customerRequestedArrivalDate, and renewalInformation for resolution and cross-field rules.

Coupon handling

See licenseChargeConditions[].coupons for PxC/AxC rules and optional yearNumber semantics (omit or 0 vs non-zero).

requestorContactId

required

string^C[0-9]{11}$

Example: "C00001234567"

Unique identifier of the contact person who submitted the order‑creation request.
The contact person who submitted the new order creation request must have the appropriate roles or permissions in the system to create or modify specific component associated with this API.

businessUnitId

required

string = 5 characters

Example: "BU001"

Unique identifier of the sales business unit.

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).

billToContactId

required

string^C[0-9]{11}$

Example: "C00001234567"

Identifier 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.

soldToContactId

string^(|C[0-9]{11})$

Examples: "C00001234567" ""

Identifier of the contact person responsible for the Sold‑To site.

onlineServiceAccessContactId

string^(|C[0-9]{11})$

Examples: "C00001234567" ""

Identifier of the contact person who is the designated individual responsible for receiving critical communications related to the administration of purchased online services.
This includes access credentials, onboarding instructions, service updates, and license renewal notifications.
This role ensures continuity in managing the service, even if separate from the technical administrator.

agreementType

required

string

Enum	Description
CLOSA	Standard CLOSA agreement.
CLOSA_E	CLOSA for Education Use.
CLOSA_R	CLOSA for Non-Profit Research Use.

Example: "CLOSA"

Type of CLOSA Agreement type that governs the order.

required

object

Renewal Information – defines how the renewal date of a software licence (or subscription) is aligned for a customer.

Renewal date alignment mechanism that standardizes the end date of software licenses to a common, recurring date (e.g., a specific day and month each year). This simplifies renewal management, billing cycles, and administrative tracking by ensuring all licenses for a customer expire and renew on the same date annually, rather than scattered throughout the year.

Possible configurations are driven by anniversaryMode attribute value :

anniversaryMode value	Description
NON_COTERM	Non Coterminous
COTERM_ALIGN	First Year Coterminous Align
COTERM_NEW	First Year Coterminous with New Date

Business rule – License end date (evaluated during batch processing):

When anniversaryMode is COTERM_NEW, newCoterminousEndDate defines the first-year coterminous end date for license charge lines. Year handling depends on whether the order creates a new Seat Id or uses an existing Seat Id (licenseChargeConditions[].onlineInstanceSeatId); see newCoterminousEndDate for the full rules. In particular, when the Final Customer site already has the month-day from newCoterminousEndDate and the order targets an existing Seat Id, the API uses that month-day but sets the license end year to the following calendar year after the year in newCoterminousEndDate (not the year in the request).
When anniversaryMode is COTERM_ALIGN, the end date is derived from coterminousDate and licenseEndYear.
The effective start date (per licenseChargeConditions[].startDate resolution rules) must be on or before the computed end date. On violation, batch processing fails with API4P_ST2 (pointer: #/licenseChargeConditions/[index]/startDate).

dsSalesRepresentativeEmail

string <= 70 characters

Example: "Jini.Doe@3ds.com"

Email address of the Dassault Systèmes sales representative responsible for the order.

billToSalesRepresentativeContactId

string^(|C[0-9]{11})$

Examples: "C00001234567" ""

Identifier of the sales contact person at the Bill-To site who acts as the Bill-To Sales Representative on the purchase order.

Optional. Use an empty string ("") or omit the field when no Bill-To Sales Representative is supplied in the request.

Business rule – Bill-To Sales Representative resolution (evaluated during batch processing):

Processing depends on whether the supplied contact is associated with the Bill-To site (billToSite) and on the Business Unit (businessUnitId):

Situation	Outcome
The contact is associated with the Bill-To site and has a Bill-To Sales Representative role (DS_ECO_554 Sales Expert or DS_ECO_506 SALES)	The contact is used as the Bill-To Sales Representative on the created purchase order.
The contact is associated with the Bill-To site but does not have either Bill-To Sales Representative role	Batch processing fails with `API4P_BTSR1` (pointer: `#/billToSalesRepresentativeContactId`).
The contact is not associated with the Bill-To site	The value in the request is not applied as-is. Behavior depends on the Business Unit (see below).

When the provided contact id does not belong to the Bill-To site:

CRE – The purchase order is still created. The Bill-To Sales Representative on the order is defaulted to the Bill-To Sales Representative from the most recent purchase order in DSx for the same Bill-To and Sold-To combination (billToSite + soldToSite).
Non-CRE business units – The Bill-To Sales Representative on the created purchase order remains blank (the submitted value is not used).

See the Contact section of the batch processing error catalog for API4P_BTSR1.

customerRequestedArrivalDate

string <date>

Example: "2025-05-31"

Customer Requested Arrival Date (CRAD) indicates the date by which the Final Customer requests delivery of the Dassault Systèmes 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.

Format: ISO 8601 format (YYYY-MM-DD)

Business rule – License line start date (evaluated during batch processing):

When a license charge line omits startDate (or supplies an empty value ""), CRAD is used as the effective line start date. See licenseChargeConditions[].startDate for the full resolution order.

Partner guidance: When using COTERM_NEW or COTERM_ALIGN, ensure CRAD (or an explicit line startDate) is on or before the computed first-year end date defined in renewalInformation.

billToPoReference

string <= 60 characters

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.
Must be a string with a maximum length of 60 characters.

subDistributorSiteId

string <= 15 characters

Example: "SDIS000000000xx"

Identifier of the Sub-Distributor, intermediary entity within a multi-tier distribution model, distinct from the Primary Distributor.

priceListId

integer <= 2 characters

Example: "17"

Unique identifier of Price List. The list of allowed Price Lists can be retrieved via the Get Price Lists API.

description

string <= 30 characters

Example: "XYZ Company Order 50 products"

Short description given to the Purchase Order / Renewal Notification.

comment

string <= 10000 characters

Example: "Please prioritize this order as the customer requires the license before the end of Q2 for a product launch. Also, note that the discount approved in the attached quote should be applied."

Free‑form text message intended for Dassault Systèmes.
This field can be used by the requestor to provide additional context, special instructions, or any other information that may help Dassault Systèmes to process the order more effectively.

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"

Billing‑cycle identifier for the recurring charge(s) on the order.

Business rule – This rule is applied for every request:

The value supplied by the client is looked up in the list of Possible Billing Cycles configured for the Business Unit identified by businessUnitId.
If the supplied value is found, it is used unchanged.
If the supplied value is missing or not found, the system falls back to the Default Billing Cycle defined on that Business Unit.

The resolved billing‑cycle value is persisted on the Purchase Order and drives all subsequent invoicing calculations.

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 when creating an order request.

Business rule – When submitting a Create Order Request, processing of opportunityId depends on the Business Unit identified by businessUnitId:

CPE – opportunityId is mandatory in the request JSON. The value must reference a valid sales opportunity in My Sales Pipeline.
CRE – Any opportunityId value supplied in the request JSON is ignored by the API; it is not processed or persisted even if the partner provides one.

licenseComplianceCaseId

string <= 14 characters

Example: "1234567890123"

License‑Compliance Case Id – a unique identifier generated by Dassault Systèmes to track a license‑compliance investigation or audit for a specific customer site. The Id is used by internal teams (License‑Compliance, Sales, Legal, etc.) as a reference when monitoring, documenting, and resolving potential non‑compliance issues such as unauthorized usage, under‑licensing, or misuse of software.

required

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.

Deployment identifier fields (onlineInstanceSeatId, lineItemUuid, parentLineItemUuid)

These three fields work together on each line. Evaluate onlineInstanceSeatId first: when it contains a concrete (non-empty) value, use the existing Online Instance or Seat Id and omit both UUID fields on that line.

Situation	`onlineInstanceSeatId`	`lineItemUuid`	`parentLineItemUuid`
Product on existing Online Instance (3DS platform)	non-empty	omit	omit
Product on existing Seat Id (SolidWorks Standalone or Network)	non-empty	omit	omit
New platform or base line in this request	empty or omitted	required	omit
Linked child line (product relates to new base in this request)	empty or omitted	omit	required

Online Instance Id resolution during batch processing (3DS platform products only)

The rules below apply when ordering 3DS platform products (Online Instance Id) and onlineInstanceSeatId is empty or omitted. They do not apply to Seat Id (SolidWorks Standalone or Network) — see the field-level descriptions for Seat Id behavior.

Fields on the line	Sold-to site has at least one Not Deployed Online Instance Id	Sold-to site has no Online Instance Id, or has only deployed ones
`onlineInstanceSeatId`, `lineItemUuid`, and `parentLineItemUuid` all empty or omitted	The system selects a Not Deployed Online Instance Id. If the request has multiple lines, they all receive the same Not Deployed Online Instance Id.	The system creates a new Online Instance Id. If the request has multiple lines, each line receives its own new Online Instance Id.
`onlineInstanceSeatId` empty; `lineItemUuid` provided; `parentLineItemUuid` empty or omitted	The system selects a Not Deployed Online Instance Id. If the request has multiple lines, they all receive the same Not Deployed Online Instance Id, even when `lineItemUuid` values differ across lines.	The system creates a new Online Instance Id. If the request has multiple lines with different `lineItemUuid` values, each line receives its own new Online Instance Id.
`onlineInstanceSeatId` contains a non-empty Online Instance Id	The system uses the provided Online Instance Id (whether deployed or not deployed).	The system uses the provided Online Instance Id (whether deployed or not deployed).

Linked child lines (parentLineItemUuid provided, lineItemUuid omitted): the child line inherits the Online Instance Id resolved for its base line. It does not trigger separate Online Instance Id resolution.

Line relationship vs Product Type

parentLineItemUuid expresses a line relationship: the product on this line relates to a product on another line in the same request. The linked product may be any product.type (for example Named User, Package, Machine Based, or Add-On). Do not assume parentLineItemUuid applies only when product.type is Add-On (A) or Single Add-On (AS).

Per-line rules

When onlineInstanceSeatId is empty or omitted, send exactly one of lineItemUuid or parentLineItemUuid (never both, never neither on the same line).
When onlineInstanceSeatId is non-empty, omit both lineItemUuid and parentLineItemUuid on that line.
parentLineItemUuid is only for a child line whose product relates to a new base line in the same request that is creating a new Online Instance or Seat Id. When the Online Instance or Seat Id already exists, set onlineInstanceSeatId on every line instead (for any product type).
lineItemUuid and parentLineItemUuid are request-scoped only; they are not stored as permanent identifiers.
product.type describes the catalog product and does not determine whether to use lineItemUuid or parentLineItemUuid.

Batch processing: If neither onlineInstanceSeatId nor lineItemUuid is provided for a base or container line, batch processing fails with API4P_SE16.

Responses

Request samples

Payload

Content type

application/json

Example

Ordering new licenses for Online Instance and its products

New order for Online Instance and its products

{"requestorContactId": "C00001234567",
"businessUnitId": "BU001",
"billToSite": {"locationId": 2
},
"soldToSite": {"id": "100012345678901",
"locationId": 2
},
"billToContactId": "C00001234567",
"soldToContactId": "C00007654321",
"onlineServiceAccessContactId": "C00001234567",
"agreementType": "CLOSA",
"renewalInformation": {"anniversaryMode": "COTERM_ALIGN",
"coterminousDate": "06-30",
"licenseEndYear": "2027"
},
"dsSalesRepresentativeEmail": "Jini.Doe@3ds.com",
"billToSalesRepresentativeContactId": "C00001234567",
"customerRequestedArrivalDate": "2026-09-16",
"billToPoReference": "EXAMPLE-CORP-20250518",
"subDistributorSiteId": "SDIS000000000xx",
"priceListId": 17,
"description": "New 3DEXPERIENCE Platform",
"comment": "Please prioritize this order as the customer requires the license before the end of Q2 for a product launch. Also, note that the discount approved in the attached quote should be applied.",
"recurringChargeBillingCycle": "ANN360",
"opportunityId": "A1B2-C3D4E5",
"licenseComplianceCaseId": "1234567890123",
"licenseChargeConditions": [{"onlineInstanceSeatId": "",
"lineItemUuid": "1928b338-5ef4-4505-b5d0-e4af60848dba",
"waiver": {"endDate": "2026-09-30"
},
"accreditationId": "PRTF088",
"release": "3DEXPERIENCE R2026x",
"product": {"trigram": "IFW-OC",
"type": "NU"
},
"quantity": 1,
"revenueType": "YSC",
"startDate": "2026-09-16",
"duration": 2,
"coupons": [{"yearNumber": 1,
"name": "ALMARC00000123"
},
{"yearNumber": 2,
"name": "ALMARC00000124"
}
]
},
{"onlineInstanceSeatId": "",
"parentLineItemUuid": "1928b338-5ef4-4505-b5d0-e4af60848dba",
"waiver": {"endDate": "2026-09-30"
},
"accreditationId": "PRTF071",
"release": "3DEXPERIENCE R2026x",
"product": {"trigram": "CSV-OC",
"type": "NU"
},
"quantity": 1,
"revenueType": "YSC",
"startDate": "2026-09-16",
"duration": 2,
"coupons": [{"yearNumber": 1,
"name": "ALMARC00000123"
},
{"yearNumber": 2,
"name": "ALMARC00000124"
}
]
}
]
}

Response samples

Content type

application/json

Example of response for order request

{"data": [{"requestorContactId": "C00001234567",
"id": "OR_000000000123",
"type": "C",
"status": "OPEN",
"creationDateTime": "2025-05-21T14:30:00Z"
}
],
"info": {"success": true,
"statusCode": 201,
"estimatedSearchCount": 1
}
}

Get Order Request Details Beta

Retrieves details of a single order request object identified by its id.
The response includes the request type (create or submit), processing status, creation timestamp, the associated purchase order when processing completes, and batch processing errors when processing fails.

Authorizations:

API Key: ApiKeyAuth

path Parameters

id

required

string

Example: OR_000000000123

Unique identifier of the order request.

Responses

Response samples

Content type

application/json

Example

Completed order request of type C (Create)

Response for a completed create order request where the transaction object is populated with its id.

{"data": [{"requestorContactId": "C00001234567",
"id": "OR_000000000123",
"type": "C",
"status": "COMP",
"creationDateTime": "2025-05-21T14:30:00Z",
"transaction": {"id": "PO_A123456789"
}
}
],
"info": {"success": true,
"statusCode": 200,
"estimatedSearchCount": 1
}
}

Price-Lists

This section defines the operations related to Price Lists.

Retrieve Price Lists

Get Price Lists

Retrieves the Price Lists for the authenticated user.

Authorizations:

API Key: ApiKeyAuth

Responses

Response samples

200
401
403
429
500

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 Product Prices

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

Examples: "PRTF0XX" "IPE000XXXXX"

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

priceListId

required

integer <= 2 characters

Example: "17"

Unique identifier of Price List.

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

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
Dassault Systèmes 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

Examples: "PRTF0XX" "IPE000XXXXX"

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

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

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

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
}
}

Customers

This section defines the operations related to final customers.

Retrieve Final Customers

Get Customers

Returns a paginated list of all final customers associated with the partner site of the authenticated user. Supports pagination with skip and top parameters to control result size and offset.

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

Content type

application/json

Example

Successful customers search example

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

{"data": [{"id": "100012345678901",
"name": "Example Corporation",
"localName": "示例公司",
"creationDate": "2025-06-01",
"isLegalEntity": true,
"legalEntityId": "",
"vatId": "FR12345678901",
"registrationIdentifiers": [{"type": "PAN",
"value": "AAAAA0000A"
}
],
"addressLocations": [{"id": 1,
"status": "A",
"isDeliverable": true,
"isTransactionPossible": true,
"hasPartnerActiveOrFutureLicense": true,
"gstin": "27ABCDE1234F1Z5",
"countryCode": "FRA",
"countryName": "France",
"stateOrProvinceCode": "IDF",
"stateOrProvinceName": "Île-de-France",
"cityName": "Paris",
"cityLocalName": "Париж",
"addressLine1": "123 Rue de Rivoli",
"addressLine2": "Apt 4B",
"addressLine3": "75001 Paris",
"addressLine4": "France",
"postalCode": "75001"
}
],
"coterminousDates": ["04-29",
"12-09",
"07-20",
"03-22"
]
}
],
"info": {"success": true,
"statusCode": 200,
"estimatedSearchCount": 3
}
}

Contacts

This section defines the operations related to contacts.

Search Contacts
Create New Contact

Search Contacts using various filters

Searches for contacts based on various filter criteria such as name, site, login, 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 contacts.

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

contactId
email
firstName
lastName
login
mobileNumber
phoneNumber
profileId
siteId
siteName

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

non-empty

contactId	string^C[0-9]{11}$ Example: "C00001234567" Unique identifier of the contact person.
firstName	string <= 30 characters Example: "Jini" First name of the contact person.
lastName	string <= 30 characters Example: "DOE" Last name (family name) of the contact person.
email	string <= 70 characters Example: "jini.doe@example.com" E‑mail address of the contact person. This is the address to which electronic communications (order confirmations, invoices, notifications, etc.) should be sent.
login	string <= 80 characters Example: "jini.doe" Web login (username) that the contact uses to authenticate to the system. This value is the identifier a user enters on the login screen.
phoneNumber	string <= 40 characters Example: "555-1234 ext. 56" Land‑line telephone number of the contact. The value is stored as free‑form text and may include any local formatting, extensions, or separators that the organization uses (e.g., “555‑1234 ext. 56”, “(02) 9876‑5432”, etc.).
mobileNumber	string <= 40 characters Example: "+33 6 12 34 56 78" Mobile (cellular) phone number of the contact. Stored as free‑form text; any local formatting, country codes, or separators are allowed (e.g., “+33 6 12 34 56 78”, “06‑12‑34‑56‑78”, etc.).
profileId	string <= 14 characters Example: "P0000XXXXXXX" Unique identifier of the contact profile.
siteId	string [ 6 .. 15 ] characters Example: "100012345678901" A unique identifier for the company. The value will be within the Legal Entity Family.
siteName	string <= 120 characters Example: "Example Corporation" The registered name of the company in English.

Responses

Request samples

Payload

Content type

application/json

Example

Sample request body for searching contacts using a single criterion

This example demonstrates how to search for contacts using the firstName criterion.

This JSON payload retrieves all contacts having first name Jini.

{"firstName": "Jini"
}

Response samples

Content type

application/json

Example

Sample successful basic search for contacts

Sample successful basic search for contacts with only 1 result.

{"data": [{"id": "C00001234567",
"prefix": "MS",
"firstName": "Jini",
"lastName": "DOE",
"email": "jini.doe@example.com",
"login": "jini.doe",
"phoneNumber": "555-1234 ext. 56",
"mobileNumber": "+33 6 12 34 56 78",
"creationDate": "2025-06-01",
"createdBy": "DOE, John",
"isObsolete": false,
"profiles": [{"id": "P0000XXXXXXX",
"name": "EXAMPLE CORP",
"siteId": "100012345678901",
"siteName": "Example Corporation",
"isSOW4PMaster": true,
"isObsolete": false,
"roles": ["Sales Administration",
"Marketing"
]
}
]
}
],
"info": {"success": true,
"statusCode": 0,
"estimatedSearchCount": 1
}
}

Create Contact

Creates a new final customer contact record.
The request body must contain all mandatory contact fields.
On success, the API returns HTTP 201 Created with the complete representation of the newly created contact.
If a contact with the same email already exists in the system, the API returns HTTP 409 Conflict.

Authorizations:

API Key: ApiKeyAuth

Request Body schema: application/json
required

The request body for creating a new contact.

requestorContactId

required

string^C[0-9]{11}$

Example: "C00001234567"

Unique identifier of the contact person who submitted the new contact creation request.
The contact person who submitted the new contact creation request must have the appropriate roles or permissions in the system to create or modify specific component associated with this API.

prefix

string <= 4 characters

Enum	Description
DR	Dr
MR	Mr
MRS	Mrs
MS	Ms

Example: "MS"

Honorific title preceding the contact's name (e.g., "Dr", "Mr", "Mrs", "Ms").
Used for formal address in communications and documentation.

firstName

required

string <= 30 characters

Example: "Jini"

First name of the contact person.

lastName

required

string <= 30 characters

Example: "DOE"

Last name (family name) of the contact person.

email

required

string <= 70 characters

Example: "jini.doe@example.com"

E‑mail address of the contact person. This is the address to which electronic communications (order confirmations, invoices, notifications, etc.) should be sent.

phoneNumber

string <= 40 characters

Example: "555-1234 ext. 56"

Land‑line telephone number of the contact. The value is stored as free‑form text and may include any local formatting, extensions, or separators that the organization uses (e.g., “555‑1234 ext. 56”, “(02) 9876‑5432”, etc.).

mobileNumber

string <= 40 characters

Example: "+33 6 12 34 56 78"

Mobile (cellular) phone number of the contact. Stored as free‑form text; any local formatting, country codes, or separators are allowed (e.g., “+33 6 12 34 56 78”, “06‑12‑34‑56‑78”, etc.).

siteId

required

string <= 15 characters

Example: "100012345678901"

A unique identifier for the final customer company.
The identifier belongs to the Legal Entity Family that has no partnership agreement with Dassault Systèmes (i.e., a pure final customer site) and that is not a branch office of a final customer.

Responses

Request samples

Payload

Content type

application/json

This example demonstrates the payload for creating new contact.

{"requestorContactId": "C00001234567",
"prefix": "MS",
"firstName": "Jini",
"lastName": "DOE",
"email": "jini.doe@example.com",
"phoneNumber": "555-1234 ext. 56",
"mobileNumber": "+33 6 12 34 56 78",
"siteId": "100012345678901"
}

Response samples

Content type

application/json

Example of response for contact creation

{"data": [{"id": "C00001234567",
"prefix": "MS",
"firstName": "Jini",
"lastName": "DOE",
"email": "jini.doe@example.com",
"login": "jini.doe",
"phoneNumber": "555-1234 ext. 56",
"mobileNumber": "+33 6 12 34 56 78",
"creationDate": "2025-06-01",
"createdBy": "DOE, John",
"isObsolete": false,
"profiles": [{"id": "P0000XXXXXXX",
"name": "EXAMPLE CORP",
"siteId": "100012345678901",
"siteName": "Example Corporation",
"isSOW4PMaster": true,
"isObsolete": false,
"roles": ["Sales Administration",
"Marketing"
]
}
]
}
],
"info": {"success": true,
"statusCode": 201,
"estimatedSearchCount": 1
}
}

Order Creation

Catalog of all error codes and corresponding messages that can be returned during order creation by batch.
Each entry provides a machine‑readable code and a detailed, user‑friendly description of the validation issue and suggested corrective action.

Security

Code	Message
API4P_FC3	You are not authorized to sell to this Customer `<soldToSite/id>`. Please verify the input and try again.
API4P_RCI1	The provided requestorContactId `<requestorContactId>` does not belong to an authorized Partner. Please verify the input and try again.
API4P_RCI2	The provided requestorContactId `<requestorContactId>` is not allowed to create purchase orders. Please verify the input and try again.

Business Unit

Code	Message
API4P_BU3	The provided value for Business Unit `<businessUnitId>` is obsolete. Please verify the input and try again.
API4P_BU5	The provided value for Business Unit `<businessUnitId>` does not match the BU declared in the row security definition of the requestorContactId `<requestorContactId>` targeted profile. Please verify the input and try again.
API4P_BU6	The provided value for Business Unit `<businessUnitId>` does not match with at least one of the BUs declared in the DA(GVA). Please verify the input and try again.

Accreditation

Code	Message
API4P_PF3	The value provided for the Portfolio `<licenseChargeConditions/portfolio>` is a GEOVIA portfolio. Note that the creation of GEOVIA licenses is not supported through the API.
API4P_PR3	The provided CA/LA product `<product>` has not been declared on the provided Final Customer `<soldToSite/id>`. Please verify the input and try again.
API4P_PR5	You are not accredited to sell the Product provided `<licenseChargeConditions/product/trigram>`. Please verify the input and try again.

Sold To Site

Code	Message
API4P_FC2	The value for the provided soldToSite/id `<soldToSite/id>` is flagged in the system as a 'None Usable' site. Please verify the input and try again.
API4P_FC4	The value for the provided soldToSite/id `<soldToSite/id>` is not a legal entity. Please verify the input and try again.

Renewal Information

Code	Message
API4P_CA4	As the overall PO line duration is greater than 1 year, the Start Date is mandatory. Please verify the input and try again.
API4P_CA401	The provided Coterminous Date `<coterminousDate>` does not exist for the Final Customer `<soldToSite/id>`. Please verify the input and try again.
API4P_CD5	The newCoterminousEndDate provided `<newCoterminousEndDate>` cannot be less than the current date. Please verify the input and try again.
API4P_CD6	The Business Unit setup does not allow setting a newCoterminousEndDate. Please verify the input and try again.
API4P_ST1	The provided year of the Start Date `<licenseChargeConditions/startDate>` cannot be greater than the licenseEndYear. Please verify the input and try again.
API4P_ST2	The provided Start Date `<licenseChargeConditions/startDate>` is greater than the End Date. Please verify the input and try again.

License Charge Conditions

Code	Message
API4P_PR2	The couple of values provided for the Trigram `<licenseChargeConditions/product/trigram>` and the Product-Type `<licenseChargeConditions/product/type>` are not valid for the provided Portfolio `<licenseChargeConditions/portfolio>` and Release `<licenseChargeConditions/release>`. Please verify the input and try again.
API4P_PF2	The value provided for the Portfolio `<licenseChargeConditions/portfolio>` is not found or is incorrect. Please verify the input and try again.
API4P_RL2	The value provided for the Release `<licenseChargeConditions/release>` is not valid for the provided Portfolio `<licenseChargeConditions/portfolio>`. Please verify the input and try again.

Revenue Type

Code	Message
API4P_RT1	The Revenue Type is a mandatory field. Please verify the input and try again.
API4P_RT2	The Revenue Type provided `<revenueType>` does not match an authorized value. Please verify the input and try again.
API4P_RT3	The selected Revenue Type `<revenueType>` is not available for the Price List `<priceListId>`, Product Trigram `<trigram>`, Product Type `<type>`, and Order Type New. Please verify the input and try again.

Price List

Code	Message
API4P_PL2	The selected Price List `<priceListId>` is not compatible with the authorized price lists for the Final Customer `<soldToSite/id>`. Please provide a valid price list.
API4P_PL3	A value for `<priceListId>` was not provided or we were not able to default it. Please verify the input and try again.

Online Instance Id

Code	Message
API4P_SE7	The onlineInstanceSeatId value provided `<licenseChargeConditions/onlineInstanceSeatId>` does not match any existing Online Instance Id belonging to the final customer `<soldToSite/id>`. Please verify the input and try again.
API4P_SA2.1	The onlineServiceContactID `<onlineServiceContactID>` does not belong to the provided soldToSite/id `<soldToSite/id>`. Please verify the input and try again.
API4P_SA2.2	The onlineServiceContactID `<onlineServiceContactID>` is an obsolete contact. Please verify the input and try again.
API4P_SA3	An Online Service Access Contact Id is mandatory for the provided Product `<licenseChargeConditions/product>`. Please verify the input and try again.

Seat Id

Code	Message
API4P_SE12	The provided Seat Id `<licenseChargeConditions/onlineInstanceSeatId>` does not match any existing Seat Id belonging to the final customer `<soldToSite/id>`. Please verify the input and try again.
API4P_SE13	The provided Revenue Type `<revenueType>` does not match any of the revenue types for this existing Seat Id `<licenseChargeConditions/onlineInstanceSeatId>`. Please verify the input and try again.
API4P_SE14	The provided product is not compatible with the provided Seat Id `<onlineInstanceSeatId>`. Only one base product is authorized on a Standalone Seat. Please verify the input and try again.
API4P_SE15	The provided product is not compatible with the provided Seat Id `<onlineInstanceSeatId>`. The Product Market information does not match the Seat Id Market information. Please verify the input and try again.
API4P_SE16	Either the onlineInstanceSeatId or the lineItemUuid is required to create the purchase order line. Please verify the input and try again.
API4P_SE17	The type of the provided onlineInstanceSeatId value `<onlineInstanceSeatId>` is not Standalone/Network. This is not compatible with the provided product `<licenseChargeConditions/product/trigram>`. Please verify the input and try again.
API4P_SE18	The provided product `<licenseChargeConditions/product/trigram>` is not compatible with a new Seat Id. Please verify the input and try again.

Coupons

Code	Message
API4P_CP1	The Coupon Name cannot be used for this Agreement `<agreementType>`. Please verify the input and try again.
API4P_CP2	The provided value for Coupon Name `<licenseChargeConditions/coupons/name>` is expired or yet to start. Please verify the input and try again.
API4P_CP3	The Territory of the transaction `<businessUnitId>` does not match at least one of the territories set in the Coupon. Please verify the input and try again.
API4P_CP5	The provided value for Coupon Name `<licenseChargeConditions/coupons/name>` has already been used. Please verify the input and try again.
API4P_CP7	The provided value for Coupon Name `<licenseChargeConditions/coupons/name>` cannot be used. The Portfolio or the Product Trigram does not match the one selected in the Purchase Order. Please verify the input and try again.
API4P_CP8	The provided value for Coupon Name `<licenseChargeConditions/coupons/name>` cannot be used. The Revenue Type does not match the one selected in the Purchase Order Line. Please verify the input and try again.
API4P_CP9	Application of Coupon is not allowed for the Business Unit of the transaction `<businessUnitId>`. Please verify the input and try again.
API4P_CN1	The provided value for Coupon Name `<check licenseChargeConditions/coupons/name>` is not found or is incorrect. Please verify the input and try again.
API4P_CN2	The provided value for Coupon Name `<licenseChargeConditions/coupons/name>` cannot be used. Only Line Level Discount Coupon with Discount Type Price List Based are allowed. Please verify the input and try again.
API4P_CY1	The provided value for Coupon Name/Year `<licenseChargeConditions/coupons/name>` + `<licenseChargeConditions/coupons/yearNumber>` cannot be used. The provided Year does not match an existing year set in the Purchase Order/PO Line/subline. Please verify the input and try again.

Sub-Distributor

Code	Message
API4P_SD1	The selected Business Unit of the transaction is not eligible for the use of Sub-Distributor. The proposed value was ignored.
API4P_SD2	The provided Sub-Distributor Id `<subDistributorSiteId>` refers to an inactive Sub-Distributor. Please verify the input and try again.
API4P_SD3	The provided Sub-Distributor Id `<subDistributorSiteId>` is not listed among authorized Sub-Distributors. Please verify the input and try again.
API4P_SD4	Support for the provided Sub-Distributor Id `<subDistributorSiteId>` has not yet started for the given Bill To Site Id `<billToSite/id>`. Please verify the input and try again.
API4P_SD5	Support for the provided Sub-Distributor Id `<subDistributorSiteId>` has expired for the given Bill To Site Id `<billToSite/id>`. Please verify the input and try again.

Opportunity

Code	Message
API4P_OP1	The value for the Final Customer `<soldToSite/id>` is not found or is incorrect. Please verify the input and try again.
API4P_OP3	The provided Opportunity Id `<opportunityId>` is not found or is incorrect. Please verify the input and try again.
API4P_OP4	The value for the provided Opportunity Id `<opportunityId>` is already used in another Purchase Order. So it cannot be used again.

Contact

Code	Message
API4P_BT1	The value for the provided Bill To Contact Id `<billToContactId>` is not found or is incorrect. Please verify the input and try again.
API4P_SO1	The value for the provided Sold To Contact Id `<soldToContactId>` is not found or is incorrect. Please verify the input and try again.
API4P_SR4	The provided DS Sales Representative e-mail `<dsSalesRepresentativeEmail>` is not valid. Please verify the input and try again.
API4P_BTSR1	The provided Bill To Sales Representative Contact Id `<billToSalesRepresentativeContactId>` is associated with the Bill-To site but is not valid as a Bill-To Sales Representative. Verify the input and ensure the contact has either the DS_ECO_554 (Sales Expert) or DS_ECO_506 (SALES) role.

Agreement

Code	Message
API4P_AT1	There is no Agreement Type defined in our system for the provided agreementType `<agreementType>`. Please verify the input and try again.

Schemas

This section list individuals Schemas or schema fragments referenced in the API.

It can be useful for focus on a particular fragment of body request or response.

country_code

string

ISO3 Code (3 capital letters code) of the country

"FRA"

country_name

string

Country Location

"France"

price_list_id

integer <= 2 characters

Unique identifier of Price List.

17

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"

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": 17,
"name": "EMEA Price List",
"currency": "USD",
"hasFuturePriceList": true,
"effectiveDate": "2025-09-09"
}
]
}
]

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:resourceConflict" … 1 more 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:resourceConflict` `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"
}

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"

accreditation_id

string <= 15 characters

Unique identifier of the Portfolio / IPE.
The list of accreditated Portfolios / IPEs can be retrieved via the Get Portfolio / IPE Accreditations API.

"PRTF0XX"

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"

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_trigram

string <= 10 characters

The trigram code for the product.

"PCS_OC"

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"

release_name

string <= 50 characters

Release Name identifies a specific version of a software

"3DEXPERIENCE R2025x"

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"

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"
}
]
}
]
}

quantity

integer >= 1

The quantity of the product being ordered.

2

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 >= 1 Example: "2" Quantity of item in the package/offer

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

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"
}
]
}
]
}

orderRequest_requestor

string^C[0-9]{11}$

Unique identifier of the contact person who submitted the order‑creation request.
The contact person who submitted the new order creation request must have the appropriate roles or permissions in the system to create or modify specific component associated with this API.

"C00001234567"

id

string = 5 characters

Unique identifier of the sales business unit.

"BU001"

billto_site

locationId

integer [ 1 .. 999 ]

Example: "2"

A unique identifier representing the company's location.
Must be an integer between 1 and 999.

Business rule – This rule is applied for every request:

If a locationId is supplied, the backend checks whether it belongs to the legal entity identified by id.
If the supplied value is valid, it is used unchanged.
If the supplied value is missing or invalid, the system falls back to the primary location of that entity (when a primary location exists).
If no primary location exists, the first configured location (Location #1) for that id is used instead.

The resolved locationId is persisted on the Purchase Order.

{"locationId": 2
}

final_customer_site_id

string <= 15 characters

A unique identifier for the final customer company.
The identifier belongs to the Legal Entity Family that has no partnership agreement with Dassault Systèmes (i.e., a pure final customer site) and that is not a branch office of a final customer.

"100012345678901"

final_customer_site

id

string <= 15 characters

Example: "100012345678901"

A unique identifier for the final customer company.
Only legal‑entity identifiers are permitted; branch‑office identifiers are not allowed.

locationId

integer [ 1 .. 999 ]

Example: "2"

A unique identifier representing the company's location.
Must be an integer between 1 and 999.

Business rule – This rule is applied for every request:

If a locationId is supplied, the backend checks whether it belongs to the legal entity identified by id.
If the supplied value is valid, it is used unchanged.
If the supplied value is missing or invalid, the system falls back to the primary location of that entity (when a primary location exists).
If no primary location exists, the first configured location (Location #1) for that id is used instead.

The resolved locationId is persisted on the Purchase Order.

{"id": "100012345678901",
"locationId": 2
}

contact_id

string^C[0-9]{11}$

Unique identifier of the contact person.

"C00001234567"

contact_id_or_empty

string^(|C[0-9]{11})$

Unique identifier of the contact person.

"C00001234567"

NON_COTERM

string

Non Coterminous

Each license or subscription line item will have its own independent renewal date, rather than aligning to a common anniversary date shared across multiple licenses.
For SolidWorks Desktop licenses under Seat Id control, all associated Network Licenses or add-ons automatically inherit and align with the Seat Id’s end date for consistency.

Business rule – When anniversaryMode is set to NON_COTERM, each element in the licenseChargeConditions array must include a duration field.

"NON_COTERM"

Non Coterminous

anniversaryMode

required

string

Non Coterminous

Each license or subscription line item will have its own independent renewal date, rather than aligning to a common anniversary date shared across multiple licenses.
For SolidWorks Desktop licenses under Seat Id control, all associated Network Licenses or add-ons automatically inherit and align with the Seat Id’s end date for consistency.

Business rule – When anniversaryMode is set to NON_COTERM, each element in the licenseChargeConditions array must include a duration field.

Value: "NON_COTERM"

{"anniversaryMode": "NON_COTERM"
}

COTERM_ALIGN

string

First Year Coterminous Align (date + year)

Standardize the renewal dates of multiple licenses under a single, recurring anniversary date.
This mode allows customers to align disparate license end dates, even if purchased at different times into a unified renewal cycle, simplifying administrative tracking, billing, and support management.

"COTERM_ALIGN"

renewal_coterminous_date

string^(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])$

Month‑day (MM‑DD) that serves as the recurring renewal anchor when anniversaryMode is set to First Year Coterminous Align. The value must match the MM‑DD pattern and existing at the Final Customer site.

The list of allowed coterminous dates can be retrieved via the Get Customers API. If the desired date is not present in that list, the anniversaryMode field value should be set COTERM-NEW and a valid newCoterminousEndDate must be supplied.

"06-30"

license_end_year

string^\d{4}$

Calendar year (YYYY) that indicates the final year the licence should remain active when anniversaryMode is set to First Year Coterminous Align. This year can be combined with the coterminousDate (MM‑DD) to determine the exact licence end‑date for multi‑year orders.

"2029"

First Year Coterminous Align

anniversaryMode required	string First Year Coterminous Align (date + year) Standardize the renewal dates of multiple licenses under a single, recurring anniversary date. This mode allows customers to align disparate license end dates, even if purchased at different times into a unified renewal cycle, simplifying administrative tracking, billing, and support management. Value: "COTERM_ALIGN"
coterminousDate required	string^(0[1-9]\|1[0-2])-(0[1-9]\|[12][0-9]\|3[01])$ Example: "06-30" Month‑day (MM‑DD) that serves as the recurring renewal anchor when anniversaryMode is set to First Year Coterminous Align. The value must match the `MM‑DD` pattern and existing at the Final Customer site. The list of allowed coterminous dates can be retrieved via the Get Customers API. If the desired date is not present in that list, the `anniversaryMode` field value should be set `COTERM-NEW` and a valid `newCoterminousEndDate` must be supplied.
licenseEndYear required	string^\d{4}$ Example: "2029" Calendar year (YYYY) that indicates the final year the licence should remain active when anniversaryMode is set to First Year Coterminous Align. This year can be combined with the `coterminousDate` (MM‑DD) to determine the exact licence end‑date for multi‑year orders.

{"anniversaryMode": "COTERM_ALIGN",
"coterminousDate": "06-30",
"licenseEndYear": "2029"
}

COTERM_NEW

string

First Year Coterminous with New Date Use a specific future end date when the desired coterminous month-day is not yet available at the customer site, or when ordering on an existing Seat Id that should align to a coterminous date already recorded at the site. See newCoterminousEndDate for year-handling rules that differ between new and existing Seat Id lines.

"COTERM_NEW"

new_coterminous_end_date

string <date>

New coterminous end date (ISO‑8601 YYYY‑MM‑DD) used when anniversaryMode is COTERM_NEW. Required when a specific future month-day that does not yet exist at the Final Customer site must be recorded.

Business rule – Year handling for COTERM_NEW (evaluated during batch processing):

New Seat Id (lines where licenseChargeConditions[].onlineInstanceSeatId is empty or omitted and a new Seat Id is created):
- When the month-day (MM-DD) from newCoterminousEndDate is not yet recorded on the Final Customer site, the date is recorded on the customer.
- The first-year license end date and licenseEndYear on the license charge line are derived from the full newCoterminousEndDate value (year and month-day).
Existing Seat Id (lines where licenseChargeConditions[].onlineInstanceSeatId contains an existing Seat Id belonging to the Final Customer):
- When the Final Customer site already has the month-day (MM-DD) from newCoterminousEndDate among its coterminous dates, the API uses that month-day for the license end date but does not use the year from newCoterminousEndDate. The license end year is the following calendar year (the year after the year in newCoterminousEndDate), not the year supplied in the request.

Partner guidance: Do not submit February 29 (YYYY-02-29), even when the selected year is a leap year. Use February 28 (YYYY-02-28) instead. The Final Customer site records February 28 as the recurring anniversary date; in leap years, the license end date may still fall on February 29.

"2025-06-30"

First Year Coterminous with New Date

anniversaryMode

required

string

First Year Coterminous with New Date Use a specific future end date when the desired coterminous month-day is not yet available at the customer site, or when ordering on an existing Seat Id that should align to a coterminous date already recorded at the site. See newCoterminousEndDate for year-handling rules that differ between new and existing Seat Id lines.

Value: "COTERM_NEW"

newCoterminousEndDate

required

string <date>

Example: "2025-06-30"

New coterminous end date (ISO‑8601 YYYY‑MM‑DD) used when anniversaryMode is COTERM_NEW. Required when a specific future month-day that does not yet exist at the Final Customer site must be recorded.

Business rule – Year handling for COTERM_NEW (evaluated during batch processing):

New Seat Id (lines where licenseChargeConditions[].onlineInstanceSeatId is empty or omitted and a new Seat Id is created):
- When the month-day (MM-DD) from newCoterminousEndDate is not yet recorded on the Final Customer site, the date is recorded on the customer.
- The first-year license end date and licenseEndYear on the license charge line are derived from the full newCoterminousEndDate value (year and month-day).
Existing Seat Id (lines where licenseChargeConditions[].onlineInstanceSeatId contains an existing Seat Id belonging to the Final Customer):
- When the Final Customer site already has the month-day (MM-DD) from newCoterminousEndDate among its coterminous dates, the API uses that month-day for the license end date but does not use the year from newCoterminousEndDate. The license end year is the following calendar year (the year after the year in newCoterminousEndDate), not the year supplied in the request.

Partner guidance: Do not submit February 29 (YYYY-02-29), even when the selected year is a leap year. Use February 28 (YYYY-02-28) instead. The Final Customer site records February 28 as the recurring anniversary date; in leap years, the license end date may still fall on February 29.

{"anniversaryMode": "COTERM_NEW",
"newCoterminousEndDate": "2025-06-30"
}

renewal_information

anniversaryMode

required

string

Non Coterminous

Each license or subscription line item will have its own independent renewal date, rather than aligning to a common anniversary date shared across multiple licenses.
For SolidWorks Desktop licenses under Seat Id control, all associated Network Licenses or add-ons automatically inherit and align with the Seat Id’s end date for consistency.

Business rule – When anniversaryMode is set to NON_COTERM, each element in the licenseChargeConditions array must include a duration field.

NON_COTERM

Value: "NON_COTERM"

Example

NON_COTERM

{"anniversaryMode": "NON_COTERM"
}

email

string <= 70 characters

E‑mail address of the employee person.

"Jini.Doe@3ds.com"

customer_requested_arrival_date

string <date>

Customer Requested Arrival Date (CRAD) indicates the date by which the Final Customer requests delivery of the Dassault Systèmes 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.

Format: ISO 8601 format (YYYY-MM-DD)

"2025-05-31"

billto_po_reference

string <= 60 characters

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.
Must be a string with a maximum length of 60 characters.

"EXAMPLE-CORP-20250518"

description

string <= 30 characters

Short description given to the Purchase Order / Renewal Notification.

"XYZ Company Order 50 products"

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"

opportunity_id

string

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 when creating an order request.

Business rule – When submitting a Create Order Request, processing of opportunityId depends on the Business Unit identified by businessUnitId:

CPE – opportunityId is mandatory in the request JSON. The value must reference a valid sales opportunity in My Sales Pipeline.
CRE – Any opportunityId value supplied in the request JSON is ignored by the API; it is not processed or persisted even if the partner provides one.

"A1B2-C3D4E5"

license_compliance_case_id

string <= 14 characters

License‑Compliance Case Id – a unique identifier generated by Dassault Systèmes to track a license‑compliance investigation or audit for a specific customer site. The Id is used by internal teams (License‑Compliance, Sales, Legal, etc.) as a reference when monitoring, documenting, and resolving potential non‑compliance issues such as unauthorized usage, under‑licensing, or misuse of software.

"1234567890123"

online_instance_seat_id

string <= 15 characters

Deployment identifier carried in onlineInstanceSeatId. The same field holds one of two identifier types, depending on the product being ordered:

Online Instance Id - identifies a 3DEXPERIENCE platform instance deployed for the customer (for example R1122334455667). Used for 3DS platform products.
Seat Id - identifies a SolidWorks Standalone or Network licensing seat (for example 5622498). Applies to SolidWorks products regardless of on-cloud or on-premise deployment.

Partners supply a non-empty value when ordering on an existing Online Instance or Seat Id. Leave empty or omit when a new Online Instance or Seat Id will be resolved during batch processing for this request.

The identifier is a combination of letters and numbers (maxLength 15).

"R1122334455667"

Waiver by duration

duration

required

integer

Example: "1"

The number of months the order is eligible for free or discount.
The duration is usually a number of months.
Note: Mutually exclusive with endDate.

{"duration": 1
}

Waiver by endDate

endDate

required

string <date>

Example: "2025-05-30"

The date untill which the order is eligible for free or discount.
Format: ISO 8601 (e.g., 2025-05-30)
Note: Mutually exclusive with duration.

{"endDate": "2025-05-30"
}

waiver

One of

duration

required

integer

Example: "1"

The number of months the order is eligible for free or discount.
The duration is usually a number of months.
Note: Mutually exclusive with endDate.

Example

Waiver by duration

{"duration": 1
}

revenue_type_line_level

string

Enum	Description
BL2	Term Based Licenses 2 + Annual License Charge
BL3	Term Based Licenses 3 + Annual License Charge
PAC	Primary License Charge + Annual License Charge
QLC	Quarterly License Charge

… 8 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.

"PAC"

start_date

string <date>

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

"2025-06-01"

duration

integer

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.

2

year_number

integer

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.

1

coupon_name

string <= 40 characters

The name of the discount coupon.

"ALMARC00000123"

coupon_references

Array

yearNumber

integer

Example: "1"

Optional contract year qualifier. When omitted or set to 0, the two forms are equivalent; omitting the field is the preferred practice.

`yearNumber`	PxC coupon	AxC coupon
Omitted or `0`	Applies to the PxC sub-line on the submitted PO line. There is only one PxC sub-line per PO line, so no year disambiguation is needed.	Applies globally to all AxC sub-lines (all contract years) in the order.
`1`, `2`, …	No additional effect (only one PxC sub-line per PO line). Partners should omit this field.	Applies to the specified contract year on the relevant sub-line(s).

The value must be a non-negative integer when provided.

name

required

string <= 40 characters

Example: "ALMARC00000123"

Name of the coupon provided by Dassault Systèmes.

[{"yearNumber": 1,
"name": "ALMARC00000123"
}
]

license_charge_conditions_concise

Array

onlineInstanceSeatId

string <= 15 characters

Example: "R1122334455667"

Deployment identifier for the Online Instance or Seat on which the product will be licensed.

The same field holds either an Online Instance Id (3DS platform products such as 3DEXPERIENCE) or a Seat Id (SolidWorks Standalone or Network products), depending on the product being ordered.

Non-empty - reuse an existing Online Instance or Seat Id that already belongs to the customer.
- Online Instance Id: set when ordering on an existing 3DS platform instance (for example R1122334455667). The system uses the provided Online Instance Id as supplied, whether that Id is deployed or not deployed on the sold-to site.
- Seat Id: set when ordering on an existing SolidWorks Standalone or Network seat (for example 5622498), including additional products on a seat the customer already owns.
- Multiple lines in the same request may use the same non-empty value when several products deploy on the same existing Online Instance or Seat Id.
- In this case both lineItemUuid and parentLineItemUuid must be omitted.
Empty ("" or omitted) - the Online Instance or Seat Id is resolved during batch processing for a new deployment in this request. Each line must identify its role:

Online Instance Id (3DS platform products):
- When the sold-to site has at least one Not Deployed Online Instance Id, the system selects that Id. Multiple lines in the same request receive the same Not Deployed Online Instance Id, regardless of whether lineItemUuid values differ across lines.
- When the sold-to site has no Online Instance Id or has only deployed ones, the system creates a new Online Instance Id. Each line with a distinct lineItemUuid receives its own new Online Instance Id.
- See the Online Instance Id resolution during batch processing table above for the full matrix.
- Container or standalone line (a new 3DEXPERIENCE platform, or any line that does not specify parentLineItemUuid): lineItemUuid is required.
- Linked child line: parentLineItemUuid is required (instead of lineItemUuid). It must reference the lineItemUuid of the base line in the same request. The child inherits the Online Instance Id resolved for the base line.
Seat Id (SolidWorks Standalone or Network):
- Container or standalone line (a new SolidWorks Standalone or Network base, or any line that does not specify parentLineItemUuid): lineItemUuid is required. When every line in the request creates its own new Seat Id, each such line must include its own lineItemUuid.
- Linked child line (a product that relates to a new base line in this request): parentLineItemUuid is required (instead of lineItemUuid). It must reference the lineItemUuid of the base line in the same request. For a linked child line (parentLineItemUuid): on a Network Seat Id, the linked product may be any product.type; on a Standalone Seat Id, the linked product must be product.type Single Add-On (AS) only.
- If this line is the container or base, the resolved Seat Id becomes the reference for any linked child lines that specify parentLineItemUuid.
- If the line is a linked child, it inherits the Seat Id of the base line that created the seat.

Do not use parentLineItemUuid when the Online Instance or Seat Id already exists - supply the existing value in onlineInstanceSeatId instead.

lineItemUuid

string <uuid>

Example: "70e3bcdc-47fc-4dbb-a0f6-87f13000e0a9"

Temporary Universally Unique Identifier (UUID) generated by the client to uniquely identify this line item for the duration of the request.

Online Instance Id (3DS platform products):

Required for container or standalone lines when onlineInstanceSeatId is empty or omitted - that is, any line that does not specify parentLineItemUuid.
When onlineInstanceSeatId is empty or omitted and the sold-to site has at least one Not Deployed Online Instance Id, the system selects that Id for all applicable lines. Different lineItemUuid values on multiple lines do not cause separate Online Instance Ids to be created.
When onlineInstanceSeatId is empty or omitted and the sold-to site has no Online Instance Id or has only deployed ones, each line with a distinct lineItemUuid receives its own newly created Online Instance Id.

Seat Id (SolidWorks Standalone or Network):

Required when onlineInstanceSeatId is empty or omitted for a container or standalone line - that is, any line that does not specify parentLineItemUuid.
Used as the base line identifier for container or standalone lines. For Online Instance Id, see the resolution rules above. For Seat Id, used when the line creates a new SolidWorks Standalone or Network base.
Linked child lines in the same request reference this value via parentLineItemUuid (and must not supply lineItemUuid).
The UUID must be unique within the purchase order.
Must be omitted when onlineInstanceSeatId already contains a concrete identifier (ordering on an existing Online Instance or Seat Id).

parentLineItemUuid

string <uuid>

Example: "4bd6e6f8-fac4-4145-a2ea-a2c08219c200"

Temporary Universally Unique Identifier (UUID) generated by the client that points to the lineItemUuid of a base line in the same request.

Scope: use only for a linked child line - a line whose product relates to a base line in the same request that is creating a new Online Instance or Seat Id. For a linked child line (parentLineItemUuid): on a Network Seat Id, the linked product may be any product.type; on a Standalone Seat Id, the linked product must be product.type Single Add-On (AS) only. Do not use when the Online Instance or Seat Id already exists; set onlineInstanceSeatId to the existing value instead (for any product type on an existing SolidWorks Network or Standalone seat).

Online Instance Id inheritance (3DS platform products): a linked child line does not trigger its own Online Instance Id resolution. It inherits the Online Instance Id assigned to the base line referenced by parentLineItemUuid, including when that Id was selected from a Not Deployed Online Instance Id on the sold-to site.

Required for linked child lines when onlineInstanceSeatId is empty or omitted.
Points to the lineItemUuid of the base line (the line that creates a new Online Instance or Seat Id in this request).
Must match a lineItemUuid present elsewhere in the same request.
Must be omitted when onlineInstanceSeatId already contains a concrete identifier.

Waiver by duration (object) or Waiver by endDate (object)

Waiver information for the license charge.

Mutually Exclusive: Only one of duration or endDate may be provided.
If neither is provided, no waiver is applied (default behavior).
If both are provided, the request/response is invalid.

accreditationId

required

string <= 15 characters

Examples: "PRTF0XX" "IPE000XXXXX"

Unique identifier of the Portfolio / IPE.
The list of accreditated Portfolios / IPEs can be retrieved via the Get Portfolio / IPE Accreditations API.

release

required

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".

required

object

This field identifies the specific product that is being ordered.

quantity

required

integer >= 1

Example: "2"

The quantity of the product being ordered.

revenueType

required

string

Enum	Description
BL2	Term Based Licenses 2 + Annual License Charge
BL3	Term Based Licenses 3 + Annual License Charge
PAC	Primary License Charge + Annual License Charge
QLC	Quarterly License Charge

… 8 more

Example: "PAC"

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.

startDate

string <date>

Example: "2025-06-01"

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

Business rule – Effective start date resolution (evaluated during batch processing):

If licenseChargeConditions[].startDate is provided (non-empty), use it.
If omitted or empty (""), use customerRequestedArrivalDate when provided.
If CRAD is also absent, use the PO Creation Date.

Date coherence (batch): The effective start date must be on or before the computed license end date. On violation, batch processing fails with API4P_ST2; the error pointer is #/licenseChargeConditions/startDate because that is the validated field, even when the value was derived from CRAD.

Partner guidance: When using COTERM_NEW or COTERM_ALIGN, ensure the effective start date is not after the computed first-year end date.

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.

Business rule - This field is mandatory for each license charge condition when the renewal information’s anniversaryMode is NON_COTERM.

Array of objects

Collection of coupon references applied to a licenseChargeConditions[] line item.

Coupons are submitted per line; effective scope is determined by the coupon's revenue type (PxC vs AxC), not only the line's revenueType.

Terminology

PxC — Primary charges (PLC, PSC, and the primary component of combined line types such as PAC / SPA).
AxC — Annual or recurring charges (ALC, ASC, YLC, YSC, and the annual component of combined line types).

Business rules

Each PO line has at most one PxC sub-line; AxC sub-lines exist per contract year.
yearNumber is optional. When omitted (or set to 0), behavior depends on the coupon revenue type (see yearNumber below).
Use a non-zero yearNumber only for AxC coupons that target a specific contract year.
For multi-year AxC deals, submit separate coupon entries with yearNumber: 1, 2, … to target individual years, or omit yearNumber (or use 0) for a single coupon across all years.
When a global AxC coupon (omit/0) is already in effect and a later entry supplies a line-specific AxC coupon (non-zero yearNumber), the line-specific coupon overwrites the global coupon for that line only.

[{"onlineInstanceSeatId": "R1122334455667",
"lineItemUuid": "70e3bcdc-47fc-4dbb-a0f6-87f13000e0a9",
"parentLineItemUuid": "4bd6e6f8-fac4-4145-a2ea-a2c08219c200",
"waiver": {"duration": 1
},
"accreditationId": "PRTF0XX",
"release": "3DEXPERIENCE R2025x",
"product": {"trigram": "PCS_OC",
"type": "NU"
},
"quantity": 2,
"revenueType": "PAC",
"startDate": "2025-06-01",
"duration": 2,
"coupons": [{"yearNumber": 1,
"name": "ALMARC00000123"
}
]
}
]

orderRequest_id

string <= 16 characters

System generated unique identifier of the Order Request.

"OR_000000000123"

orderRequest_type

string

Enum	Description
C	Create. Order Request was created by the Create Order Request API.
S	Submit. Order Request was created by the Submit Order Request API.

Action that triggered creation of the Order Request.

"C"

orderRequest_status

string

Enum	Description
OPEN	Open. Request has been received and is awaiting to be picked up by the asynchronous job.
PROG	In Progress. Request is currently being processed by the asynchronous job.
COMP	Completed. Request processed successfully - the purchase order was created or submitted.
ERR	In Error. Request failed - an error occurred during processing.

Current processing state of an Order Request.
The value reflects where the request is in the asynchronous workflow that validates the payload, stores it in the pending-request buffer, and eventually creates or submits the purchase order.

"OPEN"

orderRequest_creation_datetime

string <date-time>

UTC timestamp when the order request was created in the system.

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

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

order_requests_create_data

Array

requestorContactId

required

string^C[0-9]{11}$

Example: "C00001234567"

Unique identifier of the contact person who submitted the order‑creation request.
The contact person who submitted the new order creation request must have the appropriate roles or permissions in the system to create or modify specific component associated with this API.

id

required

string <= 16 characters

Example: "OR_000000000123"

System generated unique identifier of the Order Request.

type

required

string

Enum	Description
C	Create. Order Request was created by the Create Order Request API.
S	Submit. Order Request was created by the Submit Order Request API.

Example: "C"

Action that triggered creation of the Order Request.

status

required

string

Enum	Description
OPEN	Open. Request has been received and is awaiting to be picked up by the asynchronous job.
PROG	In Progress. Request is currently being processed by the asynchronous job.
COMP	Completed. Request processed successfully - the purchase order was created or submitted.
ERR	In Error. Request failed - an error occurred during processing.

Example: "OPEN"

Current processing state of an Order Request.
The value reflects where the request is in the asynchronous workflow that validates the payload, stores it in the pending-request buffer, and eventually creates or submits the purchase order.

creationDateTime

required

string <date-time>

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

UTC timestamp when the order request was created in the system.

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

[{"requestorContactId": "C00001234567",
"id": "OR_000000000123",
"type": "C",
"status": "OPEN",
"creationDateTime": "2025-05-21T14:30:00Z"
}
]

orderRequest_batch_error_details

Array

code required	string Example: "API4P_OP1" Machine-readable error identifier.
message required	string Example: "The value for the Final Customer <soldToSite/id> is not found or is incorrect. Please verify the input and try again." Human-readable description of the problem and possible corrective action.
pointer	string Example: "#/soldToSite/id" A JSON Pointer indicating the location of the field in the request payload where the error occurred.

[{"code": "API4P_OP1",
"message": "The value for the Final Customer <soldToSite/id> is not found or is incorrect. Please verify the input and try again."
},
{"code": "API4P_PL3",
"message": "A value for <priceListId> was not provided or we were not able to default it. Please verify the input and try again."
}
]

transaction_order_id

string <= 13 characters

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

"PO_A123456789"

order_requests_get_data

Array

requestorContactId

required

string^C[0-9]{11}$

Example: "C00001234567"

Unique identifier of the contact person who submitted the order‑creation request.
The contact person who submitted the new order creation request must have the appropriate roles or permissions in the system to create or modify specific component associated with this API.

id

required

string <= 16 characters

Example: "OR_000000000123"

System generated unique identifier of the Order Request.

type

required

string

Enum	Description
C	Create. Order Request was created by the Create Order Request API.
S	Submit. Order Request was created by the Submit Order Request API.

Example: "C"

Action that triggered creation of the Order Request.

status

string

Enum	Description
OPEN	Open. Request has been received and is awaiting to be picked up by the asynchronous job.
PROG	In Progress. Request is currently being processed by the asynchronous job.
COMP	Completed. Request processed successfully - the purchase order was created or submitted.
ERR	In Error. Request failed - an error occurred during processing.

Example: "OPEN"

Current processing state of an Order Request.
The value reflects where the request is in the asynchronous workflow that validates the payload, stores it in the pending-request buffer, and eventually creates or submits the purchase order.

Array of objects

Example: [{"code":"API4P_OP1","message":"The value for the Final Customer <soldToSite/id> is not found or is incorrect. Please verify the input and try again."},{"code":"API4P_PL3","message":"A value for <priceListId> was not provided or we were not able to default it. Please verify the input and try again."}]

One or more errors that occurred during asynchronous order-request processing.
This field is included only when status is ERR.

Refer to the Order Creation Batch Error Catalog or Order Submission Batch Error Catalog for the complete list of business error codes, depending on the type of order request.

creationDateTime

required

string <date-time>

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

UTC timestamp when the order request was created in the system.

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

object or null

Details of the purchase order associated with this request when processing completes.

For a create order request, this is the newly created purchase order. For a submit order request, this is the purchase order that was submitted to the sales department.

This object is only populated when status is COMP. When the order request is still OPEN, PROG, or ERR the field is null.

[{"requestorContactId": "C00001234567",
"id": "OR_000000000123",
"type": "C",
"status": "OPEN",
"batchProcessingErrors": [{"code": "API4P_OP1",
"message": "The value for the Final Customer <soldToSite/id> is not found or is incorrect. Please verify the input and try again."
},
{"code": "API4P_PL3",
"message": "A value for <priceListId> was not provided or we were not able to default it. Please verify the input and try again."
}
],
"creationDateTime": "2025-05-21T14:30:00Z",
"transaction": {"id": "PO_A123456789"
}
}
]

4xx_get_order_requests

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"
}
]
}
]
}

legal_entity_id

string [ 6 .. 15 ] characters

A unique identifier for the company. The value will be within the Legal Entity Family.

"100012345678901"

legal_entity_name

string <= 120 characters

The registered name of the company in English.

"Example Corporation"

localName

string <= 120 characters

The registered name of the company in the local language.

"示例公司"

registration_identifier_type

string

Enum	Description
ABN	Australian Business Number
ACN	Company Number - Australia
ANC	My Number Act - Corporations
ANI	My Number Act - Individuals

… 17 more

Identifier type used to classify a registration identifier that uniquely identifies a Final Customer in a specific country jurisdiction or from external data provider system. The value determines the format and authority of the registration identifier (e.g., an Australian Business Number, a U.S. EIN, a Brazilian CGC, etc...). User should use this enum to indicate which registration scheme applies to the value field of a registrationIdentifier object.

"PAN"

registration_identifier

type

required

string

Enum	Description
ABN	Australian Business Number
ACN	Company Number - Australia
ANC	My Number Act - Corporations
ANI	My Number Act - Individuals

… 17 more

Example: "PAN"

Identifier type used to classify a registration identifier that uniquely identifies a Final Customer in a specific country jurisdiction or from external data provider system. The value determines the format and authority of the registration identifier (e.g., an Australian Business Number, a U.S. EIN, a Brazilian CGC, etc...). User should use this enum to indicate which registration scheme applies to the value field of a registrationIdentifier object.

value

required

string

Example: "AAAAA0000A"

The registration identifier value.

{"type": "PAN",
"value": "AAAAA0000A"
}

address_location

id

required

integer

Example: "1"

Unique identifier of this address‑location record.

status

required

string

Enum	Description
A	Active
I	Inactive
P	Pending

Example: "A"

Current lifecycle status of the address location.

isDeliverable

required

boolean

Example: "true"

True – the distributor may sell and deliver software licenses to this address location. False – selling and delivering to this address location are not allowed.

isTransactionPossible

required

boolean

Example: "true"

Indicates whether a transaction is possible for the Final Customer address location. True – a transaction can be performed for this Final Customer address location. False – a transaction cannot be performed for this Final Customer address location.

hasPartnerActiveOrFutureLicense

required

boolean

Example: "true"

True – the calling partner/distributor has already sold a software license to this Final Customer address location, and the license is either currently active (with or without support) or scheduled for the future. False – there is no active (with or without support) or scheduled‑for‑the‑future license for this address location.

gstin

string

Example: "27ABCDE1234F1Z5"

GSTIN (Goods and Services Tax Identification Number) for the address location, applicable only when the country is India and the value is available.

countryCode

required

string

Example: "FRA"

ISO 3166‑1 alpha‑3 country code (three‑letter code, e.g., USA, IND, GBR).

countryName

required

string

Example: "France"

Full country name that corresponds to countryCode.

stateOrProvinceCode

required

string

Example: "IDF"

Code of the country subdivision such as state, province, or prefecture (e.g., “CA” for California, “NSW” for New South Wales) when applicable.

stateOrProvinceName

required

string

Example: "Île-de-France"

Full name of the country subdivision (state, province, or prefecture) when applicable, corresponding to stateOrProvinceCode.

cityName

required

string

Example: "Paris"

Name of the city.

cityLocalName

string

Example: "Париж"

Localized name of the city, populated only when the Final Customer's country code is one of the following:

RUS – Russian Federation
KOR – Republic of Korea
JPN – Japan
CHN – China
LTU – Lithuania

If the country is not in the above list, this field is left empty.

addressLine1

required

string

Example: "123 Rue de Rivoli"

Address Line 1

addressLine2

required

string

Example: "Apt 4B"

Address Line 2

addressLine3

required

string

Example: "75001 Paris"

Address Line 3

addressLine4

required

string

Example: "France"

Address Line 4

postalCode

required

string

Example: "75001"

Postal or ZIP code for the address location.

{"id": 1,
"status": "A",
"isDeliverable": true,
"isTransactionPossible": true,
"hasPartnerActiveOrFutureLicense": true,
"gstin": "27ABCDE1234F1Z5",
"countryCode": "FRA",
"countryName": "France",
"stateOrProvinceCode": "IDF",
"stateOrProvinceName": "Île-de-France",
"cityName": "Paris",
"cityLocalName": "Париж",
"addressLine1": "123 Rue de Rivoli",
"addressLine2": "Apt 4B",
"addressLine3": "75001 Paris",
"addressLine4": "France",
"postalCode": "75001"
}

customer_coterminous_date

string^(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])$

Month‑day (MM‑DD) that serves as the renewal anchor. The value must match the MM‑DD pattern.

"06-30"

customer

id required	string [ 6 .. 15 ] characters Example: "100012345678901" A unique identifier for the Final Customer. The value will be within the Legal Entity Family.
name required	string <= 120 characters Example: "Example Corporation" The registered name of the Final Customer in English.
localName	string <= 120 characters Example: "示例公司" The registered name of the Final Customer in the local language. Localized name of the Final Customer, populated only the Final Customer’s countryCode is one of the following: RUS - Russian Federation KOR - Republic of Korea JPN - Japan CHN - China LTU - Lithuania If the country is not in the above list, this field is left empty.
creationDate required	string <date> Example: "2025-06-01" The date the Final Customer record was created, expressed in ISO‑8601 format (`YYYY‑MM‑DD`). This value is a calendar date without a time‑zone component.
isLegalEntity required	boolean Example: "true" True - the Final Customer is the head-office of the legal entity. False - the Final Customer is a branch office of a legal entity.
legalEntityId required	string^(\|.{6,15})$ Example: "100012345678901" The identifier of the legal entity (head‑office) that this Final Customer belongs to. This field is filled only for branch office (`isLegalEntity` = false). For a legal‑entity (head‑office) itself the field is left empty.
vatId required	string Example: "FR12345678901" The VAT (Value Added Tax), SST (Sales & Services Tax), Consumption Tax number associated with the Final Customer. It is included only when the Final Customer is a qualified legal entity (head‑office) and a VAT (Value Added Tax), SST (Sales & Services Tax), Consumption Tax number is available. If the Final Customer has no VAT (Value Added Tax), SST (Sales & Services Tax), Consumption Tax number, the attribute is kept empty.
required	Array of objects or null A collection of registration identifiers that uniquely identify the Final Customer in multiple country jurisdictions where Final Customer is registered or from external data provider systems (e.g., Company registration numbers, Tax number, D&B Number...)
required	Array of objects A collection of the Final Customer’s physical locations (addresses). Each entry describes a specific location where the Final Customer operates or receives delivery, and includes details such as street address, city, postal code, state/province/prefecture, country, related flags, status and specific registration identifiers when applicable at location (address) level.
coterminousDates required	Array of strings or null[ items^(0[1-9]\|1[0-2])-(0[1-9]\|[12][0-9]\|3[01])$ ] Example: ["04-29","12-09","07-20","03-22"] Dates on which the Final Customer’s licenses are coterminous (i.e., share the same renewal/expiry month‑day). Month‑Day (MM‑DD) coterminous serves as the recurring renewal anchor when anniversaryMode is set to First Year Coterminous Align. Each entry must be a string following the `MM‑DD` pattern (month‑day, no year).

{"id": "100012345678901",
"name": "Example Corporation",
"localName": "示例公司",
"creationDate": "2025-06-01",
"isLegalEntity": true,
"legalEntityId": "100012345678901",
"vatId": "FR12345678901",
"registrationIdentifiers": [{"type": "PAN",
"value": "AAAAA0000A"
}
],
"addressLocations": [{"id": 1,
"status": "A",
"isDeliverable": true,
"isTransactionPossible": true,
"hasPartnerActiveOrFutureLicense": true,
"gstin": "27ABCDE1234F1Z5",
"countryCode": "FRA",
"countryName": "France",
"stateOrProvinceCode": "IDF",
"stateOrProvinceName": "Île-de-France",
"cityName": "Paris",
"cityLocalName": "Париж",
"addressLine1": "123 Rue de Rivoli",
"addressLine2": "Apt 4B",
"addressLine3": "75001 Paris",
"addressLine4": "France",
"postalCode": "75001"
}
],
"coterminousDates": ["04-29",
"12-09",
"07-20",
"03-22"
]
}

customers_search_data

Array

id required	string [ 6 .. 15 ] characters Example: "100012345678901" A unique identifier for the Final Customer. The value will be within the Legal Entity Family.
name required	string <= 120 characters Example: "Example Corporation" The registered name of the Final Customer in English.
localName	string <= 120 characters Example: "示例公司" The registered name of the Final Customer in the local language. Localized name of the Final Customer, populated only the Final Customer’s countryCode is one of the following: RUS - Russian Federation KOR - Republic of Korea JPN - Japan CHN - China LTU - Lithuania If the country is not in the above list, this field is left empty.
creationDate required	string <date> Example: "2025-06-01" The date the Final Customer record was created, expressed in ISO‑8601 format (`YYYY‑MM‑DD`). This value is a calendar date without a time‑zone component.
isLegalEntity required	boolean Example: "true" True - the Final Customer is the head-office of the legal entity. False - the Final Customer is a branch office of a legal entity.
legalEntityId required	string^(\|.{6,15})$ Example: "100012345678901" The identifier of the legal entity (head‑office) that this Final Customer belongs to. This field is filled only for branch office (`isLegalEntity` = false). For a legal‑entity (head‑office) itself the field is left empty.
vatId required	string Example: "FR12345678901" The VAT (Value Added Tax), SST (Sales & Services Tax), Consumption Tax number associated with the Final Customer. It is included only when the Final Customer is a qualified legal entity (head‑office) and a VAT (Value Added Tax), SST (Sales & Services Tax), Consumption Tax number is available. If the Final Customer has no VAT (Value Added Tax), SST (Sales & Services Tax), Consumption Tax number, the attribute is kept empty.
required	Array of objects or null A collection of registration identifiers that uniquely identify the Final Customer in multiple country jurisdictions where Final Customer is registered or from external data provider systems (e.g., Company registration numbers, Tax number, D&B Number...)
required	Array of objects A collection of the Final Customer’s physical locations (addresses). Each entry describes a specific location where the Final Customer operates or receives delivery, and includes details such as street address, city, postal code, state/province/prefecture, country, related flags, status and specific registration identifiers when applicable at location (address) level.
coterminousDates required	Array of strings or null[ items^(0[1-9]\|1[0-2])-(0[1-9]\|[12][0-9]\|3[01])$ ] Example: ["04-29","12-09","07-20","03-22"] Dates on which the Final Customer’s licenses are coterminous (i.e., share the same renewal/expiry month‑day). Month‑Day (MM‑DD) coterminous serves as the recurring renewal anchor when anniversaryMode is set to First Year Coterminous Align. Each entry must be a string following the `MM‑DD` pattern (month‑day, no year).

[{"id": "100012345678901",
"name": "Example Corporation",
"localName": "示例公司",
"creationDate": "2025-06-01",
"isLegalEntity": true,
"legalEntityId": "100012345678901",
"vatId": "FR12345678901",
"registrationIdentifiers": [{"type": "PAN",
"value": "AAAAA0000A"
}
],
"addressLocations": [{"id": 1,
"status": "A",
"isDeliverable": true,
"isTransactionPossible": true,
"hasPartnerActiveOrFutureLicense": true,
"gstin": "27ABCDE1234F1Z5",
"countryCode": "FRA",
"countryName": "France",
"stateOrProvinceCode": "IDF",
"stateOrProvinceName": "Île-de-France",
"cityName": "Paris",
"cityLocalName": "Париж",
"addressLine1": "123 Rue de Rivoli",
"addressLine2": "Apt 4B",
"addressLine3": "75001 Paris",
"addressLine4": "France",
"postalCode": "75001"
}
],
"coterminousDates": ["04-29",
"12-09",
"07-20",
"03-22"
]
}
]

firstName

string <= 30 characters

First name of the contact person.

"Jini"

lastName

string <= 30 characters

Last name (family name) of the contact person.

"DOE"

contact_email

string <= 70 characters

E‑mail address of the contact person. This is the address to which electronic communications (order confirmations, invoices, notifications, etc.) should be sent.

"jini.doe@example.com"

login

string <= 80 characters

Web login (username) that the contact uses to authenticate to the system. This value is the identifier a user enters on the login screen.

"jini.doe"

phoneNumber

string <= 40 characters

Land‑line telephone number of the contact. The value is stored as free‑form text and may include any local formatting, extensions, or separators that the organization uses (e.g., “555‑1234 ext. 56”, “(02) 9876‑5432”, etc.).

"555-1234 ext. 56"

mobileNumber

string <= 40 characters

Mobile (cellular) phone number of the contact. Stored as free‑form text; any local formatting, country codes, or separators are allowed (e.g., “+33 6 12 34 56 78”, “06‑12‑34‑56‑78”, etc.).

"+33 6 12 34 56 78"

profile_id

string <= 14 characters

Unique identifier of the contact profile.

"P0000XXXXXXX"

roles

Array

string <= 30 characters

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

["Sales Administration",
"Marketing"
]

profile

id required	string <= 14 characters Example: "P0000XXXXXXX" Unique identifier of the contact profile.
name	string <= 50 characters Example: "EXAMPLE CORP" Human‑readable label for the profile. This name identifies the specific role or configuration of the contact within the associated site. It may be used in UI displays and reports to distinguish among multiple profiles that a single contact may hold.
siteId required	string [ 6 .. 15 ] characters Example: "100012345678901" A unique identifier for the company. The value will be within the Legal Entity Family.
siteName required	string <= 120 characters Example: "Example Corporation" The registered name of the company in English.
isSOW4PMaster required	boolean Example: "true" Indicates whether this profile has been mastered (i.e., created or synchronized) from the external Scope of Work for Partner (SOW4P) tool. true – the profile originates from / is managed by the SOW4P tool. false – the profile was created internally and is not mastered from SOW4P.
isObsolete required	boolean Example: "false" Indicates whether this profile is obsolete (no longer active or valid). true – the profile should not be used. false – the profile is current and can be referenced.
roles required	Array of strings[ items <= 30 characters ] Example: ["Sales Administration","Marketing"] List of roles granted to profile.

{"id": "P0000XXXXXXX",
"name": "EXAMPLE CORP",
"siteId": "100012345678901",
"siteName": "Example Corporation",
"isSOW4PMaster": true,
"isObsolete": false,
"roles": ["Sales Administration",
"Marketing"
]
}

contact

id

required

string^C[0-9]{11}$

Example: "C00001234567"

Unique identifier of the contact person.

prefix

string <= 4 characters

Enum	Description
DR	Dr
MR	Mr
MRS	Mrs
MS	Ms

Example: "MS"

Honorific title preceding the contact's name (e.g., "Dr", "Mr", "Mrs", "Ms").
Used for formal address in communications and documentation.

firstName

required

string <= 30 characters

Example: "Jini"

First name of the contact person.

lastName

required

string <= 30 characters

Example: "DOE"

Last name (family name) of the contact person.

email

required

string <= 70 characters

Example: "jini.doe@example.com"

E‑mail address of the contact person. This is the address to which electronic communications (order confirmations, invoices, notifications, etc.) should be sent.

login

string <= 80 characters

Example: "jini.doe"

Web login (username) that the contact uses to authenticate to the system. This value is the identifier a user enters on the login screen.

phoneNumber

string <= 40 characters

Example: "555-1234 ext. 56"

Land‑line telephone number of the contact. The value is stored as free‑form text and may include any local formatting, extensions, or separators that the organization uses (e.g., “555‑1234 ext. 56”, “(02) 9876‑5432”, etc.).

mobileNumber

string <= 40 characters

Example: "+33 6 12 34 56 78"

Mobile (cellular) phone number of the contact. Stored as free‑form text; any local formatting, country codes, or separators are allowed (e.g., “+33 6 12 34 56 78”, “06‑12‑34‑56‑78”, etc.).

creationDate

required

string <date>

Example: "2025-06-01"

The date the contact record was created, expressed in ISO‑8601 format (YYYY‑MM‑DD). This value is a calendar date without a time‑zone component.

createdBy

required

string

Example: "DOE, John"

The name of the user who created the contact record.

isObsolete

required

boolean

Example: "false"

Indicates whether the contact record is obsolete (no longer active or valid).

true – the contact should not be used for new transactions.
false – the contact is current and can be used.

Array of objects

Collection of Profile objects that are linked to this contact.
A contact can have one or more profiles, each of which ties the contact to a specific site and gives a human‑readable name for the role the contact plays at that site (e.g., "Purchasing Manager", "Site Administrator"). The array may be empty when the contact has no assigned profiles.

{"id": "C00001234567",
"prefix": "MS",
"firstName": "Jini",
"lastName": "DOE",
"email": "jini.doe@example.com",
"login": "jini.doe",
"phoneNumber": "555-1234 ext. 56",
"mobileNumber": "+33 6 12 34 56 78",
"creationDate": "2025-06-01",
"createdBy": "DOE, John",
"isObsolete": false,
"profiles": [{"id": "P0000XXXXXXX",
"name": "EXAMPLE CORP",
"siteId": "100012345678901",
"siteName": "Example Corporation",
"isSOW4PMaster": true,
"isObsolete": false,
"roles": ["Sales Administration",
"Marketing"
]
}
]
}

contacts_search_data

Array

id

required

string^C[0-9]{11}$

Example: "C00001234567"

Unique identifier of the contact person.

prefix

string <= 4 characters

Enum	Description
DR	Dr
MR	Mr
MRS	Mrs
MS	Ms

Example: "MS"

Honorific title preceding the contact's name (e.g., "Dr", "Mr", "Mrs", "Ms").
Used for formal address in communications and documentation.

firstName

required

string <= 30 characters

Example: "Jini"

First name of the contact person.

lastName

required

string <= 30 characters

Example: "DOE"

Last name (family name) of the contact person.

email

required

string <= 70 characters

Example: "jini.doe@example.com"

E‑mail address of the contact person. This is the address to which electronic communications (order confirmations, invoices, notifications, etc.) should be sent.

login

string <= 80 characters

Example: "jini.doe"

Web login (username) that the contact uses to authenticate to the system. This value is the identifier a user enters on the login screen.

phoneNumber

string <= 40 characters

Example: "555-1234 ext. 56"

Land‑line telephone number of the contact. The value is stored as free‑form text and may include any local formatting, extensions, or separators that the organization uses (e.g., “555‑1234 ext. 56”, “(02) 9876‑5432”, etc.).

mobileNumber

string <= 40 characters

Example: "+33 6 12 34 56 78"

Mobile (cellular) phone number of the contact. Stored as free‑form text; any local formatting, country codes, or separators are allowed (e.g., “+33 6 12 34 56 78”, “06‑12‑34‑56‑78”, etc.).

creationDate

required

string <date>

Example: "2025-06-01"

The date the contact record was created, expressed in ISO‑8601 format (YYYY‑MM‑DD). This value is a calendar date without a time‑zone component.

createdBy

required

string

Example: "DOE, John"

The name of the user who created the contact record.

isObsolete

required

boolean

Example: "false"

Indicates whether the contact record is obsolete (no longer active or valid).

true – the contact should not be used for new transactions.
false – the contact is current and can be used.

Array of objects

Collection of Profile objects that are linked to this contact.
A contact can have one or more profiles, each of which ties the contact to a specific site and gives a human‑readable name for the role the contact plays at that site (e.g., "Purchasing Manager", "Site Administrator"). The array may be empty when the contact has no assigned profiles.

[{"id": "C00001234567",
"prefix": "MS",
"firstName": "Jini",
"lastName": "DOE",
"email": "jini.doe@example.com",
"login": "jini.doe",
"phoneNumber": "555-1234 ext. 56",
"mobileNumber": "+33 6 12 34 56 78",
"creationDate": "2025-06-01",
"createdBy": "DOE, John",
"isObsolete": false,
"profiles": [{"id": "P0000XXXXXXX",
"name": "EXAMPLE CORP",
"siteId": "100012345678901",
"siteName": "Example Corporation",
"isSOW4PMaster": true,
"isObsolete": false,
"roles": ["Sales Administration",
"Marketing"
]
}
]
}
]

prefix

string <= 4 characters

Enum	Description
DR	Dr
MR	Mr
MRS	Mrs
MS	Ms

Honorific title preceding the contact's name (e.g., "Dr", "Mr", "Mrs", "Ms").
Used for formal address in communications and documentation.

"MS"

contact_create_data

Array

id

required

string^C[0-9]{11}$

Example: "C00001234567"

Unique identifier of the contact person.

prefix

string <= 4 characters

Enum	Description
DR	Dr
MR	Mr
MRS	Mrs
MS	Ms

Example: "MS"

Honorific title preceding the contact's name (e.g., "Dr", "Mr", "Mrs", "Ms").
Used for formal address in communications and documentation.

firstName

required

string <= 30 characters

Example: "Jini"

First name of the contact person.

lastName

required

string <= 30 characters

Example: "DOE"

Last name (family name) of the contact person.

email

required

string <= 70 characters

Example: "jini.doe@example.com"

E‑mail address of the contact person. This is the address to which electronic communications (order confirmations, invoices, notifications, etc.) should be sent.

login

string <= 80 characters

Example: "jini.doe"

Web login (username) that the contact uses to authenticate to the system. This value is the identifier a user enters on the login screen.

phoneNumber

string <= 40 characters

Example: "555-1234 ext. 56"

Land‑line telephone number of the contact. The value is stored as free‑form text and may include any local formatting, extensions, or separators that the organization uses (e.g., “555‑1234 ext. 56”, “(02) 9876‑5432”, etc.).

mobileNumber

string <= 40 characters

Example: "+33 6 12 34 56 78"

Mobile (cellular) phone number of the contact. Stored as free‑form text; any local formatting, country codes, or separators are allowed (e.g., “+33 6 12 34 56 78”, “06‑12‑34‑56‑78”, etc.).

creationDate

required

string <date>

Example: "2025-06-01"

The date the contact record was created, expressed in ISO‑8601 format (YYYY‑MM‑DD). This value is a calendar date without a time‑zone component.

createdBy

required

string

Example: "DOE, John"

The name of the user who created the contact record.

isObsolete

required

boolean

Example: "false"

Indicates whether the contact record is obsolete (no longer active or valid).

true – the contact should not be used for new transactions.
false – the contact is current and can be used.

Array of objects

Collection of Profile objects that are linked to this contact.
A contact can have one or more profiles, each of which ties the contact to a specific site and gives a human‑readable name for the role the contact plays at that site (e.g., "Purchasing Manager", "Site Administrator"). The array may be empty when the contact has no assigned profiles.

[{"id": "C00001234567",
"prefix": "MS",
"firstName": "Jini",
"lastName": "DOE",
"email": "jini.doe@example.com",
"login": "jini.doe",
"phoneNumber": "555-1234 ext. 56",
"mobileNumber": "+33 6 12 34 56 78",
"creationDate": "2025-06-01",
"createdBy": "DOE, John",
"isObsolete": false,
"profiles": [{"id": "P0000XXXXXXX",
"name": "EXAMPLE CORP",
"siteId": "100012345678901",
"siteName": "Example Corporation",
"isSOW4PMaster": true,
"isObsolete": false,
"roles": ["Sales Administration",
"Marketing"
]
}
]
}
]

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"

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

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"
}

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 [ 6 .. 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"

online_consent_status

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

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

"A"

billto_sales_representative

string

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

"DOE, Jane"

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 <= 60 characters

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.
Must be a string with a maximum length of 60 characters.

[{"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"
}
]

name

string <= 100 characters

Descriptive name of the agreement type.

"01. CLOSA (V13.2)"

agreement

type required	string <= 100 characters Example: "01. CLOSA (V13.2)" Type or classification of the agreement.
reference	string <= 254 characters Example: "Enterprise License Agreement Q2 2024" A short, descriptive title or label assigned to the agreement at the time of its creation. This helps users identify the specific agreement applied to the order. It can be selected in the Purchase Order only for agreement types where the sub-group is `Instantiated`.

{"type": "01. CLOSA (V13.2)",
"reference": "Enterprise License Agreement Q2 2024"
}

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

end_date

string

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

"2026-05-31"

coupon_detail

name	string <= 40 characters Example: "ALMARC00000123" The name of the discount coupon.
discountPercentage	number <float> Example: "10" The discount percentage that will be applied to final 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.

{"name": "ALMARC00000123",
"discountPercentage": 10
}

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

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": "ALMARC00000123",
"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"

Deployment identifier carried in onlineInstanceSeatId. The same field holds one of two identifier types, depending on the product being ordered:

Online Instance Id - identifies a 3DEXPERIENCE platform instance deployed for the customer (for example R1122334455667). Used for 3DS platform products.
Seat Id - identifies a SolidWorks Standalone or Network licensing seat (for example 5622498). Applies to SolidWorks products regardless of on-cloud or on-premise deployment.

Partners supply a non-empty value when ordering on an existing Online Instance or Seat Id. Leave empty or omit when a new Online Instance or Seat Id will be resolved during batch processing for this request.

The identifier is a combination of letters and numbers (maxLength 15).

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.

Waiver by duration (object) or Waiver by endDate (object)

Waiver information for the license charge.

Mutually Exclusive: Only one of duration or endDate may be provided.
If neither is provided, no waiver is applied (default behavior).
If both are provided, the request/response is invalid.

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
},
"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": "ALMARC00000123",
"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

Example: "DOE, John"

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.

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 <= 60 characters

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.
Must be a string with a maximum length of 60 characters.

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 Dassault Systèmes 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.

Format: ISO 8601 format (YYYY-MM-DD)

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 when creating an order request.

Business rule – When submitting a Create Order Request, processing of opportunityId depends on the Business Unit identified by businessUnitId:

CPE – opportunityId is mandatory in the request JSON. The value must reference a valid sales opportunity in My Sales Pipeline.
CRE – Any opportunityId value supplied in the request JSON is ignored by the API; it is not processed or persisted even if the partner provides one.

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": "01. CLOSA (V13.2)",
"reference": "Enterprise License Agreement Q2 2024"
},
"billToContact": "DOE, John",
"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
},
"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": "ALMARC00000123",
"discountPercentage": 10
},
"inflation": {"date": "2025-07-01",
"ratio": 1.04,
"exception": "CAPL"
}
}
]
}
]
}
]

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"
}
]
}
]
}

deployment_type

string

Enum	Description
1	Public Cloud. Solution delivered on the Dassault Systèmes 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 Dassault Systèmes 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 (4.0.0)

apikeys

Generate a new API key

Authorizations:

Responses

Response samples

Orders

Search Orders

Authorizations:

query Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get Order details

Authorizations:

path Parameters

Responses

Response samples

Order Requests

Create Order Request Beta

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get Order Request Details Beta

Authorizations:

path Parameters

Responses

Response samples

Price-Lists

Get Price Lists

Authorizations:

Responses

Response samples

Products

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

Customers

Get Customers

Authorizations:

query Parameters

Responses

Response samples

Contacts

Search Contacts using various filters

Authorizations:

query Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Create Contact

Authorizations:

Request Body schema: application/jsonrequired

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

Request Body schema: application/json
required

Request Body schema: application/json
required