APIs for Dassault Systèmes Partners (0.11.0)

Download OpenAPI specification:Download

License: Dassault Systèmes 2025

APIs exposed by Dassault Systèmes to its partners and resellers.

apikeys

This section defines the operations related to API keys .

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

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

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

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

Generate a new API key

Main (production) server

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

Server for development by Partners (Non Production)

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

Server for Quality Assurance Testing (Non Production)

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

Server for preprod validation (Non Production)

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

Server for postprod validation (Non Production)

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

Generate a new API key and its hash.

Authorizations:

API Key: ApiKeyAuth

Responses

Response samples

200
401
403
429

Content type

application/json

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

orders

This section defines the operations related to orders, including the creation, management, and fulfillment of orders.

It provides a comprehensive overview of the order lifecycle, from initial request to final delivery.

The operations in this section are designed to support the efficient and effective management of orders, ensuring that customers receive their products or services in a timely and satisfactory manner.

The following operations are included in this section:

Searching Orders
Getting Order Details

Search Orders using various filters

Main (production) server

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

Server for development by Partners (Non Production)

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

Server for Quality Assurance Testing (Non Production)

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

Server for preprod validation (Non Production)

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

Server for postprod validation (Non Production)

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

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

object or 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.

object or 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.

object or object

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

installedBaseNumber

string <= 40 characters

Example: "LN00012345678"

A unique identifier for the installed base, representing the total number of software licenses that have been issued to a Final Customer. The Installed Base Number is used to determine the Final Customer's maintenance and support obligations, as well as to calculate the cost of future upgrades or renewals. This is used to track the Final Customer's software licenses and maintenance history.

onlineInstanceSeatId

string <= 15 characters

Example: "R1122334455667"

Unique identifier assigned to a 3DEXPERIENCE platform instance. It is used to identify a specific instance of the platform, which can be accessed through the cloud. This identifier is also referred to as the Online Instance ID. Additionally, it is also used as the Seat ID to identify a user's access to the instance. The Seat ID is used to manage user licenses, authenticate users, and track user activity within the instance. The Online Instance ID/Seat ID is a combination of letters and numbers.

billToPoReferences

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

Example: ["390830"]

List of partner order references.

transactionType

string

Enum	Description
PO	Purchase Order
RN	Renewal Notification

Example: "PO"

Order type (one of: PO, RN).

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

Responses

Request samples

Payload

Content type

application/json

Example

Sample request body for searching orders using a single criterion

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

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

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

Response samples

200
400
401
403
429

Content type

application/json

Example

Sample successful basic Search for orders

Sample successful basic search for orders with only 1 result.

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

Get Order details

Main (production) server

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

Server for development by Partners (Non Production)

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

Server for Quality Assurance Testing (Non Production)

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

Server for preprod validation (Non Production)

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

Server for postprod validation (Non Production)

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

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

Authorizations:

API Key: ApiKeyAuth

path Parameters

id

required

string

Example: PO_000123456789

id of the order to get details from

Responses

Response samples

Content type

application/json

Example of response for order details with line and subLine

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

price-lists

This section defines all the operations related to price lists, including the search of price lists for a specfic partner.

Retrieve Price Lists

Main (production) server

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

Server for development by Partners (Non Production)

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

Server for Quality Assurance Testing (Non Production)

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

Server for preprod validation (Non Production)

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

Server for postprod validation (Non Production)

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

Retrieves the price lists for the authenticated user.

Authorizations:

API Key: ApiKeyAuth

Responses

Response samples

200
401
403
429

Content type

application/json

Example

Successful price list search

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

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

accreditations

This section defines all the operations related to accreditations, including the search of accreditations for a specfic partner.

Retrieve Accreditations

Main (production) server

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

Server for development by Partners (Non Production)

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

Server for Quality Assurance Testing (Non Production)

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

Server for preprod validation (Non Production)

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

Server for postprod validation (Non Production)

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

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

Authorizations:

API Key: ApiKeyAuth

query Parameters

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

Responses

Response samples

200
400
401
403
429

Content type

application/json

Example

Successful accreditation search example

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

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

leads-opportunities

This section defines the operations related to leads and opportunities for sales pipeline management.

These ressources are managed with 'MySalesPipeline' application which implements Dassault Systèmes sales process called 'LEVERAGE' in accordance with the VALUE Engagement framework. LEVERAGE is an acronym that stands for Listen, Explore, Validate, Establish, Reach AGreement & Experience.

Create a lead-opportunity object

Main (production) server

https://apigw-prd.3ds.com/sales/api4partners/v0/leads-opportunities

Server for development by Partners (Non Production)

https://apigw-ppt.3ds.com/sales/api4partners/v0/leads-opportunities

Server for Quality Assurance Testing (Non Production)

https://apigw-qal.3ds.com/sales/api4partners/v0/leads-opportunities

Server for preprod validation (Non Production)

https://apigw-ptd.3ds.com/sales/api4partners/v0/leads-opportunities

Server for postprod validation (Non Production)

https://apigw-ppd.3ds.com/sales/api4partners/v0/leads-opportunities

Creates a lead-opportunity object from its attributes along with possible linked objects (contact, sales Rep)

Authorizations:

API Key: ApiKeyAuth

Request Body schema: application/json
required

request Body for creating a lead-opportunity

partnerId required	string Example: "200000000014442" Identification of partner LegalEntity in 3DS system.
required	object Core attributes of the lead-opportunity in case of creation.
required	Array of objects non-empty array of the various Offer Lines.
required	object identification of the target Customer Legal Entity
	Array of objects Customer Contact(s) informations
	Array of objects Partner Contact(s) informations

Responses

Request samples

Payload

Content type

application/json

Example

Basic Request for Creation of a lead

Minimal Request with mandatory attributes to create a lead with a single Offer Line, no customer Contact or partner contact.

{"partnerId": "200000000014442",
"leadOpportunity": {"partnerLeadOpportunityId": "PARTNER-CRM-LEAD-1A8R",
"name": "Projekt Big-Picture Topic + MBSE (STEP 1+2)",
"status": "LEAD_OPEN",
"closeDate": "2025-06-01T18:46:51.326Z",
"description": "Projekt Dashboard - Big-Picture TopicPilotprojekt",
"currency": "EUR"
},
"offerLines": [{"amount": 13800,
"offerNameId": "3DEXPERIENCE_Design/Engineering_On_Premise",
"revenueType": "UPFRONT"
}
],
"customerLegalEntity": {"name": "NEW CUSTOMER CORPORATION",
"city": "Stockdorf",
"country": "Germany"
}
}

Response samples

Content type

application/json

Response in case of a successful creation of a new leadOpportunity

{"dsLeadOpportunityId": "9YEL-Y3W56Q",
"partnerLeadOpportunityId": "PARTNER-CRM-LEAD-1A8R",
"action": "create",
"info": {"success": true,
"statusCode": 200,
"timestamp": null,
"traceId": null
},
"error": null
}

Update a lead-opportunity object

Main (production) server

https://apigw-prd.3ds.com/sales/api4partners/v0/leads-opportunities/{id}

Server for development by Partners (Non Production)

https://apigw-ppt.3ds.com/sales/api4partners/v0/leads-opportunities/{id}

Server for Quality Assurance Testing (Non Production)

https://apigw-qal.3ds.com/sales/api4partners/v0/leads-opportunities/{id}

Server for preprod validation (Non Production)

https://apigw-ptd.3ds.com/sales/api4partners/v0/leads-opportunities/{id}

Server for postprod validation (Non Production)

https://apigw-ppd.3ds.com/sales/api4partners/v0/leads-opportunities/{id}

Update a lead-opportunity (partial updates on some attributes is recommended)

Authorizations:

API Key: ApiKeyAuth

path Parameters

id

required

string

3DS id of the lead-opportunity object to update

Request Body schema: application/json
required

request Body for updating a lead-opportunity object

partnerId	string Example: "200000000014442" Identification of partner LegalEntity in 3DS system.
required	object Specific attributes of the lead-opportunity in case of update
	Array of objects array of the various Offer Lines.
	object identification of the target Customer Legal Entity
	Array of objects Customer Contact(s) informations
	Array of objects Partner Contact(s) informations

Responses

Request samples

Payload

Content type

application/json

Example

Example 1, updates status of lead.

Basic example of request body to update an existing lead-opportunity object.

{"leadOpportunity": {"partnerLeadOpportunityId": "CRM-LEAD-1234",
"status": "QUALIFIED"
}
}

Response samples

Content type

application/json

Response in case of a successful creation of a new leadOpportunity

{"info": {"success": true,
"statusCode": 200,
"timeStamp": null,
"traceId": null
},
"error": null,
"data": {"partnerLeadOpportunityId": "OPPY-12345",
"dsLeadOpportunityId": "XJSR-DZMFFT",
"action": "update"
}
}

Get details of a lead-opportunity object

Main (production) server

https://apigw-prd.3ds.com/sales/api4partners/v0/leads-opportunities/{id}

Server for development by Partners (Non Production)

https://apigw-ppt.3ds.com/sales/api4partners/v0/leads-opportunities/{id}

Server for Quality Assurance Testing (Non Production)

https://apigw-qal.3ds.com/sales/api4partners/v0/leads-opportunities/{id}

Server for preprod validation (Non Production)

https://apigw-ptd.3ds.com/sales/api4partners/v0/leads-opportunities/{id}

Server for postprod validation (Non Production)

https://apigw-ppd.3ds.com/sales/api4partners/v0/leads-opportunities/{id}

gets details of a lead-opportunity object from its 3DS identifier.

Authorizations:

API Key: ApiKeyAuth

path Parameters

id

required

string

3DS id of the lead-opportunity object for which details are requested

Responses

Response samples

Content type

application/json

Successful retrieval of an existing leadOpportunity object

{"error": null,
"info": {"success": true,
"statusCode": 200,
"timeStamp": null,
"traceId": null
},
"data": {"leadOpportunity": {"partnerLeadOpportunityId": "API4PARTNERS-0813C",
"dsLeadOpportunityId": "HCRQ-F1LLDE",
"name": "TEST-0813C",
"dsOwnerEmail": "john.doe@3ds.com",
"status": "WON",
"forecastCategory": "WON",
"closeDate": "2024-12-31T00:00:00.000Z",
"cometCampaignCode": "OC2DE17TAQ1C13018",
"competitors": null,
"reasonWon": ["STRNG_VAL_PROP"
],
"reasonLost": ["EMPTY"
],
"reasonWonLostComment": "",
"gtmTacticId": null,
"description": "",
"nextMilestone": "",
"nextMilestoneDate": "",
"currency": "EUR",
"approvalStatus": "PRE_APPROVED",
"engagementType": "EXTEND",
"poInformation": "",
"poStatus": null,
"poNumber": null,
"sboIndicator": "EMPTY",
"sboStatus": null,
"sboNumber": null,
"growthType": "EMPTY",
"leadPriority": "EMPTY",
"levelOfInterest": "EMPTY",
"dsComment": "",
"partnerImportMode": "EMPTY",
"createdDate": "2025-08-13T12:35:03.775Z",
"modifiedDate": "2025-08-13T15:44:44.453Z",
"offerLines": [{"amount": 10000,
"offerNameId": "MDMIND00022_PUBL_ISE00002687_IPE00021337",
"revenueType": "UPFRONT"
},
{"amount": 11,
"offerNameId": "MDMIND00022_PUBL_ISE00002687_IPE00021337",
"revenueType": "RENTAL_BOOKING"
}
],
"customerContact": [{"phoneNumber": "9658252499",
"salutation": "MR",
"jobTitle": "",
"email": "dummy123_mail@mail.com",
"firstName": "F Name1",
"lastName": "L_Name2"
}
],
"partnerContact": null,
"customerLegalEntity": {"id": "200000000781989",
"dunsNumber": null,
"vatNumber": null,
"registrationId": null,
"name": null,
"city": null,
"country": null,
"addressLine1": null,
"statePrefecture": null,
"addressLine2": null,
"zipCode": null,
"websiteUrl": null
}
}
}
}

Search for leads-opportunities

Main (production) server

https://apigw-prd.3ds.com/sales/api4partners/v0/leads-opportunities/search

Server for development by Partners (Non Production)

https://apigw-ppt.3ds.com/sales/api4partners/v0/leads-opportunities/search

Server for Quality Assurance Testing (Non Production)

https://apigw-qal.3ds.com/sales/api4partners/v0/leads-opportunities/search

Server for preprod validation (Non Production)

https://apigw-ptd.3ds.com/sales/api4partners/v0/leads-opportunities/search

Server for postprod validation (Non Production)

https://apigw-ppd.3ds.com/sales/api4partners/v0/leads-opportunities/search

Searches for leads-opportunities using various search criteria (e.g. modifiedDate)

Authorizations:

API Key: ApiKeyAuth

Request Body schema: application/json
required

Request Body for searching leads-opportunities.

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

modifiedDate
partnerLeadOpportunityId

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

required

Array of objects or objects

Array

Any of

required

object

Search criterion on the last modification date/time of the leads-opportunities.

The maximum time window allowed for the search is 1 week / 7 days (between fromDateand toDate, calculated time to time). Both lower (fromDate) and upper (toDate) bounds need to be provided as no implict range calculation is done. Lower and upper bounds need to be consistent : fromDate has to be anterior to toDate.

partnerLeadOpportunityId

Array of arrays or strings or string

Examples: "PARTNER-ID-1234" ""

Search criterion on the id of the leads-opportunities as defined in partner CRM System.

This search criterion can be used for 2 main use cases :

Exact search for a particular lead-opportunitity id from Partner CRM system.
- Set the exact id searched for (e.g "PARTNER-ID-1234")
Retrieval of all leads-opportunitities that do not have a partnerLeadOpportunityId defined in 3DS CRM application (MySalesPipeline).
- These are typically marketing leads on which update by Partner could be required.
- Simply set an empty string ("")

Responses

Request samples

Payload

Content type

application/json

Example

search on modifiedDate criterion

Sample BodyRequest to search leads-opportunities based on 'modifiedDate' criterion.

{"data": [{"modifiedDate": {"fromDate": "2025-08-04T08:00:00Z",
"toDate": "2025-08-08T18:00:00Z"
}
}
]
}

Response samples

Content type

application/json

Sample response for successful search.

{"info": {"success": true,
"statusCode": 200,
"timeStamp": "2025-08-08T16:36:23Z",
"traceId": "785594df0cbd4f149d0ffbd7e0933820"
},
"error": null,
"data": [{"dsLeadOpportunityId": ["1FFC-7BQC5E",
"BYTK-COL4A0",
"5KSL-VLSWRX"
]
}
]
}

portfolio-items

This section defines the operations related to sales portfolio-items.

The portfolio items are used in the definition of leads-opportunities in 'MySalesPipeline' application.

Search Sales portfolio items

Main (production) server

https://apigw-prd.3ds.com/sales/api4partners/v0/portfolio-items/search

Server for development by Partners (Non Production)

https://apigw-ppt.3ds.com/sales/api4partners/v0/portfolio-items/search

Server for Quality Assurance Testing (Non Production)

https://apigw-qal.3ds.com/sales/api4partners/v0/portfolio-items/search

Server for preprod validation (Non Production)

https://apigw-ptd.3ds.com/sales/api4partners/v0/portfolio-items/search

Server for postprod validation (Non Production)

https://apigw-ppd.3ds.com/sales/api4partners/v0/portfolio-items/search

Search Sales Portfolio Items. For now, no particular search criteria is offered, only pagination with skip & top query parameters.

Authorizations:

API Key: ApiKeyAuth

query Parameters

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

Responses

Response samples

200
400
401
403
429

Content type

application/json

Successful search in portfolio items (with top=1)

{"info": {"success": true,
"statusCode": 200,
"estimatedSearchCount": 3049,
"timeStamp": "2025-08-14T06:24:04.000Z"
},
"data": [{"salesPortfolioType": "Brand",
"salesPortfolioInfrastructure": "On Premise",
"salesPortfolioisOrderable": true,
"salesPortfolioLevel1": "CATIA",
"salesPortfolioLevel2": "CATIA V4",
"salesPortfolioLevel3": "MANUFACTURING",
"salesPortfolioId": "CLASS00001_ONPR_CATIAV4_SOL000038"
}
]
}

Schemas

date_time_from

string <date-time>

This property represents a timestamp in UTC format, following the ISO 8601 standard. All date-time values must be provided in Coordinated Universal Time (UTC). The timestamp must not be set in the future. If not provided, the system will automatically calculate it by subtracting the maximum number of days specified for the time range defined for the parent search criteria.

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

date_time_to

string <date-time>

This property represents a timestamp in UTC format, following the ISO 8601 standard. All date-time values must be provided in Coordinated Universal Time (UTC). If the from timestamp is specified, this value must be later than from. If not provided, the system will automatically calculate this value by adding the maximum number of days specified for the time range defined for the parent search criteria.

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

installed_base_number

string <= 40 characters

A unique identifier for the installed base, representing the total number of software licenses that have been issued to a Final Customer. The Installed Base Number is used to determine the Final Customer's maintenance and support obligations, as well as to calculate the cost of future upgrades or renewals. This is used to track the Final Customer's software licenses and maintenance history.

"LN00012345678"

online_instance_seat_id

string <= 15 characters

Unique identifier assigned to a 3DEXPERIENCE platform instance. It is used to identify a specific instance of the platform, which can be accessed through the cloud. This identifier is also referred to as the Online Instance ID. Additionally, it is also used as the Seat ID to identify a user's access to the instance. The Seat ID is used to manage user licenses, authenticate users, and track user activity within the instance. The Online Instance ID/Seat ID is a combination of letters and numbers.

"R1122334455667"

transaction_type

string

Enum	Description
PO	Purchase Order
RN	Renewal Notification

Order type (one of: PO, RN).

"PO"

orders_search_req

Any of

required

object or 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.

object or 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.

object or object

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

installedBaseNumber

string <= 40 characters

Example: "LN00012345678"

A unique identifier for the installed base, representing the total number of software licenses that have been issued to a Final Customer. The Installed Base Number is used to determine the Final Customer's maintenance and support obligations, as well as to calculate the cost of future upgrades or renewals. This is used to track the Final Customer's software licenses and maintenance history.

onlineInstanceSeatId

string <= 15 characters

Example: "R1122334455667"

Unique identifier assigned to a 3DEXPERIENCE platform instance. It is used to identify a specific instance of the platform, which can be accessed through the cloud. This identifier is also referred to as the Online Instance ID. Additionally, it is also used as the Seat ID to identify a user's access to the instance. The Seat ID is used to manage user licenses, authenticate users, and track user activity within the instance. The Online Instance ID/Seat ID is a combination of letters and numbers.

billToPoReferences

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

Example: ["390830"]

List of partner order references.

transactionType

string

Enum	Description
PO	Purchase Order
RN	Renewal Notification

Example: "PO"

Order type (one of: PO, RN).

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

{"creationDateTime": {"from": "2024-05-21T14:30:00Z",
"to": "2024-05-22T14:30:00Z"
},
"bookingDateTime": {"from": "2024-05-21T14:30:00Z",
"to": "2024-05-22T14:30:00Z"
},
"lastUpdateDateTime": {"from": "2024-05-21T14:30:00Z",
"to": "2024-05-22T14:30:00Z"
},
"installedBaseNumber": "LN00012345678",
"onlineInstanceSeatId": "R1122334455667",
"billToPoReferences": ["390830"
],
"transactionType": "PO"
}

order_processing_status

string

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

… 20 more

Current processing status of the order.

"Sales Approved"

transaction

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
Cancelled	The order has been cancelled and is no longer valid.
Claim to be Managed	The order is being claimed by a different entity for management.
Consent Refused	The Final Customer has refused to provide consent for the order.
Discarded	The order has been discarded and is no longer valid.

… 20 more

Example: "Sales Approved"

Current processing status of the order.

description

string <= 30 characters

Example: "XYZ Company Order 50 products"

Short description given to the Purchase Order / Renewal Notification.

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

local_time_zone

string

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

… 24 more

Time zone abbreviation used by the sales business unit.

"CET"

business_unit

id

required

string = 5 characters

Example: "BU001"

Unique identifier of the sales business unit.

name

required

string <= 25 characters

Example: "Corporate Sales Unit A"

Name of the sales business unit.

localTimezone

required

string

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

… 24 more

Example: "CET"

Time zone abbreviation used by the sales business unit.

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

legal_entity

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

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

creation_datetime

string <date-time>

UTC timestamp when the order was created in the system.

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

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

ds_received_po_date

string <date>

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

"2025-05-21"

booking_datetime

string <date-time>

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

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

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

currency

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

Three-letter ISO 4217 currency code representing the transaction currency.

Must be exactly 3 uppercase alphabetic characters (e.g., USD for US Dollar, EUR for Euro, INR for Indian Ruppee).

"USD"

online_consent_status

string

Default: ""

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

… 2 more

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

"Accepted"

billto_sales_representative

string

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

"DOE, Jane"

billto_po_reference

string

Identifier of the order as recorded in the Bill To site's ordering system.

If available, this reference will also appear on the Dassault Systèmes invoice.

"EXAMPLE-CORP-20250518"

orders_search_data

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)

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
Accepted	The online consent request has been successfully accepted by the designated contact.
Expired	The online consent request has expired and is no longer valid.
Not Applicable	The online consent request is not applicable to the current situation or context.
Not Requested	The online consent request has not been sent to the designated contact.

… 2 more

Example: "Accepted"

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

billToSalesRepresentative

string

Example: "DOE, Jane"

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

billToPoReference

string

Example: "EXAMPLE-CORP-20250518"

Identifier of the order as recorded in the Bill To site's ordering system.

If available, this reference will also appear on the Dassault Systèmes invoice.

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

info

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

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

error

Array

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

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

200_post_orders_search

required	Array of objects List of orders retrieved during the search operation.
required	object Metadata section of the response providing execution status and result summary.
	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": [{"transaction": {"id": "PO_A123456789",
"type": "PO",
"status": "Sales Approved",
"description": "XYZ Company Order 50 products"
},
"businessUnit": {"id": "BU001",
"name": "Corporate Sales Unit A",
"localTimezone": "CET"
},
"billToSite": {"id": "100012345678901",
"name": "Example Corporation",
"localName": "示例公司",
"locationId": 2
},
"soldToSite": {"id": "100012345678901",
"name": "Example Corporation",
"localName": "示例公司",
"locationId": 2
},
"creationDateTime": "2025-05-21T14:30:00Z",
"dsReceivedPoDate": "2025-05-21",
"bookingDateTime": "2025-05-29T18:00:00Z",
"currency": "USD",
"onlineConsentStatus": "Accepted",
"billToSalesRepresentative": "DOE, Jane",
"billToPoReference": "EXAMPLE-CORP-20250518"
}
],
"info": {"success": true,
"statusCode": 0,
"estimatedSearchCount": 0
},
"error": [{"type": "errors:3dx:invalidRequest",
"title": "string",
"errors": [{"detail": "string",
"pointer": "string"
}
]
}
]
}

400_post_orders_search

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

401_basic_unauthorized

message

required

string

{"message": "string"
}

403_basic_forbidden

message

required

string

{"message": "string"
}

429_too_many_requests

message

required

string

{"message": "string"
}

recurring_charge_billing_cycle

string

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

… 6 more

Identifies how often invoices are sent for ALC and ASC licenses. In the event of prorating (to an anniversary date, in the first month, or in the first quarter) or cancellation and refund or overpayment, the prorate calculation is based on 30 day months.

"Calendar Year"

order_type

string

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

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

"Stop - Transform"

sub_order_type

string

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

… 15 more

sub Order Type

"New License"

order_revenue_type

string

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

… 16 more

"ALC"

product_type

string

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

… 11 more

Type of the product.

"Named User"

ds_offering

string

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

… 2 more

Dassault Systèmes offering Type

"Licensed Program"

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

… 15 more

Example: "New License"

sub Order Type

revenueType

string

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

… 16 more

Example: "ALC"

portfolio

string <= 50 characters

Example: "CATIA"

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

release

string <= 50 characters

Example: "3DEXPERIENCE R2025x"

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

object

This field identifies the specific product that is being ordered.

quantity

integer >= 1

Example: "2"

The quantity of the product being ordered.

unitListPrice

number <float>

Example: "1000"

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

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

totalListPrice

number <float>

Example: "2000"

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

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

billToNetAmount

number <float>

Example: "1930"

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

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

billToAnnualAmount

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 Bill To Net Amount and Bill To Annual Amount when the product is not purchased for a full year of usage.

billToDiscountPercentage

number <float>

Example: "3.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. 3.5 represents 3.5%).

billToMarginPercentage

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.

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

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

maximumCustomerNetAmount

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.

maximumCustomerAnnualAmount

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 Maximum Customer Net Amount and Maximum Customer Annual Amount when the product is not purchased for a full year of usage.

minimumCustomerDiscountPercentage

number <float>

Example: "0.5"

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

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

startDate

string <date>

Example: "2025-06-01"

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

endDate

string

Example: "2026-05-31"

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

duration

integer

Example: "2"

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

The unit of duration depends on the Revenue Type:

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

calculatedStartDate

string <date>

Example: "2025-06-01"

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

It is based on one of the following dates:

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

calculatedEndDate

string <date>

Example: "2026-06-30"

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

It is based on one of the following values:

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

yearNumber

integer

Example: "1"

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

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

object

Details of the discount coupon applied to the final price.

object

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

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

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"

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

onlineInstanceSeatId

string <= 15 characters

Example: "R1122334455667"

Unique identifier assigned to a 3DEXPERIENCE platform instance. It is used to identify a specific instance of the platform, which can be accessed through the cloud. This identifier is also referred to as the Online Instance ID. Additionally, it is also used as the Seat ID to identify a user's access to the instance. The Seat ID is used to manage user licenses, authenticate users, and track user activity within the instance. The Online Instance ID/Seat ID is a combination of letters and numbers.

orderType

string

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

… 27 more

Example: "Stop - Transform"

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

usageScope

string <= 80 characters

Example: "GEO EMEA"

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

object

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

object or object

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

Array of objects

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

order_get_data

Array

required

object

Transactional details of the order.

required

object

Details of the sales business unit.

required

object

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

required

object

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

required

object

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

billToContact

string

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

creationDateTime

required

string <date-time>

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

UTC timestamp when the order was created in the system.

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

dsReceivedPoDate

string <date>

Example: "2025-05-21"

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

bookingDateTime

string <date-time>

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

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

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

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
Accepted	The online consent request has been successfully accepted by the designated contact.
Expired	The online consent request has expired and is no longer valid.
Not Applicable	The online consent request is not applicable to the current situation or context.
Not Requested	The online consent request has not been sent to the designated contact.

… 2 more

Example: "Accepted"

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

billToSalesRepresentative

string

Example: "DOE, Jane"

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

billToPoReference

string

Example: "EXAMPLE-CORP-20250518"

Identifier of the order as recorded in the Bill To site's ordering system.

If available, this reference will also appear on the Dassault Systèmes invoice.

sboNumber

string <= 10 characters

Example: "ABC0012345"

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

customerRequestedArrivalDate

string <date>

Example: "2025-05-31"

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

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

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

dsSalesRepresentative

string

Example: "DOE, John"

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

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

isMultiYear

boolean

Example: "true"

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

hasExitClause

boolean

Example: "true"

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

recurringChargeBillingCycle

string

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

… 6 more

Example: "Calendar Year"

Identifies how often invoices are sent for ALC and ASC licenses. In the event of prorating (to an anniversary date, in the first month, or in the first quarter) or cancellation and refund or overpayment, the prorate calculation is based on 30 day months.

opportunity

string

Example: "A1B2-C3D4E5"

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

paymentTerms

string <= 50 characters

Example: "Net Date of Invoice + 60 days"

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

Array of objects

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

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

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

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

200_get_orders

required	Array of objects List of orders retrieved during the search operation.
required	object Metadata section of the response providing execution status and result summary.
	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": [{"transaction": {"id": "PO_A123456789",
"type": "PO",
"status": "Sales Approved",
"description": "XYZ Company Order 50 products"
},
"businessUnit": {"id": "BU001",
"name": "Corporate Sales Unit A",
"localTimezone": "CET"
},
"billToSite": {"id": "100012345678901",
"name": "Example Corporation",
"localName": "示例公司",
"locationId": 2
},
"soldToSite": {"id": "100012345678901",
"name": "Example Corporation",
"localName": "示例公司",
"locationId": 2
},
"agreement": {"type": "General VAR Agreement",
"reference": "Enterprise License Agreement Q2 2024"
},
"billToContact": "string",
"creationDateTime": "2025-05-21T14:30:00Z",
"dsReceivedPoDate": "2025-05-21",
"bookingDateTime": "2025-05-29T18:00:00Z",
"currency": "USD",
"onlineConsentStatus": "Accepted",
"billToSalesRepresentative": "DOE, Jane",
"billToPoReference": "EXAMPLE-CORP-20250518",
"sboNumber": "ABC0012345",
"customerRequestedArrivalDate": "2025-05-31",
"dsSalesRepresentative": "DOE, John",
"isMultiYear": true,
"hasExitClause": true,
"recurringChargeBillingCycle": "Calendar Year",
"opportunity": "A1B2-C3D4E5",
"paymentTerms": "Net Date of Invoice + 60 days",
"licenseChargeConditions": [{"sequenceNumber": 1,
"lineGroup": "SBL0001234567",
"onlineInstanceSeatId": "R1122334455667",
"orderType": "Stop - Transform",
"usageScope": "GEO EMEA",
"promotion": {"id": "PAO0000111",
"name": "3DEXPERIENCE for small and medium business",
"combination": "Collaborative Design & Engineering Learning @Home"
},
"waiver": {"duration": 1,
"endDate": "2025-05-30"
},
"licenseChargeBreakdown": [{"sequenceNumber": 1,
"installedBaseNumber": "LN00012345678",
"subOrderType": "New License",
"revenueType": "ALC",
"portfolio": "CATIA",
"release": "3DEXPERIENCE R2025x",
"product": {"trigram": "XYZ",
"type": "Named User",
"number": "1AB-XYZ",
"name": "Generic Product Standard with Cloud Services",
"dsOffering": "Licensed Program"
},
"quantity": 2,
"unitListPrice": 1000,
"totalListPrice": 2000,
"billToNetAmount": 1930,
"billToAnnualAmount": 1930,
"billToDiscountPercentage": 3.5,
"billToMarginPercentage": 1.5,
"maximumCustomerNetAmount": 1958.95,
"maximumCustomerAnnualAmount": 1958.95,
"minimumCustomerDiscountPercentage": 0.5,
"startDate": "2025-06-01",
"endDate": "2026-05-31",
"duration": 2,
"calculatedStartDate": "2025-06-01",
"calculatedEndDate": "2026-06-30",
"yearNumber": 1,
"coupon": {"name": "10% off on Installation Fee",
"discountPercentage": 10
},
"inflation": {"date": "2025-07-01",
"ratio": 1.04,
"exception": "Capping To Price List"
}
}
]
}
]
}
],
"info": {"success": true,
"statusCode": 0,
"estimatedSearchCount": 0
},
"error": [{"type": "errors:3dx:invalidRequest",
"title": "string",
"errors": [{"detail": "string",
"pointer": "string"
}
]
}
]
}

4xx_get_orders

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

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

country_code

string

ISO3 Code (3 capital letters code) of the country

"FRA"

country_name

string

Country Location

"France"

price-lists_search_data

Array

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

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

200_price-lists_search

required	Array of objects List of Products and Industry Process Experiences (IPE) that the authorized user is accredited to sell.
required	object Metadata section of the response providing execution status and result summary.
	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": [{"countryCode": "FRA",
"countryName": "France",
"priceLists": [{"id": 9,
"name": "EMEA Price List",
"currency": "USD",
"hasFuturePriceList": true,
"effectiveDate": "2025-09-09"
}
]
}
],
"info": {"success": true,
"statusCode": 0,
"estimatedSearchCount": 0
},
"error": [{"type": "errors:3dx:invalidRequest",
"title": "string",
"errors": [{"detail": "string",
"pointer": "string"
}
]
}
]
}

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

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

deploymentType

string

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

object

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

object

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

object

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

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

200_accreditations_search

required	Array of objects List of accreditations retrieved during the search operation.
required	object Metadata section of the response providing execution status and result summary.
	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": [{"id": "IPE00034863",
"name": "04-Continuous Product Development",
"accreditationType": "Industry Process Experience",
"deploymentType": "On Premise",
"industrySolutionExperience": {"id": "ISE00004588",
"name": "Engineered to Fly"
},
"solutionRelease": {"id": "REL00000051",
"name": "3DEXPERIENCE R2024x"
},
"industry": {"id": "IND000005",
"name": "Aerospace & Defense"
}
}
],
"info": {"success": true,
"statusCode": 0,
"estimatedSearchCount": 0
},
"error": [{"type": "errors:3dx:invalidRequest",
"title": "string",
"errors": [{"detail": "string",
"pointer": "string"
}
]
}
]
}

400_accreditations_search

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

200_post_apikeys

hashed_key required	string = 60 characters Example: "$2b$12$8tcF4MTIDcup3WEo8fFSieGIYEnp/DTLHSTivUCcW2II/VVwRI9Qm" Generated hash of the API key (60 characters)
api_key required	string = 64 characters Example: "5839bcfabb9e0d20f889f366dbfbbe2973c152cfbe91fae728a9f7e662ce1a2d" Plain API key (64 characters)

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

partnerLeadOpportunityId

string

Unique Identifier of the lead-opportunity in the CRM system of the 3DS partner.

"OPPY-1004526"

dsOwnerEmail

string

email of the 3DS Partner Sales Manager (PSM).

Note : It is defaulted to the primary 3DS PSM if not provided at creation time.

"john.doe@3ds.com"

lead-opportunity-status

string

Enum	Description
LEAD_OPEN	-6 Open
QUALIFIED	-5 Qualified
ACCEPTED	-4 Accepted
OPPY_OPEN	-3 Open

… 4 more

Status of the lead-opportunity (LEVERAGE Processs)

"LEAD_OPEN"

forecastCategory

string

Enum	Description
UPSIDE	One or more major risks of closing business by the close date, however the customer stated an intention, as represented in the Win Plan, to place an order by the specified Close Date.
COMMIT	Commitment that this Opportunity will be won by the close date. All key steps to close by the close date have been agreed upon with the customer and there are no known major risks.
SAFE	The Purchase Order and agreements signed by the customer are received by 3DS, are being reviewed by Sales Operations and have been submitted to Finance.
WON	The signed Statement of work and Purchase Order are approved (by Finance)

… 3 more

Forecast Category is an assessment done by the Sales Expert to report his/her level of confidence that the Opportunity will close on the Close Date with the revenue amounts defined. Value is ignored at creation if status is ‘LEAD_OPEN’,’QUALIFIED’ or ’ACCEPTED’. if value is not provided at creation time, it defaults based on the following matrix :

status	default forecastCategory	forecastCategory values
-3 Open	Upside	Safe/Commit/Upside/Longshot
-2 validated	Upside	Safe/Commit/Upside/Longshot
-1 Established	Upside	Safe/Commit/Upside/Longshot
Won	Won	Won (set by the system)
Lost	Lost	Lost (set by the system)

"UPSIDE"

reason_won

string

Enum	Description
SOLUTION_FUNCT	Solution functionality
STRNG_VAL_PROP	Stronger value proposition
LWR_CST_OF_OWNRSHIP	Lower costs of ownership
LWR_IMPL_COST	Lower implementation costs

… 10 more

Identification of the reason a lead or an opportunity is won.

Note : At Creation time, if Value is Not provided, it will be defaulted to 'STRNG_VAL_PROP' (Stronger value proposition).

"STRNG_VAL_PROP"

reason_lost

string

Enum	Description
BETTER_COMP_OFFER	Better competition offer
CLIENT_DOES_NOT_SEE_VALUE	Client does not see value
LACK_OR_LOSS_OF_CHAMPION	Lack or loss of Champion
FUNC_GAP	Functional gap

… 39 more

A list of reason lost is used to identify the reason(s) for loss of an opportunity and for a Lead (which will give insight for the lessons learnt). Note : It is defaulted to No Project if value is Not provided during creation of the lead-opportunity.

"CLIENT_HAS_NO_MORE_BUDGET"

lead-opportunity_attributes

partnerLeadOpportunityId

string

Example: "OPPY-1004526"

Unique Identifier of the lead-opportunity in the CRM system of the 3DS partner.

name

string

Example: "Projekt Big-Picture Topic + MBSE (STEP 1+2)"

Name assigned to the lead-opportunity

dsOwnerEmail

string

Example: "john.doe@3ds.com"

email of the 3DS Partner Sales Manager (PSM).

Note : It is defaulted to the primary 3DS PSM if not provided at creation time.

status

string

Enum	Description
LEAD_OPEN	-6 Open
QUALIFIED	-5 Qualified
ACCEPTED	-4 Accepted
OPPY_OPEN	-3 Open

… 4 more

Example: "LEAD_OPEN"

Status of the lead-opportunity (LEVERAGE Processs)

forecastCategory

string

Enum	Description
UPSIDE	One or more major risks of closing business by the close date, however the customer stated an intention, as represented in the Win Plan, to place an order by the specified Close Date.
COMMIT	Commitment that this Opportunity will be won by the close date. All key steps to close by the close date have been agreed upon with the customer and there are no known major risks.
SAFE	The Purchase Order and agreements signed by the customer are received by 3DS, are being reviewed by Sales Operations and have been submitted to Finance.
WON	The signed Statement of work and Purchase Order are approved (by Finance)

… 3 more

Example: "UPSIDE"

Forecast Category is an assessment done by the Sales Expert to report his/her level of confidence that the Opportunity will close on the Close Date with the revenue amounts defined. Value is ignored at creation if status is ‘LEAD_OPEN’,’QUALIFIED’ or ’ACCEPTED’. if value is not provided at creation time, it defaults based on the following matrix :

status	default forecastCategory	forecastCategory values
-3 Open	Upside	Safe/Commit/Upside/Longshot
-2 validated	Upside	Safe/Commit/Upside/Longshot
-1 Established	Upside	Safe/Commit/Upside/Longshot
Won	Won	Won (set by the system)
Lost	Lost	Lost (set by the system)

closeDate

string <date-time>

Example: "2025-08-01T18:03:16.325Z"

Expected date for the closing of the sale in ISO 8601 format (like YYYY-MM-DDThh:mm:ss.sssZ)

cometCampaignCode

string

Example: "OC2DE17TAQ1C13018"

COMET Campaign code

reasonWon

Array of strings

Items Enum	Description
SOLUTION_FUNCT	Solution functionality
STRNG_VAL_PROP	Stronger value proposition
LWR_CST_OF_OWNRSHIP	Lower costs of ownership
LWR_IMPL_COST	Lower implementation costs

… 10 more

Example: ["STRNG_VAL_PROP"]

Identification of the reason a lead or an opportunity is won.

Note : At creation time, if value is not provided, it will be defaulted to STRNG_VAL_PROP (Stronger value proposition).

reasonLost

Array of strings

Items Enum	Description
BETTER_COMP_OFFER	Better competition offer
CLIENT_DOES_NOT_SEE_VALUE	Client does not see value
LACK_OR_LOSS_OF_CHAMPION	Lack or loss of Champion
FUNC_GAP	Functional gap

… 39 more

Example: ["CLIENT_HAS_NO_MORE_BUDGET"]

A list of reason lost is used to identify the reason(s) for loss of an opportunity and for a Lead (which will give insight for the lessons learnt).

Note : At creation time, if value is not provided, it will be defaulted to NO_PROJECT.

competitors

Array of strings

List of the competitors. In current state of the API, the list of valid values will be provided through direct communication with partners (mail or 3DSwym discussion).

reasonWonLostComment

string

Example: "The Customer has no budget"

Comment associated to WON or LOST reasons

gtmTacticId

string

identification of GoToMarket.

description

string

Example: "Projekt Dashboard - Big-Picture TopicPilotprojekt"

description associated to the lead-opportunity

nextMilestone

string

Example: "Next activity is to make a demo to the Customer"

Description of the next activity to be done

nextMilestoneDate

string <date-time>

Example: "2025-08-01T18:03:16.325Z"

Next Milestone date in ISO 8601 format (like YYYY-MM-DDThh:mm:ss.sssZ)

currency

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

{"partnerLeadOpportunityId": "OPPY-1004526",
"name": "Projekt Big-Picture Topic + MBSE (STEP 1+2)",
"dsOwnerEmail": "john.doe@3ds.com",
"status": "LEAD_OPEN",
"forecastCategory": "UPSIDE",
"closeDate": "2025-08-01T18:03:16.325Z",
"cometCampaignCode": "OC2DE17TAQ1C13018",
"reasonWon": ["STRNG_VAL_PROP"
],
"reasonLost": ["CLIENT_HAS_NO_MORE_BUDGET"
],
"competitors": ["string"
],
"reasonWonLostComment": "The Customer has no budget",
"gtmTacticId": "string",
"description": "Projekt Dashboard - Big-Picture TopicPilotprojekt",
"nextMilestone": "Next activity is to make a demo to the Customer",
"nextMilestoneDate": "2025-08-01T18:03:16.325Z",
"currency": "USD"
}

lead-opportunity_post

partnerLeadOpportunityId

required

string

Example: "OPPY-1004526"

Unique Identifier of the lead-opportunity in the CRM system of the 3DS partner.

name

required

string

Example: "Projekt Big-Picture Topic + MBSE (STEP 1+2)"

Name assigned to the lead-opportunity

dsOwnerEmail

string

Example: "john.doe@3ds.com"

email of the 3DS Partner Sales Manager (PSM).

Note : It is defaulted to the primary 3DS PSM if not provided at creation time.

status

required

string

Enum	Description
LEAD_OPEN	-6 Open
QUALIFIED	-5 Qualified
ACCEPTED	-4 Accepted
OPPY_OPEN	-3 Open

… 4 more

Example: "LEAD_OPEN"

Status of the lead-opportunity (LEVERAGE Processs)

forecastCategory

string

Enum	Description
UPSIDE	One or more major risks of closing business by the close date, however the customer stated an intention, as represented in the Win Plan, to place an order by the specified Close Date.
COMMIT	Commitment that this Opportunity will be won by the close date. All key steps to close by the close date have been agreed upon with the customer and there are no known major risks.
SAFE	The Purchase Order and agreements signed by the customer are received by 3DS, are being reviewed by Sales Operations and have been submitted to Finance.
WON	The signed Statement of work and Purchase Order are approved (by Finance)

… 3 more

Example: "UPSIDE"

Forecast Category is an assessment done by the Sales Expert to report his/her level of confidence that the Opportunity will close on the Close Date with the revenue amounts defined. Value is ignored at creation if status is ‘LEAD_OPEN’,’QUALIFIED’ or ’ACCEPTED’. if value is not provided at creation time, it defaults based on the following matrix :

status	default forecastCategory	forecastCategory values
-3 Open	Upside	Safe/Commit/Upside/Longshot
-2 validated	Upside	Safe/Commit/Upside/Longshot
-1 Established	Upside	Safe/Commit/Upside/Longshot
Won	Won	Won (set by the system)
Lost	Lost	Lost (set by the system)

closeDate

required

string <date-time>

Example: "2025-08-01T18:03:16.325Z"

Expected date for the closing of the sale in ISO 8601 format (like YYYY-MM-DDThh:mm:ss.sssZ)

cometCampaignCode

string

Example: "OC2DE17TAQ1C13018"

COMET Campaign code

reasonWon

Array of strings

Items Enum	Description
SOLUTION_FUNCT	Solution functionality
STRNG_VAL_PROP	Stronger value proposition
LWR_CST_OF_OWNRSHIP	Lower costs of ownership
LWR_IMPL_COST	Lower implementation costs

… 10 more

Example: ["STRNG_VAL_PROP"]

Identification of the reason a lead or an opportunity is won.

Note : At creation time, if value is not provided, it will be defaulted to STRNG_VAL_PROP (Stronger value proposition).

reasonLost

Array of strings

Items Enum	Description
BETTER_COMP_OFFER	Better competition offer
CLIENT_DOES_NOT_SEE_VALUE	Client does not see value
LACK_OR_LOSS_OF_CHAMPION	Lack or loss of Champion
FUNC_GAP	Functional gap

… 39 more

Example: ["CLIENT_HAS_NO_MORE_BUDGET"]

A list of reason lost is used to identify the reason(s) for loss of an opportunity and for a Lead (which will give insight for the lessons learnt).

Note : At creation time, if value is not provided, it will be defaulted to NO_PROJECT.

competitors

Array of strings

List of the competitors. In current state of the API, the list of valid values will be provided through direct communication with partners (mail or 3DSwym discussion).

reasonWonLostComment

string

Example: "The Customer has no budget"

Comment associated to WON or LOST reasons

gtmTacticId

string

identification of GoToMarket.

description

string

Example: "Projekt Dashboard - Big-Picture TopicPilotprojekt"

description associated to the lead-opportunity

nextMilestone

string

Example: "Next activity is to make a demo to the Customer"

Description of the next activity to be done

nextMilestoneDate

string <date-time>

Example: "2025-08-01T18:03:16.325Z"

Next Milestone date in ISO 8601 format (like YYYY-MM-DDThh:mm:ss.sssZ)

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

{"partnerLeadOpportunityId": "OPPY-1004526",
"name": "Projekt Big-Picture Topic + MBSE (STEP 1+2)",
"dsOwnerEmail": "john.doe@3ds.com",
"status": "LEAD_OPEN",
"forecastCategory": "UPSIDE",
"closeDate": "2025-08-01T18:03:16.325Z",
"cometCampaignCode": "OC2DE17TAQ1C13018",
"reasonWon": ["STRNG_VAL_PROP"
],
"reasonLost": ["CLIENT_HAS_NO_MORE_BUDGET"
],
"competitors": ["string"
],
"reasonWonLostComment": "The Customer has no budget",
"gtmTacticId": "string",
"description": "Projekt Dashboard - Big-Picture TopicPilotprojekt",
"nextMilestone": "Next activity is to make a demo to the Customer",
"nextMilestoneDate": "2025-08-01T18:03:16.325Z",
"currency": "USD"
}

revenueType

string

Enum	Description
UPFRONT	Upfront
RENTAL_BOOKING	Rental Booking
SUPPORT_SERVICES	Support Services
SERVICES_SIGNING	Services Signing

… 1 more

The type of revenue

"UPFRONT"

offerLine

amount

number

Example: "13000"

Amount of the offer in the desgnated currency

offerNameId

required

string

Example: "MDMIND00022_PUBL_ISE00002687_IPE00021337"

Identification of the Offer.
Note: : In current state of the API, the list of valid values will be communicated directly to 3DS Partners via email or within 3DS Partner Swym Community.

revenueType

string

Enum	Description
UPFRONT	Upfront
RENTAL_BOOKING	Rental Booking
SUPPORT_SERVICES	Support Services
SERVICES_SIGNING	Services Signing

… 1 more

Example: "UPFRONT"

The type of revenue

{"amount": 13000,
"offerNameId": "MDMIND00022_PUBL_ISE00002687_IPE00021337",
"revenueType": "UPFRONT"
}

country

null or string

Country Location

"France"

customerLegalEntity

id	string or null Example: "200000000029188" 3DS site identifier
dunsNumber	string or null Example: "266257315" Duns & Bradstreet identification
vatNumber	string or null Example: "DE128212199" VAT (Value Added Tax) identification number
registrationId	string or null registration id of the company in the country
name required	string or null Example: "World Company Limited" the targeted name
city required	string or null Example: "San Francisco" City Location
country required	null or string Example: "France" Country Location
addressLine1	string or null Example: "Kraillinger Strasse 5" 1st line of the address
statePrefecture	string or null state / Prefecture
addressLine2	string or null 2nd line of the address (if needed)
zipCode	string or null Example: "82131" ZIP Postal code
websiteUrl	string or null Example: "www.world-company-limited.com" website URL of the company

{"id": "200000000029188",
"dunsNumber": "266257315",
"vatNumber": "DE128212199",
"registrationId": "string",
"name": "World Company Limited",
"city": "San Francisco",
"country": "France",
"addressLine1": "Kraillinger Strasse 5",
"statePrefecture": "string",
"addressLine2": "string",
"zipCode": "82131",
"websiteUrl": "www.world-company-limited.com"
}

customerContact

phoneNumber	string Example: "987654321" phone number of the Customer Contact
salutation	string Example: "M." Salution of the person : Mr., Ms., Dr., etc..
jobTitle	string Example: "Director of Reseearch & Development" Job title of the customer Contact
email required	string Example: "john.smith@world-company.com" email of the customer Contact
firstName required	string Example: "John" first name of the customer Contact
lastName required	string Example: "Smith" lastname of the customer Contact

{"phoneNumber": "987654321",
"salutation": "M.",
"jobTitle": "Director of Reseearch & Development",
"email": "john.smith@world-company.com",
"firstName": "John",
"lastName": "Smith"
}

partnerContact

salesRepEmail required	string Example: "john.doe@best-partner.com" email of the partner contact
salesRepFirstName required	string Example: "John" first Name of the partner Contact
salesRepLastName required	string Example: "Doe" last name of the partner contact

{"salesRepEmail": "john.doe@best-partner.com",
"salesRepFirstName": "John",
"salesRepLastName": "Doe"
}

post_leads-opportunities_data

partnerId required	string Example: "200000000014442" Identification of partner LegalEntity in 3DS system.
required	object Core attributes of the lead-opportunity in case of creation.
required	Array of objects non-empty array of the various Offer Lines.
required	object identification of the target Customer Legal Entity
	Array of objects Customer Contact(s) informations
	Array of objects Partner Contact(s) informations

{"partnerId": "200000000014442",
"leadOpportunity": {"partnerLeadOpportunityId": "OPPY-1004526",
"name": "Projekt Big-Picture Topic + MBSE (STEP 1+2)",
"dsOwnerEmail": "john.doe@3ds.com",
"status": "LEAD_OPEN",
"forecastCategory": "UPSIDE",
"closeDate": "2025-08-01T18:03:16.325Z",
"cometCampaignCode": "OC2DE17TAQ1C13018",
"reasonWon": ["STRNG_VAL_PROP"
],
"reasonLost": ["CLIENT_HAS_NO_MORE_BUDGET"
],
"competitors": ["string"
],
"reasonWonLostComment": "The Customer has no budget",
"gtmTacticId": "string",
"description": "Projekt Dashboard - Big-Picture TopicPilotprojekt",
"nextMilestone": "Next activity is to make a demo to the Customer",
"nextMilestoneDate": "2025-08-01T18:03:16.325Z",
"currency": "USD"
},
"offerLines": [{"amount": 13000,
"offerNameId": "MDMIND00022_PUBL_ISE00002687_IPE00021337",
"revenueType": "UPFRONT"
}
],
"customerLegalEntity": {"id": "200000000029188",
"dunsNumber": "266257315",
"vatNumber": "DE128212199",
"registrationId": "string",
"name": "World Company Limited",
"city": "San Francisco",
"country": "France",
"addressLine1": "Kraillinger Strasse 5",
"statePrefecture": "string",
"addressLine2": "string",
"zipCode": "82131",
"websiteUrl": "www.world-company-limited.com"
},
"customerContacts": [{"phoneNumber": "987654321",
"salutation": "M.",
"jobTitle": "Director of Reseearch & Development",
"email": "john.smith@world-company.com",
"firstName": "John",
"lastName": "Smith"
}
],
"partnerContacts": [{"salesRepEmail": "john.doe@best-partner.com",
"salesRepFirstName": "John",
"salesRepLastName": "Doe"
}
]
}

201_post_leads-opportunities

partnerLeadOpportunityId required	string Example: "OPPY-1004526" Unique Identifier of the lead-opportunity in the CRM system of the 3DS partner.
dsLeadOpportunityId required	string Example: "5ZOQ-LF35OK" 3DS id of the lead-opportunity
action required	string Example: "create" action performed
required	object Status of the request
	object or null

{"partnerLeadOpportunityId": "OPPY-1004526",
"dsLeadOpportunityId": "5ZOQ-LF35OK",
"action": "create",
"info": {"success": true,
"statusCode": 201,
"timestamp": "2025-06-30T12:36:46.556Z",
"traceId": "3d29ece30a064ea68c3f5f4a9f785c6f"
},
"error": {"code": "string",
"message": "string"
}
}

400_post_leads-opportunities

data required	null or object
required	object
required	object

{"data": null,
"info": {"success": false,
"statusCode": 400,
"timeStamp": "2025-06-30T12:36:46.556Z",
"traceId": "3d29ece30a064ea68c3f5f4a9f785c6f"
},
"error": {"code": "string",
"message": "string"
}
}

406_leads-opportunities

	object
	object
	object

{"info": {"success": true,
"statusCode": 0,
"timeStamp": "string",
"traceId": "string"
},
"error": {"code": "string",
"message": "string"
},
"data": {"partnerLeadOpportunityId": null,
"dsLeadOpportunityId": null,
"action": null
}
}

503_leads-opportunities

required	object
required	object
	object

{"info": {"success": false,
"statusCode": 503,
"timestamp": "2025-06-30T12:36:46.556Z",
"traceId": "3d29ece30a064ea68c3f5f4a9f785c6f"
},
"error": {"code": "ERR899",
"message": "Service currently unavailable, please try again later."
},
"data": {"partnerLeadOpportunityId": null,
"dsLeadOpportunityId": null,
"action": null
}
}

200_get_leads-opportunities

required	object
required	object
error	null no error in case of succees

{"data": {"leadOpportunity": {"partnerLeadOpportunityId": "OPPY-1004526",
"dsLeadOpportunityId": "5ZOQ-LF35OK",
"name": "Projekt Big-Picture Topic + MBSE (STEP 1+2)",
"dsOwnerEmail": "john.doe@3ds.com",
"status": "LEAD_OPEN",
"forecastCategory": "UPSIDE",
"closeDate": "2025-06-30",
"cometCampaignCode": "OC2DE17TAQ1C13018",
"reasonWon": ["STRNG_VAL_PROP"
],
"reasonLost": ["CLIENT_HAS_NO_MORE_BUDGET"
],
"competitors": ["string"
],
"reasonWonLostComment": "The Customer has no budget",
"gtmTacticId": "string",
"description": "Projekt Dashboard - Big-Picture TopicPilotprojekt",
"nextMilestone": "Next activity is to make a demo to the Customer",
"nextMilestoneDate": "2025-06-15",
"currency": "USD",
"approvalStatus": "string",
"engagementType": "string",
"poInformation": "string",
"poStatus": "string",
"poNumber": "string",
"sboIndicator": "string",
"sboStatus": "string",
"sboNumber": "string",
"growthType": "string",
"leadPriority": "string",
"levelOfInterest": "string",
"dsComment": "string",
"partnerImportMode": "string",
"createdDate": "string",
"modifiedDate": "string",
"offerLines": [{"amount": 13000,
"offerNameId": "MDMIND00022_PUBL_ISE00002687_IPE00021337",
"revenueType": "UPFRONT"
}
],
"customerLegalEntity": {"id": "200000000029188",
"dunsNumber": "266257315",
"vatNumber": "DE128212199",
"registrationId": "string",
"name": "World Company Limited",
"city": "San Francisco",
"country": "France",
"addressLine1": "Kraillinger Strasse 5",
"statePrefecture": "string",
"addressLine2": "string",
"zipCode": "82131",
"websiteUrl": "www.world-company-limited.com"
},
"customerContact": [{"phoneNumber": "987654321",
"salutation": "M.",
"jobTitle": "Director of Reseearch & Development",
"email": "john.smith@world-company.com",
"firstName": "John",
"lastName": "Smith"
}
],
"partnerContact": [{"salesRepEmail": "john.doe@best-partner.com",
"salesRepFirstName": "John",
"salesRepLastName": "Doe"
}
]
}
},
"info": {"success": true,
"statusCode": 0,
"timeStamp": null,
"traceId": null
},
"error": null
}

500_get_leads-opportunities

partnerId	null
data required	null
required	object
required	object

{"partnerId": null,
"data": null,
"info": {"success": true,
"statusCode": 0,
"timeStamp": "string",
"traceId": "string"
},
"error": {"code": "string",
"message": "string"
}
}

lead-opportunity_patch

partnerLeadOpportunityId

required

string

Example: "OPPY-1004526"

Unique Identifier of the lead-opportunity in the CRM system of the 3DS partner.

name

string

Example: "Projekt Big-Picture Topic + MBSE (STEP 1+2)"

Name assigned to the lead-opportunity

dsOwnerEmail

string

Example: "john.doe@3ds.com"

email of the 3DS Partner Sales Manager (PSM).

Note : It is defaulted to the primary 3DS PSM if not provided at creation time.

status

string

Enum	Description
LEAD_OPEN	-6 Open
QUALIFIED	-5 Qualified
ACCEPTED	-4 Accepted
OPPY_OPEN	-3 Open

… 4 more

Example: "LEAD_OPEN"

Status of the lead-opportunity (LEVERAGE Processs)

forecastCategory

string

Enum	Description
UPSIDE	One or more major risks of closing business by the close date, however the customer stated an intention, as represented in the Win Plan, to place an order by the specified Close Date.
COMMIT	Commitment that this Opportunity will be won by the close date. All key steps to close by the close date have been agreed upon with the customer and there are no known major risks.
SAFE	The Purchase Order and agreements signed by the customer are received by 3DS, are being reviewed by Sales Operations and have been submitted to Finance.
WON	The signed Statement of work and Purchase Order are approved (by Finance)

… 3 more

Example: "UPSIDE"

Forecast Category is an assessment done by the Sales Expert to report his/her level of confidence that the Opportunity will close on the Close Date with the revenue amounts defined. Value is ignored at creation if status is ‘LEAD_OPEN’,’QUALIFIED’ or ’ACCEPTED’. if value is not provided at creation time, it defaults based on the following matrix :

status	default forecastCategory	forecastCategory values
-3 Open	Upside	Safe/Commit/Upside/Longshot
-2 validated	Upside	Safe/Commit/Upside/Longshot
-1 Established	Upside	Safe/Commit/Upside/Longshot
Won	Won	Won (set by the system)
Lost	Lost	Lost (set by the system)

closeDate

string <date-time>

Example: "2025-08-01T18:03:16.325Z"

Expected date for the closing of the sale in ISO 8601 format (like YYYY-MM-DDThh:mm:ss.sssZ)

cometCampaignCode

string

Example: "OC2DE17TAQ1C13018"

COMET Campaign code

reasonWon

Array of strings

Items Enum	Description
SOLUTION_FUNCT	Solution functionality
STRNG_VAL_PROP	Stronger value proposition
LWR_CST_OF_OWNRSHIP	Lower costs of ownership
LWR_IMPL_COST	Lower implementation costs

… 10 more

Example: ["STRNG_VAL_PROP"]

Identification of the reason a lead or an opportunity is won.

Note : At creation time, if value is not provided, it will be defaulted to STRNG_VAL_PROP (Stronger value proposition).

reasonLost

Array of strings

Items Enum	Description
BETTER_COMP_OFFER	Better competition offer
CLIENT_DOES_NOT_SEE_VALUE	Client does not see value
LACK_OR_LOSS_OF_CHAMPION	Lack or loss of Champion
FUNC_GAP	Functional gap

… 39 more

Example: ["CLIENT_HAS_NO_MORE_BUDGET"]

A list of reason lost is used to identify the reason(s) for loss of an opportunity and for a Lead (which will give insight for the lessons learnt).

Note : At creation time, if value is not provided, it will be defaulted to NO_PROJECT.

competitors

Array of strings

List of the competitors. In current state of the API, the list of valid values will be provided through direct communication with partners (mail or 3DSwym discussion).

reasonWonLostComment

string

Example: "The Customer has no budget"

Comment associated to WON or LOST reasons

gtmTacticId

string

identification of GoToMarket.

description

string

Example: "Projekt Dashboard - Big-Picture TopicPilotprojekt"

description associated to the lead-opportunity

nextMilestone

string

Example: "Next activity is to make a demo to the Customer"

Description of the next activity to be done

nextMilestoneDate

string <date-time>

Example: "2025-08-01T18:03:16.325Z"

Next Milestone date in ISO 8601 format (like YYYY-MM-DDThh:mm:ss.sssZ)

currency

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

{"partnerLeadOpportunityId": "OPPY-1004526",
"name": "Projekt Big-Picture Topic + MBSE (STEP 1+2)",
"dsOwnerEmail": "john.doe@3ds.com",
"status": "LEAD_OPEN",
"forecastCategory": "UPSIDE",
"closeDate": "2025-08-01T18:03:16.325Z",
"cometCampaignCode": "OC2DE17TAQ1C13018",
"reasonWon": ["STRNG_VAL_PROP"
],
"reasonLost": ["CLIENT_HAS_NO_MORE_BUDGET"
],
"competitors": ["string"
],
"reasonWonLostComment": "The Customer has no budget",
"gtmTacticId": "string",
"description": "Projekt Dashboard - Big-Picture TopicPilotprojekt",
"nextMilestone": "Next activity is to make a demo to the Customer",
"nextMilestoneDate": "2025-08-01T18:03:16.325Z",
"currency": "USD"
}

patch_leads-opportunities_data

partnerId	string Example: "200000000014442" Identification of partner LegalEntity in 3DS system.
required	object Specific attributes of the lead-opportunity in case of update
	Array of objects array of the various Offer Lines.
	object identification of the target Customer Legal Entity
	Array of objects Customer Contact(s) informations
	Array of objects Partner Contact(s) informations

{"partnerId": "200000000014442",
"leadOpportunity": {"partnerLeadOpportunityId": "OPPY-1004526",
"name": "Projekt Big-Picture Topic + MBSE (STEP 1+2)",
"dsOwnerEmail": "john.doe@3ds.com",
"status": "LEAD_OPEN",
"forecastCategory": "UPSIDE",
"closeDate": "2025-08-01T18:03:16.325Z",
"cometCampaignCode": "OC2DE17TAQ1C13018",
"reasonWon": ["STRNG_VAL_PROP"
],
"reasonLost": ["CLIENT_HAS_NO_MORE_BUDGET"
],
"competitors": ["string"
],
"reasonWonLostComment": "The Customer has no budget",
"gtmTacticId": "string",
"description": "Projekt Dashboard - Big-Picture TopicPilotprojekt",
"nextMilestone": "Next activity is to make a demo to the Customer",
"nextMilestoneDate": "2025-08-01T18:03:16.325Z",
"currency": "USD"
},
"offerLines": [{"amount": 13000,
"offerNameId": "MDMIND00022_PUBL_ISE00002687_IPE00021337",
"revenueType": "UPFRONT"
}
],
"customerLegalEntity": {"id": "200000000029188",
"dunsNumber": "266257315",
"vatNumber": "DE128212199",
"registrationId": "string",
"name": "World Company Limited",
"city": "San Francisco",
"country": "France",
"addressLine1": "Kraillinger Strasse 5",
"statePrefecture": "string",
"addressLine2": "string",
"zipCode": "82131",
"websiteUrl": "www.world-company-limited.com"
},
"customerContacts": [{"phoneNumber": "987654321",
"salutation": "M.",
"jobTitle": "Director of Reseearch & Development",
"email": "john.smith@world-company.com",
"firstName": "John",
"lastName": "Smith"
}
],
"partnerContacts": [{"salesRepEmail": "john.doe@best-partner.com",
"salesRepFirstName": "John",
"salesRepLastName": "Doe"
}
]
}

200_patch_leads-opportunities

required	object
required	object
error	null no error in case of succees

{"data": {"partnerLeadOpportunityId": "string",
"dsLeadOpportunityId": "string",
"action": "string"
},
"info": {"success": true,
"statusCode": 0,
"timeStamp": null,
"traceId": null
},
"error": null
}

400_patch_leads-opportunities

data required	object
required	object
errors required	object

{"data": { },
"info": {"success": true,
"statusCode": 0,
"estimateSearchCount": 0
},
"errors": { }
}

post_leads-opportunities_search

required

Array of objects or objects

Array

Any of

required

object

Search criterion on the last modification date/time of the leads-opportunities.

The maximum time window allowed for the search is 1 week / 7 days (between fromDateand toDate, calculated time to time). Both lower (fromDate) and upper (toDate) bounds need to be provided as no implict range calculation is done. Lower and upper bounds need to be consistent : fromDate has to be anterior to toDate.

partnerLeadOpportunityId

Array of arrays or strings or string

Examples: "PARTNER-ID-1234" ""

Search criterion on the id of the leads-opportunities as defined in partner CRM System.

This search criterion can be used for 2 main use cases :

Exact search for a particular lead-opportunitity id from Partner CRM system.
- Set the exact id searched for (e.g "PARTNER-ID-1234")
Retrieval of all leads-opportunitities that do not have a partnerLeadOpportunityId defined in 3DS CRM application (MySalesPipeline).
- These are typically marketing leads on which update by Partner could be required.
- Simply set an empty string ("")

{"data": [{"modifiedDate": {"fromDate": "2024-08-01T14:30:00Z",
"toDate": "2024-08-08T08:30:00Z"
},
"partnerLeadOpportunityId": "PARTNER-ID-1234"
}
]
}

200_post_leads-opportunities_search

required	object
error	null no error in case of succees
required	Array of objects

{"info": {"success": true,
"statusCode": 0,
"timeStamp": "string",
"traceId": "string"
},
"error": null,
"data": [{"dsLeadOpportunityId": ["string"
]
}
]
}

portfolio-items_data

salesPortfolioType	string Example: "Brand" type of portfolio item
salesPortfolioInfrastructure	string Example: "On Premise" infrastructure type
salesPortfolioisOrderable	boolean Example: "true" Whether or not the item can be ordered
salesPortfolioLevel1	string Example: "3DEXPERIENCE" Level 1 of the description of the portfolio item
salesPortfolioLevel2	string Example: "Simulation" Level 2 of the description of the portfolio item
salesPortfolioLevel3	string Example: "Design to Manufacturing Process" Level 3 of the description of the portfolio item
salesPortfolioId	string Example: "CLASS00002_ONPR_PRTF077_SOL001277" type of portfolio item

{"salesPortfolioType": "Brand",
"salesPortfolioInfrastructure": "On Premise",
"salesPortfolioisOrderable": true,
"salesPortfolioLevel1": "3DEXPERIENCE",
"salesPortfolioLevel2": "Simulation",
"salesPortfolioLevel3": "Design to Manufacturing Process",
"salesPortfolioId": "CLASS00002_ONPR_PRTF077_SOL001277"
}

info_response_base_attributes

success	boolean Example: "true" true if operation succeeded or false in case of error.
statusCode	integer Example: "200" HTTP return code of the operation
estimatedSearchCount	integer Example: "6027" Total number of Results.

{"success": true,
"statusCode": 200,
"estimatedSearchCount": 6027
}

info_response_portfolio-items

success required	boolean Example: "true" true if operation succeeded or false in case of error.
statusCode required	integer Example: "200" HTTP return code of the operation
estimatedSearchCount required	integer Example: "6027" Total number of Results.
timeStamp required	string <date-time> Example: "2025-08-14T07:45:59.000Z" Timestamp of the operation.

{"success": true,
"statusCode": 200,
"estimatedSearchCount": 6027,
"timeStamp": "2025-08-14T07:45:59.000Z"
}

200_get_portfolio-items_search

required	Array of objects
required	object Global Information on the operation requested.

{"data": [{"salesPortfolioType": "Brand",
"salesPortfolioInfrastructure": "On Premise",
"salesPortfolioisOrderable": true,
"salesPortfolioLevel1": "3DEXPERIENCE",
"salesPortfolioLevel2": "Simulation",
"salesPortfolioLevel3": "Design to Manufacturing Process",
"salesPortfolioId": "CLASS00002_ONPR_PRTF077_SOL001277"
}
],
"info": {"success": true,
"statusCode": 200,
"estimatedSearchCount": 6027,
"timeStamp": "2025-08-14T07:45:59.000Z"
}
}

400_get_portfolio-items_search

required	object Global Information on the operation requested.
required	object

{"info": {"success": true,
"statusCode": 200,
"estimatedSearchCount": 6027,
"timeStamp": "2025-08-14T07:45:59.000Z"
},
"error": {"code": "ERROR_004",
"message": "#top should be a positive, non zero integer"
}
}

APIs for Dassault Systèmes Partners (0.11.0)

apikeys

Generate a new API key

Authorizations:

Responses

Response samples

orders

Search Orders using various filters

Authorizations:

query Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get Order details

Authorizations:

path Parameters

Responses

Response samples

price-lists

Retrieve Price Lists

Authorizations:

Responses

Response samples

accreditations

Retrieve Accreditations

Authorizations:

query Parameters

Responses

Response samples

leads-opportunities

Create a lead-opportunity object

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Update a lead-opportunity object

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get details of a lead-opportunity object

Authorizations:

path Parameters

Responses

Response samples

Search for leads-opportunities

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

portfolio-items

Search Sales portfolio items

Authorizations:

query Parameters

Responses

Response samples

Schemas

date_time_from

date_time_to

installed_base_number

online_instance_seat_id

transaction_type

orders_search_req

order_processing_status

transaction

local_time_zone

business_unit

legal_entity

creation_datetime

ds_received_po_date

booking_datetime

currency

online_consent_status

billto_sales_representative

billto_po_reference

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required