Installation of the consignment

Upgrade your collection with items from your supplier or partner. Consignment is a simple way of renting.

How do you install consignment between two environments? The whole interaction takes place from the customer side and the installation is done by setting up the right supplier.

The figure below shows how we designate the environments within the installation process.

Environment A is used at the supplier side.
Environment B is used at the customer side.

The API user token is central to the integration process.

Step 1. Creating the customer

Within environment A it is important that environment B is known as a customer

To configure the customer's information:

  • In environment A, use the main menu to navigate to Relationships > General Info > Customers.

The customer overview will now open.

  • Use the filter to search for the customer for whom the consignment is to be set up using a keyword.
  • If the customer already exists:
    • Note down the corresponding customer number and go to Step 2.
  • If the customer does not exist:
    • Create a customer according to the instructions found on the New customer page.
    • Note down the corresponding customer number and go to Step 2.

After the customer has been created, it is also important to create the main contact. We will use this to assign the user account.

  • Click on the Contacts tab.
  • Use the filter to search for the contact person for whom the consignment is to be set up using a keyword.
  • Check whether the contact has already been created.
  • If the contact does not exist:
    • Create a customer according to the instructions found on the New customer page.
Once the contact has been created, it must be linked to a user account and thus an API user token.

Step 2. Creating the user and token

To allow authentication to take place between the two environments, it is important to use an API user token. This token ensures the security between both environments.

In environment A, a user has to be created to be able to authorise. Then a link has to be made between the contact person of the customer and the user to be created. Follow the steps below carefully.

To configure the user's information:

  • In environment A, in the main menu, navigate to Settings  > Users> Users.

The overview of all users will now open.

  • Use the filter to find the user for whom the consignment is to be set up by using a keyword.
  • If the user exists:
    • Double-click the user.
    • Click on the Roles tab.
    • Check that the user is already linked to the correct customer contact information from step 1.
    • If the contact information is not known:
      • Use the Roles tab to link the user to the correct contact for the customer of step 1 using this manual.
  • If the user does not yet exist:

The user has been created. Now an API token needs to be created with which it is possible to make direct contact with environment A using environment B.

To create the API token:

  • In environment A, in the main menu, navigate to Settings  > Users> API tokens.

The overview of all API tokens will now open.

  • Use the filter to search with a keyword for the token that will be used to authorise the consignment.
  • If the API token does not exist:
The API token has been created and environment A is fully prepared. The supplier side is configured. Now it is time for the customer side, see step 3.

Stap 3. Leverancier instellen

Within environment B it is important that environment A is known as the supplier.

To configure the supplier information:
  • In environment B, use the main menu to navigate to Relationships > General Info> Suppliers.

The overview of suppliers will now open.

  • Use the filter to search for the supplier on which you want to set up the consignment with a keyword.
  • If the supplier has already been created:
    • Double-click the supplier.
  • If the supplier has not yet been created:

The General tab opens, containing the form of the selected supplier.

The consignment dialogue is displayed.

  • Please fill in all fields in the consignment form:
    • Consignment customer number: Enter the customer number from step 1. 
    • Token: Enter the user token you have from step 2.
    • Consignment URL: Type in the web address of area A (incl. https://).
    • Goods Receiving Warehouse Consignment: Select the warehouse that you use by default for receiving goods from the relevant supplier of Area A.
  • Click Save.

The consignment is checked and set.

  • Check whether the consignment is set by clicking on more in the consignment section. If the information is filled in, the consignment is set correctly.

In some cases you may need to refresh the supplier details window to check the consignment settings.

  • As an extra check it is possible to view the delivery addresses with the correct customer in area A. These delivery addresses will then be set as consignment address in the Logistics section at field Consignment address.
The consignment is ready for use. Click here for more information on using the consignment module.

Problems with setting up

Should you have any problems setting up consignment, please contact your RentMagic partner.