VeePee Authentication and Database Structure
Summary of Changes: (The purpose of this table is to keep traceability and Product team to highlight the things that were changed into the scope, based on comments or discussions)
Version | Date | Created / Updated | Notes |
---|---|---|---|
1.0 | 25.01.23 | Bogomil Pavlov | First publish |
1.1 | 06.03.23 | Bogomil Pavlov | Remove Incremetal Quantity logic and use default |
1.2 | 06.03.23 | Bogomil Pavlov | Remove Marketplace Name and Marketplace Code from Account VeePee |
1.3 | 12.03.23 | Bogomil Pavlov | Add new fields in Account Vee Pee for claims default actions |
The purpose of this document is to describe how we authenticate on VeePee and also, to describe the database structure.
Authorization
They use standard Bearer Token Authorization. The token does not have expiration date so we just need to set the URL and the Token in order to be able to authenticate. The new fields can be introduced in Account VeePee.
Also we will have different points of sale which we will treat as different channels. For example we can have VeePee France, VeePee Spain, VeePee Italy, VeePee UK, VeePee Belgium.
We should be able to specify the channel for each account so we will know which orders to download for the channel and how to validate the products against the taxonomy.
We will need also to specify the Supplier ID and the Shop channel ID which are used for some of the requests.
Since VeePee supports channels on product and order level we will incorporate the channel logic for the integration and in Account VeePee we will need to have a dropdown with all available channels:
Name | Language |
---|---|
UK | en |
Belgium FR | be_fr |
France | fr |
Italy | it |
Spain | es |
What we want to achieve is to have the channels drop down list which will help us to identify this VeePee account for with Shop Channel refer and which language from the taxonomy to use. Basically the channel drop down will be used only for the mapping and downloading of the taxonomy. We want to display the Name of the channel in the UI and use the Language for mapping with the taxonomy. More details in the taxonomy page.
When we are downloading orders we also need to specify the marketplaceCode
and the marketplaceName
which are obtained from the marketplace and manually need to be added.
Account VeePee Structure
New Field Name | Field Type | Comment |
---|---|---|
Use Sandbox | Checkbox | We will have two URLs one for sandbox and one for production. |
We want to hardcode them in the code and control them with the flag | ||
Token | Text | The Bearer Token which never expires |
Channel | Dropdown | The Channels we use to map the language |
Supplier ID | Integer | |
Shop channel ID | Integer | Use for the requests as parameter |
Marketplace Name | Text | Use for the requests as parameter |
Marketplace Code | Text | Use for the requests as parameter |
Default Claim Action | Dropdown | Accept or Reject options which will be used for the claims flow |