Gift message

PreviousPayment information NextOrder

gift Message Item Repository V1Get Get

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

get

/V1/carts/mine/gift-message/{itemId}

Path parameters

itemIdstringrequired

(Required) The item ID.

Example: <integer>

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://{{baseurl}}/V1/carts/mine/gift-message/{itemId}'

200

400

401

500

{
  "sender": "<string>",
  "recipient": "<string>",
  "message": "<string>",
  "gift_message_id": "<integer>",
  "customer_id": "<integer>",
  "extension_attributes": {
    "entity_id": "aute anim aliqua nulla eu",
    "entity_type": "consectetur dolo"
  }
}

gift Message Item Repository V1Save Post

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

post

/V1/carts/mine/gift-message/{itemId}

Path parameters

itemIdstringrequired

(Required) The item ID.

Example: <integer>

Header parameters

Content-Typestring

Example: application/json

Body

object

Example:

{"giftMessage":{"sender":"<string>","recipient":"<string>","message":"<string>","gift_message_id":"<integer>","customer_id":"<integer>","extension_attributes":{"entity_id":"nulla Excepteur cillum consectetur","entity_type":"laboris in quis incididunt"}}}

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'http://{{baseurl}}/V1/carts/mine/gift-message/{itemId}' \
  --header 'Content-Type: application/json' \
  --data '{
    "giftMessage": {
      "sender": "<string>",
      "recipient": "<string>",
      "message": "<string>",
      "gift_message_id": "<integer>",
      "customer_id": "<integer>",
      "extension_attributes": {
        "entity_id": "nulla Excepteur cillum consectetur",
        "entity_type": "laboris in quis incididunt"
      }
    }
  }'

200

400

401

500

true

gift Message Cart Repository V1Get Get

Return the gift message for a specified order.

get

/V1/carts/mine/gift-message

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://{{baseurl}}/V1/carts/mine/gift-message'

200

401

500

{
  "sender": "<string>",
  "recipient": "<string>",
  "message": "<string>",
  "gift_message_id": "<integer>",
  "customer_id": "<integer>",
  "extension_attributes": {
    "entity_id": "aute anim aliqua nulla eu",
    "entity_type": "consectetur dolo"
  }
}

gift Message Cart Repository V1Save Post

Set the gift message for an entire order.

post

/V1/carts/mine/gift-message

Header parameters

Content-Typestring

Example: application/json

Body

object

Example:

{"giftMessage":{"sender":"<string>","recipient":"<string>","message":"<string>","gift_message_id":"<integer>","customer_id":"<integer>","extension_attributes":{"entity_id":"nulla Excepteur cillum consectetur","entity_type":"laboris in quis incididunt"}}}

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'http://{{baseurl}}/V1/carts/mine/gift-message' \
  --header 'Content-Type: application/json' \
  --data '{
    "giftMessage": {
      "sender": "<string>",
      "recipient": "<string>",
      "message": "<string>",
      "gift_message_id": "<integer>",
      "customer_id": "<integer>",
      "extension_attributes": {
        "entity_id": "nulla Excepteur cillum consectetur",
        "entity_type": "laboris in quis incididunt"
      }
    }
  }'

200

400

401

500

true