Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Final Mile Facility Maintenance

Final Mile Facility Maintenance can currently be done only using CSV load. Maintenance screens are in the backlog for development.

Rules for creation and update of Final Mile Facilities

  1. When a record is loaded with a location that is already disabled

    1. that location will not be updated and

    2. a new one will not be created.

    3. An error will occur in the database for this record

  2. To update a record, the Company Code and Final Mile Facility Code must match the existing record.

CSV File Contents

The CSV File should have a header line containing the following fields. The company code and final mile facility code should be unique.

Note

If the Company Code and Final Mile Code are changed after the record has been loaded, a new record will be created which will look like a duplicate. Therefore it is important to keep them the same at all times.

CSV Fields

Field Name

Max Length

Company Code

50

Company Description

50

Final Mile Facility Code

25

Final Mile Facility Name

50

Title

5

FIrstName

50

LastName

50

Line1

50

Line2

50

Line3

50

City

50

Country

50

PostcodeZip

10

CountryCode

2

PhoneNumber

50

EmailAddress

200

Load Final Mile Facility using CSV

You will need

  • Client authorisation token for Production or UAT depending on the environment being updated

  • CSV file in a specific format

How to load the CSV File

Swagger can be used for loading the final mile facilities. Press “Try it out”, authorise the token, select a file and press Execute.

Authorise

First, click Authorise to enter the credentials for the database which will be updated. This value is confidential and should not be shared under any circumstances.

...

Select Organisations

Second, select Organisations and press “Try it out”

...

Select CSV File

Select the CSV File using

...

Press Execute

...

After a while you should see some results in the black pane and any errors should also be shown.

...