ReDoc documentation

carts/{cartId}/gift-message

carts/{cartId}/gift-message

get/V1/carts/{cartId}/gift-message

Return the gift message for a specified order.

Request
path Parameters
cartId
required
integer

The shopping cart ID.

Responses
200

200 Success.

401

401 Unauthorized

default

Unexpected error

Response samples
{
  • "gift_message_id": 0,
  • "customer_id": 0,
  • "sender": "string",
  • "recipient": "string",
  • "message": "string",
  • "extension_attributes": {
    }
}

carts/{cartId}/gift-message

post/V1/carts/{cartId}/gift-message

Set the gift message for an entire order.

Request
path Parameters
cartId
required
integer

The cart ID.

Request Body schema:
required
object (gift-message-data-message-interface)

Interface MessageInterface

Responses
200

200 Success.

400

400 Bad Request

401

401 Unauthorized

default

Unexpected error

Request samples
{
  • "giftMessage": {
    }
}
Response samples
true
➔ Next to carts/{cartId}/gift-message/{itemId}