Cart - Storefront GraphQL API

mutation

removeCoupon

Remove an applied coupon from the customer's cart, thereby removing the associated discount from the cart total.

Arguments

buyNow

Boolean

Wheter to get buy_now cart.

String

The unique identifier of the cart.

Response

applied_promo_details

[AppliedPromotion]

List of applied promotions data to cart which includes promotion id, promotion name, offer text, description, buy rules, discount rules and promotion type.

breakup_values

CartBreakup

Price breakup of cart which denotes different values like coupon, display, and loyalty points.

buy_now

Boolean

Buy now flag for the cart which denotes user is doing fast checkout for the cart using buy now.

cart_id

Int

Unique identifier of the user cart.

checkout_mode

String

Checkout mode of user cart.

comment

String

Comment message to be added in user cart.

coupon

CartDetailCoupon

Coupon data of user cart which denotes if coupon is applied, coupon code, coupon amount, coupon title and coupon message.

common_config

CartCommonConfig

Common config at sales channel which includes delivery charge config.

coupon_text

String

Coupon text of coupon applied on cart.

currency

CartCurrency

Currency of the price for the cart.

delivery_charge_info

String

Delivery charge in information message on shipment.

delivery_promise

DeliveryPromiseResponse

Delivery promise of user cart.

gstin

String

GSTIN added in user cart.

String

Unique identifier of the user cart.

is_valid

Boolean

Cart validity flag determines the if the response is valid or not.

items

[CartProductInfo]

Items data list in user cart that includes item id, item size, store id, available sizes and rest of the item related data.

last_modified

String

Last modified timestamp of cart.

message

String

Message of the get cart detail API response.

notification

JSON

Notification object which denotes notification data for user cart.

pan_config

JSON

Pan card config states at what condition user should enter the pan card.

pan_no

String

Permanent Account Number of the user.

payment_selection_lock

PaymentSelectionLock

Payment selection lock config for the user cart.

restrict_checkout

Boolean

Restrict checkout flag to restrict the checkout process.

staff_user_id

String

Staff employee user id if cart is created by staff employee for the customer.

success

Boolean

Success flag of get cart detail API response.

uid

String

Unique identifier of the user cart.

custom_cart_meta

JSON

Metadata for custom cart

Mutation

1mutation removeCoupon($buyNow: Boolean, $id: String) {
2  removeCoupon(buyNow: $buyNow, id: $id) {
3    applied_promo_details {
4      amount
5      article_quantity
6      code
7      meta
8      mrp_promotion
9      offer_text
10      promo_id
11      promotion_group
12      promotion_name
13      promotion_type
14      cancellation_allowed
15    }
16    buy_now
17    cart_id
18    checkout_mode
19    comment
20    coupon {
21      cashback_amount
22      cashback_message_primary
23      cashback_message_secondary
24      coupon_code
25      coupon_description
26      coupon_id
27      coupon_subtitle
28      coupon_title
29      coupon_type
30      coupon_value
31      discount
32      is_applied
33      is_valid
34      maximum_discount_value
35      message
36      minimum_cart_value
37    }
38    coupon_text
39    currency {
40      code
41      symbol
42    }
43    delivery_charge_info
44    gstin
45    id
46    is_valid
47    items {
48      coupon_message
49      custom_order
50      discount
51      is_set
52      key
53      message
54      moq
55      parent_item_identifiers
56      product_ean_id
57      quantity
58      bulk_offer
59    }
60    last_modified
61    message
62    notification
63    pan_config
64    pan_no
65    payment_selection_lock {
66      default_options
67      enabled
68      payment_identifier
69    }
70    restrict_checkout
71    staff_user_id
72    success
73    uid
74    custom_cart_meta
75  }
76}

Try it

Input Variables

1{
2  "buyNow": true,
3  "id": "08a16b83-9094-4e89-8c05-2ccadd5c1c7e"
4}

Response

1{
2  "removeCoupon": {
3    "applied_promo_details": [
4      {
5        "amount": 30.7,
6        "article_quantity": 42,
7        "code": "code",
8        "meta": {},
9        "mrp_promotion": true,
10        "offer_text": "offer_text",
11        "promo_id": "promo_id",
12        "promotion_group": "promotion_group",
13        "promotion_name": "promotion_name",
14        "promotion_type": "promotion_type",
15        "cancellation_allowed": true
16      }
17    ],
18    "buy_now": true,
19    "cart_id": 42,
20    "checkout_mode": "checkout_mode",
21    "comment": "comment",
22    "coupon": {
23      "cashback_amount": 30.7,
24      "cashback_message_primary": "cashback_message_primary",
25      "cashback_message_secondary": "cashback_message_secondary",
26      "coupon_code": "coupon_code",
27      "coupon_description": "coupon_description",
28      "coupon_id": "coupon_id",
29      "coupon_subtitle": "coupon_subtitle",
30      "coupon_title": "coupon_title",
31      "coupon_type": "coupon_type",
32      "coupon_value": 30.7,
33      "discount": 30.7,
34      "is_applied": true,
35      "is_valid": true,
36      "maximum_discount_value": 30.7,
37      "message": "message",
38      "minimum_cart_value": 30.7
39    },
40    "coupon_text": "coupon_text",
41    "currency": {
42      "code": "code",
43      "symbol": "symbol"
44    },
45    "delivery_charge_info": "delivery_charge_info",
46    "gstin": "gstin",
47    "id": "08a16b83-9094-4e89-8c05-2ccadd5c1c7e",
48    "is_valid": true,
49    "items": [
50      {
51        "coupon_message": "coupon_message",
52        "custom_order": {},
53        "discount": "discount",
54        "is_set": true,
55        "key": "key",
56        "message": "message",
57        "moq": {},
58        "parent_item_identifiers": {},
59        "product_ean_id": "product_ean_id",
60        "quantity": 42,
61        "bulk_offer": {}
62      }
63    ],
64    "last_modified": "last_modified",
65    "message": "message",
66    "notification": {},
67    "pan_config": {},
68    "pan_no": "pan_no",
69    "payment_selection_lock": {
70      "default_options": "default_options",
71      "enabled": true,
72      "payment_identifier": "payment_identifier"
73    },
74    "restrict_checkout": true,
75    "staff_user_id": "staff_user_id",
76    "success": true,
77    "uid": "uid",
78    "custom_cart_meta": {}
79  }
80}

Was this section helpful?

« Introduction

address »