Schema Types

get product, category or page by path.

Fetch a single page by ID.

Fetch all non-hidden pages. If you are using nested pages, only root level pages will be returned.

fetch order by id

Deprecated, please use the orderId-argument

Fetches my pages content

get customer product list by id, null gets default product list

Fetches customer-unique offers

Used in the sign up process when the shop has a third party customer repository, e.g. Voyado.

Error codes: INVALID_VALUE (if key is null), ExternalCustomerLookupFailed

Get information on person by Key(personal id number or phone number)

Returns Content found by list of its IDs. Also not found Content IDs are listed.

get channel by id, null gets default channel

get all channels

get categories by channel id, culture, root and culture

category id of root parent, null or omit means all

number of levels to traverse in the category tree, null or omit means all

Deprecated, this argument does not affect the result

get category by id

This mutation's purpose is to subscribe a customer to a newsletter. In order to subscribe a customer a valid email address is required

Responds with a boolean value whether the subscription has been successful or not

Description

Adds items to product list, null id adds items to the default product list.

Error Codes

Unauthorized

Unauthorized

AddToProductListFailed

Error in underlying API call, more info may be contained in the error message.

InvalidArticleNumber

Article number cannot be empty

ProductNotFound

No match on article number

MoreThanOneMatchOnArticleNumber

Article number matched more than one article

Description

Creates a product list for a logged in customer

Error Codes

Unauthorized

UnableToCreateProductList

Error in underlying API call, more info may be contained in the error message.

Description

Deletes a product list for a logged in customer

Error Codes

Unauthorized

ProductListNotFound

Argument id did not match any list for this customer.

UnableToDeleteProductList

Error in underlying API call, more info may be contained in the error message.

Description

Removes an item from a product list for a logged in customer, null id removes item in the default product list.

Error Codes

Unauthorized

ProductListNotFound

Argument id did not match any list for this customer.

RemoveFromProductListFailed

Error in underlying API call, more info may be contained in the error message.

ProductNotFound

Argument articleNumbers did not match any products or variants.

MoreThanOneMatchOnArticleNumber

Argument articleNumbers matched more than one product/variant.

InvalidArticleNumber

Argument articleNumbers cannot be null or empty.

Description

Updates an item in product list, null id updates item in the default product list.

Error Codes

Unauthorized

ProductListNotFound

Argument id did not match any list for this customer.

UnableToUpdateProductListItem

Error in underlying API call, more info may be contained in the error message.

ProductNotFound

Argument articleNumber did not match any products or variants.

MoreThanOneMatchOnArticleNumber

Argument articleNumber matched more than one product/variant.

InvalidArticleNumber

Argument articleNumber cannot be null or empty.

Description

Updates a product list for a logged in customer

Error Codes

Unauthorized

ProductListNotFound

Argument id did not match any list for this customer.

UnableToUpdateProductList

Error in underlying API call, more info may be contained in the error message.

Error codes: CustomerNotFound, CustomerAlreadyActivated, UnableToActivateCustomer, UnableToLoginCustomer, InvalidCustomerActivateInput

Error codes: CustomerNotFound, CustomerAlreadyActivated, UnableToActivateCustomer, UnableToLoginCustomer, InvalidCustomerActivateInput

This mutation deletes a customer. An authorization token is needed in the request, in order to be able to delete the customer.

LoginMutation will log a user in. One of email, pid, externalId or memberNumber is required, along with a password. To login as external customer, the email, externalHashId and timestamp are required. Returns an authorization token if the login was successful.

Requires a valid email and returns boolean value if successful, otherwise an error will be thrown

Requires a valid resetPasswordToken and a new password and if successful will return a authentication token

A reset password token that is solely used during a password reset

The SignUp-mutation is used for creating a customer.

If the sign up is successful the customer may be considered to be logged on and an authentication token will be returned

This mutation's purpose is to update a existing customer's information. An authorization token is needed in the request, in order to be able to update the customer.

This mutation's purpose is to update a existing customer's price list using an access code. An authorization token is needed in the request, in order to be able to update the customer.

The updatePassword mutation updates the customers password. Both the old password and a new password is a requirement.

Adds products to the cart where you can add comments to the products and determine their quantities. Replies with the affected cart if a cartId has been presented, otherwise a new cart will be created.

Not specifying cart id will create new cart.

Adds a product to the cart where you can add a comment to the product and determine the quantity. Replies with the affected cart if a cartId has been presented, otherwise a new cart will be created.

This mutation is used to reduce the quantity of a product in the cart, replies with the affected cart ruled by the cartId in the input.

Used to add a specific quantity to a product in the cart. Replies with the affected cart ruled by the cartId in the input

This mutation is used to increase the quantity of a product in the cart, replies with the affected cart ruled by the cartId in the input

Removes a specific product in the cart, replies with the affected cart

Removes specific items from the cart, replies with the affected cart

Responds with the affected cart.

⚠️ DEPRECATED

Use organizationNumber instead.

Customer id for external system

⚠️ DEPRECATED

Use communication.acceptsEmail

NB: Carries a performance cost, as asking for this will result in a separate API call in the backend.

Will fetch all if this is set to 0

NB: Carries a performance cost, as asking for this will result in a separate API call in the backend.

NB: Carries a performance cost, as asking for this will result in a separate API call in the backend.

⚠️ DEPRECATED

Please use images on product instead.

Total price, including discounts

Total price, excluding discounts

Unit price, including discounts

Unit price, excluding discounts

Discount total

⚠️ DEPRECATED

Use parent.id instead

The time interval of the campaign/category

Whether or not this category and all its children are considered hidden

⚠️ DEPRECATED

This field should no longer be used and will always be false.

When empty will display the value of the name field

NB: Carries a performance cost, as asking for this will result in a separate API call in the backend.

NB: Carries a performance cost, as asking for this will result in a separate API call in the backend.

The primary route of this Category. NB: Carries a performance cost, as asking for this will result in a separate API call in the backend.

⚠️ DEPRECATED

Use parent instead

A dynamic category has no fixed products; products are dynamically included based on filters defined on the category in Admin. N.B. Products found on a dynamic category has no route that includes said category, instead product.primaryRoute will have to be used.

Get content data set via the Content Editor.NB: Carries a performance cost, as asking for this will result in a separate API call in the backend.

The root url of images, this can be used to build image urls if needed.

This channel requires a user to be authorized.

If true image content property will return ImageValue instead of a string

NB: Carries a performance cost, as asking for this will result in a separate API call in the backend.

NB: Carries a performance cost, as asking for this will result in a separate API call in the backend.

NB: Carries a performance cost, as asking for this will result in a separate API call in the backend.

This will use localization, and will work well when requesting one channel, but may give unpredictable results when getting multiple channels via channels

NB: Carries a performance cost, as asking for this will result in a separate API call in the backend.

This will use localization, and will work well when requesting one channel, but may give unpredictable results when getting multiple channels via channels

⚠️ DEPRECATED

For currency formatting to a specific culture, instead use whichever culture makes sense contextually.

NB: Carries a performance cost, as asking for this will result in a separate API call in the backend.

For display purposes, not guaranteed to match up with a currency on the channel.

NB: Carries a performance cost, as asking for this will result in a separate API call in the backend.

NB: Carries a performance cost, as asking for this will result in a separate API call in the backend.

NB: Carries a performance cost, as asking for this will result in a separate API call in the backend.

NB: Carries a performance cost, as asking for this will result in a separate API call in the backend.

NB: Carries a performance cost, as asking for this will result in a separate API call in the backend.

Text that will show on the landing page on MyPages

Will fetch all if this is set to 0

NB: Carries a performance cost, as asking for this will result in a separate API call in the backend.

If this is false, a call to order for this order will result in a failure.

Name of the Product at the time the order was placed (may since have changed). Use this as a fallback if the 'product' field itself is null.

N.B. this may be null if the Product has since been removed.

N.B. this may be null if the Product itself or the Variant has since been removed.

N.B. this may be null if the Product has since been removed.

Value of the Variant at the time the order was placed (may since have changed). Use this as a fallback if the 'variant' field itself is null. Will be null when the OrderItem is not a Variant.

The current package price with any potential discount

The previous package price without any potential discount

Total package discount amount

Total package discount in percentage

The current package price with any potential discount

The previous package price without any potential discount

External URL if page is set to URL, null if not.

NB: Carries a performance cost, as asking for this will result in a separate API call in the backend.

The primary route of this Page. NB: Carries a performance cost, as asking for this will result in a separate API call in the backend.

Get content data set via the Content Editor

• If this page was fetched by ID using the page(id) query, parent will be returned even if it is hidden.
• If this page was fetched using the pages query, parent will not be returned if it is hidden

• If this page was fetched by ID using the page(id) query, subPages will be returned even if they are hidden. This can be overridden with the includeHidden flag.
• If this page was fetched using the pages query, subPages will not be returned if they are hidden. The includeHidden flag has no effect on this.

NB: Carries a performance cost, as asking for this will result in a separate API call in the backend.

NB: Carries a performance cost, as asking for this will result in a separate API call in the backend.

Optional: ID's of filters to fetch. If not set all filters will be returned.

Customer id for external system

⚠️ DEPRECATED

Use communication.acceptsEmail

NB: Carries a performance cost, as asking for this will result in a separate API call in the backend.

Will fetch all if this is set to 0

NB: Carries a performance cost, as asking for this will result in a separate API call in the backend.

NB: Carries a performance cost, as asking for this will result in a separate API call in the backend.

Product header if it differs from the actual product name, usually displayed instead of the product name in the header tag at the product page.

NB: Carries a performance cost, as asking for this will result in a separate API call in the backend.

NB: Carries a performance cost, as asking for this will result in a separate API call in the backend.

Deprecated, this argument does not affect the result

NB: Carries a performance cost, as asking for this will result in a separate API call in the backend.

Set this to false if you prefer to manually collate these images with the images found on the Variant.

Limit the number of images you get back. Defaults to null, which will return all images.

NB: Carries a performance cost, as asking for this will result in a separate API call in the backend.

NB: Carries a performance cost, as asking for this will result in a separate API call in the backend.

The current price. Will be a Customer specific price, if that Customer has a separate price list.

The previous price (i.e. this will be higher than price if the product is discounted). Will be a Customer specific previous price, if that Customer has a separate price list.

Default price for the product in the channel, disregards Customer specific prices.

Default previous price for the product in the channel, disregards Customer specific prices.

Not in use. Always null.

The time interval of the discounted price. If the product has variants, the time interval will be that of the variant which price is shown on the product.

Specifies input field(s) for the Customer to populate on the Product that will then carry through to the Order. If 'required' is true the Product should not be purchasable until the field is populated.

NB: Carries a performance cost, as asking for this will result in a separate API call in the backend.

NB: Carries a performance cost, as asking for this will result in a separate API call in the backend.

The primary route of this Product. NB: Carries a performance cost, as asking for this will result in a separate API call in the backend.

The product is recommended to only be purchasable in multiples of the distributionPackageSize. (Different shops may have different levels of leniency on this rule).

Configurations on a product are used to assemble a complete product,

For example, if the product is a ring then the ring may have two configurations; measures of circumference and choice of engraving

In this field, all the configurations of the product will be presented, the configuration name and its various options.

Calculates the price of the product based on the configuration choices that's been made. NB: Carries a performance cost, as asking for this will result in a separate API call in the backend.

Quantity suffix e.g pcs, box, etc.

Description

NB: Carries a performance cost, as asking for this will result in a separate API call in the backend.

Error Codes

InvalidAmountOfArticleNumbers

Number of input products doesn't match package products

InvalidArticleNumber

Product or variant article number doesn't match any products

UnableToGetPackagePrice

Failed to calculate package price

NB: Carries a performance cost, as asking for this will result in a separate API call in the backend.

All other products in the same family as the product. NB: Carries a performance cost, as asking for this will result in a separate API call in the backend.

This will be set if the configuration requires price calculation, e.g. you might sell rope and price it by length.

Alternate text for the image, commonly used for the alt attribute of img-tags.

Extra information, commonly used for the title attribute of img-tag. Should be shown on hover.

⚠️ DEPRECATED

Images will no longer be offered in different sizes. Instead use 'url' in conjunction with our image resizing service.

Variant values (combination of option values)

The current price. Will be a Customer specific price, if that Customer has a separate price list.

The previous price (i.e. this will be higher than price if the product is discounted). Will be a Customer specific previous price, if that Customer has a separate price list.

Default price for the product in the channel, disregards Customer specific prices.

Default previous price for the product in the channel, disregards Customer specific prices.

Not in use. Always null.

The time interval of the discounted price.

NB: Carries a performance cost, as asking for this will result in a separate API call in the backend.

NB: Carries a performance cost, as asking for this will result in a separate API call in the backend.

Available product variant options.

Product variants, contains all possible values of options.

Customers who bought this product also bought these products.

number of recommended products to fetch

Customers who viewed this product also viewed these products.

number of recommended products to fetch

A shuffled top list of popular products.

number of recommended products to fetch

The Category, Product, Page or StartPage that the Route resolves to. NB: Carries a performance cost, as asking for this will result in a separate API call in the backend.

Parents are resolved by traversing the path, starting from the end, and are guaranteed to be returned in that order. NB: Carries a performance cost, as asking for this will result in a different, slightly more expensive (the more categories a shop has, the more expensive this gets), route query in the backend.

Alternative routes for this object, if it exists in another channel and/or in another language.NB: Carries no additional performance cost.

N.B. for troubleshooting routes only!

Breadcrumb texts; starting with the root parent, ending on this route.

NB: Carries a performance cost, as asking for this will result in a separate API call in the backend.

NB: Carries a performance cost, as asking for this will result in a separate API call in the backend.

NB: Carries a performance cost, as asking for this will result in a separate API call in the backend.

NB: Carries a performance cost, as asking for this will result in a separate API call in the backend.

NB: Carries a performance cost, as asking for this will result in a separate API call in the backend.

The primary route of this StartPage

Get content data set via the Content Editor

Globally unique id.

The stock status id, not globally unique.

Default value is 1.

Not specifying cart id will create new cart.

Default value is 1.

null is equivalent to excluding the filter.

The type of list created. Omit this and the default type will be used.

If this field is left empty, a new DeliveryAddress will be created.