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

Responses

200

200 Success.
500

Internal Server 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
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

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

curl \
 -X POST https://magento2.winkelstraat.mac/rest/all/V1/carts/guest-carts/{cartId}/giftCards \
 -d '{"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

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

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 (default)

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