API access overview (BETA)
We are beginning to trial direct integration of the UB API. This is currently in beta, and is only available on a per-invite basis. Integration involves building your basket and checkout UI components yourself with the endpoints documented here.
Introduction
The UB API can be used to enable you to build your own native basket and checkout functionalities into your app or website so that you can allow users to purchase directly with a completely seamless user experience.
Interested in joining the UB API beta?
If you'd like to become one of our UB API beta partners, contact Mark at [email protected].
Overview
Prerequisites##
You must have an API Token to perform crawling and to issue user access tokens. All other API requests are authenticated with the access token.
API flow##
Allowing users to add products to basket and to place orders requires a number of steps. The order is not totally strict and is fairly self-explanatory. The standard (recommended) order of events is laid out below.
- Issue temporary access token (if you don’t have one)
- Crawl product and wait for response from API
- Add product to basket
- Removing products from basket
- Retrieve basket
- Set product options (colour, size etc)
- Set delivery (shipping) option
- Submit & verify mobile number for verification
- Enter contact information (email, mobile number)
- Update contact information (email, mobile, number)
- Retrieve user
- Get user addresses
- Get user payment cards
- Add delivery address
- Select delivery address
- Add payment card
- Select payment card
- Place orders with CVV
Other calls which can be used at various points in the flow:
- Update address
- Delete address
- Delete payment card
- Check basket recrawl status
The following page details the API endpoints required to integrate the API into your UI.
Updated about 2 months ago