Configuration in Steps

Enabling and configuring Ingrid Tracking integration with Voyado

That is not self-onboarding process for merchantEnabling and configurations steps require support from both Ingrid and Voyado

Step 1: Enable Integration

[VOYADO] Get API credentials
Action can be taken by merchant.
  • URL (e.g. https://ingrid.voyado.com )
  • API Key

[INGRID] Enable Notifications
Action need to be taken by Ingrid Employee.
  • enable in tracking config file both progress and smart notifications
tracking.json file:

  "notification_settings": {
    "features": {
      "progress": true,
      "smart": true
    },
    "channels": {},
    "notifications": {}
  }

[INGRID] Enable Voyado channel
Action need to be taken by Ingrid Employee.
  • enable in tracking config file
  • api_key - provide value from Voyado
  • api_url - provide value from Voyado (e.g. https://ingrid.voyado.com )
  • store_id - by default "NULL", potentially could be mapped against a store in Voyado Engage
tracking.json file:
{
  "notification_settings": {
    "features": {
      "progress": true,
      "smart": true
    },
    "channels": {
      "voyado": {
        "enabled": true,
        "api_url": "<API_URL>",
        "api_key": "<API_KEY>",
        "store_id": "NULL",
      }
    },
    "notifications": {}
  }
}


Step 2: Choose notification scenarios

[INGRID] Enable required Triggers
Action need to be taken by Ingrid Employee.
Enabling all possible Triggers does not define a specific notification will be already sent to Customer. Still merchant can decide in Voyado what types can be sent with what email / SMS template.
tracking.json file:
{
  "notification_settings": {
    "features": {
      "progress": true,
      "smart": true
    },
    "channels": {
      "voyado": {
        "enabled": true,
        "api_url": "<VOYADO_URL>",
        "api_key": "<API_KEY>",
        "store_id": "NULL"
      }
    },
    "notifications": {
      "smart": {
        "pickup_reminder": {
          "channels": [
            {
              "type": "VOYADO_CHANNEL",
              "enabled": true
            }
          ],
          "threshold": 48
        },
        "order_cancelled_by_merchant": {
          "channels": [
            {
              "type": "VOYADO_CHANNEL",
              "enabled": true
            }
          ]
        },
        "order_cancelled_by_customer": {
          "channels": [
            {
              "type": "VOYADO_CHANNEL",
              "enabled": true
            }
          ]
        },
        "out_for_delivery": {
          "channels": [
            {
              "type": "VOYADO_CHANNEL",
              "enabled": true
            }
          ]
        },
        "delivery_delayed": {
          "channels": [
            {
              "type": "VOYADO_CHANNEL",
              "enabled": true
            }
          ]
        },
        "delivery_failed": {
          "channels": [
            {
              "type": "VOYADO_CHANNEL",
              "enabled": true
            }
          ]
        },
        "order_returned_to_warehouse": {
          "channels": [
            {
              "type": "VOYADO_CHANNEL",
              "enabled": true
            }
          ]
        },
        "order_returned_in_store": {
          "channels": [
            {
              "type": "VOYADO_CHANNEL",
              "enabled": true
            }
          ]
        }
      },
      "progress": {
        "steps": [
          {
            "channels": [
              {
                "type": "VOYADO_CHANNEL",
                "enabled": true
              }
            ],
            "step": "STEP_CONFIRMED_BY_MERCHANT"
          },
          {
            "channels": [
              {
                "type": "VOYADO_CHANNEL",
                "enabled": true
              }
            ],
            "step": "STEP_SUBMITTED_TO_CARRIER"
          },
          {
            "channels": [
              {
                "type": "VOYADO_CHANNEL",
                "enabled": true
              }
            ],
            "step": "STEP_DELIVERED_TO_CONSUMER"
          },
          {
            "channels": [
              {
                "type": "VOYADO_CHANNEL",
                "enabled": true
              }
            ],
            "step": "STEP_DELIVERED_TO_PICKUP_POINT"
          },
          {
            "channels": [
              {
                "type": "VOYADO_CHANNEL",
                "enabled": true
              }
            ],
            "step": "STEP_ON_ROUTE"
          },
          {
            "channels": [
              {
                "type": "VOYADO_CHANNEL",
                "enabled": true
              }
            ],
            "step": "STEP_SENT_BACK"
          },
          {
            "channels": [
              {
                "type": "VOYADO_CHANNEL",
                "enabled": true
              }
            ],
            "step": "STEP_TERMINATED"
          }
        ]
      }
    }
  }
}

[VOYADO] Remove validation on the order in Voyado back office
Action need to be taken by Voyado Employee.
[VOYADO] Enable matching Ingrid Order Statuses
Action need to be taken by Voyado Employee.
  • Endpoint: api/v2/orders
  • Orderstatuses
[
 {
 "key": "Ingrid - Order Confirmed",
 "en": "Ingrid - Order Confirmed",
 "sv": "Ingrid - Order Confirmed"
 },
 {
 "key": "Ingrid - Order Prepared",
 "en": "Ingrid - Order Prepared",
 "sv": "Ingrid - Order Prepared"
 },
 {
 "key": "Ingrid - Short Pick Items",
 "en": "Ingrid - Short Pick Items",
 "sv": "Ingrid - Short Pick Items"
 },
 {
 "key": "Ingrid - Cancelled",
 "en": "Ingrid - Cancelled",
 "sv": "Ingrid - Cancelled"
 },
 {
 "key": "Ingrid - Submitted To Carrier",
 "en": "Ingrid - Submitted To Carrier",
 "sv": "Ingrid - Submitted To Carrier"
 },
 {
 "key": "Ingrid - En Route",
 "en": "Ingrid - En Route",
 "sv": "Ingrid - En Route"
 },
 {
 "key": "Ingrid - Delivery Delayed",
 "en": "Ingrid - Delivery Delayed",
 "sv": "Ingrid - Delivery Delayed"
 },
 {
 "key": "Ingrid - Out For Delivery",
 "en": "Ingrid - Out For Delivery",
 "sv": "Ingrid - Out For Delivery"
 },
 {
 "key": "Ingrid - Delivery Failed",
 "en": "Ingrid - Delivery Failed",
 "sv": "Ingrid - Delivery Failed"
 },
 {
 "key": "Ingrid - Delivered to Pickup Point",
 "en": "Ingrid - Delivered to Pickup Point",
 "sv": "Ingrid - Delivered to Pickup Point"
 },
 {
 "key": "Ingrid - Delivered To Consumer",
 "en": "Ingrid - Delivered To Consumer",
 "sv": "Ingrid - Delivered To Consumer"
 },
 {
 "key": "Ingrid - Pickup Point Reminder",
 "en": "Ingrid - Pickup Point Reminder",
 "sv": "Ingrid - Pickup Point Reminder"
 },
 {
 "key": "Ingrid - Sent Back",
 "en": "Ingrid - Sent Back",
 "sv": "Ingrid - Sent Back"
 },
 {
 "key": "Ingrid - Return Confirmation",
 "en": "Ingrid - Return Confirmation",
 "sv": "Ingrid - Return Confirmation"
 }
]
  • Paymentstatuses
[
 {
 "key": "PAID",
 "en": "PAID",
 "sv": "PAID"
 },
 {
 "key": "UNPAID",
 "en": "UNPAID",
 "sv": "UNPAID"
 },
 {
 "key": "PARTIALLY_PAID",
 "en": "PARTIALLY_PAID",
 "sv": "PARTIALLY_PAID"
 }
]
  • Languages
tbc


Step 3: Configure and automate communication

[VOYADO] Automations and Email templates


Step 4: Testing

[INGRID] Create test orders
  • provide order or tracking numbers updates

[VOYADO] Verify emails / SMS sent
[VOYADO] Verify contact creation