Gift message

gift Message Item Repository V1Get Get

get

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

Path parameters
cartIdstringRequired

(Required) The shopping cart ID.

Example: <integer>
itemIdstringRequired

(Required) The item ID.

Example: <integer>
Responses
200

OK

application/json
Responseobject
get
GET /V1/carts/{cartId}/gift-message/{itemId} HTTP/1.1
Host: {{baseurl}}
Accept: */*

{
  "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

post

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

Path parameters
cartIdstringRequired

(Required) The cart ID.

Example: <integer>
itemIdstringRequired

(Required) The item ID.

Example: <integer>
Header parameters
Content-TypestringOptionalExample: application/json
Body
objectOptionalExample: {"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
200

OK

application/json
Responseobject
post
POST /V1/carts/{cartId}/gift-message/{itemId} HTTP/1.1
Host: {{baseurl}}
Content-Type: application/json
Accept: */*
Content-Length: 254

{
  "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"
    }
  }
}
true

gift Message Cart Repository V1Get Get

get

Return the gift message for a specified order.

Path parameters
cartIdstringRequired

(Required) The shopping cart ID.

Example: <integer>
Responses
200

OK

application/json
Responseobject
get
GET /V1/carts/{cartId}/gift-message HTTP/1.1
Host: {{baseurl}}
Accept: */*

{
  "sender": "est mollit",
  "recipient": "",
  "message": "velit minim",
  "gift_message_id": 42366693,
  "customer_id": 57035449,
  "extension_attributes": {
    "entity_id": "dolore dolore eiusmod",
    "entity_type": "minim"
  }
}

gift Message Cart Repository V1Save Post

post

Set the gift message for an entire order.

Path parameters
cartIdstringRequired

(Required) The cart ID.

Example: <integer>
Header parameters
Content-TypestringOptionalExample: application/json
Body
objectOptionalExample: {"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
200

OK

application/json
Responseobject
post
POST /V1/carts/{cartId}/gift-message HTTP/1.1
Host: {{baseurl}}
Content-Type: application/json
Accept: */*
Content-Length: 254

{
  "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"
    }
  }
}
true
PreviousCouponsNextOrder