Get shopping lists of a user
Shoppers may want to periodically review their shopping lists and ensure they are up to date.
This endpoint gets a paginated response of shopping lists by user ID. For each list, you can view user ID, list ID, list name, type, notes, custom attributes (if any), as well as time of list creation and update.
Note:
1. You can refine the results by specifying offset and limit. When they are not specified, you will get up to 10 records.
2. To view items in a list, refer to Get lists with items endpoint - GET /lists/users/{userId}/actions/get-list-details-with-items.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
A header used by fabric to identify the tenant making the request. You must include tenant id in the authentication header for an API request to access any of fabric’s endpoints. You can retrieve the tenant id , which is also called account id, from Copilot. This header is required.
x-fabric-channel-id identifies the sales channel where the API request is being made; primarily for multichannel use cases. The channel ids are 12 corresponding to US and 13 corresponding to Canada. The default channel id is 12. This field is required.
Unique request ID
Path Parameters
Unique identifier of logged-in user, from Identity service
Query Parameters
Number of records to skip before returning records. For example, offset=20, limit=10 returns records 21-30.
Maximum number of records per page
1 < x < 100Response
List details and pagination specifications
Details of shopping list
Pagination response
Was this page helpful?