Skip to content

Commit

Permalink
add multipass docs
Browse files Browse the repository at this point in the history
  • Loading branch information
otothea committed Jun 28, 2022
1 parent fc01311 commit 5b53203
Showing 1 changed file with 43 additions and 0 deletions.
43 changes: 43 additions & 0 deletions docs/loyalty/documentation/user.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ User API
- `Update User`_
- `Verify Email Address`_
- `Upload A Custom Avatar`_
- `Create Shopify Multipass Session`_

List Users
----------
Expand Down Expand Up @@ -531,3 +532,45 @@ Also supports Base64 uploads
}
}
Create Shopify Multipass Session
--------------------------------
Use this endpoint to request a URL for a Shopify Multipass session. The authenticated user's email address must be verified in our system for this to work. Otherwise anyone could put any email address in their profile and access that person's Shopify account.
Must be a Shopify Plus account holder. Contact support@botisimo.com to get this feature enabled for your account.
- **GET** /user/multipass
Request
=========== ======== ==========================================
Field Type Description
=========== ======== ==========================================
shopifyPath [string] The URL path to the product to open
=========== ======== ==========================================
.. code-block:: js
const response = await axios.get('https://botisimo.com/api/v1/loyalty/:team/user/multipass', {
params: {
shopifyPath: '/product/xxxxxx',
},
headers: {
'x-user-auth-token': 'xxxxxxx',
},
});
Response
=========== ======== ==========================================
Field Type Description
=========== ======== ==========================================
href string The href to the Shopify Multipass session
=========== ======== ==========================================
.. code-block:: js
{
"href": "https://xxxxx"
}

0 comments on commit 5b53203

Please sign in to comment.