Add gift card to the cart

POST /V1/carts/guest-carts/{cartId}/giftCards

Add gift card to the cart.

Path parameters

cartId string Required

Body

giftCardAccountData object Required

Gift Card Account data
Hide giftCardAccountData attributes Show giftCardAccountData attributes object
- gift_cards array[string]
  
  Cards codes.
- gift_cards_amount number Required
  
  Cards amount in quote currency.
- base_gift_cards_amount number Required
  
  Cards amount in base currency.
- gift_cards_amount_used number Required
  
  Cards amount used in quote currency.
- base_gift_cards_amount_used number Required
  
  Cards amount used in base currency.
- extension_attributes object
  
  ExtensionInterface class for @see \Magento\GiftCardAccount\Api\Data\GiftCardAccountInterface

Body

giftCardAccountData object Required

Gift Card Account data
Hide giftCardAccountData attributes Show giftCardAccountData attributes object
- gift_cards array[string]
  
  Cards codes.
- gift_cards_amount number Required
  
  Cards amount in quote currency.
- base_gift_cards_amount number Required
  
  Cards amount in base currency.
- gift_cards_amount_used number Required
  
  Cards amount used in quote currency.
- base_gift_cards_amount_used number Required
  
  Cards amount used in base currency.
- extension_attributes object
  
  ExtensionInterface class for @see \Magento\GiftCardAccount\Api\Data\GiftCardAccountInterface

Responses

200

application/json

application/json application/xml

200 Success.
500

application/json

application/json application/xml

Internal Server error
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Errors list
  
  Hide errors attributes Show errors attributes object
  
  Error details
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters list
  
  Hide parameters attributes Show parameters attributes object
  
  Error parameters item
  
  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 list
  
  Hide parameters attributes Show parameters attributes object
  
  Error parameters item
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- trace string
  
  Stack trace
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Errors list
  
  Hide errors attributes Show errors attributes object
  
  Error details
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters list
  
  Hide parameters attributes Show parameters attributes object
  
  Error parameters item
  
  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 list
  
  Hide parameters attributes Show parameters attributes object
  
  Error parameters item
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- trace string
  
  Stack trace
default

application/json

application/json application/xml

Unexpected error
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Errors list
  
  Hide errors attributes Show errors attributes object
  
  Error details
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters list
  
  Hide parameters attributes Show parameters attributes object
  
  Error parameters item
  
  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 list
  
  Hide parameters attributes Show parameters attributes object
  
  Error parameters item
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- trace string
  
  Stack trace
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Errors list
  
  Hide errors attributes Show errors attributes object
  
  Error details
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters list
  
  Hide parameters attributes Show parameters attributes object
  
  Error parameters item
  
  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 list
  
  Hide parameters attributes Show parameters attributes object
  
  Error parameters item
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- trace string
  
  Stack trace

POST /V1/carts/guest-carts/{cartId}/giftCards

curl \
 --request POST 'https://magento2.winkelstraat.mac/rest/all/V1/carts/guest-carts/{cartId}/giftCards' \
 --header "Content-Type: application/json" \
 --data '{"giftCardAccountData":{"gift_cards":["string"],"gift_cards_amount":42.0,"base_gift_cards_amount":42.0,"gift_cards_amount_used":42.0,"base_gift_cards_amount_used":42.0,"extension_attributes":{}}}'

curl \
 --request POST 'https://magento2.winkelstraat.mac/rest/all/V1/carts/guest-carts/{cartId}/giftCards' \
 --header "Content-Type: application/xml"

Request examples

{
  "giftCardAccountData": {
    "gift_cards": [
      "string"
    ],
    "gift_cards_amount": 42.0,
    "base_gift_cards_amount": 42.0,
    "gift_cards_amount_used": 42.0,
    "base_gift_cards_amount_used": 42.0,
    "extension_attributes": {}
  }
}

Request examples

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <giftCardAccountData>
    <gift-cards type="array">
      <gift-card>string</gift-card>
    </gift-cards>
    <gift-cards-amount type="float">42.0</gift-cards-amount>
    <base-gift-cards-amount type="float">42.0</base-gift-cards-amount>
    <gift-cards-amount-used type="float">42.0</gift-cards-amount-used>
    <base-gift-cards-amount-used type="float">42.0</base-gift-cards-amount-used>
    <extension-attributes>
    </extension-attributes>
  </giftCardAccountData>
</root>

Response examples (200)

true

Response examples (200)

true

Response examples (500)

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

Response examples (500)

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <message>string</message>
  <errors type="array">
    <error>
      <message>string</message>
      <parameters type="array">
        <parameter>
          <resources>string</resources>
          <fieldName>string</fieldName>
          <fieldValue>string</fieldValue>
        </parameter>
      </parameters>
    </error>
  </errors>
  <code type="integer">42</code>
  <parameters type="array">
    <parameter>
      <resources>string</resources>
      <fieldName>string</fieldName>
      <fieldValue>string</fieldValue>
    </parameter>
  </parameters>
  <trace>string</trace>
</root>

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

Response examples (default)

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <message>string</message>
  <errors type="array">
    <error>
      <message>string</message>
      <parameters type="array">
        <parameter>
          <resources>string</resources>
          <fieldName>string</fieldName>
          <fieldValue>string</fieldValue>
        </parameter>
      </parameters>
    </error>
  </errors>
  <code type="integer">42</code>
  <parameters type="array">
    <parameter>
      <resources>string</resources>
      <fieldName>string</fieldName>
      <fieldValue>string</fieldValue>
    </parameter>
  </parameters>
  <trace>string</trace>
</root>