Supply chain | Supply Chain Management, Commerce

How to Add a Custom Field to the Commerce Scale Unit API in Dynamics 365 Commerce

(3) Share

Report

Posted on by GV-05021644-0

Hi,

I followed this guide to set up the Commerce Scale Unit in self-hosted mode for my local development environment.

In our dev environment, the Commerce app calls the following endpoint to create a business partner prospect:
POST https://csu_url/Commerce/BusinessPartners/CreateProspect?api-version=7.3
With the following payload:

{
    "businessPartnerProspect": {
        "FirstName": "name",
        "LastName": "lastName",
        "CompanyName": "company_name",
        "Address": {
            "AddressTypeValue": 0,
            "State": "CAM",
            "ThreeLetterISORegionName": "ITA",
            "Street": "Via del sole 1",
            "City": "Napoli",
            "ZipCode": "80147",
            "Phone": "3557856988",
            "Email": "email@yopmail.com"
        },
        "CompanySize": 0,
        "ProspectTypeValue": 1
    }
}

I need to add a custom field to this object and ensure the Commerce Scale Unit (CSU) API can accept and store it in the database.

Questions:

Should I modify the existing API or create a new one to support the custom field?
Are there any best practices or steps I should follow to implement this change?

Any guidance or references would be greatly appreciated!

Thanks in advance.

Categories:

Dynamics 365 Commerce

I have the same question (0)

All responses (2)

Answers (0)

Suggested answer

JCamiloFlorez 10 on at

Like (1)

Report

Hi, First of all you need to understand the CSU development topology, then, you would understand that there is not a way to modify the already existed API's or endpoints, instead of modifying a standard API you can add extension properties to the entities.

Was this reply helpful? Yes No
GV-05021644-0 18 on at

Like (0)

Report

Hi @JCamiloFlorez,

thank you for your answer.

How do you add an extension property to an existing entity? I've reviewed the Commerce Runtime Extensibility documentation but it's not clear.

Also, does the CSU automatically handle the database mapping for new extension properties, or do I need to manually create or modify database tables and map the property to a specific column?

I'm trying to understand the complete process for getting a custom field added and saved. Any guidance or a small example would be greatly appreciated. I haven't found any clear examples for this scenario.

Thanks in advance.

Was this reply helpful? Yes No

Join the conversation

Community site session details

How to Add a Custom Field to the Commerce Scale Unit API in Dynamics 365 Commerce

Helpful resources

Quick Links

Responsible AI policies

Neeraj Kumar – Community Spotlight

Congratulations to the November Top 10 Community Leaders!

Leaderboard > Supply chain | Supply Chain Management, Commerce

Featured topics

Product updates

Community site session details

How to Add a Custom Field to the Commerce Scale Unit API in Dynamics 365 Commerce

Helpful resources

Quick Links

Responsible AI policies

Neeraj Kumar – Community Spotlight

Congratulations to the November Top 10 Community Leaders!

Subscribe to this forum!

Select categories

Leaderboard > Supply chain | Supply Chain Management, Commerce

Featured topics

Product updates