Cart
{
countryCode: "US",
customAttributes: [
{
key: "giftNote",
value: "This is a gift for you",
},
],
customer: {
tags: [
"tag1",
"tag2",
],
},
email: "dev@nyla.app",
isError: false,
isLoading: false,
lineItems: [
{
customAttributes: [
{
key: "_nyla_id",
value: "903facc8-66e7-473b-bb46-c772efa5ae11",
},
],
isRequired: true,
properties: {
_nyla_id: "903facc8-66e7-473b-bb46-c772efa5ae11",
},
quantity: 1,
sellingPlanAllocation: {
sellingPlan: {
id: "gid://shopify/SellingPlan/8363934017",
name: "Every 3 months",
priceAdjustments: [
{
adjustmentValue: {
__typename: "SellingPlanPercentagePriceAdjustment",
adjustmentPercentage: 10,
},
orderCount: null,
},
],
},
},
sellingPlanId: "gid://shopify/SellingPlan/8363934017",
variant: {
available: true,
compareAtPrice: null,
id: "gid://shopify/ProductVariant/41606287196325",
image: {
altText: "Dusk",
height: 4000,
id: "gid://shopify/ProductImage/32788373405861",
src: "https://cdn.shopify.com/s/files/1/0584/6053/6997/products/Pebble.jpg?v=1655995077",
width: 4000,
},
price: {
amount: "22.0",
currencyCode: "USD",
},
product: {
handle: "lip-liner",
id: "gid://shopify/Product/7686486884517",
title: "Lip liner",
},
selectedOptions: [
{
name: "Shade",
value: "Noon",
},
],
sku: "",
title: "Noon",
unitPrice: null,
unitPriceMeasurement: {
measuredType: null,
quantityUnit: null,
quantityValue: 0,
referenceUnit: null,
referenceValue: 0,
},
weight: 0,
},
},
{
customAttributes: [
{
key: "_nyla_id",
value: "4385197b-17ca-4989-9547-0abdfe6b54f4",
},
],
isRequired: false,
properties: {
_nyla_id: "4385197b-17ca-4989-9547-0abdfe6b54f4",
},
quantity: 1,
sellingPlanAllocation: {
sellingPlan: {
id: "gid://shopify/SellingPlan/8363934017",
name: "Every 3 months",
priceAdjustments: [
{
adjustmentValue: {
__typename: "SellingPlanFixedPriceAdjustment",
price: {
amount: "4.0",
currencyCode: "USD",
},
},
orderCount: null,
},
],
},
},
sellingPlanId: "gid://shopify/SellingPlan/8363934017",
variant: {
available: true,
compareAtPrice: {
amount: "32.0",
currencyCode: "USD",
},
id: "gid://shopify/ProductVariant/41606292635813",
image: {
altText: "50ml, Dawn",
height: 4000,
id: "gid://shopify/ProductImage/32788389986469",
src: "https://cdn.shopify.com/s/files/1/0584/6053/6997/products/Eye-pink-large.jpg?v=1670936490",
width: 4000,
},
price: {
amount: "28.0",
currencyCode: "USD",
},
product: {
handle: "eye-glow",
id: "gid://shopify/Product/7686493241509",
title: "Eye glow",
},
selectedOptions: [
{
name: "Shade",
value: "Dawn",
},
{
name: "Size",
value: "50ml",
},
],
sku: "",
title: "Dawn / 50ml",
unitPrice: null,
unitPriceMeasurement: {
measuredType: null,
quantityUnit: null,
quantityValue: 0,
referenceUnit: null,
referenceValue: 0,
},
weight: 0,
},
},
{
customAttributes: [
{
key: "_nyla_gift_id",
value: "apps_12323",
},
],
gift: {
description: "Gift Description",
id: "apps_12323",
title: "Gift Title",
type: "auto",
},
isRequired: false,
properties: {
_nyla_gift_id: "apps_12323",
},
quantity: 1,
sellingPlanAllocation: null,
variant: {
available: false,
compareAtPrice: null,
id: "gid://shopify/ProductVariant/0",
image: {
altText: "",
height: 0,
id: "gid://shopify/ProductImage/0",
src: "https://cdn.shopify.com/s/files/1/0584/6053/6997/products/Pebble.jpg?v=1655995077",
width: 0,
},
price: {
amount: "20.0",
currencyCode: "USD",
},
product: {
handle: "gift-product",
id: "gid://shopify/Product/0",
title: "Gift Product",
},
selectedOptions: [],
sku: "",
title: "Gift Variant",
unitPrice: null,
unitPriceMeasurement: {
measuredType: null,
quantityUnit: null,
quantityValue: 0,
referenceUnit: null,
referenceValue: 0,
},
weight: 0,
},
},
],
lineItemsSubtotalPrice: {
amount: "50.0",
currencyCode: "USD",
},
presentmentCurrencyRate: 1,
properties: {
giftNote: "This is a gift for you",
},
subtotalPrice: {
amount: 50,
currencyCode: "USD",
},
totalPoints: 0,
totalPrice: {
amount: "53.88",
currencyCode: "USD",
},
webUrl: "https://nyla-starter.myshopify.com/cart/c/c1-17045e3dca063ad2e7b497bf1e3bbe21",
}Properties
The country where the buyer is located.
The attributes associated with the cart. Attributes are represented as key-value pairs.
The key of the custom attribute.
The value of the custom attribute.
The customer associated with the cart.
The tags associated with the customer.
The email address of the buyer that is interacting with the cart.
The error status of the cart.
The loading status of the cart.
A list of lines containing information about the items the customer intends to purchase.
The attributes associated with the cart line. Attributes are represented as key-value pairs.
The key of the custom attribute.
The value of the custom attribute.
The gift associated with the cart line.
The description of the gift.
The id of the gift.
The title of the gift.
The type of the gift. Can be "auto" or "choice".
When this flag is enable, product should always be added to the selection, this can not be changed
The attributes associated with the cart line.
An attribute associated with the cart line.
The quantity of the merchandise that the customer intends to purchase.
Represents an association between a variant and a selling plan. Selling plan allocations describe which selling plans are available for each variant, and what their impact is on pricing.
A representation of how products and variants can be sold and purchased. For example, an individual selling plan could be '6 weeks of prepaid granola, delivered weekly'.
A globally-unique ID.
Selling plan name.
The price adjustments that a selling plan makes when a variant is purchased with a selling plan.
The type of price adjustment. An adjustment value can have one of three types: percentage, amount off, or a new price.
Discount percentage, only one time of discount is applicable at the same time, fixed or percentage.
Discount price object, this is intended to use for a fixed discount.
Discount amount
Currency code
The number of orders that the price adjustment applies to. If the price adjustment always applies, then this field is null.
Selling plan id
The variant of the line item.
Indicates if the product variant is available for sale.
The compare at price of the variant. This can be used to mark a variant as on sale, when compareAtPrice is higher than price.
A globally-unique identifier from Shopify (the GraphQL long-form format).
Image associated with the product variant. This field falls back to the product image if no image is available.
The product variant’s price.
The product of the variant.
A human-friendly unique string for the product automatically generated from its title.
A globally-unique identifier from Shopify (the GraphQL long-form format).
The title of the product.
List of product options applied to the variant.
The product option’s name.
The product option’s value.
The SKU (stock keeping unit) associated with the variant.
The title of the variant.
The unit price value for the variant based on the variant's measurement.
The unit price measurement for the variant.
The type of unit of measurement for the unit price measurement.
The quantity unit for the unit price measurement.
The quantity value for the unit price measurement.
The reference unit for the unit price measurement.
The reference value for the unit price measurement.
The weight of the product variant in the unit system specified with weight_unit.
The amount, before taxes and cart-level discounts, for the customer to pay.
The presentment currency rate of the cart.
The attributes associated with the cart.
An attribute associated with the cart.
The price at checkout before shipping and taxes.
The total loyalty points used in the cart.
The total amount for the customer to pay.
The URL of the checkout for the cart.