Skip to content

Objects

AppliedDiscounts

Fields

NameDescription
id
String
amount
String
name
String
code
String
target
String

Attribute

Fields

NameDescription
name
String!

The Name of the Attribute.

valueType
AttributeValueType

The Value Type of the Attribute.

value
AttributeValue

The Value of the Attribute.

AttributeValue

Fields

NameDescription
booleanValue
Boolean

The Boolean Value of the Attribute

stringValue
String

The String Value of the Attribute

stringValues
[String!]

The String Values of the Attribute

BillingAddress

Fields

NameDescription
email
String
firstName
String

Gets or sets the first name associated with the address.

lastName
String

Gets or sets the last name associated with the address.

company
String

Gets or sets the company name associated with the address.

address1
String

Gets or sets the first line of the address.

address2
String

Gets or sets the second line of the address (if applicable).

city
String

Gets or sets the city associated with the address.

countryCode
String

Gets or sets the country code of the address (e.g., ISO 3166-1 alpha-2 code).

postalCode
String

Gets or sets the postal code (ZIP code) associated with the address.

stateOrProvince
String

Gets or sets the state or province associated with the address.

phone
String

Gets or sets the phone number associated with the address.

streetNumber
String

Gets or sets the street number (if applicable).

additionalStreetInfo
String

Gets or sets additional street information (if applicable).

Breadcrumbs class

Fields

NameDescription
slug
String!

Gets or sets the slug.

key
String!

Gets or sets the key.

name
String!

Gets or sets the name.

path
String

Gets or sets the path.

CartAddress

Fields

NameDescription
email
String
firstName
String

Gets or sets the first name associated with the address.

lastName
String

Gets or sets the last name associated with the address.

company
String

Gets or sets the company name associated with the address.

address1
String

Gets or sets the first line of the address.

address2
String

Gets or sets the second line of the address (if applicable).

city
String

Gets or sets the city associated with the address.

countryCode
String

Gets or sets the country code of the address (e.g., ISO 3166-1 alpha-2 code).

postalCode
String

Gets or sets the postal code (ZIP code) associated with the address.

stateOrProvince
String

Gets or sets the state or province associated with the address.

phone
String

Gets or sets the phone number associated with the address.

streetNumber
String

Gets or sets the street number (if applicable).

additionalStreetInfo
String

Gets or sets additional street information (if applicable).

CartLineItem

The cart line item.

Fields

NameDescription
id
String!

Gets or sets the id.

quantity
Long!

Gets or sets the quantity.

totalPriceExclTax
Money!

Gets or sets the total price excl tax.

totalPriceInclTax
Money!

Gets or sets the total.

productLineItem
ProductLineItem

Gets or sets the ProductLineItem

CartResponse

The cart.

Fields

NameDescription
customerId
String

Gets or sets the customer id.

customerEmail
String

Gets or sets the customer email.

country
String

Gets or sets the country.

shippingAddress
CartAddress

Gets or sets the shipping address

billingAddress
CartAddress

Gets or sets the billing address

lineItems
[CartLineItem!]!

Gets or sets the line items.

productLineItems
[ProductLineItem!]

Gets or sets the ProductLineItems items.

createdAt
DateTime!

Gets or sets the created at.

lastModifiedAt
DateTime!

Gets or sets the last modified at.

taxTotal
Money!

Gets or sets the tax total.

subtotalExclTax
Money!

Gets or sets the subtotal excl tax.

subtotalInclTax
Money!

Gets or sets the subtotal incl tax.

discountTotal
Money!

Gets or sets the discount total.

productDiscountTotal
Money

Gets or sets the product discount total.

saleTotal
Money

Gets or sets the sale total.

shippingCostInclTax
Money

Gets or sets the shipping cost incl tax.

shippingCostExclTax
Money

Gets or sets the shipping cost excl tax.

anonymousId
String

Id to identify anonymous user resources

contentHasChanged
Boolean
shippingMethod
String
deliveryComments
String
id
String!

The ID of the Cart.

Category

Implements

Fields

NameDescription
id
String!

The ID of the Category.

key
String

The Key of the Category.

name
String!

The Name of the Category.

slug
String!

The Slug of the Category.

path
String!

The Path of the Category.

description
String!

The Description of the Category.

seo
Seo!

The SEO of the Category.

breadcrumbs
[Breadcrumbs!]
children
[Category!]!

The Sub Categories of the Category.

CategoryFacets

Fields

NameDescription
category
Category

Gets or sets the category.

facets
[Facets!]

Gets or sets the filters.

Customer

Customer representation.

Fields

NameDescription
id
String!

Gets or sets the unique identifier for the customer.

customerGroupId
String

Gets or sets the identifier for the customer group to which the customer belongs, if applicable.

firstName
String!

Gets or sets the first name of the customer.

lastName
String!

Gets or sets the last name of the customer.

middleName
String

Gets or sets the middle name of the customer, if applicable.

email
String!

Gets or sets the email address of the customer.

companyName
String

Gets or sets the company name associated with the customer, if applicable.

vatNumber
String

Gets or sets the VAT (Value Added Tax) number of the customer, if applicable.

phone
String

Gets or sets the phone number of the customer, if provided.

birthDate
String

Gets or sets the birth date of the customer, if available.

version
Long!

Gets or sets the version of the customer object.

defaultBillingAddress
CustomerAddress

Gets or sets the default billing address for the customer, if specified.

defaultShippingAddress
CustomerAddress

Gets or sets the default shipping address for the customer, if specified.

addresses
[CustomerAddress]!

Gets or sets a list of addresses associated with the customer.

CustomerAddress

Fields

NameDescription
id
String!
type
AddressType!
firstName
String

Gets or sets the first name associated with the address.

lastName
String

Gets or sets the last name associated with the address.

company
String

Gets or sets the company name associated with the address.

address1
String

Gets or sets the first line of the address.

address2
String

Gets or sets the second line of the address (if applicable).

city
String

Gets or sets the city associated with the address.

countryCode
String

Gets or sets the country code of the address (e.g., ISO 3166-1 alpha-2 code).

postalCode
String

Gets or sets the postal code (ZIP code) associated with the address.

stateOrProvince
String

Gets or sets the state or province associated with the address.

phone
String

Gets or sets the phone number associated with the address.

streetNumber
String

Gets or sets the street number (if applicable).

additionalStreetInfo
String

Gets or sets additional street information (if applicable).

DiscountedLineItemPriceForQuantityCoreConnect

Fields

NameDescription
id
String

Facets

The filters.

Fields

NameDescription
name
String!

Gets or sets the name.

options
[Options!]!

Gets or sets the options.

GetMyOrdersResponse

Fields

NameDescription
orders
[Order!]
pagination
Pagination

Image

Fields

NameDescription
url
String!

The URL of the Image.

KeyValuePairOfStringAndString

Fields

NameDescription
key
String!
value
String!

LookupUrlResponse

Fields

NameDescription
node
Node

The product or category.

MethodTaxRateCoreConnect

Fields

NameDescription
id
String

Money

Fields

NameDescription
currencyCode
String!

The Currency Code of the Money.

amount
Decimal!

The Amount of the Money.

Options

The options.

Fields

NameDescription
name
String

Gets or sets the name.

value
String

Gets or sets the value.

count
Int

Gets or sets the count.

Order

Fields

NameDescription
id
String
orderDate
String
orderNumber
String
status
String
anonymousId
String
customerId
String
orderState
String
billingAddress
BillingAddress
shippingAddress
ShippingAddress
taxTotal
Money
subtotalExclTax
Money
shippingCostExclTax
Money
shippingCostInclTax
Money
totalInclTax
Money
lineItems
[OrderLineItem!]
paymentState
String
shippingMode
String
paymentLinkUrl
String
packages
[OrderPackage!]

OrderLineItem

Fields

NameDescription
id
String
productId
String
sku
String
name
String
nameMerchant
String
quantity
Int!
priceExclTax
Money
priceInclTax
Money
costPriceExTax
Money
costPriceInclTax
Money
originalPrice
Money
originalTotal
Money
subTotalInclTax
Money
saleTotal
Money
image
Image
appliedDiscounts
[AppliedDiscounts!]
subItems
[OrderLineItem!]
productOptions
[ProducOptions!]
parentOrderProductId
Int
productDiscountTotal
Money
extraInfo
[KeyValuePairOfStringAndString!]
isSample
Boolean
path
String
isGift
Boolean
package
OrderPackage

OrderPackage

Fields

NameDescription
id
String
carrier
String
deliveryStatus
String
minimumDeliveryDate
String
maximumDeliveryDate
String

Pagination

Fields

NameDescription
skip
Int
limit
Int!
total
Int
page
Int
totalPages
Int

PaymentMethod

Fields

NameDescription
id
String!
image
String
code
String
name
String!
provider
String
subMethods
[SubPaymentMethod!]!
minAuthorizationAmount
Decimal!

ProducOptions

Fields

NameDescription
displayValue
String

Product

Implements

Fields

NameDescription
id
String!

The ID of the Product.

key
String

The Key of the Product.

sku
String!

The SKU of the Product.

name
String!

The Name of the Product.

slug
String!

The Slug of the Product.

description
String!

The Description of the Product.

priceInclTax
Money

The Price Include Tax of the Product.

priceExclTax
Money

The Price Exclude Tax of the Product.

salePriceInclTax
Money

The Sale Price Include Tax (Discounted Price Include Tax) of the Product.

salePriceExclTax
Money

The Sale Price Exclude Tax (Discounted Price Exclude Tax) of the Product.

oldPriceInclTax
Money

The Old Price Include Tax of the Product.

oldPriceExclTax
Money

The Sale Price Exclude Tax of the Product.

defaultImage
Image

The Default Image of the Product.

images
[Image!]!

The Images of the Product.

categories
[Category!]!

Gets or sets the categories.

attributes
[Attribute!]!

The Attributes of the Product.

variants
[ProductVariant!]!

The Variants of the Product.

allVariants
[ProductVariant!]
seo
Seo!

The SEO of the Product.

productsResponse
ProductsResponse
createdAt
DateTime!

Gets or sets the created at.

lastModifiedAt
DateTime!

Gets or sets the last modified at.

breadcrumbs
[Breadcrumbs!]!

Gets or sets the breadcrumbs.

relatedProducts
[Product!]!

List of related products

metadata
ProductMetadata!

ProductLineItem

Fields

NameDescription
id
String!
productId
String!
name
String!
slug
String!
variant
ProductVariant!
priceInclTax
Money
priceExclTax
Money
salePriceInclTax
Money
salePriceExclTax
Money
quantity
Int!
discountedPricePerQuantity
[DiscountedLineItemPriceForQuantityCoreConnect!]
perMethodTaxRate
[MethodTaxRateCoreConnect!]
addedAt
DateTime
lastModifiedAt
DateTime

ProductMetadata

Fields

NameDescription
key
String!
value
JSON!

ProductsResponse

Fields

NameDescription
products
[Product!]!
productsResponseTotals
ProductsResponseTotals!

ProductsResponseTotals

Fields

NameDescription
limit
Long!

The maximum number of records to retrieve.

offset
Long!

By specifying offset, you retrieve a subset of records starting with the offset.

total
Long

ProductVariant

The product variant.

Fields

NameDescription
id
String!

The ID of the Product Variant.

sku
String!

The SKU of the Product Variant.

priceInclTax
Money

The Price Include Tax of the Product Variant.

priceExclTax
Money

The Price Exclude Tax of the Product Variant.

salePriceInclTax
Money

The Sale Price Include Tax (Discounted Price Include Tax) of the Product Variant.

salePriceExclTax
Money

The Sale Price Exclude Tax (Discounted Price Exclude Tax) of the Product Variant.

oldPriceInclTax
Money

The Old Price Include Tax of the Product Variant.

oldPriceExclTax
Money

The Old Price Exclude Tax of the Product Variant.

defaultImage
Image

The Default Image of the Product Variant.

images
[Image!]!

The Images of the Product Variant.

attributes
[Attribute!]!

The Attributes of the Product Variant.

stock
ProductVariantStock

The stock info

metadata
ProductVariantMetadata!

ProductVariantMetadata

Fields

NameDescription
key
String!
value
JSON!

ProductVariantStock

Fields

NameDescription
availableQuantity
Int!
isSellableWithoutStock
Boolean!
isAvailable
Boolean!

ResponsiveImage

Represents product images in customer’s wishlist or cart.

Fields

NameDescription
urlThumbnail
String
urlOriginal
String
altText
String
width
Int
height
Int
alternativeSizes
[ResponsiveImageAlternative!]

ResponsiveImageAlternative

Represents alternative images.

Fields

NameDescription
type
String!
url
String!

SearchProductsResponse

The search products response.

Fields

NameDescription
products
[Product!]

The products.

facets
[Facets!]

Gets or sets the filters.

categoriesFacets
[CategoryFacets!]

Gets or sets the categories filters.

productsResponseTotals
ProductsResponseTotals

Gets or sets the products response totals.

Seo

Fields

NameDescription
metaTitle
String!

The Meta Title of the SEO.

metaDescription
String!

The Meta Description of the SEO.

ShippingAddress

Fields

NameDescription
email
String
firstName
String

Gets or sets the first name associated with the address.

lastName
String

Gets or sets the last name associated with the address.

company
String

Gets or sets the company name associated with the address.

address1
String

Gets or sets the first line of the address.

address2
String

Gets or sets the second line of the address (if applicable).

city
String

Gets or sets the city associated with the address.

countryCode
String

Gets or sets the country code of the address (e.g., ISO 3166-1 alpha-2 code).

postalCode
String

Gets or sets the postal code (ZIP code) associated with the address.

stateOrProvince
String

Gets or sets the state or province associated with the address.

phone
String

Gets or sets the phone number associated with the address.

streetNumber
String

Gets or sets the street number (if applicable).

additionalStreetInfo
String

Gets or sets additional street information (if applicable).

SignInResponse

Fields

NameDescription
accessToken
String!
customer
Customer!
cartId
String

SignUpResponse

Fields

NameDescription
accessToken
String!
customer
Customer!

SubPaymentMethod

Fields

NameDescription
id
String
image
String
code
String
name
String

Wishlist

Fields

NameDescription
id
String
version
Int
name
String!
lineItems
[WishlistItem!]
anonymousId
String
createdAt
DateTime!
lastModifiedAt
DateTime

WishlistItem

Fields

NameDescription
id
String
productId
String!
variantId
Long
sku
String
name
String
image
ResponsiveImage
priceExclTax
Money
salePriceExclTax
Money
priceInclTax
Money
salePriceInclTax
Money