deleteProducts.v1

POST

/shopgate.cart.deleteProducts.v1

Deletes all given cart items of type “product” from the cart, if the applied cart rules don’t prevent it.

Note: Depending on the installed extensions, custom errors can be returned on failure.

Request Body

Media typeapplication/json

Id of the cart item to be deleted or modified.

Array<string>

Example^generated

[
  "example"
]

Responses

ok

Returns an empty object after the action was performed.

Media typeapplication/json

object

output

required

object

Example

{
  "output": {}
}

ECART

This error is thrown when there is an issue with deleting one or multiple products from the cart.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: ECART

message

string

errors

Array<object>

object

entityId

required

string

code

required

string

Allowed values: ENOTFOUND EINSUFFICIENTSTOCK

message

required

The message specific to the product with the matching identifier. This is either a translation string or an already translated string. Translation strings are just key/object or key/value pairs defined in the ‘locales/.json’ files, that have a translation which could be applied. The value syntax assigned for each translation string key is described here: https://github.com/yahoo/intl-messageformat#message-syntax

string

messageParams

The message params for the translation string. Translation params are just key/value pairs defined in the translation string defined in the ‘locales/.json’ for the translation key in the message property. It defaults to an empty object if the property is missing or null. The translation string syntax is described here: https://github.com/yahoo/intl-messageformat#message-syntax

object

my-custom-key

string

my-custom-value

string

translated

Indicates if the ‘message’ property contains a translated string (true) or a translation string (false or undefined). Defaults to true if the property is missing or null.

boolean

Example

{
  "error": {
    "code": "ECART",
    "message": "There was a problem while trying to delete one or multiple products.",
    "errors": [
      {
        "entityId": "cart-item-product-ABC54321",
        "code": "ENOTFOUND",
        "message": "cart.error.cartItemProductNotFound",
        "messageParams": {
          "cartItemName": "5 Pack of Apple Pie"
        },
        "translated": false
      }
    ]
  }
}

EUNKNOWN

An internal error occurred.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: EUNKNOWN

message

string

Example

{
  "error": {
    "code": "EUNKNOWN",
    "message": "An internal error occurred."
  }
}