Magidoc

Shop
Object

Represents a shop resource containing general shop data and configuration.

Fields

#

activePlugins

[ Plugin !]!
Non-null

Gets active plugins.

apiUrl

API url for the shop.

automaticFulfillmentDigitalProducts

Enable automatic fulfillment for all digital products.

availablePaymentGateways

Non-null

List of available payment gateways.

builderKey

None if shop does not use Builder, otherwise this contains Builder public api key.

chargeTaxesOnShipping

Non-null

Charge taxes on shipping.

checkoutTheme

The shop's active checkout theme.

companyAddress

Company address.

countries

Non-null

List of countries available in the shop.

crispWebsiteId

None if shop does not use Crisp, otherwise this contains Crisp Website ID.

currencies

[ String !]!
Non-null

List of available currencies.

customerSetPasswordUrl

URL of a view where customers can set their password.

dashboardUrl

Dashboard url for the shop.

defaultCountry

Shop's default country.

defaultCurrency

Non-null

Shop's default currency.

defaultDigitalMaxDownloads

Default number of max downloads per digital content URL.

defaultDigitalUrlValidDays

Default number of days which digital content URL will be valid.

defaultMailSenderAddress

Default shop's email sender's address.

defaultMailSenderName

Default shop's email sender's name.

defaultMailSupportAddress

Default shop's email support's address.

defaultWeightUnit

Default weight unit.

description

Shop's description.

displayGrossPrices

Non-null

Display prices with tax in store.

domain

Non-null

Shop's domain data.

enableOfferOrders

Whether the marketplace has enabled offer orders.

enableQuoteOrders

Whether the marketplace has enabled quote orders.

geolocalization

Customer's geolocalization data.

geolocationEnabled

headerText

Header text.

includeTaxesInPrices

Non-null

Include taxes in prices.

languages

Non-null

List of the shops's supported languages.

loginForCheckout

Is authenticated user required for checkout.

loginForPrice

Is authenticated user required for to view product price information.

loginForProducts

Is authenticated user required to view product listings.

name

Non-null

Shop's name.

navigation

Shop's navigation.

permissions

Non-null

List of available permissions.

phonePrefixes

[ String !]!
Non-null

List of possible phone prefixes.

requireProductApproval

Determines whether seller products require approval

sellerOnboardingSettings

The seller onboarding settings for the shop.

storefrontTheme

The shop's active storefront theme.

supportedCurrencies

Non-null

List of supported currencies.

timezone

Non-null

The IANA timezone to use when displaying all dates and times

trackInventoryByDefault

Enable inventory tracking.

Usages

#

References

#