openapi: 3.2.0
info:
  title: Adobe Suite Guest Carts/{cart Id}/gift Message API
  version: 2.4.6
  description: 'Operations tagged guest-carts/{cartId}/gift-message across 2 of this provider''s published API definitions: adobe-suite-commerce-rest-customer-openapi.yaml, adobe-suite-commerce-rest-guest-openapi.yaml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://example.com/rest/default
tags:
- name: guest-carts/{cartId}/gift-message
paths:
  /V1/guest-carts/{cartId}/gift-message:
    get:
      tags:
      - guest-carts/{cartId}/gift-message
      description: Return the gift message for a specified order.
      operationId: GetV1GuestcartsCartIdGiftmessage
      parameters:
      - name: cartId
        in: path
        required: true
        description: The shopping cart ID.
        schema:
          type: string
      responses:
        '200':
          description: 200 Success.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/gift-message-data-message-interface'
            application/xml:
              schema:
                $ref: '#/components/schemas/gift-message-data-message-interface'
        default:
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error-response'
            application/xml:
              schema:
                $ref: '#/components/schemas/error-response'
      summary: guest-carts/{cartId}/gift-message
    post:
      tags:
      - guest-carts/{cartId}/gift-message
      description: Set the gift message for an entire order.
      operationId: PostV1GuestcartsCartIdGiftmessage
      parameters:
      - name: cartId
        in: path
        required: true
        description: The cart ID.
        schema:
          type: string
      responses:
        '200':
          description: 200 Success.
          content:
            application/json:
              schema:
                type: boolean
            application/xml:
              schema:
                type: boolean
        '400':
          description: 400 Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error-response'
            application/xml:
              schema:
                $ref: '#/components/schemas/error-response'
        default:
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error-response'
            application/xml:
              schema:
                $ref: '#/components/schemas/error-response'
      summary: guest-carts/{cartId}/gift-message
      requestBody:
        content:
          application/json:
            schema:
              required:
              - giftMessage
              properties:
                giftMessage:
                  $ref: '#/components/schemas/gift-message-data-message-interface'
              type: object
              xml:
                name: request
          application/xml:
            schema:
              required:
              - giftMessage
              properties:
                giftMessage:
                  $ref: '#/components/schemas/gift-message-data-message-interface'
              type: object
              xml:
                name: request
    servers:
    - url: https://example.com/rest/default
components:
  schemas:
    error-errors:
      type: array
      description: Errors list
      items:
        $ref: '#/components/schemas/error-errors-item'
    error-errors-item:
      type: object
      description: Error details
      properties:
        message:
          type: string
          description: Error message
        parameters:
          $ref: '#/components/schemas/error-parameters'
    gift-message-data-message-interface:
      type: object
      description: Interface MessageInterface
      properties:
        gift_message_id:
          type: integer
          description: Gift message ID. Otherwise, null.
        customer_id:
          type: integer
          description: Customer ID. Otherwise, null.
        sender:
          type: string
          description: Sender name.
        recipient:
          type: string
          description: Recipient name.
        message:
          type: string
          description: Message text.
        extension_attributes:
          $ref: '#/components/schemas/gift-message-data-message-extension-interface'
      required:
      - sender
      - recipient
      - message
    error-parameters-item:
      type: object
      description: Error parameters item
      properties:
        resources:
          type: string
          description: ACL resource
        fieldName:
          type: string
          description: Missing or invalid field name
        fieldValue:
          type: string
          description: Incorrect field value
    error-response:
      type: object
      properties:
        message:
          type: string
          description: Error message
        errors:
          $ref: '#/components/schemas/error-errors'
        code:
          type: integer
          description: Error code
        parameters:
          $ref: '#/components/schemas/error-parameters'
        trace:
          type: string
          description: Stack trace
      required:
      - message
    gift-message-data-message-extension-interface:
      type: object
      description: ExtensionInterface class for @see \Magento\GiftMessage\Api\Data\MessageInterface
      properties:
        entity_id:
          type: string
        entity_type:
          type: string
        wrapping_id:
          type: integer
        wrapping_allow_gift_receipt:
          type: boolean
        wrapping_add_printed_card:
          type: boolean
    error-parameters:
      type: array
      description: Error parameters list
      items:
        $ref: '#/components/schemas/error-parameters-item'
  securitySchemes:
    api_key:
      type: apiKey
      name: api_key
      in: header
x-refined-from:
- adobe-suite-commerce-rest-customer-openapi.yaml
- adobe-suite-commerce-rest-guest-openapi.yaml
x-original-swagger-version: '2.0'