Queries and mutations for managing Stores in the platform.
Queries
Query Stores
Get Store
| Arguments | |
|---|---|
idString | Queries with specified ID |
keyString | Queries with specified key |
Mutations
Create Store
Update Store
| Arguments | |
|---|---|
versionLong | |
actionsArray of StoreUpdateAction | |
idString | Queries with specified ID |
keyString | Queries with specified key |
Delete Store
Output types
Store
Stores allow defining different contexts for a project.
idString | Unique ID of the Store. |
versionLong | Current version of the Store. |
keyString | User-defined unique and immutable identifier for the Store. |
nameString | Name of the Store. |
nameAllLocalesArray of LocalizedString | Name of the Store. |
languagesArray of Locale | Languages configured for the Store. |
countriesArray of StoreCountry | Countries defined for the Store. |
productSelectionsArray of ProductSelectionSetting | Controls availability of Products for this Store via Product Selections:
|
distributionChannelsRefArray of Reference | Product Distribution Channels allowed for the Store. |
distributionChannelsArray of Channel | Product Distribution Channels allowed for the Store. |
supplyChannelsRefArray of Reference | Inventory Supply Channels allowed for the Store. |
supplyChannelsArray of Channel | Inventory Supply Channels allowed for the Store. |
storefront | Customer-facing URLs and policy links for the Store's storefront. |
createdAt | Date and time (UTC) the Store was initially created. |
lastModifiedAt | Date and time (UTC) the Store was last updated. |
custom | Custom fields for the Store. |
createdBy | IDs and references that created the Store. |
lastModifiedBy | IDs and references that last modified the Store. |
StoreCountry
code | Two-digit country code as per ISO 3166-1 alpha-2. |
ProductSelectionSetting
productSelectionRef | Reference to a ProductSelection. |
productSelection | Reference to a ProductSelection. |
activeBoolean | Whether all Products assigned to this Product Selection are part of the Store's assortment. |
Storefront
Customer-facing URLs and policy links for the Store's storefront. All fields are optional and only present when set.
checkoutUrlTemplateString | RFC 6570 URI template for the customer-facing checkout page.
Must contain the checkoutId variable, for example https://example.com/checkout/{checkoutId}. |
orderUrlTemplateString | RFC 6570 URI template for the customer-facing order status page.
Must contain the orderId variable, for example https://example.com/orders/{orderId}. |
termsOfServiceUrlString | Absolute https URL of the storefront's terms of service page. |
privacyPolicyUrlString | Absolute https URL of the storefront's privacy policy page. |
refundPolicyUrlString | Absolute https URL of the storefront's refund policy page. |
shippingPolicyUrlString | Absolute https URL of the storefront's shipping policy page. |
cookiePolicyUrlString | Absolute https URL of the storefront's cookie policy page. |
imprintUrlString | Absolute https URL of the storefront's imprint (legal notice) page. |
faqUrlString | Absolute https URL of the storefront's FAQ page. |
contactUrlString | Absolute https URL of the storefront's contact page. |
Store Query Result
Input types
CreateStore
keyString | |
nameArray of LocalizedStringItemInputType | |
languagesArray of Locale | |
countriesArray of StoreCountryInput | |
distributionChannelsArray of ResourceIdentifierInput | |
supplyChannelsArray of ResourceIdentifierInput | |
productSelectionsArray of ProductSelectionSettingDraft | |
custom | |
storefront |
StoreCountryInput
code |
ProductSelectionSettingDraft
productSelection | Resource Identifier of a ProductSelection. |
activeBoolean | Whether all Products assigned to the Product Selection should become part of the Store's assortment. |
StorefrontInput
checkoutUrlTemplateString | |
orderUrlTemplateString | |
termsOfServiceUrlString | |
privacyPolicyUrlString | |
refundPolicyUrlString | |
shippingPolicyUrlString | |
cookiePolicyUrlString | |
imprintUrlString | |
faqUrlString | |
contactUrlString |
StoreUpdateAction
addProductSelection | |
addCountry | |
addDistributionChannel | |
addSupplyChannel | |
changeProductSelectionActive | |
removeProductSelection | |
removeCountry | |
removeDistributionChannel | |
removeSupplyChannel | |
setProductSelections | |
setCheckoutUrlTemplate | |
setContactUrl | |
setCookiePolicyUrl | |
setCountries | |
setCustomField | |
setCustomType | |
setDistributionChannels | |
setFaqUrl | |
setImprintUrl | |
setLanguages | |
setName | |
setOrderUrlTemplate | |
setPrivacyPolicyUrl | |
setRefundPolicyUrl | |
setShippingPolicyUrl | |
setSupplyChannels | |
setTermsOfServiceUrl |
Update actions
Add Product Selection
active flag.productSelection | Product Selection to add to the Store either activated or deactivated. |
activeBoolean | Whether to make all Products assigned to the referenced Product Selection available in the Store. |
Add Country
country | Value to append to countries. |
StoreCountryInput
code |
Add Distribution Channel
ProductDistribution ChannelRoleEnum returns a MissingRoleOnChannel error.distributionChannel | Value to append. |
Add Supply Channel
This action has no effect if a given supply channel is already present in a Store.
supplyChannel | Value to append. |
Change Product Selection Active
productSelection | |
activeBoolean |
Remove Product Selection
This action has no effect if the given Product Selection is not in the Store.
productSelection | Value to remove. The removed Product Selection is made offline. |
Remove Country
country | Value to remove from countries. |
StoreCountryInput
code |
Remove Distribution Channel
distributionChannel | Value to remove. ResourceIdentifier of a Channel with the ProductDistribution ChannelRoleEnum. |
Remove Supply Channel
supplyChannel | Value to remove. ResourceIdentifier of a Channel with the InventorySupply ChannelRoleEnum. |
Set Product Selections
productSelectionsArray of ProductSelectionSettingInActionInput | Value to set.
|
ProductSelectionSettingInActionInput
productSelection | |
activeBoolean |
Set Checkout Url Template
checkoutUrlTemplateString | Value to set. Must be an RFC 6570 URI template containing the checkoutId variable.
If empty, any existing value is removed. |
Set Contact Url
contactUrlString | Value to set. Must be an absolute https URL. If empty, any existing value is removed. |
Set Countries
countriesArray of StoreCountryInput | New value to set. |
StoreCountryInput
code |
Set Custom Field
nameString | Name of the Custom Field. |
valueString | If value is absent or null, this field will be removed if it exists.
Removing a field that does not exist returns an InvalidOperation error.
If value is provided, it is set for the field defined by name. |
Set Custom Type
fieldsArray of CustomFieldInput | |
type | |
typeKeyString | |
typeIdString |
Set Distribution Channels
ProductDistribution ChannelRoleEnum returns a MissingRoleOnChannel error.distributionChannelsArray of ResourceIdentifierInput | Value to set.
If not defined, the Store's distributionChannels are unset. |
Set Faq Url
faqUrlString | Value to set. Must be an absolute https URL. If empty, any existing value is removed. |
Set Imprint Url
imprintUrlString | Value to set. Must be an absolute https URL. If empty, any existing value is removed. |
Set Languages
languagesArray of Locale | Value to set. If a language is not configured for the Project, a ProjectNotConfiguredForLanguages error is returned. |
Set Name
nameArray of LocalizedStringItemInputType | Value to set. |
Set Order Url Template
orderUrlTemplateString | Value to set. Must be an RFC 6570 URI template containing the orderId variable.
If empty, any existing value is removed. |
Set Privacy Policy Url
privacyPolicyUrlString | Value to set. Must be an absolute https URL. If empty, any existing value is removed. |
Set Refund Policy Url
refundPolicyUrlString | Value to set. Must be an absolute https URL. If empty, any existing value is removed. |
Set Shipping Policy Url
shippingPolicyUrlString | Value to set. Must be an absolute https URL. If empty, any existing value is removed. |
Set Supply Channels
supplyChannelsArray of ResourceIdentifierInput | Value to set.
If not defined, the Store's supplyChannels are unset. |
Set Terms Of Service Url
termsOfServiceUrlString | Value to set. Must be an absolute https URL. If empty, any existing value is removed. |