Mapped companies

Jakamo offers a way to query active integration and its mapped company identifiers. Mapped company identifier (mapped ID) means the company mapping you have set to your partner company for spesific integration in Jakamo. To do this query is supported in all the integrations that you have currently active.

This can be useful in situations where you might want to send your messages to certain set of suppliers. For example, send forecasts only companies using Jakamo with you, and to do that, you need to check which of them has company mappings in place. By doing this, you can potentially avoid making erroneous API calls.

1. Reading the API queue

To get mapped company identifiers from the desired integration, simply use the authentication method of that integration to retrieve this data. With a GET request to respective endpoint below will return all the mapped company IDs your company has in the Jakamo, in JSON format.

Endpoints

Jakamo environment	HTTP request	Jakamo API endpoint
Test environment	GET	https://demo.thejakamo.com/api/mappedcompanies
Production environment	GET	https://www.thejakamo.com/api/mappedcompanies

Response as JSON

[
    {
        "CompanyName": "Steel & Thunder Ltd", 
        "MappedId": "Forecast-Steelandthunder-001" 
    }
]

• CompanyName: Company account name in Jakamo your partner company has.
• MappedId: The identifier you have set for that partner company in Jakamo Integrations.

2. Example with Forecast integration

You might want to send your forecasts to only certain companies, but you are not sure which ones are mapped in your Jakamo integrations settings.Without manually checking company mappings from Jakamo user interface, you may send a GET request to dedicated endpoint to get the data of which companies are mapped and can receive forecasts via Jakamo.

Jakamo Forecast integration's company mappings may look like this:

By doing GET request to endpoint by using Forecast API authentication method will return the following JSON:

[
    {
        "CompanyName": "Keuruu Manufacturing",
        "MappedId": "12345"
    },
    {
        "CompanyName": "Sorva Steeling AB",
        "MappedId": "56892"
    },
    {
        "CompanyName": "Steeley Oy",
        "MappedId": "16497"
    },
    {
        "CompanyName": "Weghar Company Inc.",
        "MappedId": "98765"
    }
]

Help & Support

Didn't you find what you were looking for? Send email to Jakamo support (support@thejakamo.com) and we will help you.