# My Shopping Lists

The My Shopping Lists endpoint creates and provides access to [Shopping Lists](/api/projects/shoppingLists.md) scoped to a specific [Customer](/api/projects/customers.md). The endpoint requires an access token from the [password flow](/api/authorization.md#password-flow) or [anonymous session flow](/api/authorization.md#tokens-for-anonymous-sessions).

The My Shopping Lists endpoint intentionally provides access to a limited subset of the fields on a [Shopping List](/api/projects/shoppingLists.md). This provides extra security in scenarios where the client application must communicate directly with the API on behalf of a customer, such as commerce in a mobile application. If you need to modify a field available on the full [Shopping List](/api/projects/shoppingLists.md) resource, pass the response from the My Shopping List endpoint to an internal service in your client application which accesses the [Shopping List](/api/projects/shoppingLists.md) resource.

## Representations

Responses are equal to the responses on the [Shopping List](/api/projects/shoppingLists.md) endpoint, but requests may differ.

#### MyShoppingListDraft

[type definition](/api/projects/me-shoppingLists.md?urn=ctp:api:type:MyShoppingListDraft).

## Get My ShoppingList

### Get My ShoppingList by ID

[endpoint definition](/api/projects/me-shoppingLists.md?urn=ctp:api:endpoint:/\{projectKey}/me/shopping-lists/\{id}:GET).

### Get My ShoppingList by Key

[endpoint definition](/api/projects/me-shoppingLists.md?urn=ctp:api:endpoint:/\{projectKey}/me/shopping-lists/key=\{key}:GET).

## Get My ShoppingList in Store

### Get My ShoppingList in Store by ID

[endpoint definition](/api/projects/me-shoppingLists.md?urn=ctp:api:endpoint:/\{projectKey}/in-store/key=\{storeKey}/me/shopping-lists/\{id}:GET).

### Get My ShoppingList in Store by Key

[endpoint definition](/api/projects/me-shoppingLists.md?urn=ctp:api:endpoint:/\{projectKey}/in-store/key=\{storeKey}/me/shopping-lists/key=\{key}:GET).

## Query My ShoppingLists

[endpoint definition](/api/projects/me-shoppingLists.md?urn=ctp:api:endpoint:/\{projectKey}/me/shopping-lists:GET).

## Query My ShoppingLists in Store

[endpoint definition](/api/projects/me-shoppingLists.md?urn=ctp:api:endpoint:/\{projectKey}/in-store/key=\{storeKey}/me/shopping-lists:GET).

## Check if My ShoppingList exists

### Check if My ShoppingList exists by ID

[endpoint definition](/api/projects/me-shoppingLists.md?urn=ctp:api:endpoint:/\{projectKey}/me/shopping-lists/\{id}:HEAD).

### Check if My ShoppingList exists by Key

[endpoint definition](/api/projects/me-shoppingLists.md?urn=ctp:api:endpoint:/\{projectKey}/me/shopping-lists/key=\{key}:HEAD).

### Check if My ShoppingList exists by Query Predicate

[endpoint definition](/api/projects/me-shoppingLists.md?urn=ctp:api:endpoint:/\{projectKey}/me/shopping-lists:HEAD).

## Check if My ShoppingList exists in Store

### Check if My ShoppingList exists in Store by ID

[endpoint definition](/api/projects/me-shoppingLists.md?urn=ctp:api:endpoint:/\{projectKey}/in-store/key=\{storeKey}/me/shopping-lists/\{id}:HEAD).

### Check if My ShoppingList exists in Store by Key

[endpoint definition](/api/projects/me-shoppingLists.md?urn=ctp:api:endpoint:/\{projectKey}/in-store/key=\{storeKey}/me/shopping-lists/key=\{key}:HEAD).

### Check if My ShoppingList exists in Store by Query Predicate

[endpoint definition](/api/projects/me-shoppingLists.md?urn=ctp:api:endpoint:/\{projectKey}/in-store/key=\{storeKey}/me/shopping-lists:HEAD).

## Create My ShoppingList

[endpoint definition](/api/projects/me-shoppingLists.md?urn=ctp:api:endpoint:/\{projectKey}/me/shopping-lists:POST).

## Create My ShoppingList in Store

[endpoint definition](/api/projects/me-shoppingLists.md?urn=ctp:api:endpoint:/\{projectKey}/in-store/key=\{storeKey}/me/shopping-lists:POST).

## Update My ShoppingList

### Update My ShoppingList by ID

[endpoint definition](/api/projects/me-shoppingLists.md?urn=ctp:api:endpoint:/\{projectKey}/me/shopping-lists/\{id}:POST).

### Update My ShoppingList by Key

[endpoint definition](/api/projects/me-shoppingLists.md?urn=ctp:api:endpoint:/\{projectKey}/me/shopping-lists/key=\{key}:POST).

## Update My ShoppingList in Store

### Update My ShoppingList in Store by ID

[endpoint definition](/api/projects/me-shoppingLists.md?urn=ctp:api:endpoint:/\{projectKey}/in-store/key=\{storeKey}/me/shopping-lists/\{id}:POST).

### Update My ShoppingList in Store by Key

[endpoint definition](/api/projects/me-shoppingLists.md?urn=ctp:api:endpoint:/\{projectKey}/in-store/key=\{storeKey}/me/shopping-lists/key=\{key}:POST).

## Update actions

#### Change Name

[type definition](/api/projects/me-shoppingLists.md?urn=ctp:api:type:MyShoppingListChangeNameAction).

#### Set Description

[type definition](/api/projects/me-shoppingLists.md?urn=ctp:api:type:MyShoppingListSetDescriptionAction).

#### Set Custom Type

[type definition](/api/projects/me-shoppingLists.md?urn=ctp:api:type:MyShoppingListSetCustomTypeAction).

#### Set CustomField

[type definition](/api/projects/me-shoppingLists.md?urn=ctp:api:type:MyShoppingListSetCustomFieldAction).

#### Set DeleteDaysAfterLastModification

[type definition](/api/projects/me-shoppingLists.md?urn=ctp:api:type:MyShoppingListSetDeleteDaysAfterLastModificationAction).

#### Update ShoppingListLineItems

##### Add ShoppingListLineItem

[type definition](/api/projects/me-shoppingLists.md?urn=ctp:api:type:MyShoppingListAddLineItemAction).

##### Remove ShoppingListLineItem

[type definition](/api/projects/me-shoppingLists.md?urn=ctp:api:type:MyShoppingListRemoveLineItemAction).

##### Change ShoppingListLineItem Quantity

[type definition](/api/projects/me-shoppingLists.md?urn=ctp:api:type:MyShoppingListChangeLineItemQuantityAction).

##### Change ShoppingListLineItems Order

[type definition](/api/projects/me-shoppingLists.md?urn=ctp:api:type:MyShoppingListChangeLineItemsOrderAction).

##### Set ShoppingListLineItem Custom Type

[type definition](/api/projects/me-shoppingLists.md?urn=ctp:api:type:MyShoppingListSetLineItemCustomTypeAction).

##### Set ShoppingListLineItem CustomField

[type definition](/api/projects/me-shoppingLists.md?urn=ctp:api:type:MyShoppingListSetLineItemCustomFieldAction).

#### Update TextLineItems

##### Add TextLineItem

[type definition](/api/projects/me-shoppingLists.md?urn=ctp:api:type:MyShoppingListAddTextLineItemAction).

##### Remove TextLineItem

[type definition](/api/projects/me-shoppingLists.md?urn=ctp:api:type:MyShoppingListRemoveTextLineItemAction).

##### Change TextLineItem Quantity

[type definition](/api/projects/me-shoppingLists.md?urn=ctp:api:type:MyShoppingListChangeTextLineItemQuantityAction).

##### Change TextLineItem Name

[type definition](/api/projects/me-shoppingLists.md?urn=ctp:api:type:MyShoppingListChangeTextLineItemNameAction).

##### Set TextLineItem Description

[type definition](/api/projects/me-shoppingLists.md?urn=ctp:api:type:MyShoppingListSetTextLineItemDescriptionAction).

##### Change TextLineItems Order

[type definition](/api/projects/me-shoppingLists.md?urn=ctp:api:type:MyShoppingListChangeTextLineItemsOrderAction).

##### Set TextLineItem Custom Type

[type definition](/api/projects/me-shoppingLists.md?urn=ctp:api:type:MyShoppingListSetTextLineItemCustomTypeAction).

##### Set TextLineItem CustomField

[type definition](/api/projects/me-shoppingLists.md?urn=ctp:api:type:MyShoppingListSetTextLineItemCustomFieldAction).

## Delete My ShoppingList

### Delete My ShoppingList by ID

[endpoint definition](/api/projects/me-shoppingLists.md?urn=ctp:api:endpoint:/\{projectKey}/me/shopping-lists/\{id}:DELETE).

### Delete My ShoppingList by Key

[endpoint definition](/api/projects/me-shoppingLists.md?urn=ctp:api:endpoint:/\{projectKey}/me/shopping-lists/key=\{key}:DELETE).

## Delete My ShoppingList in Store

### Delete My ShoppingList in Store by ID

[endpoint definition](/api/projects/me-shoppingLists.md?urn=ctp:api:endpoint:/\{projectKey}/in-store/key=\{storeKey}/me/shopping-lists/\{id}:DELETE).

### Delete My ShoppingList in Store by Key

[endpoint definition](/api/projects/me-shoppingLists.md?urn=ctp:api:endpoint:/\{projectKey}/in-store/key=\{storeKey}/me/shopping-lists/key=\{key}:DELETE).

## Related pages

- [Area overview page with navigation](/api.md)
- [Previous page: My Payments](/api/projects/me-payments.md)
- [Next page: My Quote Requests](/api/projects/me-quote-requests.md)