Option 1 - complex link

Option 1 is applicable whenever using code-level logic to generate link is possible, for example vendor’s own backend is sending out an order confirmation email and is capable of generating this link. Gives most control.

1. There needs to be a mapping stored between particular store and our ‘queue ID’ on ecom side in order to be able to create correct link.  Queue id (in form of string) will be provided by us for each location you want to enable the pickup functionality at.

2. Create schedule pickup link:

   1. Constructing the link:

  i.      URL: https://queue.{env}.ombori.com/{organization}/queues/{queueId}/book/curbside-pickup?options={options}&note={note} (please note this is not available in production environment just yet)

  ii.      Query string parameters

1. options – JSON stringified configuration object, encoded Base64, that contains following fields:

   1. orderId – string containing order identifier (required)

   2. minDate – earliest pickup date in form of UTC timestamp (seconds, required)

   3. maxDate – latest pickup date in form of UTC timestamp (seconds, required)

   4. phoneNumber – customer’s phone number in E.164 format (optional)

   5. note – extra information such as order summary (for example, comma separated list of purchased items) to be displayed to the staff and customer in UI for improved UX (required, maximum 500 characters)

JavaScript code example: https://codesandbox.io/s/boring-rubin-briq0?file=/src/index.js

Option 2 - simple link

Option 2 is applicable whenever adding code-level logic is not possible, for example when vendor is using an ecom platform (like Shopify) that gives you limited control over the contents of your email

1. There needs to be a mapping stored between particular store and our ‘queue ID’ on ecom side in order to be able to create correct link.  Queue id (in form of string) will be provided by us for each location you want to enable the pickup functionality at.

2. Create schedule pickup link:

   1. URL schema: https://queue.{env}.ombori.com/{organization}/queues/{queueId}/book/curbside-pickup?orderId={orderId}&pickupDuration={numberOfDays}&note={note}

   2. Query string parameters:

      1. orderId – string containing order identifier (required)

      2. pickupDuration - how many days in the future can pickup be booked at, used for getting maximum pickup date (maximum pickup date = today + pickupDuration)

      3. note

General notes:

1. order id can be used as uniq identifier to retrieve an existing ticket (so we avoid double bookings)