GW-BYOD Sequence Diagram

DES Technical Documentation

V1.1

DATEMA RETAIL AB
Box 1492 · 171 28 SOLNA · Visiting address: Hemvärnsgatan 9
Phone: +46 (0)8-517 150 00 · Helpdesk: +46 (0)8-517 150 55 · info@datema.se · www.datemaretail.com
Contents
1 Revision History ................................................................................................................ 2
2 Definition of Terms........................................................................................................... 3
2.1 Limitations ................................................................................................................ 3
3 Gateway Sequence Diagrams ........................................................................................... 4
3.1 Accounts ................................................................................................................... 4
3.1.1 Creating an account ......................................................................................... 4
3.1.2 Deleting an account.......................................................................................... 5
3.1.3 Changing an account's password ..................................................................... 5
3.1.4 Resetting an account's password ..................................................................... 6
3.2 Authorization............................................................................................................ 7
3.3 User Info ................................................................................................................... 7
3.4 Shopping trips .......................................................................................................... 8
3.4.1 Starting a shopping trip .................................................................................... 8
3.4.2 Retrieving an active shopping trip.................................................................... 9
3.4.3 Adding an item to or removing an item from a shopping trip ....................... 10
3.4.4 Changing the quantity of an item on a shopping trip .................................... 11
3.4.5 Removing a basket item from a shopping trip ............................................... 12
3.4.6 Retrieving a final basket for a shopping trip .................................................. 13
3.4.7 Ending a shopping trip.................................................................................... 14
3.4.8 Retrieving end state of a shopping trip .......................................................... 15
3.4.9 Cancelling a shopping trip .............................................................................. 16

1
DATEMA RETAIL AB
Box 1492 · 171 28 SOLNA · Visiting address: Hemvärnsgatan 9
Phone: +46 (0)8-517 150 00 · Helpdesk: +46 (0)8-517 150 55 · info@datema.se · www.datemaretail.com
1 Revision History
Date Version Description Author
2021-05-05 1.0 First version Fredrik Englund/Mikael Nensén
2021-05-07 1.1 Added more dia- Fredrik Englund/Mikael Nensén
grams and updated

2
DATEMA RETAIL AB
Box 1492 · 171 28 SOLNA · Visiting address: Hemvärnsgatan 9
Phone: +46 (0)8-517 150 00 · Helpdesk: +46 (0)8-517 150 55 · info@datema.se · www.datemaretail.com
2 Definition of Terms
Shopper API Refers to an implementation of the EasyShop Standard Shopper
Loyalty API which a Retailer, Partner or POS vendor has imple-
mented.
Basket API Refers to an implementation of the EasyShop Standard Basket
API which a Retailer, Partner or POS vendor has implemented.

2.1 Limitations
A lot of business logic calls have been removed from the sequence diagrams as to keep
them simpler. Certain parts of the sequence diagrams might have been abstracted away
and might differ from Retailer to Retailer

3
DATEMA RETAIL AB
Box 1492 · 171 28 SOLNA · Visiting address: Hemvärnsgatan 9
Phone: +46 (0)8-517 150 00 · Helpdesk: +46 (0)8-517 150 55 · info@datema.se · www.datemaretail.com
3 Gateway Sequence Diagrams
3.1 Accounts
Using Accounts requires that a full Loyalty integration has to be put in place. It is used to
validate Shopper identifiers as well as retrieving Shopper data.
Accounts are used when the Retailer does not have their own Loyalty App and wishes to
use our Standard EasyShop iOS & Android client for Shopping.

3.1.1 Creating an account

4
DATEMA RETAIL AB
Box 1492 · 171 28 SOLNA · Visiting address: Hemvärnsgatan 9
Phone: +46 (0)8-517 150 00 · Helpdesk: +46 (0)8-517 150 55 · info@datema.se · www.datemaretail.com
3.1.2 Deleting an account
The request requires a valid access or refresh token. The sequence for getting a valid access
token has been omitted on purpose.

3.1.3 Changing an account's password

The request requires a valid access or refresh token. The sequence for getting a valid access
token has been omitted on purpose.

5
DATEMA RETAIL AB
Box 1492 · 171 28 SOLNA · Visiting address: Hemvärnsgatan 9
Phone: +46 (0)8-517 150 00 · Helpdesk: +46 (0)8-517 150 55 · info@datema.se · www.datemaretail.com
3.1.4 Resetting an account's password

6
DATEMA RETAIL AB
Box 1492 · 171 28 SOLNA · Visiting address: Hemvärnsgatan 9
Phone: +46 (0)8-517 150 00 · Helpdesk: +46 (0)8-517 150 55 · info@datema.se · www.datemaretail.com
3.2 Authorization
When using accounts you will be getting an access and refresh tokens. When accounts are
not used there are two other fallbacks, one is using client credentials and the third is using
an external JWT provider. When using client credentials you will only be getting an access
token.

3.3 User Info

The request requires a valid access or refresh token and that accounts are used. The se-
quence for getting a valid access token has been omitted on purpose.

7
DATEMA RETAIL AB
Box 1492 · 171 28 SOLNA · Visiting address: Hemvärnsgatan 9
Phone: +46 (0)8-517 150 00 · Helpdesk: +46 (0)8-517 150 55 · info@datema.se · www.datemaretail.com
3.4 Shopping trips
All requests require a valid access token. The sequence for getting a valid access token has
been omitted on purpose.

3.4.1 Starting a shopping trip

The sequence diagram will differ slightly depending on a Retailer's setup. Certain Retailers
have centralised lookup of Shopper data while others retrieve Shopper data from a Store
level. The below sequence diagram will try and be a bit abstract related to those parts and
only refer to them as Shopper & POS API.

8
DATEMA RETAIL AB
Box 1492 · 171 28 SOLNA · Visiting address: Hemvärnsgatan 9
Phone: +46 (0)8-517 150 00 · Helpdesk: +46 (0)8-517 150 55 · info@datema.se · www.datemaretail.com
3.4.2 Retrieving an active shopping trip

9
DATEMA RETAIL AB
Box 1492 · 171 28 SOLNA · Visiting address: Hemvärnsgatan 9
Phone: +46 (0)8-517 150 00 · Helpdesk: +46 (0)8-517 150 55 · info@datema.se · www.datemaretail.com
3.4.3 Adding an item to or removing an item from a shopping trip
The request to add and remove an item using a barcode is the same, whether it is treated
as an add or remove request depends on the request data.

10
DATEMA RETAIL AB
Box 1492 · 171 28 SOLNA · Visiting address: Hemvärnsgatan 9
Phone: +46 (0)8-517 150 00 · Helpdesk: +46 (0)8-517 150 55 · info@datema.se · www.datemaretail.com
3.4.4 Changing the quantity of an item on a shopping trip

11
DATEMA RETAIL AB
Box 1492 · 171 28 SOLNA · Visiting address: Hemvärnsgatan 9
Phone: +46 (0)8-517 150 00 · Helpdesk: +46 (0)8-517 150 55 · info@datema.se · www.datemaretail.com
3.4.5 Removing a basket item from a shopping trip

12
DATEMA RETAIL AB
Box 1492 · 171 28 SOLNA · Visiting address: Hemvärnsgatan 9
Phone: +46 (0)8-517 150 00 · Helpdesk: +46 (0)8-517 150 55 · info@datema.se · www.datemaretail.com
3.4.6 Retrieving a final basket for a shopping trip

13
DATEMA RETAIL AB
Box 1492 · 171 28 SOLNA · Visiting address: Hemvärnsgatan 9
Phone: +46 (0)8-517 150 00 · Helpdesk: +46 (0)8-517 150 55 · info@datema.se · www.datemaretail.com
3.4.7 Ending a shopping trip

14
DATEMA RETAIL AB
Box 1492 · 171 28 SOLNA · Visiting address: Hemvärnsgatan 9
Phone: +46 (0)8-517 150 00 · Helpdesk: +46 (0)8-517 150 55 · info@datema.se · www.datemaretail.com
3.4.8 Retrieving end state of a shopping trip

15
DATEMA RETAIL AB
Box 1492 · 171 28 SOLNA · Visiting address: Hemvärnsgatan 9
Phone: +46 (0)8-517 150 00 · Helpdesk: +46 (0)8-517 150 55 · info@datema.se · www.datemaretail.com
3.4.9 Cancelling a shopping trip

16
DATEMA RETAIL AB
Box 1492 · 171 28 SOLNA · Visiting address: Hemvärnsgatan 9
Phone: +46 (0)8-517 150 00 · Helpdesk: +46 (0)8-517 150 55 · info@datema.se · www.datemaretail.com