Input objects

AddCartLineItemsRequestInput

The add cart line items request.

Arguments

Name	Description
lineItems [AddCartLineItemsRequestLineItemInput!]!	Gets or sets the line items.
id String!	The ID of the Cart.

AddCartLineItemsRequestLineItemInput

The add cart line items request.

Arguments

Name	Description
productId String	Gets or sets the product id.
variantId String	Gets or sets the variant id.
quantity Int	Gets or sets the quantity.

AddCustomerAddressRequestInput

Represents a request to add a customer’s address.

Arguments

Name	Description
isDefault Boolean!
isDefaultBilling Boolean!
isDefaultShipping Boolean!
type AddressType
firstName String!
lastName String!
company String
address1 String!
address2 String
postalCode String!
city String!
stateOrProvince String
countryCode String!
phone String
streetNumber String
additionalStreetInfo String

AddressInput

Customer’s address.

Arguments

Name	Description
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).

AddWishlistLineItemRequestInput

Arguments

Name	Description
addActions [WishListAddUpdateActionInput!]!
shoppingListId String

AvailableFiltersInput

Arguments

Name	Description
name String
keys [String!]
sort Sort

CancelOrderRequestInput

Arguments

Name	Description
orderId String!

CartAddressInput

Arguments

Name	Description
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).

CartRequestInput

The get cart request.

Arguments

Name	Description
id String!	The ID of the Cart.

CartUpdateRequestInput

The create cart request.

Arguments

Name	Description
id String!	Cart Id
anonymousId String	Optional anonymous user Identifier.
shippingAddress CartAddressInput
billingAddress CartAddressInput
deliveryComment DeliveryCommentInput
discountCode String

ChangeWishListNameRequestInput

Change customer’s wishlist name request.

Arguments

Name	Description
shoppingListId String	Shopping list id.
name String!	Name of the shopping list

CreateCartRequestInput

The create cart request.

Arguments

Name	Description
lineItems [AddCartLineItemsRequestLineItemInput!]!	Gets or sets the line items.
anonymousId String	Optional anonymous user Identifier.

CreateOrderRequestInput

Arguments

Name	Description
cartId String!
paymentMethod String
returnUrl String

DeliveryCommentInput

Arguments

Name	Description
deliveryCommentMsg String

DescriptionInput

Arguments

Name	Description
en String!

GetCategoryRequestInput

Arguments

Name	Description
id String	The ID of the Category.
key String	The Key of the Category.
slug String

GetMyOrderRequestInput

Arguments

Name	Description
id String!

GetMyOrdersRequestInput

Arguments

Name	Description
page Int!
limit Int!
sortBy OrderSortBy
orderNumber String
minOrderDate DateTime
maxOrderDate DateTime

GetOrderRequestInput

Arguments

Name	Description
id String!

GetProductRequestInput

Arguments

Name	Description
id String	The ID of the Product.
key String	The Key of the Product.
slug String	The Slug of the Product.
variantFilter VariantFilterInput	Gets or sets the variants filters.

GetWishListRequestInput

Arguments

Name	Description
shoppingListId String

LookupUrlRequestInput

Arguments

Name	Description
path String!	The URL path.

MoneyInput

Arguments

Name	Description
currencyCode String!	The Currency Code of the Money.
amount Decimal!	The Amount of the Money.

NameInput

Arguments

Name	Description
en String!

RemoveCartLineItemRequestInput

The remove cart line item request.

Arguments

Name	Description
lineItemId String!	Gets or sets the line item id.
id String!	The ID of the Cart.

RemoveCustomerAddressRequestInput

Arguments

Name	Description
addressId String!

RemoveWishlistLineItemRequestInput

Remove wishlist lineitem request

Arguments

Name	Description
lineItemIds [String!]!
shoppingListId String

ResetPasswordRequestInput

Arguments

Name	Description
token String!
currentPassword String!
newPassword String!

ResponsiveImageAlternativeInput

Represents alternative images.

Arguments

Name	Description
type String!
url String!

ResponsiveImageInput

Represents product images in customer’s wishlist or cart.

Arguments

Name	Description
urlThumbnail String
urlOriginal String
altText String
width Int
height Int
alternativeSizes [ResponsiveImageAlternativeInput!]

SearchProductsRequestInput

Arguments

Name	Description
text String	The text string on which to search, for example: "Sofa" or "Bed".
productIds [String!]	The list of product ids.
productKeys [String!]	The list of product keys.
productSlugs [String!]	The list of product slugs.
productCategoryKeys [String!]	Gets or sets the product category keys.
productCategorySlugs [String!]	Gets or sets the product category slugs.
facets [String!]	Gets or sets the facets.
filters [AvailableFiltersInput!]	Gets or sets the filters.
sortings [SortingInput!]	Gets or sets the sortings.
haveVariantFilter Boolean	Get or sets if the filters must be used to filter the variants
limit Int	The maximum number of records to retrieve.
offset Int	By specifying offset, you retrieve a subset of records starting with the offset.

SignInRequestInput

Arguments

Name	Description
email String!
password String!
cartId String
useNewCart Boolean!
anonymousId String	Optional anonymous session id if applicable.

SignUpRequestInput

Arguments

Name	Description
firstName String!
lastName String!
companyName String
vatNumber String
email String!
password String!
phone String
birthDate String
address AddressInput

SortingInput

Arguments

Name	Description
sortType String!
sort Sort

UpdateCartLineItemRequestInput

The update cart line item request.

Arguments

Name	Description
lineItemId String!	Gets or sets the line item id.
quantity Int!	Gets or sets the quantity.
id String!	The ID of the Cart.

UpdateCustomerAddressRequestInput

Arguments

Name	Description
addressId String
isDefault Boolean!
isDefaultForTypes [AddressType!]
type AddressType!
firstName String
lastName String
company String
address1 String
address2 String
postalCode String
city String
stateOrProvince String
countryCode String
phone String
streetNumber String
additionalStreetInfo String

VariantFilterInput

Arguments

Name	Description
name String!
key String!

WishListAddUpdateActionInput

Arguments

Name	Description
action String!
productId String!
variantId Int!
quantity Int!

WishlistItemInput

Arguments

Name	Description
id String
productId String!
variantId Long
sku String
name String
image ResponsiveImageInput
priceExclTax MoneyInput
salePriceExclTax MoneyInput
priceInclTax MoneyInput
salePriceInclTax MoneyInput

WishlistRequestInput

Arguments

Name	Description
name NameInput
description DescriptionInput
anonymousId String
lineItems [WishlistItemInput!]