{ } API Explorer Support

Shipping integration

Avasam integrates with a number of leading shipping & logistics companies, so that you can print labels directly as part of your dispatch process.

When you first loginto Avasam, there won’t be any shipping integrations, so you will see an empty list:

Once you have integrated one or more providers, then you will see a screen more like this: Shipping integration

For each integration, the system shows you:

  1. Logo.
  2. Name (shipping provider).
  3. The account name you have provided.
  4. Status of the account (Active/Inactive).

Add a new shipping provider

The ‘Add shipping provider’ button allows you start the integration of a new provider or account (you may have more than one account for some providers).

To add/integrate a new shipping provider:

  1. Click the ‘Add’ button for one of the providers.
  2. Specify a name for the integration. Add a new shipping provider
  3. Click ‘Next’ to proceed.
  4. Provide information about your company that matches the records of the shipping provider(this may vary by provider). configuration screen
  5. Click ‘Next’ to proceed.
  6. Complete the information for integrating with the shipping provider: configuration screen
Field Description
APIkeyRequired Your provider will give you an API key value.
Customer account number:Required Your provider will give you anaccount number.
Weight Select a weight unit from the dropdown list (Kilograms, Grams, Pounds, Ounces).
Default weight If an item does not specify a weight, then enter a value which will be provided as a default weight when requesting a label.
Dimension Select a unit of measurement from the dropdown list for the dimensions (Millimeters, centimeters, inches).
Default height If an item does not specify a height, then enter a value which will be provided as a default height when requesting a label.
Default width If an item does not specify a width, then enter a value which will be provided as a default width when requesting a label.
Default depth If an item does not specify a depth, then enter a value which will be provided as a default depth when requesting a label.
  1. Click ‘Next’ to continue with the setup.
  2. Automatically submit manifest:
    a. Avasam can automatically submit your shipping manifests for you. If you do not select ‘Yes’ you’ll need to submit them manually each day.
  3. The ‘Next’ button returns you to the ‘Shipping integrations' screen with a new entry for the integration you just setup. Shipping integration
  • You can return to the main page by clicking on the ‘Settings’ link, or the ‘Cancel’ button.
  • If using Linnworks, please ensure that both Avasam and Linnworks are using the same units of measurement.
  • Fields marked with an asterisk (*) are compulsory and must be completed.

Update shipping integration

You can review and update the details of an existing shipping integration as required.

To do this:

  1. Click the entry to open up a detailed view of the selected integration. selected integration
  2. If you want to edit or adjust the details you entered for the shipping integration, click the ‘Edit’ link to review those details. edit details
  3. If you make any changes, then the system will show ‘Unsaved changes’, and show the ‘Save’ button.
  4. Click the ‘Save’ button to apply them. Save button
    If you are having problems with the connection to your shipping provider, use the ‘Reauthorise’ link to check if there are any issues connecting tothem.
  • Click ‘Cancel’ to discard changes.

Add shipping service

To print labels, you must add one or more shipping services for the integration.

To add a shipping service:

  1. Under the ‘Shipping services’ heading is a drop down list of services available for this account.
  2. Select one service from the list.
  3. Click the ‘Add’ button.
  4. The service should now be shown in the list below the drop down field. shipping service

Remove shipping service

If you are no longer using a shipping service, you can remove it from Avasam.

  1. Check the list of currently integrated services.
  2. Select the service to be deleted from the list. Remove shipping service
  3. Click the ‘X’ button to remove the service.
  4. Confirm deletion by clicking ‘OK’.
  5. The service should now be shown in the dropdown field.

Remove integration

You can remove a shipping integration from Avasam.

To do this:

  1. Locate the shipping integration that you want to remove.
  2. Click on the entry.
  3. Click the ‘Remove account’ button. Remove account
  4. Confirm that you wish to delete it by clicking ‘OK’. Confirm remove account