ReDoc documentation

carts/{cartId}/gift-message/{itemId}

carts/{cartId}/gift-message/{itemId}

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

Return the gift message for a specified item in a specified shopping cart.

Request
path Parameters
cartId
required
integer

The shopping cart ID.

itemId
required
integer

The item ID.

Responses
200

200 Success.

400

400 Bad Request

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/{itemId}

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

Set the gift message for a specified item in a specified shopping cart.

Request
path Parameters
cartId
required
integer

The cart ID.

itemId
required
integer

The item 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}/giftCards