Return the gift message for a specified order

GET /V1/guest-carts/{cartId}/gift-message

Return the gift message for a specified order.

Path parameters

cartId string Required

The shopping cart ID.

Responses

200

200 Success.
Hide response attributes Show response attributes object
- gift_message_id integer
  
  Gift message ID. Otherwise, null.
- customer_id integer
  
  Customer ID. Otherwise, null.
- sender string Required
  
  Sender name.
- recipient string Required
  
  Recipient name.
- message string Required
  
  Message text.
- extension_attributes object
  
  ExtensionInterface class for @see \Magento\GiftMessage\Api\Data\MessageInterface
  
  Hide extension_attributes attributes Show extension_attributes attributes object
  
  entity_id string
  
  entity_type string
  
  wrapping_id integer
  
  wrapping_allow_gift_receipt boolean
  
  wrapping_add_printed_card boolean
default

Unexpected error
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Error details
  
  Hide errors attributes Show errors attributes object
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- code integer
  
  Error code
- parameters array[object]
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- trace string
  
  Stack trace

GET /V1/guest-carts/{cartId}/gift-message

curl \
 -X GET https://magento2.winkelstraat.mac/rest/all/V1/guest-carts/{cartId}/gift-message

Response examples (200)

{
  "gift_message_id": 42,
  "customer_id": 42,
  "sender": "string",
  "recipient": "string",
  "message": "string",
  "extension_attributes": {
    "entity_id": "string",
    "entity_type": "string",
    "wrapping_id": 42,
    "wrapping_allow_gift_receipt": true,
    "wrapping_add_printed_card": true
  }
}

Response examples (default)

{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}