openapi: 3.2.0
info:
  title: Adobe Suite Carts/guest Carts/{cart Id}/gift Cards API
  version: 2.4.6
  description: 'Operations tagged carts/guest-carts/{cartId}/giftCards 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: carts/guest-carts/{cartId}/giftCards
paths:
  /V1/carts/guest-carts/{cartId}/giftCards:
    post:
      tags:
      - carts/guest-carts/{cartId}/giftCards
      description: Add gift card to the cart.
      operationId: PostV1CartsGuestcartsCartIdGiftCards
      parameters:
      - name: cartId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: 200 Success.
          content:
            application/json:
              schema:
                type: boolean
            application/xml:
              schema:
                type: boolean
        '500':
          description: Internal Server error
          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: carts/guest-carts/{cartId}/giftCards
      requestBody:
        content:
          application/json:
            schema:
              required:
              - giftCardAccountData
              properties:
                giftCardAccountData:
                  $ref: '#/components/schemas/gift-card-account-data-gift-card-account-interface'
              type: object
              xml:
                name: request
          application/xml:
            schema:
              required:
              - giftCardAccountData
              properties:
                giftCardAccountData:
                  $ref: '#/components/schemas/gift-card-account-data-gift-card-account-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'
    gift-card-account-data-gift-card-account-interface:
      type: object
      description: Gift Card Account data
      properties:
        gift_cards:
          type: array
          description: Cards codes.
          items:
            type: string
        gift_cards_amount:
          type: number
          description: Cards amount in quote currency.
        base_gift_cards_amount:
          type: number
          description: Cards amount in base currency.
        gift_cards_amount_used:
          type: number
          description: Cards amount used in quote currency.
        base_gift_cards_amount_used:
          type: number
          description: Cards amount used in base currency.
        extension_attributes:
          $ref: '#/components/schemas/gift-card-account-data-gift-card-account-extension-interface'
      required:
      - gift_cards_amount
      - base_gift_cards_amount
      - gift_cards_amount_used
      - base_gift_cards_amount_used
    error-errors-item:
      type: object
      description: Error details
      properties:
        message:
          type: string
          description: Error message
        parameters:
          $ref: '#/components/schemas/error-parameters'
    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-card-account-data-gift-card-account-extension-interface:
      type: object
      description: ExtensionInterface class for @see \Magento\GiftCardAccount\Api\Data\GiftCardAccountInterface
    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'