Skip to content
Last update: February 14, 2024

Cart query

This query allows you to retrieve information about a shopping cart.

Arguments

Argument Description
storeId String! The Id of the store to retrieve carts from.
userId String The Id of the user.
currencyCode String! A standardized code of a specific currency.
cultureName String The language to retrieve data in.
cartName String The name or the identifier of the cart.
cartType String The type of cart being queried.

Possible returns

Possible return Description
CartType Defines the properties and fields associated with a shopping cart.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
{
  cart(
    storeId: "B2B-Store"
    cartName: "default"
    userId: "d97ee2c7-e29d-440a-a43a-388eb5586087"
    cultureName: "en-Us"
    currencyCode: "USD"
    cartType: "cart"
  ) {
    id
    name
    hasPhysicalProducts
    status
    storeId
    isAnonymous
    comment
    taxPercentRate
    taxType
    addresses {
      countryName
      regionName
      city
      addressType
    }
    dynamicProperties {
      name
      value
      valueType
    }
    shipments {
      shipmentMethodCode
      shipmentMethodOption
    }
    availableShippingMethods {
      code
      optionName
      optionDescription
    }
    discounts {
      amount
      description
    }
    currency {
      code
      symbol
    }
    payments {
      paymentGatewayCode
    }
    availablePaymentMethods {
      code
      paymentMethodType
    }
    items {
      id
      sku
    }
    coupons {
      code
      isAppliedSuccessfully
    }
    itemsCount
    itemsQuantity
    type
  }
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
{
  "data": {
    "cart": {
    "id": "6255f029-d3d9-41ea-9643-a1f99c29c534",
    "name": "default",
    "hasPhysicalProducts": false,
    "status": null,
    "storeId": "B2B-Store",
    "isAnonymous": true,
    "comment": null,
    "taxPercentRate": 0,
    "taxType": null,
    "addresses": [],
    "dynamicProperties": [
        {
        "name": "CartModule_ShoppingCart_Boolean_0_0_0",
        "value": null,
        "valueType": "Boolean"
        },
        {
        "name": "CartModule_ShoppingCart_DateTime_0_0_0",
        "value": null,
        "valueType": "DateTime"
        },
        {
        "name": "CartModule_ShoppingCart_Decimal_0_0_0",
        "value": null,
        "valueType": "Decimal"
        },
        {
        "name": "CartModule_ShoppingCart_Decimal_1_0_0",
        "value": null,
        "valueType": "Decimal"
        },
        {
        "name": "CartModule_ShoppingCart_Html_0_0_0",
        "value": null,
        "valueType": "Html"
        },
        {
        "name": "CartModule_ShoppingCart_Html_0_1_0",
        "value": null,
        "valueType": "Html"
        },
        {
        "name": "CartModule_ShoppingCart_Image_0_0_0",
        "value": null,
        "valueType": "Image"
        },
    ],
    "shipments": [],
    "availableShippingMethods": [
        {
        "code": "FixedRate",
        "optionName": "Ground",
        "optionDescription": null
        },
        {
        "code": "FixedRate",
        "optionName": "Air",
        "optionDescription": null
        }
    ],
    "discounts": null,
    "currency": {
        "code": "USD",
        "symbol": "$"
    },
    "payments": [],
    "availablePaymentMethods": [
        {
        "code": "AuthorizeNetPaymentMethod",
        "paymentMethodType": "PreparedForm"
        },
        {
        "code": "DefaultManualPaymentMethod",
        "paymentMethodType": "Unknown"
        }
    ],
    "items": [],
    "coupons": [],
    "itemsCount": 0,
    "itemsQuantity": 0,
    "type": "cart"
    }
  }
}