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 Items 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
Upload Inventory
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 Subscription
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 of Plans
Retrieve Plans by Item IDs
Retrieve All Plans
Retrieve Single Plan
Remove Plan
Members
Members - WIP
Member - Earn
Earn Points
Retrieve Transaction
Reverse Points
Powered By GitBook
Refresh User Token
Path:
1
POST https://{baseurl}/api-commerceIdentity/auth/local/refresh
Copied!
The access token returned in the response of the Login Local User endpoint is valid for 35 minutes. When the user's session is about to expire, this endpoint is triggered automatically to extend the session, seamlessly and securely. The refresh token is passed in the request body to extend the session and its validity is generally 45 days.
Note: The validity of the JWT tokens (access and refresh) is configurable.
Headers
Content-Type : application/json
x-site-context : { "date": "2020-08-28T02:35:27.787Z", "channel": 12, "account": 5f493c9f30ec2a0007a94fc8", "stage": "sandbox" }

Parameters

Type : requestBody
Name : The JWT Refresh Token
Required: true

Sample Request

1
{
2
"refreshToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVlOTc5NDdkM2NiODU1M2MwZTQzZDg3ZiIsInJvbGVzIjpbeyJpZCI6IjVkZTENDZmOGM2MzUyMDkxZDk0NGYxYyJ9XSwiaWF0IjoxNTg3MDExMjg5LCJleHAiOjE1ODcwMTMwODl9.GM0t3TOsHL7HAOwBY8LaC1mnp79e6E_XV8rd4pT0mC2hlHoPHgLfgfj5x7qMzQzuD9Mirgi5Wtfmf9LkZw4Bg"
3
}
Copied!

Response

HTTP Code: 200 Message: OK
Description: You will see this message when the user details are retrieved along with the JWT tokens (access and refresh).
Sample
1
{
2
"_id": "5e97947d3cb8553c0e43d87f",
3
"userId": 90,
4
"roles": [
5
{
6
"id": "5de1646f8c6352091d944f1c"
7
}
8
],
9
"name": {
10
"first": "John",
11
"middle": "A",
12
"last": "Smith"
13
},
14
"accessToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVlOTc5NDdkM2NiODU1M2MwZTQzZDg3ZiIsInJvbGVzIjpbeyJpZCI6IjVkZTE2NDZmOGM2MzUyMDkxZDk0NGYxYyJ9XSwiaWF0IjoxNTg3MDExMzEzLCJleHAiOjE1ODcwMTMxMTN9.Xo5hhZVWA79cx4h2sy5iFvfDCbzcrDsVjHkmMq-F_EHobw93Ql5n8uJp1Fap--m_6h6lWgg7D2BblQFxGRr5aw",
15
"refreshToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVlOTc5NDdkM2NiODU1M2MwZTQzZDg3ZiIsImlhdCI6MTU4NzAxMTMxMywiZXhwIjoxNTkwODk5MzEzfQ.SJl_1ikNTo7iziHuxUhdJ3KFk4dsAReGvKhjyJcGIEqqObs4G-v-n4Xe_ydITw1ZBwNqZzbosJXUIrDsdLMJ9g"
16
}
Copied!
HTTP Code: 400 Message: Bad Request
Description: You will see this error when the refresh token is incorrect or invalid.
Sample
1
{
2
"code": "TOKEN_VALIDATION_FAILED",
3
"message": "Token validation failed."
4
}
Copied!

Changelog

  • Last updated - July 2020
Users - Previous
Login Local User
Next - Users
Get User Details
Last modified 5mo ago
Copy link
Contents
Changelog