Retail GraphQL API
Official API documentation
API Endpoints
https://api.yourdomain.com/graphqlVersion
1.0.0
Queries
aiProductsSugeestions
Response
Returns an AIProductList
Example
Query
query aiProductsSugeestions(
$storeId: String!,
$countries: [String],
$priceMin: Float,
$priceMax: Float,
$searchValue: String,
$isNewArrival: Boolean,
$quantityMin: Float
) {
aiProductsSugeestions(
storeId: $storeId,
countries: $countries,
priceMin: $priceMin,
priceMax: $priceMax,
searchValue: $searchValue,
isNewArrival: $isNewArrival,
quantityMin: $quantityMin
) {
items {
...ProductFragment
}
totalCount
productIds
nextPageCursor
}
}
Variables
{
"storeId": "abc123",
"countries": ["xyz789"],
"priceMin": 987.65,
"priceMax": 123.45,
"searchValue": "abc123",
"isNewArrival": false,
"quantityMin": 987.65
}
Response
{
"data": {
"aiProductsSugeestions": {
"items": [Product],
"totalCount": 987,
"productIds": ["abc123"],
"nextPageCursor": "abc123"
}
}
}
block
Example
Query
query block(
$projectId: String,
$slug: String
) {
block(
projectId: $projectId,
slug: $slug
) {
buttons {
...ButtonFragment
}
id
image
imageAlt
category
deltaContent
htmlContent
textContent
slug
projectId
storeId
deltaPreTitle
htmlPreTitle
textPreTitle
deltaTitle
htmlTitle
textTitle
variant
}
}
Variables
{
"projectId": "abc123",
"slug": "xyz789"
}
Response
{
"data": {
"block": {
"buttons": [Button],
"id": 4,
"image": "abc123",
"imageAlt": "abc123",
"category": "abc123",
"deltaContent": "xyz789",
"htmlContent": "xyz789",
"textContent": "abc123",
"slug": "xyz789",
"projectId": "xyz789",
"storeId": "abc123",
"deltaPreTitle": "abc123",
"htmlPreTitle": "abc123",
"textPreTitle": "xyz789",
"deltaTitle": "abc123",
"htmlTitle": "xyz789",
"textTitle": "abc123",
"variant": "xyz789"
}
}
}
blockBySlug
Description
Get a specific block by its slug
Response
Returns a Block
Example
Query
query blockBySlug(
$projectId: String!,
$slug: String!,
$storeId: String
) {
blockBySlug(
projectId: $projectId,
slug: $slug,
storeId: $storeId
) {
buttons {
...ButtonFragment
}
id
image
imageAlt
category
deltaContent
htmlContent
textContent
slug
projectId
storeId
deltaPreTitle
htmlPreTitle
textPreTitle
deltaTitle
htmlTitle
textTitle
variant
}
}
Variables
{
"projectId": "abc123",
"slug": "abc123",
"storeId": "xyz789"
}
Response
{
"data": {
"blockBySlug": {
"buttons": [Button],
"id": "4",
"image": "abc123",
"imageAlt": "xyz789",
"category": "xyz789",
"deltaContent": "xyz789",
"htmlContent": "xyz789",
"textContent": "xyz789",
"slug": "xyz789",
"projectId": "abc123",
"storeId": "abc123",
"deltaPreTitle": "abc123",
"htmlPreTitle": "xyz789",
"textPreTitle": "xyz789",
"deltaTitle": "xyz789",
"htmlTitle": "xyz789",
"textTitle": "xyz789",
"variant": "xyz789"
}
}
}
blocks
Response
Returns a BlockList
Example
Query
query blocks(
$category: String!,
$projectId: String!,
$storeId: String
) {
blocks(
category: $category,
projectId: $projectId,
storeId: $storeId
) {
items {
...BlockFragment
}
nextPageCursor
totalCount
}
}
Variables
{
"category": "xyz789",
"projectId": "xyz789",
"storeId": "abc123"
}
Response
{
"data": {
"blocks": {
"items": [Block],
"nextPageCursor": "abc123",
"totalCount": 987
}
}
}
blogPost
Description
Get a specific blog post by its slug
Example
Query
query blogPost($slug: String!) {
blogPost(slug: $slug) {
id
title
image
content
deltaContent
author
slug
featured
date
}
}
Variables
{"slug": "xyz789"}
Response
{
"data": {
"blogPost": {
"id": 4,
"title": "xyz789",
"image": "abc123",
"content": "xyz789",
"deltaContent": "abc123",
"author": "xyz789",
"slug": "xyz789",
"featured": 987,
"date": "abc123"
}
}
}
blogPosts
Description
Get a list of blog posts
Response
Returns a BlogPostList
Example
Query
query blogPosts(
$dateAfter: String,
$dateBefore: String
) {
blogPosts(
dateAfter: $dateAfter,
dateBefore: $dateBefore
) {
items {
...BlogPostFragment
}
nextPageCursor
totalCount
}
}
Variables
{
"dateAfter": "xyz789",
"dateBefore": "xyz789"
}
Response
{
"data": {
"blogPosts": {
"items": [BlogPost],
"nextPageCursor": "abc123",
"totalCount": 123
}
}
}
broadcastToAdmin
Response
Returns a String
Example
Query
query broadcastToAdmin {
broadcastToAdmin
}
Response
{"data": {"broadcastToAdmin": "xyz789"}}
cart
Description
Get a user's cart. User must be either logged in or supply a token.
Example
Query
query cart(
$token: String,
$storeId: String!
) {
cart(
token: $token,
storeId: $storeId
) {
id
blockCheckout
phone
email
vipId
items {
...CartItemFragment
}
giftCardRecipientName
giftWrapping
adjustments {
...CartAdjustmentFragment
}
discounts {
...CartDiscountFragment
}
promoCode
tipPercent
specialInstructions
eventInfo {
...CartEventInfoFragment
}
shippingAddress {
...CartShippingAddressFragment
}
shippingQuotes {
...CartShippingMethodFragment
}
shippingMethod {
...CartShippingMethodFragment
}
isAsap
dateExpected
deliveryPriority
deliveryWindowFrom
deliveryWindowUntil
loyaltyPoints
loyaltyError
billingAddress {
...CartBillingAddressFragment
}
summary {
...CartSummaryFragment
}
token
storeId
orderNumber
}
}
Variables
{
"token": "abc123",
"storeId": "abc123"
}
Response
{
"data": {
"cart": {
"id": "xyz789",
"blockCheckout": true,
"phone": "abc123",
"email": "abc123",
"vipId": "abc123",
"items": [CartItem],
"giftCardRecipientName": "xyz789",
"giftWrapping": 123.45,
"adjustments": [CartAdjustment],
"discounts": [CartDiscount],
"promoCode": "xyz789",
"tipPercent": 123.45,
"specialInstructions": "abc123",
"eventInfo": CartEventInfo,
"shippingAddress": CartShippingAddress,
"shippingQuotes": [CartShippingMethod],
"shippingMethod": CartShippingMethod,
"isAsap": false,
"dateExpected": "abc123",
"deliveryPriority": "abc123",
"deliveryWindowFrom": "xyz789",
"deliveryWindowUntil": "abc123",
"loyaltyPoints": 987,
"loyaltyError": "xyz789",
"billingAddress": CartBillingAddress,
"summary": CartSummary,
"token": "abc123",
"storeId": "xyz789",
"orderNumber": "xyz789"
}
}
}
collection
Description
Get a specific collection by its id
Response
Returns a Collection
Arguments
| Name | Description |
|---|---|
slug - String!
|
Example
Query
query collection($slug: String!) {
collection(slug: $slug) {
id
name
image
deltaContent
htmlContent
slug
storeId
}
}
Variables
{"slug": "abc123"}
Response
{
"data": {
"collection": {
"id": 4,
"name": "xyz789",
"image": "abc123",
"deltaContent": "xyz789",
"htmlContent": "abc123",
"slug": "abc123",
"storeId": "xyz789"
}
}
}
collectionList
Description
Get a list of collections
Response
Returns a CollectionList
Example
Query
query collectionList {
collectionList {
items {
...CollectionFragment
}
nextPageCursor
totalCount
}
}
Response
{
"data": {
"collectionList": {
"items": [Collection],
"nextPageCursor": "xyz789",
"totalCount": 987
}
}
}
customer
Response
Returns a Customer
Example
Query
query customer {
customer {
id
stripeId
firstName
lastName
phone
email
vipId
shippingAddress {
...CustomerShippingAddressFragment
}
billingAddress {
...CustomerBillingAddressFragment
}
subscriptions
stores {
...CustomerStoreFragment
}
payment {
...CustomerCreditCardFragment
}
error
}
}
Response
{
"data": {
"customer": {
"id": "abc123",
"stripeId": "xyz789",
"firstName": "xyz789",
"lastName": "abc123",
"phone": "abc123",
"email": "abc123",
"vipId": "xyz789",
"shippingAddress": CustomerShippingAddress,
"billingAddress": CustomerBillingAddress,
"subscriptions": ["abc123"],
"stores": [CustomerStore],
"payment": CustomerCreditCard,
"error": ["xyz789"]
}
}
}
event
Description
Get a specific event by its id
Example
Query
query event($slug: String!) {
event(slug: $slug) {
id
name
image
description
slug
begins
ends
location {
...LocationFragment
}
locationMap
type
isTicketed
isRsvpOnly
isAvailableOnline
ticketCost
sku
}
}
Variables
{"slug": "abc123"}
Response
{
"data": {
"event": {
"id": 4,
"name": "xyz789",
"image": "xyz789",
"description": "xyz789",
"slug": "xyz789",
"begins": "abc123",
"ends": "xyz789",
"location": [Location],
"locationMap": "abc123",
"type": "abc123",
"isTicketed": true,
"isRsvpOnly": true,
"isAvailableOnline": true,
"ticketCost": 123.45,
"sku": "xyz789"
}
}
}
events
Description
Get a list of events
Response
Returns [Event]
Example
Query
query events(
$beginsAfter: String,
$beginsBefore: String,
$type: String,
$isTicketed: Boolean,
$isRsvpOnly: Boolean,
$isAvailableOnline: Boolean,
$sortBy: String,
$sortOrder: String,
$pageLimit: Int
) {
events(
beginsAfter: $beginsAfter,
beginsBefore: $beginsBefore,
type: $type,
isTicketed: $isTicketed,
isRsvpOnly: $isRsvpOnly,
isAvailableOnline: $isAvailableOnline,
sortBy: $sortBy,
sortOrder: $sortOrder,
pageLimit: $pageLimit
) {
id
name
image
description
slug
begins
ends
location {
...LocationFragment
}
locationMap
type
isTicketed
isRsvpOnly
isAvailableOnline
ticketCost
sku
}
}
Variables
{
"beginsAfter": "abc123",
"beginsBefore": "abc123",
"type": "abc123",
"isTicketed": false,
"isRsvpOnly": true,
"isAvailableOnline": false,
"sortBy": "abc123",
"sortOrder": "xyz789",
"pageLimit": 123
}
Response
{
"data": {
"events": [
{
"id": "4",
"name": "abc123",
"image": "xyz789",
"description": "abc123",
"slug": "abc123",
"begins": "xyz789",
"ends": "abc123",
"location": [Location],
"locationMap": "abc123",
"type": "abc123",
"isTicketed": true,
"isRsvpOnly": false,
"isAvailableOnline": false,
"ticketCost": 987.65,
"sku": "xyz789"
}
]
}
}
faqs
Description
Get a list of faqs
Response
Returns [Faq]
Example
Query
query faqs {
faqs {
id
question
answer
}
}
Response
{
"data": {
"faqs": [
{
"id": "4",
"question": "abc123",
"answer": "xyz789"
}
]
}
}
homePage
Response
Returns a Homepage!
Example
Query
query homePage {
homePage {
logo
Location
ThemeColor {
...ThemeColorFragment
}
BannerSlides {
...BannerSlideFragment
}
BrandSlides {
...BrandSlideFragment
}
CTASection {
...CTASectionFragment
}
ServiceSection {
...ServiceSectionFragment
}
NewlyLauched
AIRecommendation
MatchedMoods
Footer {
...FooterFragment
}
BulkDiscount {
...BulkDiscountDataFragment
}
}
}
Response
{
"data": {
"homePage": {
"logo": "abc123",
"Location": true,
"ThemeColor": ThemeColor,
"BannerSlides": [BannerSlide],
"BrandSlides": [BrandSlide],
"CTASection": CTASection,
"ServiceSection": ServiceSection,
"NewlyLauched": true,
"AIRecommendation": true,
"MatchedMoods": false,
"Footer": Footer,
"BulkDiscount": BulkDiscountData
}
}
}
moods
Response
Returns a MoodsReponse
Example
Query
query moods {
moods {
moods {
...MoodsFragment
}
}
}
Response
{"data": {"moods": {"moods": [Moods]}}}
order
Description
Get a specific order. User must be either logged in or supply a token.
Response
Returns an Order
Example
Query
query order(
$id: ID,
$orderNumber: String,
$cartToken: String
) {
order(
id: $id,
orderNumber: $orderNumber,
cartToken: $cartToken
) {
id
orderNumber
date
dateDelivered
email
items {
...OrderItemFragment
}
giftWrapping
promoCode
eventInfo {
...OrderEventInfoFragment
}
shippingAddress {
...OrderShippingAddressFragment
}
shippingMethod {
...OrderShippingMethodFragment
}
specialInstructions
billingAddress {
...OrderBillingAddressFragment
}
paymentMethod
summary {
...OrderSummaryFragment
}
storeId
}
}
Variables
{
"id": 4,
"orderNumber": "abc123",
"cartToken": "xyz789"
}
Response
{
"data": {
"order": {
"id": 4,
"orderNumber": "xyz789",
"date": "abc123",
"dateDelivered": "xyz789",
"email": "xyz789",
"items": [OrderItem],
"giftWrapping": 123.45,
"promoCode": "xyz789",
"eventInfo": OrderEventInfo,
"shippingAddress": OrderShippingAddress,
"shippingMethod": OrderShippingMethod,
"specialInstructions": "xyz789",
"billingAddress": OrderBillingAddress,
"paymentMethod": "abc123",
"summary": OrderSummary,
"storeId": "abc123"
}
}
}
orders
Description
Get a list of user's orders. User must be logged in.
Response
Returns [Order]
Example
Query
query orders {
orders {
id
orderNumber
date
dateDelivered
email
items {
...OrderItemFragment
}
giftWrapping
promoCode
eventInfo {
...OrderEventInfoFragment
}
shippingAddress {
...OrderShippingAddressFragment
}
shippingMethod {
...OrderShippingMethodFragment
}
specialInstructions
billingAddress {
...OrderBillingAddressFragment
}
paymentMethod
summary {
...OrderSummaryFragment
}
storeId
}
}
Response
{
"data": {
"orders": [
{
"id": 4,
"orderNumber": "xyz789",
"date": "abc123",
"dateDelivered": "xyz789",
"email": "xyz789",
"items": [OrderItem],
"giftWrapping": 987.65,
"promoCode": "xyz789",
"eventInfo": OrderEventInfo,
"shippingAddress": OrderShippingAddress,
"shippingMethod": OrderShippingMethod,
"specialInstructions": "abc123",
"billingAddress": OrderBillingAddress,
"paymentMethod": "xyz789",
"summary": OrderSummary,
"storeId": "xyz789"
}
]
}
}
ping
Response
Returns a String!
Example
Query
query ping {
ping
}
Response
{"data": {"ping": "xyz789"}}
privacyAndTerms
Description
Get privacy and terms content
Example
Query
query privacyAndTerms($type: String!) {
privacyAndTerms(type: $type) {
id
title
content
type
}
}
Variables
{"type": "abc123"}
Response
{
"data": {
"privacyAndTerms": {
"id": 4,
"title": "xyz789",
"content": "xyz789",
"type": "abc123"
}
}
}
productBrands
Description
Get all possible brands
productByOldSlug
Response
Returns a Product
Example
Query
query productByOldSlug(
$productTags: [String],
$oldSlug: String!,
$storeId: String!
) {
productByOldSlug(
productTags: $productTags,
oldSlug: $oldSlug,
storeId: $storeId
) {
id
name
brand
customBrand
slug
oldSlug
description
collections
country
region
priceFrom
priceTo
retailPriceFrom
retailPriceTo
isOnSale
tags {
...ProductTagFragment
}
imageIds
posImages
customImages
gulpImages
bestSellerScore
isFeatured
isFeaturedOnHomepage
isStaffPick
storeId
variants {
...ProductVariantFragment
}
}
}
Variables
{
"productTags": ["abc123"],
"oldSlug": "abc123",
"storeId": "xyz789"
}
Response
{
"data": {
"productByOldSlug": {
"id": "4",
"name": "abc123",
"brand": "xyz789",
"customBrand": "xyz789",
"slug": "abc123",
"oldSlug": "xyz789",
"description": "xyz789",
"collections": ["xyz789"],
"country": "xyz789",
"region": "abc123",
"priceFrom": 987.65,
"priceTo": 123.45,
"retailPriceFrom": 987.65,
"retailPriceTo": 987.65,
"isOnSale": false,
"tags": [ProductTag],
"imageIds": ["xyz789"],
"posImages": ["abc123"],
"customImages": ["abc123"],
"gulpImages": ["xyz789"],
"bestSellerScore": 123,
"isFeatured": false,
"isFeaturedOnHomepage": false,
"isStaffPick": true,
"storeId": "xyz789",
"variants": [ProductVariant]
}
}
}
productBySlug
Description
Get a specific product by its slug
Response
Returns a Product
Example
Query
query productBySlug(
$productTags: [String],
$slug: String!,
$storeId: String!
) {
productBySlug(
productTags: $productTags,
slug: $slug,
storeId: $storeId
) {
id
name
brand
customBrand
slug
oldSlug
description
collections
country
region
priceFrom
priceTo
retailPriceFrom
retailPriceTo
isOnSale
tags {
...ProductTagFragment
}
imageIds
posImages
customImages
gulpImages
bestSellerScore
isFeatured
isFeaturedOnHomepage
isStaffPick
storeId
variants {
...ProductVariantFragment
}
}
}
Variables
{
"productTags": ["xyz789"],
"slug": "abc123",
"storeId": "xyz789"
}
Response
{
"data": {
"productBySlug": {
"id": "4",
"name": "abc123",
"brand": "abc123",
"customBrand": "abc123",
"slug": "xyz789",
"oldSlug": "abc123",
"description": "xyz789",
"collections": ["xyz789"],
"country": "xyz789",
"region": "abc123",
"priceFrom": 123.45,
"priceTo": 987.65,
"retailPriceFrom": 987.65,
"retailPriceTo": 987.65,
"isOnSale": false,
"tags": [ProductTag],
"imageIds": ["xyz789"],
"posImages": ["xyz789"],
"customImages": ["abc123"],
"gulpImages": ["xyz789"],
"bestSellerScore": 987,
"isFeatured": true,
"isFeaturedOnHomepage": true,
"isStaffPick": false,
"storeId": "xyz789",
"variants": [ProductVariant]
}
}
}
productCountries
Description
Get all possible countries for products filtered by given tags
Response
Returns [String]
Example
Query
query productCountries(
$allTags: [String],
$anyTags: [String],
$storeId: String!
) {
productCountries(
allTags: $allTags,
anyTags: $anyTags,
storeId: $storeId
)
}
Variables
{
"allTags": ["abc123"],
"anyTags": ["xyz789"],
"storeId": "abc123"
}
Response
{"data": {"productCountries": ["abc123"]}}
productRegions
Description
Get all possible regions for products filtered by given country and tags
Response
Returns [String]
Example
Query
query productRegions(
$country: String!,
$allTags: [String],
$anyTags: [String],
$storeId: String!
) {
productRegions(
country: $country,
allTags: $allTags,
anyTags: $anyTags,
storeId: $storeId
)
}
Variables
{
"country": "abc123",
"allTags": ["abc123"],
"anyTags": ["abc123"],
"storeId": "xyz789"
}
Response
{"data": {"productRegions": ["abc123"]}}
productSearch
Description
Search for products by a text query
Response
Returns a ProductList
Example
Query
query productSearch(
$query: String,
$moodId: ID,
$pageLimit: Int,
$sortBy: String,
$storeId: String!
) {
productSearch(
query: $query,
moodId: $moodId,
pageLimit: $pageLimit,
sortBy: $sortBy,
storeId: $storeId
) {
items {
...ProductFragment
}
nextPageCursor
totalCount
}
}
Variables
{
"query": "xyz789",
"moodId": 4,
"pageLimit": 987,
"sortBy": "abc123",
"storeId": "xyz789"
}
Response
{
"data": {
"productSearch": {
"items": [Product],
"nextPageCursor": "abc123",
"totalCount": 123
}
}
}
productTags
Description
Get a list of all product tags
Response
Returns [ProductTag]
Arguments
| Name | Description |
|---|---|
storeId - String!
|
Example
Query
query productTags($storeId: String!) {
productTags(storeId: $storeId) {
id
parent
name
slug
}
}
Variables
{"storeId": "xyz789"}
Response
{
"data": {
"productTags": [
{
"id": 4,
"parent": 4,
"name": "abc123",
"slug": "abc123"
}
]
}
}
products
Description
Get a list of products
Response
Returns a ProductList
Arguments
| Name | Description |
|---|---|
allTags - [String]
|
|
anyTags - [String]
|
|
collectionSlug - String
|
|
countries - [String]
|
|
isBestSeller - Boolean
|
|
isFeatured - Boolean
|
|
isNewArrival - Boolean
|
|
isFeaturedOnHomepage - Boolean
|
|
isOnSale - Boolean
|
|
isStaffPick - Boolean
|
|
pageCursor - String
|
|
pageLimit - Int
|
|
pointsMin - Int
|
|
priceMin - Float
|
|
priceMax - Float
|
|
quantityMin - Float
|
|
brandValue - String
|
|
searchValue - String
|
|
regions - [String]
|
|
sortOrder - String
|
|
sortBy - String
|
|
storeId - String!
|
Example
Query
query products(
$allTags: [String],
$anyTags: [String],
$collectionSlug: String,
$countries: [String],
$isBestSeller: Boolean,
$isFeatured: Boolean,
$isNewArrival: Boolean,
$isFeaturedOnHomepage: Boolean,
$isOnSale: Boolean,
$isStaffPick: Boolean,
$pageCursor: String,
$pageLimit: Int,
$pointsMin: Int,
$priceMin: Float,
$priceMax: Float,
$quantityMin: Float,
$brandValue: String,
$searchValue: String,
$regions: [String],
$sortOrder: String,
$sortBy: String,
$storeId: String!
) {
products(
allTags: $allTags,
anyTags: $anyTags,
collectionSlug: $collectionSlug,
countries: $countries,
isBestSeller: $isBestSeller,
isFeatured: $isFeatured,
isNewArrival: $isNewArrival,
isFeaturedOnHomepage: $isFeaturedOnHomepage,
isOnSale: $isOnSale,
isStaffPick: $isStaffPick,
pageCursor: $pageCursor,
pageLimit: $pageLimit,
pointsMin: $pointsMin,
priceMin: $priceMin,
priceMax: $priceMax,
quantityMin: $quantityMin,
brandValue: $brandValue,
searchValue: $searchValue,
regions: $regions,
sortOrder: $sortOrder,
sortBy: $sortBy,
storeId: $storeId
) {
items {
...ProductFragment
}
nextPageCursor
totalCount
}
}
Variables
{
"allTags": ["abc123"],
"anyTags": ["xyz789"],
"collectionSlug": "xyz789",
"countries": ["abc123"],
"isBestSeller": true,
"isFeatured": false,
"isNewArrival": true,
"isFeaturedOnHomepage": true,
"isOnSale": false,
"isStaffPick": false,
"pageCursor": "abc123",
"pageLimit": 987,
"pointsMin": 123,
"priceMin": 987.65,
"priceMax": 123.45,
"quantityMin": 987.65,
"brandValue": "xyz789",
"searchValue": "abc123",
"regions": ["abc123"],
"sortOrder": "abc123",
"sortBy": "xyz789",
"storeId": "abc123"
}
Response
{
"data": {
"products": {
"items": [Product],
"nextPageCursor": "abc123",
"totalCount": 123
}
}
}
productsByBrand
Response
Returns a ProductList
Example
Query
query productsByBrand(
$brand: String!,
$storeId: String
) {
productsByBrand(
brand: $brand,
storeId: $storeId
) {
items {
...ProductFragment
}
nextPageCursor
totalCount
}
}
Variables
{
"brand": "xyz789",
"storeId": "xyz789"
}
Response
{
"data": {
"productsByBrand": {
"items": [Product],
"nextPageCursor": "xyz789",
"totalCount": 123
}
}
}
productsBySku
Description
Get a specific product by its sku
Response
Returns a ProductList
Example
Query
query productsBySku(
$productTags: [String],
$sku: String!,
$storeId: String
) {
productsBySku(
productTags: $productTags,
sku: $sku,
storeId: $storeId
) {
items {
...ProductFragment
}
nextPageCursor
totalCount
}
}
Variables
{
"productTags": ["xyz789"],
"sku": "abc123",
"storeId": "abc123"
}
Response
{
"data": {
"productsBySku": {
"items": [Product],
"nextPageCursor": "xyz789",
"totalCount": 123
}
}
}
Mutations
addCard
Response
Returns a StripeResponse
Example
Query
mutation addCard(
$customerId: ID!,
$token: String,
$paymentMethodId: String,
$setAsDefault: Boolean,
$connectedAccountId: ID,
$postalCode: String
) {
addCard(
customerId: $customerId,
token: $token,
paymentMethodId: $paymentMethodId,
setAsDefault: $setAsDefault,
connectedAccountId: $connectedAccountId,
postalCode: $postalCode
) {
success
message
card {
...CardFragment
}
}
}
Variables
{
"customerId": 4,
"token": "xyz789",
"paymentMethodId": "xyz789",
"setAsDefault": true,
"connectedAccountId": 4,
"postalCode": "xyz789"
}
Response
{
"data": {
"addCard": {
"success": false,
"message": "abc123",
"card": Card
}
}
}
addEventToCart
Description
Add an event to user's cart
Response
Returns a Cart
Example
Query
mutation addEventToCart(
$eventId: ID!,
$quantity: Int!,
$token: String,
$storeId: String!
) {
addEventToCart(
eventId: $eventId,
quantity: $quantity,
token: $token,
storeId: $storeId
) {
id
blockCheckout
phone
email
vipId
items {
...CartItemFragment
}
giftCardRecipientName
giftWrapping
adjustments {
...CartAdjustmentFragment
}
discounts {
...CartDiscountFragment
}
promoCode
tipPercent
specialInstructions
eventInfo {
...CartEventInfoFragment
}
shippingAddress {
...CartShippingAddressFragment
}
shippingQuotes {
...CartShippingMethodFragment
}
shippingMethod {
...CartShippingMethodFragment
}
isAsap
dateExpected
deliveryPriority
deliveryWindowFrom
deliveryWindowUntil
loyaltyPoints
loyaltyError
billingAddress {
...CartBillingAddressFragment
}
summary {
...CartSummaryFragment
}
token
storeId
orderNumber
}
}
Variables
{
"eventId": 4,
"quantity": 123,
"token": "xyz789",
"storeId": "xyz789"
}
Response
{
"data": {
"addEventToCart": {
"id": "abc123",
"blockCheckout": false,
"phone": "abc123",
"email": "abc123",
"vipId": "abc123",
"items": [CartItem],
"giftCardRecipientName": "abc123",
"giftWrapping": 123.45,
"adjustments": [CartAdjustment],
"discounts": [CartDiscount],
"promoCode": "xyz789",
"tipPercent": 987.65,
"specialInstructions": "abc123",
"eventInfo": CartEventInfo,
"shippingAddress": CartShippingAddress,
"shippingQuotes": [CartShippingMethod],
"shippingMethod": CartShippingMethod,
"isAsap": true,
"dateExpected": "abc123",
"deliveryPriority": "xyz789",
"deliveryWindowFrom": "abc123",
"deliveryWindowUntil": "xyz789",
"loyaltyPoints": 987,
"loyaltyError": "xyz789",
"billingAddress": CartBillingAddress,
"summary": CartSummary,
"token": "abc123",
"storeId": "abc123",
"orderNumber": "abc123"
}
}
}
addProductToCart
Description
Add a product to user's cart
Response
Returns a Cart
Example
Query
mutation addProductToCart(
$productId: ID!,
$variantId: ID!,
$quantity: Int!,
$token: String,
$storeId: String!
) {
addProductToCart(
productId: $productId,
variantId: $variantId,
quantity: $quantity,
token: $token,
storeId: $storeId
) {
id
blockCheckout
phone
email
vipId
items {
...CartItemFragment
}
giftCardRecipientName
giftWrapping
adjustments {
...CartAdjustmentFragment
}
discounts {
...CartDiscountFragment
}
promoCode
tipPercent
specialInstructions
eventInfo {
...CartEventInfoFragment
}
shippingAddress {
...CartShippingAddressFragment
}
shippingQuotes {
...CartShippingMethodFragment
}
shippingMethod {
...CartShippingMethodFragment
}
isAsap
dateExpected
deliveryPriority
deliveryWindowFrom
deliveryWindowUntil
loyaltyPoints
loyaltyError
billingAddress {
...CartBillingAddressFragment
}
summary {
...CartSummaryFragment
}
token
storeId
orderNumber
}
}
Variables
{
"productId": "4",
"variantId": "4",
"quantity": 987,
"token": "abc123",
"storeId": "abc123"
}
Response
{
"data": {
"addProductToCart": {
"id": "abc123",
"blockCheckout": false,
"phone": "abc123",
"email": "abc123",
"vipId": "abc123",
"items": [CartItem],
"giftCardRecipientName": "xyz789",
"giftWrapping": 123.45,
"adjustments": [CartAdjustment],
"discounts": [CartDiscount],
"promoCode": "xyz789",
"tipPercent": 987.65,
"specialInstructions": "abc123",
"eventInfo": CartEventInfo,
"shippingAddress": CartShippingAddress,
"shippingQuotes": [CartShippingMethod],
"shippingMethod": CartShippingMethod,
"isAsap": true,
"dateExpected": "abc123",
"deliveryPriority": "abc123",
"deliveryWindowFrom": "abc123",
"deliveryWindowUntil": "xyz789",
"loyaltyPoints": 987,
"loyaltyError": "abc123",
"billingAddress": CartBillingAddress,
"summary": CartSummary,
"token": "xyz789",
"storeId": "xyz789",
"orderNumber": "xyz789"
}
}
}
cartApplyDiscount
Description
Apply a gift card or promo discount
Example
Query
mutation cartApplyDiscount(
$code: String,
$token: String,
$storeId: String!
) {
cartApplyDiscount(
code: $code,
token: $token,
storeId: $storeId
) {
id
blockCheckout
phone
email
vipId
items {
...CartItemFragment
}
giftCardRecipientName
giftWrapping
adjustments {
...CartAdjustmentFragment
}
discounts {
...CartDiscountFragment
}
promoCode
tipPercent
specialInstructions
eventInfo {
...CartEventInfoFragment
}
shippingAddress {
...CartShippingAddressFragment
}
shippingQuotes {
...CartShippingMethodFragment
}
shippingMethod {
...CartShippingMethodFragment
}
isAsap
dateExpected
deliveryPriority
deliveryWindowFrom
deliveryWindowUntil
loyaltyPoints
loyaltyError
billingAddress {
...CartBillingAddressFragment
}
summary {
...CartSummaryFragment
}
token
storeId
orderNumber
}
}
Variables
{
"code": "xyz789",
"token": "xyz789",
"storeId": "abc123"
}
Response
{
"data": {
"cartApplyDiscount": {
"id": "xyz789",
"blockCheckout": true,
"phone": "xyz789",
"email": "abc123",
"vipId": "abc123",
"items": [CartItem],
"giftCardRecipientName": "abc123",
"giftWrapping": 123.45,
"adjustments": [CartAdjustment],
"discounts": [CartDiscount],
"promoCode": "abc123",
"tipPercent": 987.65,
"specialInstructions": "abc123",
"eventInfo": CartEventInfo,
"shippingAddress": CartShippingAddress,
"shippingQuotes": [CartShippingMethod],
"shippingMethod": CartShippingMethod,
"isAsap": false,
"dateExpected": "xyz789",
"deliveryPriority": "abc123",
"deliveryWindowFrom": "xyz789",
"deliveryWindowUntil": "abc123",
"loyaltyPoints": 987,
"loyaltyError": "xyz789",
"billingAddress": CartBillingAddress,
"summary": CartSummary,
"token": "abc123",
"storeId": "xyz789",
"orderNumber": "xyz789"
}
}
}
cartPlaceOrder
Description
Place an order (not used for Payment Intents)
Response
Returns an ID
Example
Query
mutation cartPlaceOrder(
$amount: Float!,
$rememberCard: Boolean,
$stripeToken: String,
$payInPerson: Boolean,
$token: String,
$storeId: String!,
$customerName: String!
) {
cartPlaceOrder(
amount: $amount,
rememberCard: $rememberCard,
stripeToken: $stripeToken,
payInPerson: $payInPerson,
token: $token,
storeId: $storeId,
customerName: $customerName
)
}
Variables
{
"amount": 987.65,
"rememberCard": false,
"stripeToken": "xyz789",
"payInPerson": false,
"token": "xyz789",
"storeId": "abc123",
"customerName": "abc123"
}
Response
{"data": {"cartPlaceOrder": 4}}
cartReturnLoyaltyPoints
Response
Returns a Cart
Example
Query
mutation cartReturnLoyaltyPoints(
$itemId: ID!,
$quantity: Int!,
$token: String,
$storeId: String!
) {
cartReturnLoyaltyPoints(
itemId: $itemId,
quantity: $quantity,
token: $token,
storeId: $storeId
) {
id
blockCheckout
phone
email
vipId
items {
...CartItemFragment
}
giftCardRecipientName
giftWrapping
adjustments {
...CartAdjustmentFragment
}
discounts {
...CartDiscountFragment
}
promoCode
tipPercent
specialInstructions
eventInfo {
...CartEventInfoFragment
}
shippingAddress {
...CartShippingAddressFragment
}
shippingQuotes {
...CartShippingMethodFragment
}
shippingMethod {
...CartShippingMethodFragment
}
isAsap
dateExpected
deliveryPriority
deliveryWindowFrom
deliveryWindowUntil
loyaltyPoints
loyaltyError
billingAddress {
...CartBillingAddressFragment
}
summary {
...CartSummaryFragment
}
token
storeId
orderNumber
}
}
Variables
{
"itemId": "4",
"quantity": 987,
"token": "xyz789",
"storeId": "abc123"
}
Response
{
"data": {
"cartReturnLoyaltyPoints": {
"id": "xyz789",
"blockCheckout": false,
"phone": "xyz789",
"email": "abc123",
"vipId": "abc123",
"items": [CartItem],
"giftCardRecipientName": "xyz789",
"giftWrapping": 987.65,
"adjustments": [CartAdjustment],
"discounts": [CartDiscount],
"promoCode": "abc123",
"tipPercent": 123.45,
"specialInstructions": "abc123",
"eventInfo": CartEventInfo,
"shippingAddress": CartShippingAddress,
"shippingQuotes": [CartShippingMethod],
"shippingMethod": CartShippingMethod,
"isAsap": true,
"dateExpected": "abc123",
"deliveryPriority": "abc123",
"deliveryWindowFrom": "xyz789",
"deliveryWindowUntil": "abc123",
"loyaltyPoints": 987,
"loyaltyError": "abc123",
"billingAddress": CartBillingAddress,
"summary": CartSummary,
"token": "xyz789",
"storeId": "abc123",
"orderNumber": "abc123"
}
}
}
cartSetAdditionalInfo
Description
Set additional info for user's cart
Response
Returns a Cart
Example
Query
mutation cartSetAdditionalInfo(
$address2: String,
$giftCardRecipientName: String,
$giftWrap: Boolean,
$tipPercent: Float,
$specialInstructions: String,
$isAsap: Boolean,
$dateExpected: String,
$deliveryPriority: String,
$deliveryWindowFrom: String,
$deliveryWindowUntil: String,
$token: String,
$storeId: String!
) {
cartSetAdditionalInfo(
address2: $address2,
giftCardRecipientName: $giftCardRecipientName,
giftWrap: $giftWrap,
tipPercent: $tipPercent,
specialInstructions: $specialInstructions,
isAsap: $isAsap,
dateExpected: $dateExpected,
deliveryPriority: $deliveryPriority,
deliveryWindowFrom: $deliveryWindowFrom,
deliveryWindowUntil: $deliveryWindowUntil,
token: $token,
storeId: $storeId
) {
id
blockCheckout
phone
email
vipId
items {
...CartItemFragment
}
giftCardRecipientName
giftWrapping
adjustments {
...CartAdjustmentFragment
}
discounts {
...CartDiscountFragment
}
promoCode
tipPercent
specialInstructions
eventInfo {
...CartEventInfoFragment
}
shippingAddress {
...CartShippingAddressFragment
}
shippingQuotes {
...CartShippingMethodFragment
}
shippingMethod {
...CartShippingMethodFragment
}
isAsap
dateExpected
deliveryPriority
deliveryWindowFrom
deliveryWindowUntil
loyaltyPoints
loyaltyError
billingAddress {
...CartBillingAddressFragment
}
summary {
...CartSummaryFragment
}
token
storeId
orderNumber
}
}
Variables
{
"address2": "xyz789",
"giftCardRecipientName": "xyz789",
"giftWrap": false,
"tipPercent": 987.65,
"specialInstructions": "abc123",
"isAsap": true,
"dateExpected": "xyz789",
"deliveryPriority": "xyz789",
"deliveryWindowFrom": "abc123",
"deliveryWindowUntil": "abc123",
"token": "xyz789",
"storeId": "xyz789"
}
Response
{
"data": {
"cartSetAdditionalInfo": {
"id": "xyz789",
"blockCheckout": false,
"phone": "abc123",
"email": "abc123",
"vipId": "abc123",
"items": [CartItem],
"giftCardRecipientName": "abc123",
"giftWrapping": 123.45,
"adjustments": [CartAdjustment],
"discounts": [CartDiscount],
"promoCode": "abc123",
"tipPercent": 123.45,
"specialInstructions": "xyz789",
"eventInfo": CartEventInfo,
"shippingAddress": CartShippingAddress,
"shippingQuotes": [CartShippingMethod],
"shippingMethod": CartShippingMethod,
"isAsap": false,
"dateExpected": "xyz789",
"deliveryPriority": "abc123",
"deliveryWindowFrom": "abc123",
"deliveryWindowUntil": "xyz789",
"loyaltyPoints": 987,
"loyaltyError": "abc123",
"billingAddress": CartBillingAddress,
"summary": CartSummary,
"token": "xyz789",
"storeId": "xyz789",
"orderNumber": "abc123"
}
}
}
cartSetBillingAddress
Description
Set billing address for user's cart
Response
Returns a Cart
Arguments
| Name | Description |
|---|---|
address - CartBillingAddressInput!
|
|
token - String
|
|
storeId - String!
|
Example
Query
mutation cartSetBillingAddress(
$address: CartBillingAddressInput!,
$token: String,
$storeId: String!
) {
cartSetBillingAddress(
address: $address,
token: $token,
storeId: $storeId
) {
id
blockCheckout
phone
email
vipId
items {
...CartItemFragment
}
giftCardRecipientName
giftWrapping
adjustments {
...CartAdjustmentFragment
}
discounts {
...CartDiscountFragment
}
promoCode
tipPercent
specialInstructions
eventInfo {
...CartEventInfoFragment
}
shippingAddress {
...CartShippingAddressFragment
}
shippingQuotes {
...CartShippingMethodFragment
}
shippingMethod {
...CartShippingMethodFragment
}
isAsap
dateExpected
deliveryPriority
deliveryWindowFrom
deliveryWindowUntil
loyaltyPoints
loyaltyError
billingAddress {
...CartBillingAddressFragment
}
summary {
...CartSummaryFragment
}
token
storeId
orderNumber
}
}
Variables
{
"address": CartBillingAddressInput,
"token": "xyz789",
"storeId": "abc123"
}
Response
{
"data": {
"cartSetBillingAddress": {
"id": "abc123",
"blockCheckout": false,
"phone": "abc123",
"email": "xyz789",
"vipId": "abc123",
"items": [CartItem],
"giftCardRecipientName": "abc123",
"giftWrapping": 123.45,
"adjustments": [CartAdjustment],
"discounts": [CartDiscount],
"promoCode": "abc123",
"tipPercent": 123.45,
"specialInstructions": "abc123",
"eventInfo": CartEventInfo,
"shippingAddress": CartShippingAddress,
"shippingQuotes": [CartShippingMethod],
"shippingMethod": CartShippingMethod,
"isAsap": false,
"dateExpected": "abc123",
"deliveryPriority": "xyz789",
"deliveryWindowFrom": "abc123",
"deliveryWindowUntil": "xyz789",
"loyaltyPoints": 987,
"loyaltyError": "xyz789",
"billingAddress": CartBillingAddress,
"summary": CartSummary,
"token": "xyz789",
"storeId": "abc123",
"orderNumber": "xyz789"
}
}
}
cartSetEmail
Description
Set email for user's cart
Response
Returns a Cart
Example
Query
mutation cartSetEmail(
$email: String!,
$token: String,
$storeId: String!,
$mailchimpSubscribe: Boolean
) {
cartSetEmail(
email: $email,
token: $token,
storeId: $storeId,
mailchimpSubscribe: $mailchimpSubscribe
) {
id
blockCheckout
phone
email
vipId
items {
...CartItemFragment
}
giftCardRecipientName
giftWrapping
adjustments {
...CartAdjustmentFragment
}
discounts {
...CartDiscountFragment
}
promoCode
tipPercent
specialInstructions
eventInfo {
...CartEventInfoFragment
}
shippingAddress {
...CartShippingAddressFragment
}
shippingQuotes {
...CartShippingMethodFragment
}
shippingMethod {
...CartShippingMethodFragment
}
isAsap
dateExpected
deliveryPriority
deliveryWindowFrom
deliveryWindowUntil
loyaltyPoints
loyaltyError
billingAddress {
...CartBillingAddressFragment
}
summary {
...CartSummaryFragment
}
token
storeId
orderNumber
}
}
Variables
{
"email": "abc123",
"token": "xyz789",
"storeId": "abc123",
"mailchimpSubscribe": true
}
Response
{
"data": {
"cartSetEmail": {
"id": "xyz789",
"blockCheckout": true,
"phone": "xyz789",
"email": "abc123",
"vipId": "abc123",
"items": [CartItem],
"giftCardRecipientName": "abc123",
"giftWrapping": 987.65,
"adjustments": [CartAdjustment],
"discounts": [CartDiscount],
"promoCode": "abc123",
"tipPercent": 123.45,
"specialInstructions": "xyz789",
"eventInfo": CartEventInfo,
"shippingAddress": CartShippingAddress,
"shippingQuotes": [CartShippingMethod],
"shippingMethod": CartShippingMethod,
"isAsap": false,
"dateExpected": "xyz789",
"deliveryPriority": "abc123",
"deliveryWindowFrom": "xyz789",
"deliveryWindowUntil": "abc123",
"loyaltyPoints": 987,
"loyaltyError": "xyz789",
"billingAddress": CartBillingAddress,
"summary": CartSummary,
"token": "xyz789",
"storeId": "abc123",
"orderNumber": "abc123"
}
}
}
cartSetEventInfo
Description
Set event info in user's cart
Response
Returns a Cart
Arguments
| Name | Description |
|---|---|
info - CartEventInfoInput!
|
|
token - String
|
|
storeId - String!
|
Example
Query
mutation cartSetEventInfo(
$info: CartEventInfoInput!,
$token: String,
$storeId: String!
) {
cartSetEventInfo(
info: $info,
token: $token,
storeId: $storeId
) {
id
blockCheckout
phone
email
vipId
items {
...CartItemFragment
}
giftCardRecipientName
giftWrapping
adjustments {
...CartAdjustmentFragment
}
discounts {
...CartDiscountFragment
}
promoCode
tipPercent
specialInstructions
eventInfo {
...CartEventInfoFragment
}
shippingAddress {
...CartShippingAddressFragment
}
shippingQuotes {
...CartShippingMethodFragment
}
shippingMethod {
...CartShippingMethodFragment
}
isAsap
dateExpected
deliveryPriority
deliveryWindowFrom
deliveryWindowUntil
loyaltyPoints
loyaltyError
billingAddress {
...CartBillingAddressFragment
}
summary {
...CartSummaryFragment
}
token
storeId
orderNumber
}
}
Variables
{
"info": CartEventInfoInput,
"token": "xyz789",
"storeId": "xyz789"
}
Response
{
"data": {
"cartSetEventInfo": {
"id": "abc123",
"blockCheckout": true,
"phone": "abc123",
"email": "abc123",
"vipId": "xyz789",
"items": [CartItem],
"giftCardRecipientName": "xyz789",
"giftWrapping": 123.45,
"adjustments": [CartAdjustment],
"discounts": [CartDiscount],
"promoCode": "abc123",
"tipPercent": 987.65,
"specialInstructions": "abc123",
"eventInfo": CartEventInfo,
"shippingAddress": CartShippingAddress,
"shippingQuotes": [CartShippingMethod],
"shippingMethod": CartShippingMethod,
"isAsap": false,
"dateExpected": "abc123",
"deliveryPriority": "abc123",
"deliveryWindowFrom": "xyz789",
"deliveryWindowUntil": "abc123",
"loyaltyPoints": 987,
"loyaltyError": "xyz789",
"billingAddress": CartBillingAddress,
"summary": CartSummary,
"token": "abc123",
"storeId": "abc123",
"orderNumber": "abc123"
}
}
}
cartSetPhone
Description
Set phone for user's cart
Example
Query
mutation cartSetPhone(
$phone: String!,
$token: String,
$storeId: String!
) {
cartSetPhone(
phone: $phone,
token: $token,
storeId: $storeId
) {
id
blockCheckout
phone
email
vipId
items {
...CartItemFragment
}
giftCardRecipientName
giftWrapping
adjustments {
...CartAdjustmentFragment
}
discounts {
...CartDiscountFragment
}
promoCode
tipPercent
specialInstructions
eventInfo {
...CartEventInfoFragment
}
shippingAddress {
...CartShippingAddressFragment
}
shippingQuotes {
...CartShippingMethodFragment
}
shippingMethod {
...CartShippingMethodFragment
}
isAsap
dateExpected
deliveryPriority
deliveryWindowFrom
deliveryWindowUntil
loyaltyPoints
loyaltyError
billingAddress {
...CartBillingAddressFragment
}
summary {
...CartSummaryFragment
}
token
storeId
orderNumber
}
}
Variables
{
"phone": "xyz789",
"token": "abc123",
"storeId": "abc123"
}
Response
{
"data": {
"cartSetPhone": {
"id": "xyz789",
"blockCheckout": true,
"phone": "xyz789",
"email": "xyz789",
"vipId": "abc123",
"items": [CartItem],
"giftCardRecipientName": "abc123",
"giftWrapping": 987.65,
"adjustments": [CartAdjustment],
"discounts": [CartDiscount],
"promoCode": "xyz789",
"tipPercent": 987.65,
"specialInstructions": "abc123",
"eventInfo": CartEventInfo,
"shippingAddress": CartShippingAddress,
"shippingQuotes": [CartShippingMethod],
"shippingMethod": CartShippingMethod,
"isAsap": false,
"dateExpected": "xyz789",
"deliveryPriority": "abc123",
"deliveryWindowFrom": "xyz789",
"deliveryWindowUntil": "xyz789",
"loyaltyPoints": 987,
"loyaltyError": "xyz789",
"billingAddress": CartBillingAddress,
"summary": CartSummary,
"token": "abc123",
"storeId": "xyz789",
"orderNumber": "abc123"
}
}
}
cartSetShippingAddress
Description
Set shipping address for user's cart
Response
Returns a Cart
Arguments
| Name | Description |
|---|---|
address - CartShippingAddressInput
|
|
onlyIfNotSet - Boolean
|
|
token - String
|
|
storeId - String!
|
Example
Query
mutation cartSetShippingAddress(
$address: CartShippingAddressInput,
$onlyIfNotSet: Boolean,
$token: String,
$storeId: String!
) {
cartSetShippingAddress(
address: $address,
onlyIfNotSet: $onlyIfNotSet,
token: $token,
storeId: $storeId
) {
id
blockCheckout
phone
email
vipId
items {
...CartItemFragment
}
giftCardRecipientName
giftWrapping
adjustments {
...CartAdjustmentFragment
}
discounts {
...CartDiscountFragment
}
promoCode
tipPercent
specialInstructions
eventInfo {
...CartEventInfoFragment
}
shippingAddress {
...CartShippingAddressFragment
}
shippingQuotes {
...CartShippingMethodFragment
}
shippingMethod {
...CartShippingMethodFragment
}
isAsap
dateExpected
deliveryPriority
deliveryWindowFrom
deliveryWindowUntil
loyaltyPoints
loyaltyError
billingAddress {
...CartBillingAddressFragment
}
summary {
...CartSummaryFragment
}
token
storeId
orderNumber
}
}
Variables
{
"address": CartShippingAddressInput,
"onlyIfNotSet": false,
"token": "xyz789",
"storeId": "xyz789"
}
Response
{
"data": {
"cartSetShippingAddress": {
"id": "abc123",
"blockCheckout": true,
"phone": "xyz789",
"email": "xyz789",
"vipId": "xyz789",
"items": [CartItem],
"giftCardRecipientName": "abc123",
"giftWrapping": 123.45,
"adjustments": [CartAdjustment],
"discounts": [CartDiscount],
"promoCode": "xyz789",
"tipPercent": 987.65,
"specialInstructions": "xyz789",
"eventInfo": CartEventInfo,
"shippingAddress": CartShippingAddress,
"shippingQuotes": [CartShippingMethod],
"shippingMethod": CartShippingMethod,
"isAsap": false,
"dateExpected": "xyz789",
"deliveryPriority": "abc123",
"deliveryWindowFrom": "abc123",
"deliveryWindowUntil": "xyz789",
"loyaltyPoints": 123,
"loyaltyError": "xyz789",
"billingAddress": CartBillingAddress,
"summary": CartSummary,
"token": "xyz789",
"storeId": "xyz789",
"orderNumber": "abc123"
}
}
}
cartSetShippingMethod
Description
Set shipping method for user's cart
Response
Returns a Cart
Example
Query
mutation cartSetShippingMethod(
$shippingMethodId: ID!,
$token: String,
$storeId: String!
) {
cartSetShippingMethod(
shippingMethodId: $shippingMethodId,
token: $token,
storeId: $storeId
) {
id
blockCheckout
phone
email
vipId
items {
...CartItemFragment
}
giftCardRecipientName
giftWrapping
adjustments {
...CartAdjustmentFragment
}
discounts {
...CartDiscountFragment
}
promoCode
tipPercent
specialInstructions
eventInfo {
...CartEventInfoFragment
}
shippingAddress {
...CartShippingAddressFragment
}
shippingQuotes {
...CartShippingMethodFragment
}
shippingMethod {
...CartShippingMethodFragment
}
isAsap
dateExpected
deliveryPriority
deliveryWindowFrom
deliveryWindowUntil
loyaltyPoints
loyaltyError
billingAddress {
...CartBillingAddressFragment
}
summary {
...CartSummaryFragment
}
token
storeId
orderNumber
}
}
Variables
{
"shippingMethodId": "4",
"token": "abc123",
"storeId": "abc123"
}
Response
{
"data": {
"cartSetShippingMethod": {
"id": "abc123",
"blockCheckout": true,
"phone": "abc123",
"email": "xyz789",
"vipId": "abc123",
"items": [CartItem],
"giftCardRecipientName": "abc123",
"giftWrapping": 123.45,
"adjustments": [CartAdjustment],
"discounts": [CartDiscount],
"promoCode": "abc123",
"tipPercent": 987.65,
"specialInstructions": "abc123",
"eventInfo": CartEventInfo,
"shippingAddress": CartShippingAddress,
"shippingQuotes": [CartShippingMethod],
"shippingMethod": CartShippingMethod,
"isAsap": false,
"dateExpected": "abc123",
"deliveryPriority": "xyz789",
"deliveryWindowFrom": "xyz789",
"deliveryWindowUntil": "xyz789",
"loyaltyPoints": 123,
"loyaltyError": "xyz789",
"billingAddress": CartBillingAddress,
"summary": CartSummary,
"token": "xyz789",
"storeId": "xyz789",
"orderNumber": "xyz789"
}
}
}
cartSetVipId
Response
Returns a Cart
Example
Query
mutation cartSetVipId(
$vipId: String,
$phone: String,
$token: String,
$storeId: String!
) {
cartSetVipId(
vipId: $vipId,
phone: $phone,
token: $token,
storeId: $storeId
) {
id
blockCheckout
phone
email
vipId
items {
...CartItemFragment
}
giftCardRecipientName
giftWrapping
adjustments {
...CartAdjustmentFragment
}
discounts {
...CartDiscountFragment
}
promoCode
tipPercent
specialInstructions
eventInfo {
...CartEventInfoFragment
}
shippingAddress {
...CartShippingAddressFragment
}
shippingQuotes {
...CartShippingMethodFragment
}
shippingMethod {
...CartShippingMethodFragment
}
isAsap
dateExpected
deliveryPriority
deliveryWindowFrom
deliveryWindowUntil
loyaltyPoints
loyaltyError
billingAddress {
...CartBillingAddressFragment
}
summary {
...CartSummaryFragment
}
token
storeId
orderNumber
}
}
Variables
{
"vipId": "xyz789",
"phone": "abc123",
"token": "xyz789",
"storeId": "xyz789"
}
Response
{
"data": {
"cartSetVipId": {
"id": "abc123",
"blockCheckout": true,
"phone": "abc123",
"email": "abc123",
"vipId": "abc123",
"items": [CartItem],
"giftCardRecipientName": "xyz789",
"giftWrapping": 123.45,
"adjustments": [CartAdjustment],
"discounts": [CartDiscount],
"promoCode": "xyz789",
"tipPercent": 987.65,
"specialInstructions": "abc123",
"eventInfo": CartEventInfo,
"shippingAddress": CartShippingAddress,
"shippingQuotes": [CartShippingMethod],
"shippingMethod": CartShippingMethod,
"isAsap": true,
"dateExpected": "xyz789",
"deliveryPriority": "xyz789",
"deliveryWindowFrom": "xyz789",
"deliveryWindowUntil": "xyz789",
"loyaltyPoints": 123,
"loyaltyError": "xyz789",
"billingAddress": CartBillingAddress,
"summary": CartSummary,
"token": "abc123",
"storeId": "abc123",
"orderNumber": "xyz789"
}
}
}
cartSpendLoyaltyPoints
Response
Returns a Cart
Example
Query
mutation cartSpendLoyaltyPoints(
$itemId: ID!,
$quantity: Int!,
$token: String,
$storeId: String!
) {
cartSpendLoyaltyPoints(
itemId: $itemId,
quantity: $quantity,
token: $token,
storeId: $storeId
) {
id
blockCheckout
phone
email
vipId
items {
...CartItemFragment
}
giftCardRecipientName
giftWrapping
adjustments {
...CartAdjustmentFragment
}
discounts {
...CartDiscountFragment
}
promoCode
tipPercent
specialInstructions
eventInfo {
...CartEventInfoFragment
}
shippingAddress {
...CartShippingAddressFragment
}
shippingQuotes {
...CartShippingMethodFragment
}
shippingMethod {
...CartShippingMethodFragment
}
isAsap
dateExpected
deliveryPriority
deliveryWindowFrom
deliveryWindowUntil
loyaltyPoints
loyaltyError
billingAddress {
...CartBillingAddressFragment
}
summary {
...CartSummaryFragment
}
token
storeId
orderNumber
}
}
Variables
{
"itemId": "4",
"quantity": 987,
"token": "xyz789",
"storeId": "abc123"
}
Response
{
"data": {
"cartSpendLoyaltyPoints": {
"id": "xyz789",
"blockCheckout": true,
"phone": "abc123",
"email": "xyz789",
"vipId": "abc123",
"items": [CartItem],
"giftCardRecipientName": "abc123",
"giftWrapping": 123.45,
"adjustments": [CartAdjustment],
"discounts": [CartDiscount],
"promoCode": "abc123",
"tipPercent": 987.65,
"specialInstructions": "abc123",
"eventInfo": CartEventInfo,
"shippingAddress": CartShippingAddress,
"shippingQuotes": [CartShippingMethod],
"shippingMethod": CartShippingMethod,
"isAsap": false,
"dateExpected": "xyz789",
"deliveryPriority": "abc123",
"deliveryWindowFrom": "xyz789",
"deliveryWindowUntil": "xyz789",
"loyaltyPoints": 123,
"loyaltyError": "abc123",
"billingAddress": CartBillingAddress,
"summary": CartSummary,
"token": "xyz789",
"storeId": "xyz789",
"orderNumber": "abc123"
}
}
}
contactUs
Description
Contanct Us Data
Response
Returns a Boolean
Example
Query
mutation contactUs(
$fullName: String,
$number: String,
$email: String,
$description: String
) {
contactUs(
fullName: $fullName,
number: $number,
email: $email,
description: $description
)
}
Variables
{
"fullName": "abc123",
"number": "abc123",
"email": "abc123",
"description": "abc123"
}
Response
{"data": {"contactUs": false}}
createApplePaySession
Response
Returns an ApplePaySessionResponse!
Arguments
| Name | Description |
|---|---|
domain - String!
|
Example
Query
mutation createApplePaySession($domain: String!) {
createApplePaySession(domain: $domain) {
success
message
session
}
}
Variables
{"domain": "abc123"}
Response
{
"data": {
"createApplePaySession": {
"success": false,
"message": "xyz789",
"session": {}
}
}
}
createBlock
Description
Create a new block
Response
Returns a Block
Arguments
| Name | Description |
|---|---|
image - Upload
|
|
imageAlt - String
|
|
category - String
|
|
deltaContent - String
|
|
htmlContent - String
|
|
textContent - String
|
|
slug - String
|
|
projectId - String!
|
|
storeId - String
|
|
deltaPreTitle - String
|
|
htmlPreTitle - String
|
|
textPreTitle - String
|
|
deltaTitle - String
|
|
htmlTitle - String
|
|
textTitle - String
|
|
variant - String
|
Example
Query
mutation createBlock(
$image: Upload,
$imageAlt: String,
$category: String,
$deltaContent: String,
$htmlContent: String,
$textContent: String,
$slug: String,
$projectId: String!,
$storeId: String,
$deltaPreTitle: String,
$htmlPreTitle: String,
$textPreTitle: String,
$deltaTitle: String,
$htmlTitle: String,
$textTitle: String,
$variant: String
) {
createBlock(
image: $image,
imageAlt: $imageAlt,
category: $category,
deltaContent: $deltaContent,
htmlContent: $htmlContent,
textContent: $textContent,
slug: $slug,
projectId: $projectId,
storeId: $storeId,
deltaPreTitle: $deltaPreTitle,
htmlPreTitle: $htmlPreTitle,
textPreTitle: $textPreTitle,
deltaTitle: $deltaTitle,
htmlTitle: $htmlTitle,
textTitle: $textTitle,
variant: $variant
) {
buttons {
...ButtonFragment
}
id
image
imageAlt
category
deltaContent
htmlContent
textContent
slug
projectId
storeId
deltaPreTitle
htmlPreTitle
textPreTitle
deltaTitle
htmlTitle
textTitle
variant
}
}
Variables
{
"image": Upload,
"imageAlt": "abc123",
"category": "abc123",
"deltaContent": "xyz789",
"htmlContent": "abc123",
"textContent": "abc123",
"slug": "abc123",
"projectId": "xyz789",
"storeId": "xyz789",
"deltaPreTitle": "xyz789",
"htmlPreTitle": "abc123",
"textPreTitle": "xyz789",
"deltaTitle": "abc123",
"htmlTitle": "xyz789",
"textTitle": "abc123",
"variant": "xyz789"
}
Response
{
"data": {
"createBlock": {
"buttons": [Button],
"id": "4",
"image": "abc123",
"imageAlt": "xyz789",
"category": "xyz789",
"deltaContent": "xyz789",
"htmlContent": "abc123",
"textContent": "xyz789",
"slug": "abc123",
"projectId": "abc123",
"storeId": "abc123",
"deltaPreTitle": "xyz789",
"htmlPreTitle": "xyz789",
"textPreTitle": "abc123",
"deltaTitle": "xyz789",
"htmlTitle": "xyz789",
"textTitle": "abc123",
"variant": "xyz789"
}
}
}
createBlogPost
Description
Create a new blog post
Response
Returns a BlogPost
Example
Query
mutation createBlogPost(
$title: String,
$image: Upload,
$content: String,
$deltaContent: String,
$date: String
) {
createBlogPost(
title: $title,
image: $image,
content: $content,
deltaContent: $deltaContent,
date: $date
) {
id
title
image
content
deltaContent
author
slug
featured
date
}
}
Variables
{
"title": "xyz789",
"image": Upload,
"content": "abc123",
"deltaContent": "xyz789",
"date": "abc123"
}
Response
{
"data": {
"createBlogPost": {
"id": "4",
"title": "xyz789",
"image": "xyz789",
"content": "abc123",
"deltaContent": "xyz789",
"author": "abc123",
"slug": "xyz789",
"featured": 123,
"date": "abc123"
}
}
}
createCollection
Description
Create a new collection
Response
Returns a Collection
Example
Query
mutation createCollection(
$name: String,
$image: Upload,
$deltaContent: String,
$htmlContent: String
) {
createCollection(
name: $name,
image: $image,
deltaContent: $deltaContent,
htmlContent: $htmlContent
) {
id
name
image
deltaContent
htmlContent
slug
storeId
}
}
Variables
{
"name": "xyz789",
"image": Upload,
"deltaContent": "abc123",
"htmlContent": "abc123"
}
Response
{
"data": {
"createCollection": {
"id": 4,
"name": "abc123",
"image": "xyz789",
"deltaContent": "xyz789",
"htmlContent": "abc123",
"slug": "xyz789",
"storeId": "xyz789"
}
}
}
customerCheckVipId
Description
Create VIP ID
Example
Query
mutation customerCheckVipId(
$email: String!,
$storeId: String!
) {
customerCheckVipId(
email: $email,
storeId: $storeId
)
}
Variables
{
"email": "abc123",
"storeId": "abc123"
}
Response
{"data": {"customerCheckVipId": true}}
customerCreateVipId
Response
Returns a Customer
Example
Query
mutation customerCreateVipId(
$id: String,
$name: String!,
$phone: String,
$email: String!,
$address1: String,
$address2: String,
$address3: String,
$postal: String,
$storeId: String!
) {
customerCreateVipId(
id: $id,
name: $name,
phone: $phone,
email: $email,
address1: $address1,
address2: $address2,
address3: $address3,
postal: $postal,
storeId: $storeId
) {
id
stripeId
firstName
lastName
phone
email
vipId
shippingAddress {
...CustomerShippingAddressFragment
}
billingAddress {
...CustomerBillingAddressFragment
}
subscriptions
stores {
...CustomerStoreFragment
}
payment {
...CustomerCreditCardFragment
}
error
}
}
Variables
{
"id": "xyz789",
"name": "xyz789",
"phone": "abc123",
"email": "xyz789",
"address1": "xyz789",
"address2": "abc123",
"address3": "xyz789",
"postal": "xyz789",
"storeId": "xyz789"
}
Response
{
"data": {
"customerCreateVipId": {
"id": "abc123",
"stripeId": "abc123",
"firstName": "abc123",
"lastName": "abc123",
"phone": "xyz789",
"email": "xyz789",
"vipId": "xyz789",
"shippingAddress": CustomerShippingAddress,
"billingAddress": CustomerBillingAddress,
"subscriptions": ["xyz789"],
"stores": [CustomerStore],
"payment": CustomerCreditCard,
"error": ["abc123"]
}
}
}
customerDeletePayment
Description
Deletes customer's payment source
Response
Returns a Customer
Example
Query
mutation customerDeletePayment {
customerDeletePayment {
id
stripeId
firstName
lastName
phone
email
vipId
shippingAddress {
...CustomerShippingAddressFragment
}
billingAddress {
...CustomerBillingAddressFragment
}
subscriptions
stores {
...CustomerStoreFragment
}
payment {
...CustomerCreditCardFragment
}
error
}
}
Response
{
"data": {
"customerDeletePayment": {
"id": "abc123",
"stripeId": "abc123",
"firstName": "xyz789",
"lastName": "abc123",
"phone": "xyz789",
"email": "abc123",
"vipId": "abc123",
"shippingAddress": CustomerShippingAddress,
"billingAddress": CustomerBillingAddress,
"subscriptions": ["xyz789"],
"stores": [CustomerStore],
"payment": CustomerCreditCard,
"error": ["xyz789"]
}
}
}
customerRegister
Description
Register a new customer tied to a userId
Response
Returns a Customer
Example
Query
mutation customerRegister(
$firstName: String,
$lastName: String,
$phone: String,
$email: String
) {
customerRegister(
firstName: $firstName,
lastName: $lastName,
phone: $phone,
email: $email
) {
id
stripeId
firstName
lastName
phone
email
vipId
shippingAddress {
...CustomerShippingAddressFragment
}
billingAddress {
...CustomerBillingAddressFragment
}
subscriptions
stores {
...CustomerStoreFragment
}
payment {
...CustomerCreditCardFragment
}
error
}
}
Variables
{
"firstName": "abc123",
"lastName": "abc123",
"phone": "abc123",
"email": "xyz789"
}
Response
{
"data": {
"customerRegister": {
"id": "abc123",
"stripeId": "abc123",
"firstName": "abc123",
"lastName": "xyz789",
"phone": "abc123",
"email": "xyz789",
"vipId": "abc123",
"shippingAddress": CustomerShippingAddress,
"billingAddress": CustomerBillingAddress,
"subscriptions": ["xyz789"],
"stores": [CustomerStore],
"payment": CustomerCreditCard,
"error": ["xyz789"]
}
}
}
customerSetBillingAddress
Description
Set customer's billing address
Response
Returns a Customer
Arguments
| Name | Description |
|---|---|
address - CustomerBillingAddressInput!
|
Example
Query
mutation customerSetBillingAddress($address: CustomerBillingAddressInput!) {
customerSetBillingAddress(address: $address) {
id
stripeId
firstName
lastName
phone
email
vipId
shippingAddress {
...CustomerShippingAddressFragment
}
billingAddress {
...CustomerBillingAddressFragment
}
subscriptions
stores {
...CustomerStoreFragment
}
payment {
...CustomerCreditCardFragment
}
error
}
}
Variables
{"address": CustomerBillingAddressInput}
Response
{
"data": {
"customerSetBillingAddress": {
"id": "xyz789",
"stripeId": "xyz789",
"firstName": "xyz789",
"lastName": "abc123",
"phone": "abc123",
"email": "xyz789",
"vipId": "xyz789",
"shippingAddress": CustomerShippingAddress,
"billingAddress": CustomerBillingAddress,
"subscriptions": ["abc123"],
"stores": [CustomerStore],
"payment": CustomerCreditCard,
"error": ["xyz789"]
}
}
}
customerSetPersonalInfo
Description
Set customer's personal info
Response
Returns a Customer
Arguments
| Name | Description |
|---|---|
firstName - String
|
|
lastName - String
|
|
phone - String
|
|
email - String
|
|
billingAddress - CustomerBillingAddressInput
|
Example
Query
mutation customerSetPersonalInfo(
$firstName: String,
$lastName: String,
$phone: String,
$email: String,
$billingAddress: CustomerBillingAddressInput
) {
customerSetPersonalInfo(
firstName: $firstName,
lastName: $lastName,
phone: $phone,
email: $email,
billingAddress: $billingAddress
) {
id
stripeId
firstName
lastName
phone
email
vipId
shippingAddress {
...CustomerShippingAddressFragment
}
billingAddress {
...CustomerBillingAddressFragment
}
subscriptions
stores {
...CustomerStoreFragment
}
payment {
...CustomerCreditCardFragment
}
error
}
}
Variables
{
"firstName": "xyz789",
"lastName": "abc123",
"phone": "xyz789",
"email": "abc123",
"billingAddress": CustomerBillingAddressInput
}
Response
{
"data": {
"customerSetPersonalInfo": {
"id": "xyz789",
"stripeId": "abc123",
"firstName": "xyz789",
"lastName": "abc123",
"phone": "abc123",
"email": "abc123",
"vipId": "xyz789",
"shippingAddress": CustomerShippingAddress,
"billingAddress": CustomerBillingAddress,
"subscriptions": ["xyz789"],
"stores": [CustomerStore],
"payment": CustomerCreditCard,
"error": ["abc123"]
}
}
}
customerSetShippingAddress
Description
Set customer's shipping address
Response
Returns a Customer
Arguments
| Name | Description |
|---|---|
address - CustomerShippingAddressInput!
|
Example
Query
mutation customerSetShippingAddress($address: CustomerShippingAddressInput!) {
customerSetShippingAddress(address: $address) {
id
stripeId
firstName
lastName
phone
email
vipId
shippingAddress {
...CustomerShippingAddressFragment
}
billingAddress {
...CustomerBillingAddressFragment
}
subscriptions
stores {
...CustomerStoreFragment
}
payment {
...CustomerCreditCardFragment
}
error
}
}
Variables
{"address": CustomerShippingAddressInput}
Response
{
"data": {
"customerSetShippingAddress": {
"id": "abc123",
"stripeId": "abc123",
"firstName": "abc123",
"lastName": "xyz789",
"phone": "abc123",
"email": "xyz789",
"vipId": "xyz789",
"shippingAddress": CustomerShippingAddress,
"billingAddress": CustomerBillingAddress,
"subscriptions": ["abc123"],
"stores": [CustomerStore],
"payment": CustomerCreditCard,
"error": ["xyz789"]
}
}
}
customerSetSubscriptions
Description
Set customer's subscriptions
Example
Query
mutation customerSetSubscriptions($subscriptions: [String]) {
customerSetSubscriptions(subscriptions: $subscriptions) {
id
stripeId
firstName
lastName
phone
email
vipId
shippingAddress {
...CustomerShippingAddressFragment
}
billingAddress {
...CustomerBillingAddressFragment
}
subscriptions
stores {
...CustomerStoreFragment
}
payment {
...CustomerCreditCardFragment
}
error
}
}
Variables
{"subscriptions": ["abc123"]}
Response
{
"data": {
"customerSetSubscriptions": {
"id": "xyz789",
"stripeId": "xyz789",
"firstName": "xyz789",
"lastName": "xyz789",
"phone": "xyz789",
"email": "xyz789",
"vipId": "abc123",
"shippingAddress": CustomerShippingAddress,
"billingAddress": CustomerBillingAddress,
"subscriptions": ["abc123"],
"stores": [CustomerStore],
"payment": CustomerCreditCard,
"error": ["xyz789"]
}
}
}
customerUpdatePayment
Description
Updates customer's payment source
Example
Query
mutation customerUpdatePayment($stripeToken: String!) {
customerUpdatePayment(stripeToken: $stripeToken) {
id
stripeId
firstName
lastName
phone
email
vipId
shippingAddress {
...CustomerShippingAddressFragment
}
billingAddress {
...CustomerBillingAddressFragment
}
subscriptions
stores {
...CustomerStoreFragment
}
payment {
...CustomerCreditCardFragment
}
error
}
}
Variables
{"stripeToken": "xyz789"}
Response
{
"data": {
"customerUpdatePayment": {
"id": "xyz789",
"stripeId": "abc123",
"firstName": "xyz789",
"lastName": "xyz789",
"phone": "xyz789",
"email": "abc123",
"vipId": "xyz789",
"shippingAddress": CustomerShippingAddress,
"billingAddress": CustomerBillingAddress,
"subscriptions": ["xyz789"],
"stores": [CustomerStore],
"payment": CustomerCreditCard,
"error": ["abc123"]
}
}
}
customerUpdateVipId
Response
Returns a Customer
Example
Query
mutation customerUpdateVipId(
$email: String!,
$vipId: String!,
$storeId: String!
) {
customerUpdateVipId(
email: $email,
vipId: $vipId,
storeId: $storeId
) {
id
stripeId
firstName
lastName
phone
email
vipId
shippingAddress {
...CustomerShippingAddressFragment
}
billingAddress {
...CustomerBillingAddressFragment
}
subscriptions
stores {
...CustomerStoreFragment
}
payment {
...CustomerCreditCardFragment
}
error
}
}
Variables
{
"email": "xyz789",
"vipId": "abc123",
"storeId": "xyz789"
}
Response
{
"data": {
"customerUpdateVipId": {
"id": "xyz789",
"stripeId": "abc123",
"firstName": "xyz789",
"lastName": "xyz789",
"phone": "xyz789",
"email": "xyz789",
"vipId": "xyz789",
"shippingAddress": CustomerShippingAddress,
"billingAddress": CustomerBillingAddress,
"subscriptions": ["abc123"],
"stores": [CustomerStore],
"payment": CustomerCreditCard,
"error": ["xyz789"]
}
}
}
deleteBlock
Description
Delete a block
echo
getCards
Response
Returns a StripeCardsResponse!
Example
Query
mutation getCards(
$customerId: ID!,
$connectedAccountId: ID
) {
getCards(
customerId: $customerId,
connectedAccountId: $connectedAccountId
) {
success
message
cards {
...CardFragment
}
}
}
Variables
{"customerId": 4, "connectedAccountId": 4}
Response
{
"data": {
"getCards": {
"success": true,
"message": "abc123",
"cards": [Card]
}
}
}
joinLoyaltyProgram
Description
Join loyalty program
Response
Returns a Boolean
Example
Query
mutation joinLoyaltyProgram(
$address1: String!,
$city: String!,
$company: String!,
$email: String!,
$name: String!,
$phone: String,
$state: String!,
$zipCode: String!
) {
joinLoyaltyProgram(
address1: $address1,
city: $city,
company: $company,
email: $email,
name: $name,
phone: $phone,
state: $state,
zipCode: $zipCode
)
}
Variables
{
"address1": "abc123",
"city": "xyz789",
"company": "abc123",
"email": "xyz789",
"name": "abc123",
"phone": "xyz789",
"state": "xyz789",
"zipCode": "xyz789"
}
Response
{"data": {"joinLoyaltyProgram": false}}
placeOrder
Description
Deprecated Place an order
Response
Returns an ID
Example
Query
mutation placeOrder(
$amount: Float!,
$stripeToken: String,
$token: String,
$storeId: String!
) {
placeOrder(
amount: $amount,
stripeToken: $stripeToken,
token: $token,
storeId: $storeId
)
}
Variables
{
"amount": 987.65,
"stripeToken": "xyz789",
"token": "xyz789",
"storeId": "abc123"
}
Response
{"data": {"placeOrder": 4}}
reconcileCarts
Description
Reconcile an anonymous cart with a logged-in user's existing cart
Example
Query
mutation reconcileCarts(
$token: String,
$storeId: String!
) {
reconcileCarts(
token: $token,
storeId: $storeId
) {
id
blockCheckout
phone
email
vipId
items {
...CartItemFragment
}
giftCardRecipientName
giftWrapping
adjustments {
...CartAdjustmentFragment
}
discounts {
...CartDiscountFragment
}
promoCode
tipPercent
specialInstructions
eventInfo {
...CartEventInfoFragment
}
shippingAddress {
...CartShippingAddressFragment
}
shippingQuotes {
...CartShippingMethodFragment
}
shippingMethod {
...CartShippingMethodFragment
}
isAsap
dateExpected
deliveryPriority
deliveryWindowFrom
deliveryWindowUntil
loyaltyPoints
loyaltyError
billingAddress {
...CartBillingAddressFragment
}
summary {
...CartSummaryFragment
}
token
storeId
orderNumber
}
}
Variables
{
"token": "xyz789",
"storeId": "xyz789"
}
Response
{
"data": {
"reconcileCarts": {
"id": "xyz789",
"blockCheckout": false,
"phone": "abc123",
"email": "xyz789",
"vipId": "abc123",
"items": [CartItem],
"giftCardRecipientName": "xyz789",
"giftWrapping": 987.65,
"adjustments": [CartAdjustment],
"discounts": [CartDiscount],
"promoCode": "xyz789",
"tipPercent": 987.65,
"specialInstructions": "xyz789",
"eventInfo": CartEventInfo,
"shippingAddress": CartShippingAddress,
"shippingQuotes": [CartShippingMethod],
"shippingMethod": CartShippingMethod,
"isAsap": false,
"dateExpected": "abc123",
"deliveryPriority": "xyz789",
"deliveryWindowFrom": "xyz789",
"deliveryWindowUntil": "xyz789",
"loyaltyPoints": 123,
"loyaltyError": "abc123",
"billingAddress": CartBillingAddress,
"summary": CartSummary,
"token": "xyz789",
"storeId": "xyz789",
"orderNumber": "xyz789"
}
}
}
recordProductView
Description
Record product view
reddemPoints
Response
Returns a reddemPointsResponse
Example
Query
mutation reddemPoints(
$cartId: String,
$points: Float,
$amount: Float
) {
reddemPoints(
cartId: $cartId,
points: $points,
amount: $amount
) {
message
}
}
Variables
{
"cartId": "abc123",
"points": 123.45,
"amount": 123.45
}
Response
{
"data": {
"reddemPoints": {"message": "xyz789"}
}
}
removeCard
Response
Returns a StripeResponse
Example
Query
mutation removeCard(
$customerId: ID!,
$cardId: ID!,
$connectedAccountId: ID
) {
removeCard(
customerId: $customerId,
cardId: $cardId,
connectedAccountId: $connectedAccountId
) {
success
message
card {
...CardFragment
}
}
}
Variables
{
"customerId": 4,
"cardId": 4,
"connectedAccountId": "4"
}
Response
{
"data": {
"removeCard": {
"success": true,
"message": "xyz789",
"card": Card
}
}
}
removeCartItem
Description
Remove an item from user's cart
Example
Query
mutation removeCartItem(
$itemId: ID!,
$token: String,
$storeId: String!
) {
removeCartItem(
itemId: $itemId,
token: $token,
storeId: $storeId
) {
id
blockCheckout
phone
email
vipId
items {
...CartItemFragment
}
giftCardRecipientName
giftWrapping
adjustments {
...CartAdjustmentFragment
}
discounts {
...CartDiscountFragment
}
promoCode
tipPercent
specialInstructions
eventInfo {
...CartEventInfoFragment
}
shippingAddress {
...CartShippingAddressFragment
}
shippingQuotes {
...CartShippingMethodFragment
}
shippingMethod {
...CartShippingMethodFragment
}
isAsap
dateExpected
deliveryPriority
deliveryWindowFrom
deliveryWindowUntil
loyaltyPoints
loyaltyError
billingAddress {
...CartBillingAddressFragment
}
summary {
...CartSummaryFragment
}
token
storeId
orderNumber
}
}
Variables
{
"itemId": 4,
"token": "abc123",
"storeId": "xyz789"
}
Response
{
"data": {
"removeCartItem": {
"id": "xyz789",
"blockCheckout": false,
"phone": "abc123",
"email": "abc123",
"vipId": "xyz789",
"items": [CartItem],
"giftCardRecipientName": "abc123",
"giftWrapping": 987.65,
"adjustments": [CartAdjustment],
"discounts": [CartDiscount],
"promoCode": "abc123",
"tipPercent": 123.45,
"specialInstructions": "abc123",
"eventInfo": CartEventInfo,
"shippingAddress": CartShippingAddress,
"shippingQuotes": [CartShippingMethod],
"shippingMethod": CartShippingMethod,
"isAsap": true,
"dateExpected": "xyz789",
"deliveryPriority": "xyz789",
"deliveryWindowFrom": "xyz789",
"deliveryWindowUntil": "xyz789",
"loyaltyPoints": 987,
"loyaltyError": "abc123",
"billingAddress": CartBillingAddress,
"summary": CartSummary,
"token": "abc123",
"storeId": "abc123",
"orderNumber": "xyz789"
}
}
}
respondToEvent
Description
Respond to an event
Response
Returns an EventResponse
Example
Query
mutation respondToEvent(
$eventId: ID!,
$attending: Boolean!,
$firstName: String,
$lastName: String,
$email: String,
$dateOfBirth: String
) {
respondToEvent(
eventId: $eventId,
attending: $attending,
firstName: $firstName,
lastName: $lastName,
email: $email,
dateOfBirth: $dateOfBirth
) {
id
eventId
firstName
lastName
email
dateOfBirth
}
}
Variables
{
"eventId": 4,
"attending": true,
"firstName": "abc123",
"lastName": "xyz789",
"email": "xyz789",
"dateOfBirth": "abc123"
}
Response
{
"data": {
"respondToEvent": {
"id": 4,
"eventId": 4,
"firstName": "xyz789",
"lastName": "abc123",
"email": "xyz789",
"dateOfBirth": "xyz789"
}
}
}
siteSendEmail
Description
Sends an email with the specified contents
Response
Returns a Boolean
Example
Query
mutation siteSendEmail(
$name: String!,
$email: String!,
$phone: String,
$message: String!
) {
siteSendEmail(
name: $name,
email: $email,
phone: $phone,
message: $message
)
}
Variables
{
"name": "xyz789",
"email": "abc123",
"phone": "xyz789",
"message": "xyz789"
}
Response
{"data": {"siteSendEmail": false}}
stripeClientSecret
Description
Fetch Stripe's Client Secret for confirming payments on the client
Response
Returns a String
Example
Query
mutation stripeClientSecret(
$token: String,
$storeId: String!,
$cartId: String
) {
stripeClientSecret(
token: $token,
storeId: $storeId,
cartId: $cartId
)
}
Variables
{
"token": "xyz789",
"storeId": "abc123",
"cartId": "abc123"
}
Response
{"data": {"stripeClientSecret": "abc123"}}
updateBlock
Description
Update a block
Response
Returns a Block
Arguments
| Name | Description |
|---|---|
id - ID!
|
|
image - Upload
|
|
imageAlt - String
|
|
imageDelete - Boolean
|
|
category - String
|
|
deltaContent - String
|
|
htmlContent - String
|
|
textContent - String
|
|
slug - String
|
|
projectId - String
|
|
storeId - String
|
|
deltaPreTitle - String
|
|
htmlPreTitle - String
|
|
textPreTitle - String
|
|
deltaTitle - String
|
|
htmlTitle - String
|
|
textTitle - String
|
|
variant - String
|
Example
Query
mutation updateBlock(
$id: ID!,
$image: Upload,
$imageAlt: String,
$imageDelete: Boolean,
$category: String,
$deltaContent: String,
$htmlContent: String,
$textContent: String,
$slug: String,
$projectId: String,
$storeId: String,
$deltaPreTitle: String,
$htmlPreTitle: String,
$textPreTitle: String,
$deltaTitle: String,
$htmlTitle: String,
$textTitle: String,
$variant: String
) {
updateBlock(
id: $id,
image: $image,
imageAlt: $imageAlt,
imageDelete: $imageDelete,
category: $category,
deltaContent: $deltaContent,
htmlContent: $htmlContent,
textContent: $textContent,
slug: $slug,
projectId: $projectId,
storeId: $storeId,
deltaPreTitle: $deltaPreTitle,
htmlPreTitle: $htmlPreTitle,
textPreTitle: $textPreTitle,
deltaTitle: $deltaTitle,
htmlTitle: $htmlTitle,
textTitle: $textTitle,
variant: $variant
) {
buttons {
...ButtonFragment
}
id
image
imageAlt
category
deltaContent
htmlContent
textContent
slug
projectId
storeId
deltaPreTitle
htmlPreTitle
textPreTitle
deltaTitle
htmlTitle
textTitle
variant
}
}
Variables
{
"id": "4",
"image": Upload,
"imageAlt": "xyz789",
"imageDelete": true,
"category": "xyz789",
"deltaContent": "abc123",
"htmlContent": "abc123",
"textContent": "abc123",
"slug": "xyz789",
"projectId": "abc123",
"storeId": "xyz789",
"deltaPreTitle": "abc123",
"htmlPreTitle": "abc123",
"textPreTitle": "xyz789",
"deltaTitle": "abc123",
"htmlTitle": "xyz789",
"textTitle": "abc123",
"variant": "abc123"
}
Response
{
"data": {
"updateBlock": {
"buttons": [Button],
"id": 4,
"image": "abc123",
"imageAlt": "abc123",
"category": "xyz789",
"deltaContent": "xyz789",
"htmlContent": "abc123",
"textContent": "abc123",
"slug": "abc123",
"projectId": "abc123",
"storeId": "xyz789",
"deltaPreTitle": "xyz789",
"htmlPreTitle": "xyz789",
"textPreTitle": "xyz789",
"deltaTitle": "abc123",
"htmlTitle": "abc123",
"textTitle": "xyz789",
"variant": "abc123"
}
}
}
updateBlogPost
Description
Update a blog post
Response
Returns a BlogPost
Example
Query
mutation updateBlogPost(
$id: ID!,
$title: String,
$image: Upload,
$content: String,
$deltaContent: String,
$date: String
) {
updateBlogPost(
id: $id,
title: $title,
image: $image,
content: $content,
deltaContent: $deltaContent,
date: $date
) {
id
title
image
content
deltaContent
author
slug
featured
date
}
}
Variables
{
"id": "4",
"title": "abc123",
"image": Upload,
"content": "abc123",
"deltaContent": "abc123",
"date": "xyz789"
}
Response
{
"data": {
"updateBlogPost": {
"id": "4",
"title": "xyz789",
"image": "abc123",
"content": "abc123",
"deltaContent": "abc123",
"author": "xyz789",
"slug": "abc123",
"featured": 987,
"date": "xyz789"
}
}
}
updateCard
Response
Returns a StripeResponse
Example
Query
mutation updateCard(
$customerId: ID!,
$cardId: ID!,
$expMonth: Int,
$expYear: Int,
$name: String,
$connectedAccountId: ID,
$postalCode: String
) {
updateCard(
customerId: $customerId,
cardId: $cardId,
expMonth: $expMonth,
expYear: $expYear,
name: $name,
connectedAccountId: $connectedAccountId,
postalCode: $postalCode
) {
success
message
card {
...CardFragment
}
}
}
Variables
{
"customerId": "4",
"cardId": 4,
"expMonth": 123,
"expYear": 123,
"name": "xyz789",
"connectedAccountId": "4",
"postalCode": "xyz789"
}
Response
{
"data": {
"updateCard": {
"success": true,
"message": "xyz789",
"card": Card
}
}
}
updateCartItemQuantity
Description
Update item quantity in user's cart
Response
Returns a Cart
Example
Query
mutation updateCartItemQuantity(
$itemId: ID!,
$quantity: Int!,
$token: String,
$storeId: String!
) {
updateCartItemQuantity(
itemId: $itemId,
quantity: $quantity,
token: $token,
storeId: $storeId
) {
id
blockCheckout
phone
email
vipId
items {
...CartItemFragment
}
giftCardRecipientName
giftWrapping
adjustments {
...CartAdjustmentFragment
}
discounts {
...CartDiscountFragment
}
promoCode
tipPercent
specialInstructions
eventInfo {
...CartEventInfoFragment
}
shippingAddress {
...CartShippingAddressFragment
}
shippingQuotes {
...CartShippingMethodFragment
}
shippingMethod {
...CartShippingMethodFragment
}
isAsap
dateExpected
deliveryPriority
deliveryWindowFrom
deliveryWindowUntil
loyaltyPoints
loyaltyError
billingAddress {
...CartBillingAddressFragment
}
summary {
...CartSummaryFragment
}
token
storeId
orderNumber
}
}
Variables
{
"itemId": "4",
"quantity": 123,
"token": "xyz789",
"storeId": "abc123"
}
Response
{
"data": {
"updateCartItemQuantity": {
"id": "abc123",
"blockCheckout": false,
"phone": "xyz789",
"email": "abc123",
"vipId": "xyz789",
"items": [CartItem],
"giftCardRecipientName": "xyz789",
"giftWrapping": 123.45,
"adjustments": [CartAdjustment],
"discounts": [CartDiscount],
"promoCode": "xyz789",
"tipPercent": 987.65,
"specialInstructions": "abc123",
"eventInfo": CartEventInfo,
"shippingAddress": CartShippingAddress,
"shippingQuotes": [CartShippingMethod],
"shippingMethod": CartShippingMethod,
"isAsap": true,
"dateExpected": "xyz789",
"deliveryPriority": "xyz789",
"deliveryWindowFrom": "abc123",
"deliveryWindowUntil": "abc123",
"loyaltyPoints": 123,
"loyaltyError": "xyz789",
"billingAddress": CartBillingAddress,
"summary": CartSummary,
"token": "xyz789",
"storeId": "abc123",
"orderNumber": "xyz789"
}
}
}
updateCartLoyalty
Description
Update cart loyalty info
Example
Query
mutation updateCartLoyalty(
$storeId: String!,
$cartId: String
) {
updateCartLoyalty(
storeId: $storeId,
cartId: $cartId
) {
id
blockCheckout
phone
email
vipId
items {
...CartItemFragment
}
giftCardRecipientName
giftWrapping
adjustments {
...CartAdjustmentFragment
}
discounts {
...CartDiscountFragment
}
promoCode
tipPercent
specialInstructions
eventInfo {
...CartEventInfoFragment
}
shippingAddress {
...CartShippingAddressFragment
}
shippingQuotes {
...CartShippingMethodFragment
}
shippingMethod {
...CartShippingMethodFragment
}
isAsap
dateExpected
deliveryPriority
deliveryWindowFrom
deliveryWindowUntil
loyaltyPoints
loyaltyError
billingAddress {
...CartBillingAddressFragment
}
summary {
...CartSummaryFragment
}
token
storeId
orderNumber
}
}
Variables
{
"storeId": "abc123",
"cartId": "xyz789"
}
Response
{
"data": {
"updateCartLoyalty": {
"id": "xyz789",
"blockCheckout": false,
"phone": "abc123",
"email": "xyz789",
"vipId": "abc123",
"items": [CartItem],
"giftCardRecipientName": "xyz789",
"giftWrapping": 123.45,
"adjustments": [CartAdjustment],
"discounts": [CartDiscount],
"promoCode": "abc123",
"tipPercent": 123.45,
"specialInstructions": "abc123",
"eventInfo": CartEventInfo,
"shippingAddress": CartShippingAddress,
"shippingQuotes": [CartShippingMethod],
"shippingMethod": CartShippingMethod,
"isAsap": false,
"dateExpected": "abc123",
"deliveryPriority": "xyz789",
"deliveryWindowFrom": "abc123",
"deliveryWindowUntil": "xyz789",
"loyaltyPoints": 987,
"loyaltyError": "xyz789",
"billingAddress": CartBillingAddress,
"summary": CartSummary,
"token": "xyz789",
"storeId": "abc123",
"orderNumber": "abc123"
}
}
}
updateCollection
Description
Update a collection
Response
Returns a Collection
Example
Query
mutation updateCollection(
$id: ID!,
$name: String,
$image: Upload,
$deltaContent: String,
$htmlContent: String
) {
updateCollection(
id: $id,
name: $name,
image: $image,
deltaContent: $deltaContent,
htmlContent: $htmlContent
) {
id
name
image
deltaContent
htmlContent
slug
storeId
}
}
Variables
{
"id": "4",
"name": "abc123",
"image": Upload,
"deltaContent": "xyz789",
"htmlContent": "abc123"
}
Response
{
"data": {
"updateCollection": {
"id": 4,
"name": "xyz789",
"image": "abc123",
"deltaContent": "xyz789",
"htmlContent": "xyz789",
"slug": "abc123",
"storeId": "xyz789"
}
}
}
Types
AIProductList
ApplePaySessionResponse
BannerSlide
Block
Fields
| Field Name | Description |
|---|---|
buttons - [Button]
|
|
id - ID
|
|
image - String
|
|
imageAlt - String
|
|
category - String
|
|
deltaContent - String
|
|
htmlContent - String
|
|
textContent - String
|
|
slug - String
|
|
projectId - String
|
|
storeId - String
|
|
deltaPreTitle - String
|
|
htmlPreTitle - String
|
|
textPreTitle - String
|
|
deltaTitle - String
|
|
htmlTitle - String
|
|
textTitle - String
|
|
variant - String
|
Example
{
"buttons": [Button],
"id": "4",
"image": "xyz789",
"imageAlt": "xyz789",
"category": "abc123",
"deltaContent": "xyz789",
"htmlContent": "xyz789",
"textContent": "abc123",
"slug": "abc123",
"projectId": "xyz789",
"storeId": "abc123",
"deltaPreTitle": "xyz789",
"htmlPreTitle": "abc123",
"textPreTitle": "abc123",
"deltaTitle": "abc123",
"htmlTitle": "abc123",
"textTitle": "xyz789",
"variant": "abc123"
}
BlockList
BlogPost
Example
{
"id": "4",
"title": "abc123",
"image": "abc123",
"content": "xyz789",
"deltaContent": "xyz789",
"author": "xyz789",
"slug": "xyz789",
"featured": 987,
"date": "abc123"
}
BlogPostList
Fields
| Field Name | Description |
|---|---|
items - [BlogPost]
|
|
nextPageCursor - String
|
|
totalCount - Int!
|
Example
{
"items": [BlogPost],
"nextPageCursor": "xyz789",
"totalCount": 123
}
Boolean
Description
The Boolean scalar type represents true or false.
BrandSlide
Fields
| Field Name | Description |
|---|---|
BrandName - [String]
|
Example
{"BrandName": ["xyz789"]}
BulkDiscountData
Button
CTASection
Card
Cart
Fields
| Field Name | Description |
|---|---|
id - String
|
|
blockCheckout - Boolean
|
|
phone - String
|
|
email - String
|
|
vipId - String
|
|
items - [CartItem]
|
|
giftCardRecipientName - String
|
|
giftWrapping - Float
|
|
adjustments - [CartAdjustment]
|
|
discounts - [CartDiscount]
|
|
promoCode - String
|
|
tipPercent - Float
|
|
specialInstructions - String
|
|
eventInfo - CartEventInfo
|
|
shippingAddress - CartShippingAddress
|
|
shippingQuotes - [CartShippingMethod]
|
|
shippingMethod - CartShippingMethod
|
|
isAsap - Boolean
|
|
dateExpected - String
|
|
deliveryPriority - String
|
|
deliveryWindowFrom - String
|
|
deliveryWindowUntil - String
|
|
loyaltyPoints - Int
|
|
loyaltyError - String
|
|
billingAddress - CartBillingAddress
|
|
summary - CartSummary
|
|
token - String
|
|
storeId - String
|
|
orderNumber - String
|
Example
{
"id": "abc123",
"blockCheckout": true,
"phone": "abc123",
"email": "abc123",
"vipId": "xyz789",
"items": [CartItem],
"giftCardRecipientName": "xyz789",
"giftWrapping": 987.65,
"adjustments": [CartAdjustment],
"discounts": [CartDiscount],
"promoCode": "abc123",
"tipPercent": 987.65,
"specialInstructions": "xyz789",
"eventInfo": CartEventInfo,
"shippingAddress": CartShippingAddress,
"shippingQuotes": [CartShippingMethod],
"shippingMethod": CartShippingMethod,
"isAsap": false,
"dateExpected": "xyz789",
"deliveryPriority": "abc123",
"deliveryWindowFrom": "abc123",
"deliveryWindowUntil": "abc123",
"loyaltyPoints": 987,
"loyaltyError": "xyz789",
"billingAddress": CartBillingAddress,
"summary": CartSummary,
"token": "abc123",
"storeId": "abc123",
"orderNumber": "abc123"
}
CartAdjustment
CartBillingAddress
Example
{
"firstName": "abc123",
"lastName": "abc123",
"address1": "abc123",
"address2": "abc123",
"city": "abc123",
"region": "xyz789",
"country": "abc123",
"postal": "xyz789",
"phone": "xyz789",
"email": "abc123"
}
CartBillingAddressInput
Example
{
"firstName": "xyz789",
"lastName": "abc123",
"address1": "xyz789",
"address2": "abc123",
"city": "xyz789",
"region": "abc123",
"country": "abc123",
"postal": "xyz789",
"phone": "abc123",
"email": "xyz789"
}
CartDiscount
CartEventInfo
CartEventInfoInput
CartItem
Possible Types
| CartItem Types |
|---|
Example
{
"id": 4,
"type": "xyz789",
"name": "abc123",
"quantity": 123,
"priceEach": 987.65
}
CartItemEvent
CartItemProduct
Fields
| Field Name | Description |
|---|---|
id - ID
|
|
type - String
|
|
alcoholByVolume - Float
|
|
name - String
|
|
shortName - String
|
|
quantity - Int
|
|
priceEach - Float
|
|
loyaltyPrice - Int
|
|
discountAmount - Float
|
|
fullLoyalty - Boolean
|
|
loyaltyAmount - Int
|
|
productId - ID
|
|
variantId - ID
|
|
slug - String
|
|
image - String
|
|
sku - String
|
|
tags - [ProductTag]
|
Example
{
"id": 4,
"type": "xyz789",
"alcoholByVolume": 987.65,
"name": "abc123",
"shortName": "xyz789",
"quantity": 123,
"priceEach": 987.65,
"loyaltyPrice": 987,
"discountAmount": 123.45,
"fullLoyalty": true,
"loyaltyAmount": 123,
"productId": "4",
"variantId": "4",
"slug": "abc123",
"image": "xyz789",
"sku": "abc123",
"tags": [ProductTag]
}
CartShippingAddress
Example
{
"firstName": "xyz789",
"lastName": "abc123",
"address1": "abc123",
"address2": "abc123",
"city": "xyz789",
"region": "abc123",
"country": "xyz789",
"postal": "abc123",
"lat": 123.45,
"lng": 987.65,
"plusCode": "abc123",
"phone": "xyz789",
"email": "abc123"
}
CartShippingAddressInput
Example
{
"firstName": "abc123",
"lastName": "abc123",
"address1": "abc123",
"address2": "xyz789",
"city": "abc123",
"postal": "abc123",
"region": "xyz789",
"country": "abc123",
"lat": 987.65,
"lng": 123.45,
"plusCode": "abc123",
"phone": "abc123",
"email": "xyz789"
}
CartShippingMethod
CartSummary
Example
{
"quantity": 987,
"subtotal": 987.65,
"adjustmentAmount": 987.65,
"discountAmount": 987.65,
"promoDiscount": 987.65,
"tip": 123.45,
"taxes": [CartTax],
"taxTotal": 987.65,
"total": 123.45
}
CartTax
Collection
CollectionList
Fields
| Field Name | Description |
|---|---|
items - [Collection]
|
|
nextPageCursor - String
|
|
totalCount - Int!
|
Example
{
"items": [Collection],
"nextPageCursor": "xyz789",
"totalCount": 987
}
ContactInfo
Content
Customer
Fields
| Field Name | Description |
|---|---|
id - String
|
|
stripeId - String
|
|
firstName - String
|
|
lastName - String
|
|
phone - String
|
|
email - String
|
|
vipId - String
|
|
shippingAddress - CustomerShippingAddress
|
|
billingAddress - CustomerBillingAddress
|
|
subscriptions - [String]
|
|
stores - [CustomerStore]
|
|
payment - CustomerCreditCard
|
|
error - [String]
|
Example
{
"id": "abc123",
"stripeId": "abc123",
"firstName": "xyz789",
"lastName": "abc123",
"phone": "xyz789",
"email": "abc123",
"vipId": "abc123",
"shippingAddress": CustomerShippingAddress,
"billingAddress": CustomerBillingAddress,
"subscriptions": ["xyz789"],
"stores": [CustomerStore],
"payment": CustomerCreditCard,
"error": ["abc123"]
}
CustomerBillingAddress
Example
{
"firstName": "abc123",
"lastName": "abc123",
"address1": "abc123",
"address2": "abc123",
"city": "xyz789",
"postal": "xyz789",
"region": "xyz789",
"country": "xyz789",
"phone": "abc123",
"email": "abc123"
}
CustomerBillingAddressInput
Example
{
"firstName": "xyz789",
"lastName": "abc123",
"address1": "abc123",
"address2": "abc123",
"city": "xyz789",
"region": "xyz789",
"postal": "abc123",
"phone": "xyz789",
"email": "xyz789",
"country": "xyz789"
}
CustomerCreditCard
CustomerShippingAddress
Example
{
"firstName": "xyz789",
"lastName": "xyz789",
"address1": "xyz789",
"address2": "abc123",
"city": "xyz789",
"postal": "abc123",
"region": "xyz789",
"country": "abc123",
"phone": "abc123",
"email": "xyz789"
}
CustomerShippingAddressInput
Example
{
"firstName": "xyz789",
"lastName": "xyz789",
"address1": "xyz789",
"address2": "abc123",
"city": "abc123",
"postal": "xyz789",
"phone": "abc123",
"email": "abc123"
}
CustomerStore
Fields
| Field Name | Description |
|---|---|
storeId - String
|
|
creditCard - CustomerCreditCard
|
Example
{
"storeId": "xyz789",
"creditCard": CustomerCreditCard
}
Event
Example
{
"id": "4",
"name": "abc123",
"image": "xyz789",
"description": "abc123",
"slug": "abc123",
"begins": "abc123",
"ends": "xyz789",
"location": [Location],
"locationMap": "abc123",
"type": "abc123",
"isTicketed": false,
"isRsvpOnly": true,
"isAvailableOnline": false,
"ticketCost": 123.45,
"sku": "abc123"
}
EventResponse
Faq
Float
Description
The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.
Example
123.45
Homepage
Fields
| Field Name | Description |
|---|---|
logo - String
|
|
Location - Boolean
|
|
ThemeColor - ThemeColor
|
|
BannerSlides - [BannerSlide]
|
|
BrandSlides - [BrandSlide]
|
|
CTASection - CTASection
|
|
ServiceSection - ServiceSection
|
|
NewlyLauched - Boolean
|
|
AIRecommendation - Boolean
|
|
MatchedMoods - Boolean
|
|
Footer - Footer
|
|
BulkDiscount - BulkDiscountData
|
Example
{
"logo": "abc123",
"Location": true,
"ThemeColor": ThemeColor,
"BannerSlides": [BannerSlide],
"BrandSlides": [BrandSlide],
"CTASection": CTASection,
"ServiceSection": ServiceSection,
"NewlyLauched": true,
"AIRecommendation": true,
"MatchedMoods": false,
"Footer": Footer,
"BulkDiscount": BulkDiscountData
}
ID
Description
The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.
Example
"4"
Int
Description
The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
Example
123
JSON
Example
{}
Location
Moods
MoodsReponse
Fields
| Field Name | Description |
|---|---|
moods - [Moods]
|
Example
{"moods": [Moods]}
Order
Fields
| Field Name | Description |
|---|---|
id - ID
|
|
orderNumber - String
|
|
date - String
|
|
dateDelivered - String
|
|
email - String
|
|
items - [OrderItem]
|
|
giftWrapping - Float
|
|
promoCode - String
|
|
eventInfo - OrderEventInfo
|
|
shippingAddress - OrderShippingAddress
|
|
shippingMethod - OrderShippingMethod
|
|
specialInstructions - String
|
|
billingAddress - OrderBillingAddress
|
|
paymentMethod - String
|
|
summary - OrderSummary
|
|
storeId - String
|
Example
{
"id": "4",
"orderNumber": "xyz789",
"date": "abc123",
"dateDelivered": "abc123",
"email": "xyz789",
"items": [OrderItem],
"giftWrapping": 123.45,
"promoCode": "xyz789",
"eventInfo": OrderEventInfo,
"shippingAddress": OrderShippingAddress,
"shippingMethod": OrderShippingMethod,
"specialInstructions": "abc123",
"billingAddress": OrderBillingAddress,
"paymentMethod": "abc123",
"summary": OrderSummary,
"storeId": "abc123"
}
OrderBillingAddress
Example
{
"firstName": "abc123",
"lastName": "xyz789",
"address1": "abc123",
"address2": "xyz789",
"city": "abc123",
"region": "xyz789",
"country": "xyz789",
"postal": "abc123",
"phone": "xyz789",
"email": "xyz789"
}
OrderEventInfo
OrderItem
Possible Types
| OrderItem Types |
|---|
Example
{
"id": "4",
"type": "xyz789",
"name": "abc123",
"quantity": 987,
"priceEach": 123.45
}
OrderItemEvent
OrderItemProduct
Example
{
"id": "4",
"type": "abc123",
"name": "abc123",
"quantity": 123,
"priceEach": 123.45,
"productId": 4,
"variantId": 4,
"slug": "xyz789",
"image": "abc123",
"sku": "abc123",
"tags": [ProductTag]
}
OrderShippingAddress
Example
{
"firstName": "abc123",
"lastName": "abc123",
"address1": "abc123",
"address2": "xyz789",
"city": "xyz789",
"region": "xyz789",
"country": "abc123",
"postal": "abc123",
"lat": 987.65,
"lng": 987.65,
"plusCode": "xyz789",
"phone": "xyz789"
}
OrderShippingMethod
OrderSummary
OrderTax
Product
Fields
| Field Name | Description |
|---|---|
id - ID
|
|
name - String
|
|
brand - String
|
|
customBrand - String
|
|
slug - String
|
|
oldSlug - String
|
|
description - String
|
|
collections - [String]
|
|
country - String
|
|
region - String
|
|
priceFrom - Float
|
|
priceTo - Float
|
|
retailPriceFrom - Float
|
|
retailPriceTo - Float
|
|
isOnSale - Boolean
|
|
tags - [ProductTag]
|
|
imageIds - [String]
|
|
posImages - [String]
|
|
customImages - [String]
|
|
gulpImages - [String]
|
|
bestSellerScore - Int
|
|
isFeatured - Boolean
|
|
isFeaturedOnHomepage - Boolean
|
|
isStaffPick - Boolean
|
|
storeId - String
|
|
variants - [ProductVariant]
|
Example
{
"id": 4,
"name": "abc123",
"brand": "abc123",
"customBrand": "abc123",
"slug": "abc123",
"oldSlug": "xyz789",
"description": "xyz789",
"collections": ["abc123"],
"country": "abc123",
"region": "xyz789",
"priceFrom": 123.45,
"priceTo": 987.65,
"retailPriceFrom": 987.65,
"retailPriceTo": 123.45,
"isOnSale": true,
"tags": [ProductTag],
"imageIds": ["xyz789"],
"posImages": ["xyz789"],
"customImages": ["abc123"],
"gulpImages": ["abc123"],
"bestSellerScore": 123,
"isFeatured": true,
"isFeaturedOnHomepage": true,
"isStaffPick": true,
"storeId": "abc123",
"variants": [ProductVariant]
}
ProductList
ProductTag
ProductVariant
Fields
| Field Name | Description |
|---|---|
id - ID
|
|
fullName - String
|
Variant full name to be used without its corresponding product name |
shortName - String
|
Variant short name to be used together with its corresponding product name |
image - String
|
|
price - Float
|
|
retailPrice - Float
|
|
isOnSale - Boolean
|
|
scores - Int
|
|
quantity - Int
|
|
sku - String
|
|
volume - Int
|
|
alcoholByVolume - Float
|
|
deposit - Float
|
|
loyaltyPoints - Int
|
|
varietal - String
|
|
vintage - String
|
|
points - Int
|
Example
{
"id": 4,
"fullName": "abc123",
"shortName": "abc123",
"image": "abc123",
"price": 123.45,
"retailPrice": 123.45,
"isOnSale": true,
"scores": 123,
"quantity": 987,
"sku": "abc123",
"volume": 987,
"alcoholByVolume": 123.45,
"deposit": 123.45,
"loyaltyPoints": 987,
"varietal": "xyz789",
"vintage": "abc123",
"points": 987
}
ServiceSection
SocialLink
String
Description
The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
Example
"abc123"
StripeCardsResponse
StripeResponse
ThemeColor
Upload
Description
The Upload scalar type represents a file upload.
Example
Upload
reddemPointsResponse
Fields
| Field Name | Description |
|---|---|
message - String
|
Example
{"message": "abc123"}