Cart - Storefront GraphQL API

query

cartShipmentDetails

Get shipment details for the items in a cart, specific to the selected address. Shipment details include delivery promises, seller information, item details, and other relevant information.

Arguments

addressId

String

ID allotted to the selected address.

areaCode

String

The PIN Code of the destination address, e.g. 400059.

buyNow

Boolean

This is boolean to get buy_now cart.

String

The unique identifier of the cart.

orderType

String

The order type of shipment HomeDelivery - If the customer wants the order home-delivered PickAtStore - If the customer wants the handover of an order at the store itself. Digital - If the customer wants to buy digital voucher ( for jiogames ).

includePayment

Boolean

This is a boolean value. Select `true` to get a payment option in response.

Response

breakup_values

CartBreakup

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

buy_now

Boolean

Buy now flag of user cart.

cart_id

Int

Cart id of the user cart.

checkout_mode

String

Checkout mode of cart.

comment

String

Comment message added in cart.

coupon_text

String

Coupon text of coupon applied on cart.

currency

CartCurrency

Currency data of the cart for prices.

delivery_charge_info

String

Delivery charge in information message on shipment.

delivery_promise

ShipmentPromise

Shipment level promise information which denotes time in 3 different formats i.e formatted time, timestamp and iso format.

error

Boolean

Error details if any error occurs which includes type of error, error code and error message.

gstin

String

GSTIN number added in cart.

String

Cart id of the user cart.

is_valid

Boolean

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

last_modified

String

Last modified timestamp of cart.

message

String

Response message of get shipments API.

payment_selection_lock

PaymentSelectionLock

Payment Default Selection Schema.

restrict_checkout

Boolean

Restrict checkout flag to restrict the checkout process.

shipments

[ShipmentResponse]

List of Shipments which includes shipment data like shipment items, shipment promise, Shipment type, shipment order type, shipment dp options etc.

uid

String

Cart id of the user cart.

custom_cart_meta

JSON

Metadata for custom cart

Query

1query cartShipmentDetails(
2  $addressId: String
3  $areaCode: String
4  $buyNow: Boolean
5  $id: String
6  $orderType: String
7  $includePayment: Boolean
8) {
9  cartShipmentDetails(
10    addressId: $addressId
11    areaCode: $areaCode
12    buyNow: $buyNow
13    id: $id
14    orderType: $orderType
15    includePayment: $includePayment
16  ) {
17    buy_now
18    cart_id
19    checkout_mode
20    comment
21    coupon_text
22    currency {
23      code
24      symbol
25    }
26    delivery_charge_info
27    error
28    gstin
29    id
30    is_valid
31    last_modified
32    message
33    payment_selection_lock {
34      default_options
35      enabled
36      payment_identifier
37    }
38    restrict_checkout
39    shipments {
40      box_type
41      dp_id
42      dp_options
43      fulfillment_id
44      fulfillment_type
45      order_type
46      shipment_type
47      shipments
48    }
49    uid
50    custom_cart_meta
51  }
52}

Try it

Input Variables

1{
2  "addressId": "addressId",
3  "areaCode": "areaCode",
4  "buyNow": true,
5  "id": "08a16b83-9094-4e89-8c05-2ccadd5c1c7e",
6  "orderType": "orderType",
7  "includePayment": true
8}

Response

1{
2  "cartShipmentDetails": {
3    "buy_now": true,
4    "cart_id": 42,
5    "checkout_mode": "checkout_mode",
6    "comment": "comment",
7    "coupon_text": "coupon_text",
8    "currency": {
9      "code": "code",
10      "symbol": "symbol"
11    },
12    "delivery_charge_info": "delivery_charge_info",
13    "error": true,
14    "gstin": "gstin",
15    "id": "08a16b83-9094-4e89-8c05-2ccadd5c1c7e",
16    "is_valid": true,
17    "last_modified": "last_modified",
18    "message": "message",
19    "payment_selection_lock": {
20      "default_options": "default_options",
21      "enabled": true,
22      "payment_identifier": "payment_identifier"
23    },
24    "restrict_checkout": true,
25    "shipments": [
26      {
27        "box_type": "box_type",
28        "dp_id": "dp_id",
29        "dp_options": {},
30        "fulfillment_id": 42,
31        "fulfillment_type": "fulfillment_type",
32        "order_type": "order_type",
33        "shipment_type": "shipment_type",
34        "shipments": 42
35      }
36    ],
37    "uid": "uid",
38    "custom_cart_meta": {}
39  }
40}

Was this section helpful?

« updateCartWithSharedItems

AddCartRequestInput »