Magidoc

Shop
Object

Represents a shop resource containing general shop data and configuration.

Fields

#

activePlugins

[ Plugin !]!
Non-null

Gets active plugins.

apiUrl

String

API url for the shop.

automaticFulfillmentDigitalProducts

Boolean

Enable automatic fulfillment for all digital products.

availablePaymentGateways

[ PaymentGateway !]!
Non-null

List of available payment gateways.

chargeTaxesOnShipping

Boolean !
Non-null

Charge taxes on shipping.

checkoutTheme

CheckoutTheme

The shop's active checkout theme.

companyAddress

Address

Company address.

countries

[ CountryDisplay !]!
Non-null

List of countries available in the shop.

crispWebsiteId

String

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

customerSetPasswordUrl

String

URL of a view where customers can set their password.

dashboardUrl

String

Dashboard url for the shop.

defaultCountry

CountryDisplay

Shop's default country.

defaultDigitalMaxDownloads

Int

Default number of max downloads per digital content URL.

defaultDigitalUrlValidDays

Int

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

defaultMailSenderAddress

String

Default shop's email sender's address.

defaultMailSenderName

String

Default shop's email sender's name.

defaultMailSupportAddress

String

Default shop's email support's address.

defaultWeightUnit

WeightUnitsEnum

Default weight unit.

description

String

Shop's description.

displayGrossPrices

Boolean !
Non-null

Display prices with tax in store.

domain

Domain !
Non-null

Shop's domain data.

enableOfferOrders

Boolean

Whether the marketplace has enabled offer orders.

enableQuoteOrders

Boolean

Whether the marketplace has enabled quote orders.

geolocalization

Geolocalization

Customer's geolocalization data.

geolocationEnabled

Boolean

includeTaxesInPrices

Boolean !
Non-null

Include taxes in prices.

loginForCheckout

Boolean

Is authenticated user required for checkout.

loginForPrice

Boolean

Is authenticated user required for to view product price information.

loginForProducts

Boolean

Is authenticated user required to view product listings.

name

String !
Non-null

Shop's name.

permissions

[ Permission !]!
Non-null

List of available permissions.

phonePrefixes

[ String !]!
Non-null

List of possible phone prefixes.

requireProductApproval

Boolean

Determines whether seller products require approval

sellerOnboardingSettings

SellerOnboardingSettings

The seller onboarding settings for the shop.

storefrontTheme

StorefrontTheme

The shop's active storefront theme.

supportedCurrencies

[ NauticalCurrency !]!
Non-null

List of supported currencies.

timezone

String !
Non-null

The IANA timezone to use when displaying all dates and times

trackInventoryByDefault

Boolean

Enable inventory tracking.

Usages

#

References

#