Implementation instructions

Follow below steps to enable the tracking events for DHL Parcel eCommerce to become available in the Viya platform.

1. Create a token

Create a token in your viya environment, which will be used to authenticate the webhook requests from DHL Parcel eCommerce.

1. Create a token by going to “Configuration” > “Tokens” > “Add your first Token”/“New”

2. Enter a descriptive name eg “DHL Parcel ecommerce tracking push”

3. Select scope for the token: tracking-event-create-only

4. Set validity period for 1 year, remind to renew this every year for security reasons.

5. Click “Generate & Save” to generate the token

6. Copy the generated token and store it securely. You will need it in the next step.

2. Compose the URL

The URl to register with DHL Parcel is should be:

https://{customername}.viya.me/api/carriers/dhlparcelnl/tracking/events?carrierReference={carrierReference}

In this URL replace the following placeholders:

• {customername}: The name of your Viya environment, this is part of the URL you use to access the page.
• {carrierReference}: The carrier reference that you used to configure DHL Parcel eCommerce in Viya.

Register URL with DHL Parcel eCommerce

1. Login via https://my.dhlparcel.nl with the business account that has the right role; atleast one account is provided during onboarding.

2. Then under ‘Settings > Integrations’open up the ‘Track and Trace pusher’ integration.

3. Create a new integration

   1. name: Choose a name for the integration, e.g. “Viya Tracking Push”
   2. url: Paste the URL you composed in the previous step 2
   3. max requests per seconde: leave on the default (100)
   4. Authorisatietype: Choose API key
      1. API key header: set to `x-api-pat
      2. API key: Paste the token you created in step 1
   5. Mark/check “Track and trace pusher op organisatieniveau” so all events are sent to the URL.
   6. Press “Opslaan” to save the integration.

From this moment on, all events for the registered accounts will be sent to the URL you provided.