ShopArticle Object

Root Connection

All ShopArticle objects of an account are accessible by a query on the root connection shopArticles. Such a query will return a ShopArticleConnection!, which contains the ShopArticle objects in its nodes field.

shopArticles (ShopArticleConnection!)

Root connection for retrieving ShopArticle records.

Argument Type Description
after String

Returns the elements in the list that come after the specified cursor.

before String

Returns the elements in the list that come before the specified cursor.

filter ShopArticleFilter

Filter to determine which ShopArticle records are returned.

first Int

Returns the first n elements from the list.

last Int

Returns the last n elements from the list.

order [ShopArticleOrder!]

Order of the ShopArticle records returned.

view ShopArticleView

View name.

The default value is current_account.

Fields

The fields in this section list which values can be retrieved when querying ShopArticle records.

account (Account)

The account this record belongs to.

calendar (Calendar)

Calendar that represents the work hours related to the fulfillment/delivery.

createdAt (ISO8601Timestamp)

The date and time at which the record was created.

deliveryDuration (Int)

The number of minutes it usually takes to deliver the shop article.

disabled (Boolean)

Whether the shop article is visible in the shop.

endAt (ISO8601Timestamp)

After this moment the shop article is no longer available in the shop.

fulfillmentTemplate (RequestTemplate)

The request template used to order one of more units of this shop article.

fullDescription (String)

The full description of the shop article.

id (ID!)

Unique identifier of the object.

maxQuantity (Int)

The largest number of units that may be bought at once.

name (String)

The display name of the shop article.

pictureUri (String)

The hyperlink to the image file for the record.

price (MonetaryAmount)

The price of a single unit.

priceCurrency (Currency)

The currency of the price of this shop article.

product (Product)

Related product.

providerShopArticle (ProviderShopArticle)

Information from the provider.

recurringPeriod (ShopArticleRecurringPeriod)

The frequency in which the recurring price is due.

recurringPrice (MonetaryAmount)

The recurring price of a single unit.

recurringPriceCurrency (Currency)

The currency of the recurring price of this shop article.

reference (String)

This reference can be used to link the shop article to a shop order line using the 4me APIs or the 4me Import functionality.

requiresShipping (Boolean)

Whether or not this is a physical article that requires shipping.

shortDescription (String)

The shop description of the shop article.

source (String)

An identifier for the client application submitting the resource or the name of an external system

sourceID (String)

The unique identifier of the resource in an external system

startAt (ISO8601Timestamp)

The moment the shop article becomes available in the shop.

timeZone (TimeZone)

The Time zone related to the calendar.

uiExtension (UiExtension)

UI extension that is to be used when the shop article is ordered.

updatedAt (ISO8601Timestamp)

The date and time of the last update of the record. If the record has no updates it contains the createdAt value.

Implements

ShopArticle implements the following interfaces. This means that fragments defined on these interfaces may be used in queries returning a ShopArticle.