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.
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 |
Fields
The fields in this section list which values can be retrieved when querying ShopArticle records.
Account)
The account this record belongs to.
Calendar)
Calendar that represents the work hours related to the fulfillment/delivery.
ShopArticleCategory)
Related category.
ISO8601Timestamp)
The date and time at which the record was created.
Int)
The number of minutes it usually takes to deliver the shop article.
Boolean)
Whether the shop article is visible in the shop.
ISO8601Timestamp)
After this moment the shop article is no longer available in the shop.
RequestTemplate)
The request template used to order one of more units of this shop article.
String)
The full description of the shop article.
ID!)
Unique identifier of the record.
Int)
The largest number of units that may be bought at once.
String)
The display name of the shop article.
String)
The hyperlink to the image file for the record.
MonetaryAmount)
The price of a single unit.
Currency)
The currency of the price of this shop article.
Product)
Related product.
ProviderShopArticle)
Information from the provider.
ShopArticleRecurringPeriod)
The frequency in which the recurring price is due.
MonetaryAmount)
The recurring price of a single unit.
Currency)
The currency of the recurring price of this shop article.
String)
This reference can be used to link the shop article to a shop order line using the Xurrent APIs or the Xurrent Import functionality.
Boolean)
Whether or not this is a physical article that requires shipping.
String)
The shop description of the shop article.
String)
An identifier for the client application submitting the resource or the name of an external system.
String)
The unique identifier of the resource in an external system.
ISO8601Timestamp)
The moment the shop article becomes available in the shop.
TimeZone)
The Time zone related to the calendar.
UiExtension)
UI extension that is to be used when the shop article is ordered.
ISO8601Timestamp)
The date and time of the last update of the record. If the record has no updates it contains the createdAt value.
Connections
The connection fields in this section allow (paged) access to objects related to a specific ShopArticle record.
The actual objects will be in the nodes field of the connection.
TranslationConnection)
Translations associated with this object.
| 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. |
first |
Int
|
Returns the first n elements from the list. |
last |
Int
|
Returns the last n elements from the list. |
Implements
ShopArticle implements the following interfaces. This means that fragments defined on these interfaces may be used in queries returning a ShopArticle.