Update cart comment

PATCH/api/carts/{handle}/comment

Stores or clears the customer comment associated with the active cart.

Path Parameters

handle*string

Stable handle used in routes and lookups.

Example"starter-catalog"

Request Body

application/json

Request payload for Update cart comment.

TypeScript Definitions

Use the request body type in TypeScript.

cartId?|

cart identifier.

comment*|

Optional customer note stored with the cart.

Example"Please deliver after 2pm"

Response Body

`application/json`

curl -X PATCH "https://example.com/api/carts/starter-catalog/comment" \  -H "Content-Type: application/json" \  -d '{    "comment": "Please deliver after 2pm"  }'

{  "id": "string",  "session": "string",  "workspaceId": "string",  "handle": "string",  "data": null,  "createdAt": "string",  "updatedAt": "string"}

{  "_tag": "ApiBadRequestError",  "code": "PRICE_IMPORT_DUPLICATE_SKUS",  "message": "The request payload is invalid.",  "description": "Remove duplicate SKU rows before importing the file.",  "details": null}

{  "_tag": "Unauthorized"}

{  "_tag": "ApiForbiddenError",  "message": "You do not have permission to perform this action."}

{  "_tag": "ApiNotFoundError",  "message": "The requested resource was not found."}

{  "_tag": "ApiConflictError",  "message": "A resource with this handle already exists."}

{  "_tag": "ApiUnprocessableEntityError",  "message": "The order cannot be submitted without items."}

{  "_tag": "ServiceUnavailable"}

{  "_tag": "ApiTimeoutError",  "message": "The upstream operation timed out."}

Path Parameters

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

503application/json

504application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`