cart

cart.coupon.condition.add

Use this method to add additional conditions for coupon application.

post/cart.coupon.condition.add.json

Request

  • Base URL: https://api.api2cart.com/v1.1
  • URL: https://api.api2cart.com/v1.1/cart.coupon.condition.add.json
  • Auth: API key in header x-api-key and API key in header x-store-key

Query parameters

coupon_idstring required

Coupon Id

entity'order' | 'order_shipping_address' | 'product' | 'customer' required

Defines condition entity type

key'total' | 'subtotal' | 'shipping_total' | 'total_quantity' | 'total_weight' | 'country' | 'product_id' | 'variant_id' | 'category_id' | 'customer_id' | 'item_price' | 'item_total_price' | 'item_quantity' | 'carrier_id' required

Defines condition entity attribute key

operatorstring required

Defines condition operator

valuestring required

Defines condition value, can be comma separated according to the operator.

targetstring

Defines condition operator

include_taxboolean

Indicates whether to apply a discount for taxes.

include_shippingboolean

Indicates whether to apply a discount for shipping.

store_idstring

Store Id

idempotency_keystring

A unique identifier associated with a specific request. Repeated requests with the same <strong>idempotency_key</strong> return a cached response without re-executing the business logic. <strong>Please note that the cache lifetime is 15 minutes.</strong>

Response

successful operation

return_codeinteger
return_messagestring

Changes

No recorded changes to this operation across all 1 revision of this API.