Fabric API Reference
Search…
Introduction
Browse all topics
Users
About Users APIs
Create Local User
Login Local User
Refresh User Token
Get User Details
Update User Details
Update Username
Reset Password
Verify Reset Token
Update Password
Change Password
Create Address
Update Address
Delete Address
Retrieve Address by ID
Retrieve Address by Kind
Retrieve All Addresses Of User
Set Default Address
Unset Default Address
Product Information Management
About PIM
Retrieve Product
Search Products
Retrieve Product Category
Retrieve Product Category Tree
Retrieve Product Attributes
Retrieve SKUs For A Category
Retrieve Category Attributes
Add Products In Bulk
Update Products In Bulk
Cart
About Cart APIs
Add Item to Cart
Retrieve Cart by Cart ID or Authorization Token
Remove Item from Cart
Empty Cart
Update Cart
Apply Promo
Remove Promo
Merge Guest Cart with Logged-in User Cart
Delete Cart
Add Shipping to Line Items
Add Pickup and Shipping to Line Items
Billing
About Billing
Add Billing
Retrieve Billing by Bill-to ID
Retrieve Billing by Ship-to ID
Update Billing
Shipping Methods
About Shipping Method
Retrieve Single Shipping Method
Retrieve All Shipping Methods
Retrieve Available Shipping Methods
Orders
About Orders APIs
Add Shipment
Add Bulk Shipments
Cancel Order
Cancel Orders in Bulk
Cancel Order By Order ID
Order Query
Checkout 2.0 (legacy)
Checkout 4.0 (New)
Retrieve Order By Order ID
Retrieve Orders By Authorization Token
Retrieve Orders By Email
Payment
About Payment
Add Payment To Cart
Retrieve Payment
Delete Payment
Attributes
About Attributes
Add Attributes To Cart Items
Add Attributes To Cart
Retrieve Order-Level Attributes
Retrieve Attributes By Item IDs
Wishlist
About Wishlist APIs
Add Item to Wishlist
Retrieve Wishlist
Delete Item from Wishlist
Inventory
About Inventory APIs
Bulk Insert
Retrieve Inventory of Multiple Items
Retrieve Inventory of Single Item
Retrieve Pickup Points
Warehouse
Retrieve Default Warehouse
Shipping
About Shipping
Add Shipping (Legacy)
Update Shipping (Legacy)
Retrieve Shipping by shipTo-ID
Retrieve Cart by Ship-to ID
Add Shipping and Pickup (New)
Update Shipping and Pickup (New)
Decoupled Cart
About Decoupled Cart
Add Items to Cart
Retrieve Cart by Cart ID or Authorization Token
Remove Item from Cart
Update Cart
Merge Guest Cart with Customer Cart
Empty Cart
Delete Cart
Tax
Create Estimate Transaction
Items
About Items APIs
Retrieve Multiple Items By Item IDs
Retrieve Single Item With Price By SKU
Retrieve Multiple Items By SKUs
Notifications
About Notifications API
Communication - Send Email
XM
About XM
Retrieve Live Pages
Retrieve Page by URL
Retrieve Live Global Components
Retrieve Menu List
Retrieve Menu
Retrieve Menu Items
Retrieve Page by URL and Channel ID
Retrieve Live Menu List By Channel ID
Retrieve Global Components By Channel ID
Promotions
About Promotions
Validate Promotions
Retrieve a List of Promotions
Retrieve a Single Promotion
Price
About Price
Add or Update Price
Add or Update Bulk Price
Retrieve Price by Item IDs
Retrieve Price by Item and Price List IDs
Subscriptions
About Subscriptions
Create Subscriptions
Update Subscriptions
Retrieve All Subscriptions
Retrieve Single Subscription
Retrieve Order by Order ID
Retrieve All Orders by Customer Reference ID
Retrieve All Scheduled Orders
Retrieve Orders by Subscription ID
Remove Single Subscription
Skip Subscription
Subscription Customers
About Customers
Retrieve All Subscribers
Retrieve Single Subscriber
Subscription Plans
About Plans
Count Plans
Retrieve Plans by Item IDs
Retrieve All Plans
Retrieve Single Plan
Remove Plan
Powered By GitBook
Get User Details
Path:
1
GET https://{baseurl}/api-commerceIdentity/user/{user Id}
Copied!
The 24 character system-generated user ID is passed as path param of this API, to retrieve the user details. In addition to running focused campaigns to offer product recommendation, promos, and the like, user details are required to build user profile and create personalized experience across channels.
Headers
Content-Type : application/json
x-site-context : { "date": "2020-08-28T02:35:27.787Z", "channel": 12, "account": 5f493c9f30ec2a0007a94fc8", "stage": "sandbox" }
Authorization: The JWT access token from the Login API. This is applicable only for a logged in user (not for guest user).

Parameters

Type : Path
Name : The system-generated user ID (represented as _Id)
Required: true

Sample Request

1
https://{baseurl}/user/5e97947d3cb8553c0e43d87f
Copied!

Response

HTTP Code : 200 Message : OK
You will see this message when the user details are successfully retrieved.
Sample
1
{
2
"_id": "5e97947d3cb8553c0e43d87f",
3
"isActive": {
4
"status": true
5
},
6
"registrationDate": "2020-04-15T22:34:22.429Z",
7
"expiryDate": "2070-04-15T22:34:22.429Z",
8
"roles": [
9
"5de1646f8c6352091d944f1c"
10
],
11
"name": {
12
"first": "John",
13
"middle": "A",
14
"last": "Smith"
15
},
16
"phone": [
17
{
18
"_id": "5e97947d3cb8553c0e43d880",
19
"number": "123456789",
20
"countryCode": "+1",
21
"extension": "1234",
22
"kind": "mobile",
23
"id": "5e97947d3cb8553c0e43d880"
24
}
25
],
26
"email": "[email protected]",
27
"extra": {
28
"dob": "03-19-1993"
29
},
30
"registrationSite": "abcde.com",
31
"account": "5e97947d3cb8553c0e43d87e",
32
"userId": 90,
33
"address": [],
34
"provider": [
35
{
36
"registrationDate": "2020-04-15T22:34:22.429Z",
37
"isActive": true,
38
"_id": "5e97947d3cb8553c0e43d881",
39
"name": "LOCAL",
40
"lastLoginDate": "2020-04-16T04:28:33.560Z",
41
"id": "5e97947d3cb8553c0e43d881"
42
}
43
],
44
"createdAt": "2020-04-15T23:10:53.773Z",
45
"updatedAt": "2020-04-16T04:28:33.560Z",
46
"__v": 0
47
}
Copied!
HTTP Code : 403 Message : Forbidden
Description: You will see this message when the system user ID is incorrect.
Sample
1
{
2
"statusCode": 403,
3
"error": "Forbidden",
4
"message": "User is not authorized to access this resource"
5
}
Copied!

Changelog

    Last updated - July 2020
Users - Previous
Refresh User Token
Next - Users
Update User Details
Last modified 3mo ago
Copy link
Contents
Changelog