> This page is for Developer. > For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.bigcommerce.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.bigcommerce.com/_mcp/server. # List Shopping List Items Extension GET https://api-b2b.bigcommerce.com/api/v2/shoppinglists/items-extension Get a shopping list detail information. Equivalent Storefront GraphQL API Query: `shoppingList`. For more information, see the [GraphQL Playground](https://api-b2b.bigcommerce.com/graphql/playground). Reference: https://docs.bigcommerce.com/developer/api-reference/rest/b2b/storefront/shopping-list/get-shoppinglists-items-extension ## Authentication - `Authorization` header (bearer token, required) — ### Authentication header | Header | Argument | Description | | :-------------- | :------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Authorization` | `Bearer {{B2B_JWT_TOKEN}}` | You can obtain this token using the steps described in the [REST Storefront API](/developer/docs/b2b-edition/getting-started/authentication#rest-storefront-api) section\[...] | ## Request ### Query parameters - `id` (string, optional) — Shopping list ID - `offset` (string, optional, default: 0) — Pagination offset - `limit` (string, optional, default: 100) — Pagination limit - `sortBy` (enum, optional) — the field to sort by - Allowed values: `product_name`, `quantity`, `product_sku`, `updated_at`, `created_at`, `sort_order` ## Response ### 200 OK - `code` (double, required) - `message` (string, required) - `data` (ShoppinglistsItemsExtensionGetResponsesContentApplicationJsonSchemaData, required) ## Types ### ShoppinglistsItemsExtensionGetResponsesContentApplicationJsonSchemaData - `name` (string, required) — Shopping list name - `description` (string, required) — Description of shopping list - `status` (double, required) - `isOwner` (string, required) — If owner of shopping list - `products` (list of ShoppinglistsItemsExtensionGetResponsesContentApplicationJsonSchemaDataProductsItems, required) - `customerInfo` (ShoppinglistsItemsExtensionGetResponsesContentApplicationJsonSchemaDataCustomerInfo, required) - `grandTotal` (double, required) - `pagination` (ShoppinglistsItemsExtensionGetResponsesContentApplicationJsonSchemaDataPagination, required) - `channelId` (integer, optional) — B2B Edition channel ID - `channelName` (string, optional) — Store Channel name ### ShoppinglistsItemsExtensionGetResponsesContentApplicationJsonSchemaDataProductsItems - `itemId` (double, required) — Shopping list item ID - `productId` (string, required) — Product ID - `baseSku` (string, required) — Product base SKU - `variantSku` (string, required) — SKU name - `qty` (double, required) — Qty number - `basePrice` (double, required) - `productUrl` (string, required) - `variantId` (string, required) — Variant SKU ID - `productName` (string, required) — Product name - `updatedAt` (double, required) - `createdAt` (double, required) - `optionsList` (list of ShoppinglistsItemsExtensionGetResponsesContentApplicationJsonSchemaDataProductsItemsOptionsListItems, optional) - `primaryImage` (ShoppinglistsItemsExtensionGetResponsesContentApplicationJsonSchemaDataProductsItemsPrimaryImage, optional) - `sortOrder` (integer, optional) — The sort order for item ### ShoppinglistsItemsExtensionGetResponsesContentApplicationJsonSchemaDataCustomerInfo - `firstName` (string, required) - `lastName` (string, required) ### ShoppinglistsItemsExtensionGetResponsesContentApplicationJsonSchemaDataPagination - `totalCount` (double, required) - `offset` (double, required) - `limit` (double, required) ### ShoppinglistsItemsExtensionGetResponsesContentApplicationJsonSchemaDataProductsItemsOptionsListItems - `option_id` (string, required) - `option_value` (string, required) ### ShoppinglistsItemsExtensionGetResponsesContentApplicationJsonSchemaDataProductsItemsPrimaryImage - `urlThumbnail` (string, required) ## Examples **Response** ```json { "code": 200, "message": "SUCCESS", "data": { "name": "shopping list name", "description": "Shopping list desc", "status": 0, "isOwner": "1", "products": [ { "itemId": 1558, "productId": "107", "baseSku": "DPB", "variantSku": "d1-1", "qty": 5, "basePrice": 34.95, "productUrl": "/sample-dustpan-brush/", "variantId": "130", "productName": "[Sample] Dustpan & Brush", "updatedAt": 1622603634, "createdAt": 1622603183, "optionsList": [ { "option_id": "attribute[145]", "option_value": "95" } ], "primaryImage": { "urlThumbnail": "https://cdn11.bigcommerce.com/s-1i6zpxpe3g/products/107/images/351/dustpan1.1554505753.220.290.jpg?c=2" } }, { "itemId": 1557, "productId": "93", "baseSku": "SLLPJ", "variantSku": "SLLPJ-6088C959", "qty": 2, "basePrice": 7, "productUrl": "/1-l-le-parfait-jar/", "variantId": "46", "productName": "[Sample] 1 L Le Parfait Jar", "updatedAt": 1622603542, "createdAt": 1622602889, "optionsList": [ { "option_id": "attribute[112]", "option_value": "95" } ], "primaryImage": { "urlThumbnail": "https://cdn11.bigcommerce.com/s-1i6zpxpe3g/products/93/images/311/leparfaitmedium3.1554505753.220.290.jpg?c=2" } } ], "customerInfo": { "firstName": "Jo", "lastName": "Sweet" }, "grandTotal": 188.75, "pagination": { "totalCount": 2, "offset": 0, "limit": 100 } } } ``` **SDK Code** ```python example-1 import requests url = "https://api-b2b.bigcommerce.com/api/v2/shoppinglists/items-extension" querystring = {"sortBy":"sort_order"} headers = {"Authorization": "Bearer "} response = requests.get(url, headers=headers, params=querystring) print(response.json()) ``` ```javascript example-1 const url = 'https://api-b2b.bigcommerce.com/api/v2/shoppinglists/items-extension?sortBy=sort_order'; const options = {method: 'GET', headers: {Authorization: 'Bearer '}}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go example-1 package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api-b2b.bigcommerce.com/api/v2/shoppinglists/items-extension?sortBy=sort_order" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("Authorization", "Bearer ") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby example-1 require 'uri' require 'net/http' url = URI("https://api-b2b.bigcommerce.com/api/v2/shoppinglists/items-extension?sortBy=sort_order") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer ' response = http.request(request) puts response.read_body ``` ```java example-1 import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api-b2b.bigcommerce.com/api/v2/shoppinglists/items-extension?sortBy=sort_order") .header("Authorization", "Bearer ") .asString(); ``` ```php example-1 request('GET', 'https://api-b2b.bigcommerce.com/api/v2/shoppinglists/items-extension?sortBy=sort_order', [ 'headers' => [ 'Authorization' => 'Bearer ', ], ]); echo $response->getBody(); ``` ```csharp example-1 using RestSharp; var client = new RestClient("https://api-b2b.bigcommerce.com/api/v2/shoppinglists/items-extension?sortBy=sort_order"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Bearer "); IRestResponse response = client.Execute(request); ``` ```swift example-1 import Foundation let headers = ["Authorization": "Bearer "] let request = NSMutableURLRequest(url: NSURL(string: "https://api-b2b.bigcommerce.com/api/v2/shoppinglists/items-extension?sortBy=sort_order")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```