Import Partners

You can use a default partner registration JSON template to import several partners in bulk. After the import process is complete, Trading Partner Management creates a new record for each imported partner based on the domain of the primary contact’s email address.

Copy

Example

[
                            {
                            "accountDetails": {
                            "formData": {
                            "summary": {
                            "BUSINESS_NAME": "BBC.mohali",
                            "BUSINESS_TYPE": null,
                            "contactInformation": {
                            "ADDRESS": null,
                            "ADDRESS1": null,
                            "CITY": null,
                            "STATE": null,
                            "ZIP": null,
                            "PHONE": null,
                            "FAX": null
                            }
                            },
                            "primaryContact": {
                            "FIRST_NAME": "BBC",
                            "LAST_NAME": "Mohali",
                            "EMAIL": "news@bbc.mohali"
                            }
                            }
                            },
                            "customDetails": {},
                            "registrationTemplateId": "1"
                            },
                            {
                            "accountDetails": {
                            "formData": {
                            "summary": {
                            "BUSINESS_NAME": "BBC.aero",
                            "BUSINESS_TYPE": null,
                            "contactInformation": {
                            "ADDRESS": null,
                            "ADDRESS1": null,
                            "CITY": null,
                            "STATE": null,
                            "ZIP": null,
                            "PHONE": null,
                            "FAX": null
                            }
                            },
                            "primaryContact": {
                            "FIRST_NAME": "BBC",
                            "LAST_NAME": "Mohali",
                            "EMAIL": "news@bbc.aero"
                            }
                            }
                            },
                            "customDetails": {},
                            "registrationTemplateId": "1"
                            }
                        ]

To import partners:

  1. On the Partners page, select Import from the drop-down menu.
  2. Click Download Sample File you want to use a default template.
  3. On the Import Partners page, click TPM_Upload_icon to upload the list of partners.

    Trading Partner Management does not import any of the partners from an import file and displays an error:

    • if a partner in the JSON file you want to import is already present in Trading Partner Management,

    • If the domain in an email address of the partner’s primary contact matches any other partner’s organization domain,

    • If the import file has missing fields, or an improper format.

    You can then make necessary corrections and import these partners again.

The API for the module Import Partners allows you to import several partners in bulk. For more information on the APIs supported by Trading Partner Management, see APIs.

Note This API require a user bearer token.

POST 'https://tpm.uat.edifecsfedcloud.com/api/tpm/partnerships/register' \

--header 'accept: application/json' \

--header 'Authorization: Bearer <token>' \

--header 'Content-Type: application/json' \

--data-raw '[

{

"partnerProfile": {

"accountDetails": {

"formData": {

"summary": {

"BUSINESS_NAME": "News31.dl",

"BUSINESS_TYPE": null,

"contactInformation": {

"ADDRESS": null,

"ADDRESS1": null,

"CITY": null,

"STATE": null,

"ZIP": null,

"PHONE": null,

"FAX": null

}

},

"primaryContact": {

"FIRST_NAME": "News31",

"LAST_NAME": "Dl31",

"EMAIL": "news31@news.dl"

}

}

},

"customDetails": {},

"registrationTemplateId": "1"

}

},

{

"partnerProfile": {

"accountDetails": {

"formData": {

"summary": {

"BUSINESS_NAME": "News4.cd",

"BUSINESS_TYPE": null,

"contactInformation": {

"ADDRESS": null,

"ADDRESS1": null,

"CITY": null,

"STATE": null,

"ZIP": null,

"PHONE": null,

"FAX": null

}

},

"primaryContact": {

"FIRST_NAME": "News4",

"LAST_NAME": "Cd4",

"EMAIL": "news4@news.cd"

}

}

},

"customDetails": {},

"registrationTemplateId": "1"

}

}

]'

Sample Response

Copy 
{
    "status": "200",
    "message": "A partner has been registered successfully.",
    "success": true,
    "value": [
        {
            "version": 0,
            "id": "19bb88be-5b06-4d62-87dc-6b8c1c588ad8",
            "name": "United Clinic",
            "status": "Active",
            "email": "john.doe@domain1.com",
            "owner": false
        },
        {
            "version": 0,
            "id": "a5532d7b-fbc6-4f27-89d5-6c4f7eb2422a",
            "name": "Principal Hospital",
            "status": "Active",
            "email": "brianna.price@testmail2.com",
            "owner": false
        }
    ],
    "timestamp": "2022-11-17T10:57:16Z"
}

Generate a bearer token:

  1. Make the following request to the token endpoint.

    POST https://auth.uat.edifecsfedcloud.com/auth/realms/main/protocol/openid-connect/token

    The request must include the following parameters (x-www-form-urlencoded):

    • grant_type=password

    • client_id=onboarding-service-frontend

    • username={username}

    • password={password}

    As a response, the Account Service returns an access token that you can use as a bearer token.