Import Groups (Business Units)

Import a CSV file that contains data for groups . Groups are Organizational Hierarchy in a Business. They are also known as business units.

Prerequisites

Your unique Tenant ID, obtained from support.
Your unique apiKey, as generated in Company Info.
A CSV file containing group data
- One record per row
- The first row should contain column headings.
  (That row is ignored during import.)
Use the File Upload API to upload the CSV file to Pulpstream.
That process gives you a file reference to use in this API.

Details

Method: POST

URL: https://us.pulpstream.com/vfr/api/imports/locations

Headers:

tenantId: {tenantId}

apiKey: {apiKey}

Content-Type: application/json

apiUserName: Optional. Specify internal username from the User definition to submit the data on behalf of that user.

PayLoad:

{"file":"123123123213_groups.csv", // The reference obtained from the File Upload API

"fieldMapList":[
{"column":"0","objectField":"ID"},

{"column":"1","objectField":"Name"},

{"column":"2","objectField":"Parent_Location"}
{"column":"3","objectField":"State"}
]
}

Notes:

The field map list is an array of pairs, where each item in the pair is itself a name/value pair.
- The first pair is the literal "column", with a column-number value.
- The second pair is the literal "objectField".
  The value is the name of the field to receive the data in that column.
As with all CSV files, the first row should be a title row that contains column headings.
That row is ignored on import.
When the import finishes, an email is sent to the user specified in the apiUserName parameter.
If that parameter is not present, the email goes to the designated administrators in the
general Company Information settings.

Mappable Fields
These fields are available for mapping. (The internal field names are shown in parentheses.)

ID (ID) - required (Typically this will be Business Unit or Group Unique Code)
Name (Name) - required
Parent ID (Parent_Location) - required (It should contain the ID of Parent Location)
State, Address - any custom fields that you have created on groups smart object