docs: add clarification for set cart's customer API route (#13506)

2025-09-15 14:32:36 +03:00
parent 2ceed66b4d
commit 9f7df88c84
33 changed files with 92 additions and 32 deletions
@@ -58,6 +58,7 @@
 *         publishableKey: process.env.NEXT_PUBLIC_MEDUSA_PUBLISHABLE_KEY,
 *       })
 * 
+ *       // TODO must be authenticated as the customer to delete their address
 *       sdk.store.customer.deleteAddress("caddr_123")
 *       .then(({ deleted, parent: customer }) => {
 *         console.log(customer)
@@ -66,8 +67,8 @@
 *     label: cURL
 *     source: |-
 *       curl -X DELETE '{backend_url}/store/customers/me/addresses/{address_id}' \
- *       -H 'x-publishable-api-key: {your_publishable_api_key}' \
- *       -H 'Authorization: Bearer {access_token}'
+ *       -H 'Authorization: Bearer {access_token}' \
+ *       -H 'x-publishable-api-key: {your_publishable_api_key}'
 * tags:
 *   - Customers
 * responses:
@@ -52,6 +52,7 @@
 *         publishableKey: process.env.NEXT_PUBLIC_MEDUSA_PUBLISHABLE_KEY,
 *       })
 * 
+ *       // TODO must be authenticated as the customer to retrieve their details
 *       sdk.store.customer.retrieve()
 *       .then(({ customer }) => {
 *         console.log(customer)
@@ -141,6 +141,7 @@
 *         publishableKey: process.env.NEXT_PUBLIC_MEDUSA_PUBLISHABLE_KEY,
 *       })
 * 
+ *       // TODO must be authenticated as the customer to list their addresses
 *       sdk.store.customer.listAddress()
 *       .then(({ addresses, count, offset, limit }) => {
 *         console.log(addresses)
@@ -55,6 +55,7 @@
 *         publishableKey: process.env.NEXT_PUBLIC_MEDUSA_PUBLISHABLE_KEY,
 *       })
 * 
+ *       // TODO must be authenticated as the customer to retrieve their address
 *       sdk.store.customer.retrieveAddress(
 *         "caddr_123"
 *       )
@@ -147,6 +147,7 @@
 *         publishableKey: process.env.NEXT_PUBLIC_MEDUSA_PUBLISHABLE_KEY,
 *       })
 * 
+ *       // TODO must be authenticated as the customer to list their orders
 *       sdk.store.order.list()
 *       .then(({ orders, count, offset, limit }) => {
 *         console.log(orders)
@@ -155,6 +156,7 @@
 *     label: cURL
 *     source: |-
 *       curl '{backend_url}/store/orders' \
+ *       -H 'Authorization: Bearer {access_token}' \
 *       -H 'x-publishable-api-key: {your_publishable_api_key}'
 * tags:
 *   - Orders
@@ -1,13 +1,13 @@
 /**
 * @oas [post] /store/carts/{id}/customer
 * operationId: PostCartsIdCustomer
- * summary: Set Cart's Customer
- * x-sidebar-summary: Set Customer
- * description: Set the customer of the cart. This is useful when you create the cart for a guest customer, then they log in with their account.
+ * summary: Change Cart's Customer to Logged-in Customer
+ * x-sidebar-summary: Change Customer
+ * description: Change the cart's customer to the currently logged-in customer. This is useful when you create the cart for a guest customer, then they log in with their account.
 * externalDocs:
 *   url: https://docs.medusajs.com/resources/storefront-development/cart/update#set-carts-customer
 *   description: "Storefront guide: How to set the cart's customer."
- * x-authenticated: false
+ * x-authenticated: true
 * parameters:
 *   - name: id
 *     in: path
@@ -55,6 +55,7 @@
 *         publishableKey: process.env.NEXT_PUBLIC_MEDUSA_PUBLISHABLE_KEY,
 *       })
 * 
+ *       // TODO must be authenticated as the customer to set the cart's customer
 *       sdk.store.cart.transferCart("cart_123")
 *       .then(({ cart }) => {
 *         console.log(cart)
@@ -63,6 +64,7 @@
 *     label: cURL
 *     source: |-
 *       curl -X POST '{backend_url}/store/carts/{id}/customer' \
+ *       -H 'Authorization: Bearer {access_token}' \
 *       -H 'x-publishable-api-key: {your_publishable_api_key}'
 * tags:
 *   - Carts
@@ -98,6 +100,9 @@
 *     description: Emitted when the customer in the cart is transferred.
 *     deprecated: false
 *     since: 2.8.0
+ * security:
+ *   - cookie_auth: []
+ *   - jwt_token: []
 * 
 */

@@ -55,6 +55,7 @@
 *         publishableKey: process.env.NEXT_PUBLIC_MEDUSA_PUBLISHABLE_KEY,
 *       })
 * 
+ *       // TODO must be authenticated as the customer to update their details
 *       sdk.store.customer.update({
 *         first_name: "John"
 *       })
@@ -57,6 +57,7 @@
 *         publishableKey: process.env.NEXT_PUBLIC_MEDUSA_PUBLISHABLE_KEY,
 *       })
 * 
+ *       // TODO must be authenticated as the customer to create an address
 *       sdk.store.customer.createAddress({
 *         country_code: "us"
 *       })
@@ -63,6 +63,7 @@
 *         publishableKey: process.env.NEXT_PUBLIC_MEDUSA_PUBLISHABLE_KEY,
 *       })
 * 
+ *       // TODO must be authenticated as the customer to update their address
 *       sdk.store.customer.updateAddress(
 *         "caddr_123",
 *         {
@@ -52,6 +52,7 @@
 *         publishableKey: process.env.NEXT_PUBLIC_MEDUSA_PUBLISHABLE_KEY,
 *       })
 * 
+ *       // TODO must be authenticated as the customer to cancel the order transfer
 *       sdk.store.order.cancelTransfer(
 *         "order_123",
 *         {},
@@ -66,6 +67,7 @@
 *     label: cURL
 *     source: |-
 *       curl -X POST '{backend_url}/store/orders/{id}/transfer/cancel' \
+ *       -H 'Authorization: Bearer {access_token}' \
 *       -H 'x-publishable-api-key: {your_publishable_api_key}'
 * tags:
 *   - Orders
@@ -58,6 +58,7 @@
 *         publishableKey: process.env.NEXT_PUBLIC_MEDUSA_PUBLISHABLE_KEY,
 *       })
 * 
+ *       // TODO must be authenticated as the customer to request the order transfer
 *       sdk.store.order.requestTransfer(
 *         "order_123",
 *         {
@@ -75,6 +76,7 @@
 *     label: cURL
 *     source: |-
 *       curl -X POST '{backend_url}/store/orders/{id}/transfer/request' \
+ *       -H 'Authorization: Bearer {access_token}' \
 *       -H 'x-publishable-api-key: {your_publishable_api_key}'
 * tags:
 *   - Orders