Add/update the specified cart item

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

Add/update the specified cart item.

Path parameters

cartId string Required

Body

cartItem object Required

Interface CartItemInterface
Hide cartItem attributes Show cartItem attributes object
- item_id integer
  
  Item ID. Otherwise, null.
- sku string
  
  Product SKU. Otherwise, null.
- qty number Required
  
  Product quantity.
- name string
  
  Product name. Otherwise, null.
- price number
  
  Product price. Otherwise, null.
- product_type string
  
  Product type. Otherwise, null.
- quote_id string Required
  
  Quote id.
- product_option object
  
  Product option interface
  Hide product_option attribute Show product_option attribute object
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\Quote\Api\Data\ProductOptionInterface
  
  Hide extension_attributes attributes Show extension_attributes attributes object
  
  custom_options array[object]
  
  Interface CustomOptionInterface
  
  Hide custom_options attributes Show custom_options attributes object
  
  Interface CustomOptionInterface
  
  option_id string Required
  
  Option id
  
  option_value string Required
  
  Option value
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\Catalog\Api\Data\CustomOptionInterface
  
  Hide extension_attributes attribute Show extension_attributes attribute object
  
  file_info object
  
  Image Content data interface
  
  Hide file_info attributes Show file_info attributes object
  
  base64_encoded_data string Required
  
  Media data (base64 encoded content)
  
  type string Required
  
  MIME type
  
  name string Required
  
  Image name
  
  bundle_options array[object]
  
  Interface BundleOptionInterface
  
  Hide bundle_options attributes Show bundle_options attributes object
  
  Interface BundleOptionInterface
  
  option_id integer Required
  
  Bundle option id.
  
  option_qty integer Required
  
  Bundle option quantity.
  
  option_selections array[integer] Required
  
  Bundle option selection ids.
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\Bundle\Api\Data\BundleOptionInterface
  
  downloadable_option object
  
  Downloadable Option
  
  Hide downloadable_option attribute Show downloadable_option attribute object
  
  downloadable_links array[integer] Required
  
  The list of downloadable links
  
  giftcard_item_option object
  
  Interface GiftCardOptionInterface
  
  Hide giftcard_item_option attributes Show giftcard_item_option attributes object
  
  giftcard_amount string Required
  
  Gift card amount.
  
  custom_giftcard_amount number
  
  Gift card open amount value.
  
  giftcard_sender_name string Required
  
  Gift card sender name.
  
  giftcard_recipient_name string Required
  
  Gift card recipient name.
  
  giftcard_sender_email string Required
  
  Gift card sender email.
  
  giftcard_recipient_email string Required
  
  Gift card recipient email.
  
  giftcard_message string
  
  Giftcard message.
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\GiftCard\Api\Data\GiftCardOptionInterface
  
  Hide extension_attributes attribute Show extension_attributes attribute object
  
  giftcard_created_codes array[string]
  
  configurable_item_options array[object]
  
  Interface ConfigurableItemOptionValueInterface
  
  Hide configurable_item_options attributes Show configurable_item_options attributes object
  
  Interface ConfigurableItemOptionValueInterface
  
  option_id string Required
  
  Option SKU
  
  option_value string
  
  Item id
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\ConfigurableProduct\Api\Data\ConfigurableItemOptionValueInterface
  
  grouped_options array[object]
  
  Represents product item id with qty of a grouped product.
  
  Hide grouped_options attributes Show grouped_options attributes object
  
  Represents product item id with qty of a grouped product.
  
  id integer
  
  Associated product id
  
  qty integer
  
  Associated product qty
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\GroupedProduct\Api\Data\GroupedOptionsInterface
- extension_attributes object
  
  ExtensionInterface class for @see \Magento\Quote\Api\Data\CartItemInterface
  Hide extension_attributes attributes Show extension_attributes attributes object
  
  discounts array[object]
  
  Rule discount Interface
  
  Hide discounts attributes Show discounts attributes object
  
  Rule discount Interface
  
  discount_data object Required
  
  Discount Data Interface
  
  Hide discount_data attributes Show discount_data attributes object
  
  amount number Required
  
  Amount
  
  base_amount number Required
  
  Base Amount
  
  original_amount number Required
  
  Original Amount
  
  base_original_amount number Required
  
  Base Original Amount
  
  rule_label string Required
  
  Rule Label
  
  rule_i_d integer Required
  
  Rule ID
  
  negotiable_quote_item object
  
  Interface CompanyQuoteConfigInterface
  
  Hide negotiable_quote_item attributes Show negotiable_quote_item attributes object
  
  item_id integer Required
  
  Quote item id
  
  original_price number Required
  
  Quote item original price
  
  original_tax_amount number Required
  
  Quote item original tax amount
  
  original_discount_amount number Required
  
  Quote item original discount amount
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\NegotiableQuote\Api\Data\NegotiableQuoteItemInterface
  
  Hide extension_attributes attributes Show extension_attributes attributes object
  
  negotiated_price_type integer
  
  negotiated_price_value number
  
  last_item_notes array[object]
  
  Interface ItemNoteInterface
  
  Hide last_item_notes attributes Show last_item_notes attributes object
  
  Interface ItemNoteInterface
  
  note_id integer
  
  Note ID.
  
  negotiable_quote_item_id integer Required
  
  Negotiable quote item Id
  
  creator_type integer Required
  
  The note creator type.
  
  creator_id integer Required
  
  Note creator ID.
  
  note string Required
  
  Note.
  
  created_at string
  
  Comment created at.
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\NegotiableQuote\Api\Data\ItemNoteInterface
  
  size string
  
  color string
  
  merchant_product_reference string
  
  category_code string
  
  image string
  
  mpn string
  
  msrp number
  
  manufacturer_code string
  
  manufacturer_name string
  
  merchant_code string
  
  merchant_name string
  
  merchant_city string
  
  parent_sku string
  
  is_sale boolean
  
  return_item_fee number
  
  base_return_item_fee number
  
  is_outlet boolean

Responses

200

200 Success.
Hide response attributes Show response attributes object
Interface CartItemInterface
- item_id integer
  
  Item ID. Otherwise, null.
- sku string
  
  Product SKU. Otherwise, null.
- qty number Required
  
  Product quantity.
- name string
  
  Product name. Otherwise, null.
- price number
  
  Product price. Otherwise, null.
- product_type string
  
  Product type. Otherwise, null.
- quote_id string Required
  
  Quote id.
- product_option object
  
  Product option interface
  
  Hide product_option attribute Show product_option attribute object
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\Quote\Api\Data\ProductOptionInterface
  
  Hide extension_attributes attributes Show extension_attributes attributes object
  
  custom_options array[object]
  
  Interface CustomOptionInterface
  
  Hide custom_options attributes Show custom_options attributes object
  
  Interface CustomOptionInterface
  
  option_id string Required
  
  Option id
  
  option_value string Required
  
  Option value
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\Catalog\Api\Data\CustomOptionInterface
  
  Hide extension_attributes attribute Show extension_attributes attribute object
  
  file_info object
  
  Image Content data interface
  
  Hide file_info attributes Show file_info attributes object
  
  base64_encoded_data string Required
  
  Media data (base64 encoded content)
  
  type string Required
  
  MIME type
  
  name string Required
  
  Image name
  
  bundle_options array[object]
  
  Interface BundleOptionInterface
  
  Hide bundle_options attributes Show bundle_options attributes object
  
  Interface BundleOptionInterface
  
  option_id integer Required
  
  Bundle option id.
  
  option_qty integer Required
  
  Bundle option quantity.
  
  option_selections array[integer] Required
  
  Bundle option selection ids.
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\Bundle\Api\Data\BundleOptionInterface
  
  downloadable_option object
  
  Downloadable Option
  
  Hide downloadable_option attribute Show downloadable_option attribute object
  
  downloadable_links array[integer] Required
  
  The list of downloadable links
  
  giftcard_item_option object
  
  Interface GiftCardOptionInterface
  
  Hide giftcard_item_option attributes Show giftcard_item_option attributes object
  
  giftcard_amount string Required
  
  Gift card amount.
  
  custom_giftcard_amount number
  
  Gift card open amount value.
  
  giftcard_sender_name string Required
  
  Gift card sender name.
  
  giftcard_recipient_name string Required
  
  Gift card recipient name.
  
  giftcard_sender_email string Required
  
  Gift card sender email.
  
  giftcard_recipient_email string Required
  
  Gift card recipient email.
  
  giftcard_message string
  
  Giftcard message.
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\GiftCard\Api\Data\GiftCardOptionInterface
  
  Hide extension_attributes attribute Show extension_attributes attribute object
  
  giftcard_created_codes array[string]
  
  configurable_item_options array[object]
  
  Interface ConfigurableItemOptionValueInterface
  
  Hide configurable_item_options attributes Show configurable_item_options attributes object
  
  Interface ConfigurableItemOptionValueInterface
  
  option_id string Required
  
  Option SKU
  
  option_value string
  
  Item id
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\ConfigurableProduct\Api\Data\ConfigurableItemOptionValueInterface
  
  grouped_options array[object]
  
  Represents product item id with qty of a grouped product.
  
  Hide grouped_options attributes Show grouped_options attributes object
  
  Represents product item id with qty of a grouped product.
  
  id integer
  
  Associated product id
  
  qty integer
  
  Associated product qty
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\GroupedProduct\Api\Data\GroupedOptionsInterface
- extension_attributes object
  
  ExtensionInterface class for @see \Magento\Quote\Api\Data\CartItemInterface
  
  Hide extension_attributes attributes Show extension_attributes attributes object
  
  discounts array[object]
  
  Rule discount Interface
  
  Hide discounts attributes Show discounts attributes object
  
  Rule discount Interface
  
  discount_data object Required
  
  Discount Data Interface
  
  Hide discount_data attributes Show discount_data attributes object
  
  amount number Required
  
  Amount
  
  base_amount number Required
  
  Base Amount
  
  original_amount number Required
  
  Original Amount
  
  base_original_amount number Required
  
  Base Original Amount
  
  rule_label string Required
  
  Rule Label
  
  rule_i_d integer Required
  
  Rule ID
  
  negotiable_quote_item object
  
  Interface CompanyQuoteConfigInterface
  
  Hide negotiable_quote_item attributes Show negotiable_quote_item attributes object
  
  item_id integer Required
  
  Quote item id
  
  original_price number Required
  
  Quote item original price
  
  original_tax_amount number Required
  
  Quote item original tax amount
  
  original_discount_amount number Required
  
  Quote item original discount amount
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\NegotiableQuote\Api\Data\NegotiableQuoteItemInterface
  
  Hide extension_attributes attributes Show extension_attributes attributes object
  
  negotiated_price_type integer
  
  negotiated_price_value number
  
  last_item_notes array[object]
  
  Interface ItemNoteInterface
  
  Hide last_item_notes attributes Show last_item_notes attributes object
  
  Interface ItemNoteInterface
  
  note_id integer
  
  Note ID.
  
  negotiable_quote_item_id integer Required
  
  Negotiable quote item Id
  
  creator_type integer Required
  
  The note creator type.
  
  creator_id integer Required
  
  Note creator ID.
  
  note string Required
  
  Note.
  
  created_at string
  
  Comment created at.
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\NegotiableQuote\Api\Data\ItemNoteInterface
  
  size string
  
  color string
  
  merchant_product_reference string
  
  category_code string
  
  image string
  
  mpn string
  
  msrp number
  
  manufacturer_code string
  
  manufacturer_name string
  
  merchant_code string
  
  merchant_name string
  
  merchant_city string
  
  parent_sku string
  
  is_sale boolean
  
  return_item_fee number
  
  base_return_item_fee number
  
  is_outlet boolean
400

400 Bad Request
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Error details
  
  Hide errors attributes Show errors attributes object
  
  Error details
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters item
  
  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 item
  
  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

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
  
  Error details
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters item
  
  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 item
  
  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/guest-carts/{cartId}/items

curl \
 -X POST https://magento2.winkelstraat.mac/rest/all/V1/guest-carts/{cartId}/items \
 -d '{"cartItem":{"item_id":42,"sku":"string","qty":42.0,"name":"string","price":42.0,"product_type":"string","quote_id":"string","product_option":{"extension_attributes":{"custom_options":[{"option_id":"string","option_value":"string","extension_attributes":{"file_info":{"base64_encoded_data":"string","type":"string","name":"string"}}}],"bundle_options":[{"option_id":42,"option_qty":42,"option_selections":[42],"extension_attributes":{}}],"downloadable_option":{"downloadable_links":[42]},"giftcard_item_option":{"giftcard_amount":"string","custom_giftcard_amount":42.0,"giftcard_sender_name":"string","giftcard_recipient_name":"string","giftcard_sender_email":"string","giftcard_recipient_email":"string","giftcard_message":"string","extension_attributes":{"giftcard_created_codes":["string"]}},"configurable_item_options":[{"option_id":"string","option_value":"string","extension_attributes":{}}],"grouped_options":[{"id":42,"qty":42,"extension_attributes":{}}]}},"extension_attributes":{"discounts":[{"discount_data":{"amount":42.0,"base_amount":42.0,"original_amount":42.0,"base_original_amount":42.0},"rule_label":"string","rule_i_d":42}],"negotiable_quote_item":{"item_id":42,"original_price":42.0,"original_tax_amount":42.0,"original_discount_amount":42.0,"extension_attributes":{"negotiated_price_type":42,"negotiated_price_value":42.0,"last_item_notes":[{"note_id":42,"negotiable_quote_item_id":42,"creator_type":42,"creator_id":42,"note":"string","created_at":"string","extension_attributes":{}}]}},"size":"string","color":"string","merchant_product_reference":"string","category_code":"string","image":"string","mpn":"string","msrp":42.0,"manufacturer_code":"string","manufacturer_name":"string","merchant_code":"string","merchant_name":"string","merchant_city":"string","parent_sku":"string","is_sale":true,"return_item_fee":42.0,"base_return_item_fee":42.0,"is_outlet":true}}}'

Request examples

{
  "cartItem": {
    "item_id": 42,
    "sku": "string",
    "qty": 42.0,
    "name": "string",
    "price": 42.0,
    "product_type": "string",
    "quote_id": "string",
    "product_option": {
      "extension_attributes": {
        "custom_options": [
          {
            "option_id": "string",
            "option_value": "string",
            "extension_attributes": {
              "file_info": {
                "base64_encoded_data": "string",
                "type": "string",
                "name": "string"
              }
            }
          }
        ],
        "bundle_options": [
          {
            "option_id": 42,
            "option_qty": 42,
            "option_selections": [
              42
            ],
            "extension_attributes": {}
          }
        ],
        "downloadable_option": {
          "downloadable_links": [
            42
          ]
        },
        "giftcard_item_option": {
          "giftcard_amount": "string",
          "custom_giftcard_amount": 42.0,
          "giftcard_sender_name": "string",
          "giftcard_recipient_name": "string",
          "giftcard_sender_email": "string",
          "giftcard_recipient_email": "string",
          "giftcard_message": "string",
          "extension_attributes": {
            "giftcard_created_codes": [
              "string"
            ]
          }
        },
        "configurable_item_options": [
          {
            "option_id": "string",
            "option_value": "string",
            "extension_attributes": {}
          }
        ],
        "grouped_options": [
          {
            "id": 42,
            "qty": 42,
            "extension_attributes": {}
          }
        ]
      }
    },
    "extension_attributes": {
      "discounts": [
        {
          "discount_data": {
            "amount": 42.0,
            "base_amount": 42.0,
            "original_amount": 42.0,
            "base_original_amount": 42.0
          },
          "rule_label": "string",
          "rule_i_d": 42
        }
      ],
      "negotiable_quote_item": {
        "item_id": 42,
        "original_price": 42.0,
        "original_tax_amount": 42.0,
        "original_discount_amount": 42.0,
        "extension_attributes": {
          "negotiated_price_type": 42,
          "negotiated_price_value": 42.0,
          "last_item_notes": [
            {
              "note_id": 42,
              "negotiable_quote_item_id": 42,
              "creator_type": 42,
              "creator_id": 42,
              "note": "string",
              "created_at": "string",
              "extension_attributes": {}
            }
          ]
        }
      },
      "size": "string",
      "color": "string",
      "merchant_product_reference": "string",
      "category_code": "string",
      "image": "string",
      "mpn": "string",
      "msrp": 42.0,
      "manufacturer_code": "string",
      "manufacturer_name": "string",
      "merchant_code": "string",
      "merchant_name": "string",
      "merchant_city": "string",
      "parent_sku": "string",
      "is_sale": true,
      "return_item_fee": 42.0,
      "base_return_item_fee": 42.0,
      "is_outlet": true
    }
  }
}

Response examples (200)

{
  "item_id": 42,
  "sku": "string",
  "qty": 42.0,
  "name": "string",
  "price": 42.0,
  "product_type": "string",
  "quote_id": "string",
  "product_option": {
    "extension_attributes": {
      "custom_options": [
        {
          "option_id": "string",
          "option_value": "string",
          "extension_attributes": {
            "file_info": {
              "base64_encoded_data": "string",
              "type": "string",
              "name": "string"
            }
          }
        }
      ],
      "bundle_options": [
        {
          "option_id": 42,
          "option_qty": 42,
          "option_selections": [
            42
          ],
          "extension_attributes": {}
        }
      ],
      "downloadable_option": {
        "downloadable_links": [
          42
        ]
      },
      "giftcard_item_option": {
        "giftcard_amount": "string",
        "custom_giftcard_amount": 42.0,
        "giftcard_sender_name": "string",
        "giftcard_recipient_name": "string",
        "giftcard_sender_email": "string",
        "giftcard_recipient_email": "string",
        "giftcard_message": "string",
        "extension_attributes": {
          "giftcard_created_codes": [
            "string"
          ]
        }
      },
      "configurable_item_options": [
        {
          "option_id": "string",
          "option_value": "string",
          "extension_attributes": {}
        }
      ],
      "grouped_options": [
        {
          "id": 42,
          "qty": 42,
          "extension_attributes": {}
        }
      ]
    }
  },
  "extension_attributes": {
    "discounts": [
      {
        "discount_data": {
          "amount": 42.0,
          "base_amount": 42.0,
          "original_amount": 42.0,
          "base_original_amount": 42.0
        },
        "rule_label": "string",
        "rule_i_d": 42
      }
    ],
    "negotiable_quote_item": {
      "item_id": 42,
      "original_price": 42.0,
      "original_tax_amount": 42.0,
      "original_discount_amount": 42.0,
      "extension_attributes": {
        "negotiated_price_type": 42,
        "negotiated_price_value": 42.0,
        "last_item_notes": [
          {
            "note_id": 42,
            "negotiable_quote_item_id": 42,
            "creator_type": 42,
            "creator_id": 42,
            "note": "string",
            "created_at": "string",
            "extension_attributes": {}
          }
        ]
      }
    },
    "size": "string",
    "color": "string",
    "merchant_product_reference": "string",
    "category_code": "string",
    "image": "string",
    "mpn": "string",
    "msrp": 42.0,
    "manufacturer_code": "string",
    "manufacturer_name": "string",
    "merchant_code": "string",
    "merchant_name": "string",
    "merchant_city": "string",
    "parent_sku": "string",
    "is_sale": true,
    "return_item_fee": 42.0,
    "base_return_item_fee": 42.0,
    "is_outlet": true
  }
}

Response examples (400)

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