Skip to main content

Setup and configuration

The following needs to be in place for the integration to work.

See also here in the Ingrid documentation.

1 - Tracking function

The "Tracking" function needs to be active in Ingrid.

2 - Order validation

Order validation needs to be disabled in the Engage back end (your Voyado PM can do this).

3 - Order statuses must be configured in Engage

These order statuses must be set up in Engage:

[
  {
    "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"
  }
]

Caution

Change the "en" and "sv" values to whatever is needed, but do not edit the "key" value.

4 - Payment statuses

These payment statuses must be set up in Engage:

[
  {
    "key": "PAID",
    "en": "PAID",
    "sv": "PAID"
  },
  {
    "key": "UNPAID",
    "en": "UNPAID",
    "sv": "UNPAID"
  },
  {
    "key": "PARTIALLY_PAID",
    "en": "PARTIALLY_PAID",
    "sv": "PARTIALLY_PAID"
  }
]

Caution

As with the order statuses, you can change the "en" and "sv" values but do not edit the "key" value.

5 - The /orders endpoint

This integration uses v2 of the /orders endpoint:

POST api/v2/orders

Read more about this endpoint here.

In this section: