Skip to content

Configuration

Every key of the Shopper 3.x configuration files, with its default value, its environment variable and the page that explains it.

This page lists every key of the Shopper configuration files, with its default value and the environment variable that sets it. php artisan shopper:install publishes the main files to config/shopper, and php artisan vendor:publish --tag=shopper-config publishes them again; the files with their own command are listed in Files.

Files

Each Composer package merges its files under the key below, so a file you do not publish keeps the package defaults. The last column is the option of php artisan vendor:publish that copies the file into your application.

KeyPackagePublished toPublished with
shopper.addonsshopper/frameworkconfig/shopper/addons.php--tag=shopper-config
shopper.adminshopper/frameworkconfig/shopper/admin.php--tag=shopper-config
shopper.authshopper/frameworkconfig/shopper/auth.php--tag=shopper-config
shopper.featuresshopper/frameworkconfig/shopper/features.php--tag=shopper-config
shopper.mediashopper/frameworkconfig/shopper/media.php--tag=shopper-config
shopper.modelsshopper/frameworkconfig/shopper/models.php--tag=shopper-config
shopper.routesshopper/frameworkconfig/shopper/routes.php--tag=shopper-config
shopper.settingsshopper/frameworkconfig/shopper/settings.php--tag=shopper-config
shopper.themesshopper/frameworkconfig/shopper/themes.php--tag=shopper-config
shopper.components.{name}shopper/frameworkconfig/shopper/components/{name}.phpphp artisan shopper:component:publish, no tag
shopper.coreshopper/coreconfig/shopper/core.php--tag=shopper-config
shopper.ordersshopper/coreconfig/shopper/orders.php--tag=shopper-config
shopper.searchshopper/coreconfig/shopper/search.php--tag=shopper-config
shopper.webhooksshopper/coreconfig/shopper/webhooks.php--tag=shopper-config
shopper.cartshopper/cartconfig/shopper/cart.php--tag=shopper-config
shopper.paymentshopper/paymentconfig/shopper/payment.php--tag=shopper-config
shopper.shippingshopper/shippingconfig/shopper/shipping.php--tag=shopper-config
shopper.apishopper/apiconfig/shopper/api.php--tag=shopper-config
shopper.httpshopper/httpconfig/shopper/http.php--tag=shopper-config
shopper.stripeshopper/stripeconfig/shopper/stripe.php--tag=shopper-stripe-config
shopper.fedexshopper/fedexconfig/shopper/fedex.php--tag=shopper-fedex-config
shopper.upsshopper/upsconfig/shopper/ups.php--tag=shopper-ups-config
shopper.uspsshopper/uspsconfig/shopper/usps.php--tag=shopper-usps-config
sidebarshopper/sidebarconfig/sidebar.php--tag=sidebar-config

php artisan shopper:publish publishes the shopper-config tag together with the translation files. shopper/upgrade has no configuration file.

shopper.addons

config/shopper/addons.php turns installed add-ons off. It ships empty, so every installed add-on is active.

KeyDefaultEnvDescription
shopper.addons.{id}truefalse disables the add-on with this ID, see Disabling an Add-on

shopper.admin

config/shopper/admin.php sets the URL, the branding, the roles and the languages of the admin panel.

KeyDefaultEnvDescription
shopper.admin.prefixcpanelSHOPPER_PREFIXURL prefix of the admin panel, see Admin Panel
shopper.admin.domainnullSHOPPER_DOMAINDomain the admin routes answer on. null serves them on every domain
shopper.admin.pages.namespaceApp\Livewire\ShopperNamespace of the classes make:shopper-page creates, see Custom Pages
shopper.admin.pages.view_pathresource_path('views/livewire/shopper')Folder of the Blade views make:shopper-page creates
shopper.admin.roles.adminadministratorRole with access to every screen, given by shopper:user, see Roles
shopper.admin.roles.managermanagerStaff role. Users with this role or the administrator role are staff, the others are customers
shopper.admin.roles.useruserCustomer role, given to customers created in the panel or registered through the Store API, see Role Configuration
shopper.admin.brandnullLogo path under public, shown on the login page and in the sidebar header. null shows the Shopper logo, see Branding Logo
shopper.admin.faviconnullFavicon URL of the panel pages. null keeps the Shopper favicons
shopper.admin.avatar.color1d4ed8Text color, in hex without #, of the generated avatar of a user without a photo, see Avatar Colors
shopper.admin.avatar.bg_colordbeafeBackground color of that avatar
shopper.admin.primary_colorColor::BluePrimary color of the panel, any palette of Filament\Support\Colors\Color, see Admin Panel
shopper.admin.localesen, frLanguages of the panel language switcher, each with a label and a flag. The Store API accepts the same list, see Locales and Language
shopper.admin.icon-picker.cachetrueCaches the search results of the icon picker field
shopper.admin.icon-picker.duration7 daysHow long those results stay cached
shopper.admin.notifications.database.enabledfalseSends order, payment and import notifications to the database and shows the bell in the panel header, see Enabling Database Notifications
shopper.admin.notifications.database.polling_interval30sHow often the panel checks for new notifications, see Polling and Broadcasting

shopper.auth

config/shopper/auth.php sets how staff sign in to the admin panel.

KeyDefaultEnvDescription
shopper.auth.guardwebAuthentication guard of the admin panel, see Authentication
shopper.auth.2fa_enabledfalseSHOPPER_ENABLED_TWO_FACTORLets staff turn on two-factor authentication from their account page, see Two-Factor Configuration
shopper.auth.passkeys_enabledfalseSHOPPER_ENABLED_PASSKEYSAdds passkey sign-in to the login page and passkey management to the account page, see Passkeys
shopper.auth.password_resettruefalse removes the forgot password link and the password reset routes

shopper.features

config/shopper/features.php turns the optional sections of the admin panel on and off. Each value is a Shopper\Enum\FeatureState case, see Feature Flags.

KeyDefaultEnvDescription
shopper.features.attributeFeatureState::EnabledAttributes section and the attribute fields of products
shopper.features.brandFeatureState::EnabledBrands section and the brand field of products
shopper.features.campaignFeatureState::EnabledCampaigns section
shopper.features.categoryFeatureState::EnabledCategories section and the category field of products
shopper.features.collectionFeatureState::EnabledCollections section
shopper.features.discountFeatureState::EnabledDiscounts section
shopper.features.reviewFeatureState::EnabledReviews section
shopper.features.supplierFeatureState::DisabledSuppliers section and the supplier field of products
shopper.features.tagFeatureState::EnabledTags section and the tag field of products

shopper.media

config/shopper/media.php sets the media collections, disks, accepted types, size limits and image conversions of the catalog.

KeyDefaultEnvDescription
shopper.media.storage.collection_nameuploadsMedia collection of the image galleries of products, variants, brands, categories and collections, see Storage Disk
shopper.media.storage.thumbnail_collectionthumbnailMedia collection of the single main image of those models
shopper.media.storage.disk_namepublicDisk of the galleries and thumbnails
shopper.media.storage.files_disklocalDisk of the downloadable files of virtual products. Keep it private, see Downloadable Files
shopper.media.accepts_mime_typesimage/jpeg, image/png, image/webp, image/avifImage types the upload fields accept, see Accepts MIME Types
shopper.media.accepts_file_typesthe 10 built-in types: PDF, ZIP, RAR, 7z, Word, Excel, plain text and CSVMIME types accepted for the downloadable files of virtual products
shopper.media.max_size.thumbnail1024Largest thumbnail upload in the admin forms, in kilobytes, see Media Filesize
shopper.media.max_size.images2048Largest gallery image upload in the admin forms, in kilobytes
shopper.media.conversions.large.width800Width in pixels of the large conversion, see Image Conversions
shopper.media.conversions.large.height800Height in pixels of the large conversion
shopper.media.conversions.medium.width500Width in pixels of the medium conversion
shopper.media.conversions.medium.height500Height in pixels of the medium conversion

shopper.models

config/shopper/models.php maps each swappable model to the class Shopper uses, as Swapping a Model explains. The cart models live in shopper.cart.

KeyDefaultEnvDescription
shopper.models.addressShopper\Core\Models\AddressCustomer addresses
shopper.models.brandShopper\Models\BrandBrands
shopper.models.categoryShopper\Models\CategoryCategories
shopper.models.collectionShopper\Models\CollectionCollections
shopper.models.productShopper\Models\ProductProducts
shopper.models.variantShopper\Models\ProductVariantProduct variants
shopper.models.attribute_productShopper\Models\AttributeProductPivot between attributes and products
shopper.models.channelShopper\Core\Models\ChannelSales channels
shopper.models.inventoryShopper\Core\Models\InventoryInventory locations
shopper.models.orderShopper\Core\Models\OrderOrders
shopper.models.supplierShopper\Core\Models\SupplierSuppliers
shopper.models.tax_zoneShopper\Core\Models\TaxZoneTax zones
shopper.models.tax_rateShopper\Core\Models\TaxRateTax rates

shopper.routes

config/shopper/routes.php extends the routes of the admin panel.

KeyDefaultEnvDescription
shopper.routes.middleware[]Middleware added to every authenticated admin route, see Middleware
shopper.routes.custom_filenullPath of a route file loaded inside the authenticated admin group, with the shopper. name prefix, see Custom Routes

shopper.settings

config/shopper/settings.php lists the cards of the Settings page.

KeyDefaultEnvDescription
shopper.settings.itemsthe 12 built-in settings itemsSetting item classes, each mapped to true or false. false hides a card and a new class adds one, see Settings and Adding a Settings Page

shopper.themes

config/shopper/themes.php registers the color themes of the admin panel.

KeyDefaultEnvDescription
shopper.themes.defaultdefaultTheme used until a merchant picks one on the Appearance page, see The Active Theme
shopper.themes.registeredthe 3 built-in themes: default, midnight, evergreenThemes offered on the Appearance page, each with a name, an author, has_dark and an optional css stylesheet, see Themes

shopper.components

The twelve files in config/components of shopper/framework list the Livewire classes of each admin screen, and Shopper registers each key of pages and components as the alias shopper-{key}. They have no vendor:publish tag: php artisan shopper:component:publish {name} copies one to config/shopper/components/{name}.php and --all copies them all, see Components.

KeyDefaultEnvDescription
shopper.components.account.pagesaccount-indexAccount page of the signed-in user
shopper.components.account.componentsthe 6 built-in componentsProfile, password, two-factor, passkeys and devices blocks of the account page, and the user menu
shopper.components.brand.pagesbrand-indexBrands page
shopper.components.brand.componentsslide-overs.brand-formForm that creates and edits a brand
shopper.components.campaign.pagescampaign-index, campaign-create, campaign-editCampaign list, creation and edit pages
shopper.components.category.pagescategory-indexCategories page
shopper.components.category.componentsslide-overs.category-form, slide-overs.re-order-categoriesCategory form and category reordering panel
shopper.components.collection.pagescollection-index, collection-editCollection list and edit pages
shopper.components.collection.componentsthe 4 built-in componentsProduct list, rules and creation panels of collections
shopper.components.customer.pagescustomer-index, customer-create, customer-showCustomer list, creation and detail pages
shopper.components.customer.componentscustomers.addresses, customers.orders, customers.profileTabs of the customer detail page
shopper.components.dashboard.pagesdashboardDashboard page, see Replacing the Page
shopper.components.dashboard.componentslocale-switcherLanguage switcher of the panel
shopper.components.discount.pagesdiscount-index, discount-editDiscount list and edit pages
shopper.components.discount.componentsthe 4 built-in componentsPromotion form, product and customer pickers, and stats panel of discounts
shopper.components.order.pagesorder-index, order-detail, order-shipments, order-abandoned-cartsOrder list, order detail, shipments and abandoned carts pages
shopper.components.order.componentsthe 9 built-in componentsBlocks of the order detail page, and the shipment and abandoned cart panels
shopper.components.product.sectionsthe 10 built-in sectionsTab classes of the product edit page, each mapped to true or false. false hides a tab, see Product Sections
shopper.components.product.pagesthe 15 built-in pagesProduct list, the tabs of the product edit page, the variant page, and the attribute, supplier and tag pages
shopper.components.product.componentsthe 15 built-in componentsProduct actions, import, pricing, variant and attribute panels, and the supplier form
shopper.components.review.pagesreview-indexReviews page
shopper.components.review.componentsslide-overs.review-detailReview detail panel
shopper.components.setting.pagesthe 15 built-in pagesSettings pages: general, appearance, locations, legal, channels, payment methods, carriers, team, zones, taxes, currencies and webhooks
shopper.components.setting.componentsthe 14 built-in componentsForms and panels of the settings pages

shopper.core

config/shopper/core.php sets the table prefix, the barcode format, the import batch size and the category tree cache.

KeyDefaultEnvDescription
shopper.core.table_prefixsh_Prefix of every Shopper table name. Set it before the first migration, see Database Table Prefix and Table Names
shopper.core.barcode_typeC128Barcode symbology the variant page draws, see SKU and Barcode
shopper.core.import.chunk_size25Products per queued job of a product import, see Import Configuration
shopper.core.cache.category_tree3600Seconds the category tree stays cached. null turns the cache off, see Tree Cache

shopper.orders

config/shopper/orders.php sets the order number format and the reclaim of unpaid orders, see Orders.

KeyDefaultEnvDescription
shopper.orders.generator.prefixORDFirst part of every order number. Empty leaves it out, see Order Number Generation
shopper.orders.generator.separator-Characters between the parts of the number
shopper.orders.generator.date_formatYmdPHP date format of the middle part. Empty leaves the date out
shopper.orders.generator.start_sequence_from0Number added to the order ID to form the sequence
shopper.orders.generator.pad_length6Length the sequence is padded to
shopper.orders.generator.pad_string0Character the sequence is padded with, on the left
shopper.orders.reclaim_pending_after_hours24Hours after which shopper:orders:reclaim cancels an unpaid order. null takes the command off the schedule, see Reclaiming Pending Orders

config/shopper/search.php sets the Scout engine and the indexer of each searchable model.

KeyDefaultEnvDescription
shopper.search.engine_map[]Scout driver per model class. A model not listed uses SCOUT_DRIVER, see Choosing an Engine per Model
shopper.search.indexersthe 5 built-in indexers: brands, categories, collections, orders and productsIndexer class per model class, which builds the search document of the model. Shopper adds CustomerIndexer for the user model when the list has no entry for it, see Custom Indexers
shopper.search.facetsbrand and categories on productsFacet fields per model, each with a label. Only the shopper/search add-on reads this key, see Facets

shopper.webhooks

config/shopper/webhooks.php sets the events, destinations, delivery and retention of outgoing webhooks, see Webhooks Configuration.

KeyDefaultEnvDescription
shopper.webhooks.eventsthe 13 built-in eventsEvent classes a subscription can listen to, each mapped to its public name. Remove a line to stop offering that event, see Registering Custom Events
shopper.webhooks.database.connectionnullSHOPPER_WEBHOOKS_DB_CONNECTIONDatabase connection of the subscriptions, events and deliveries. null uses the default connection
shopper.webhooks.allowed_hosts[]SHOPPER_WEBHOOKS_ALLOWED_HOSTSHosts webhooks may be sent to, comma-separated in the env variable. Empty allows any public host, see Endpoint Restrictions
shopper.webhooks.max_subscriptions50SHOPPER_WEBHOOKS_MAX_SUBSCRIPTIONSMost subscriptions the admin panel creates
shopper.webhooks.queuewebhooksSHOPPER_WEBHOOKS_QUEUEQueue of the delivery jobs, see Deliveries and Retries
shopper.webhooks.backoff[10, 30, 60, 300, 1800, 3600, 7200, 14400, 28800, 43200]Seconds before each retry of a delivery
shopper.webhooks.disable_after_failures15Failed deliveries in a row that deactivate a subscription
shopper.webhooks.timeout10Seconds Shopper waits for the endpoint to answer
shopper.webhooks.signature_tolerance300Seconds WebhookSignature::verify() accepts between the signature timestamp and the current time, see Signatures
shopper.webhooks.prune.succeeded_after_days7Age in days at which succeeded deliveries are pruned, see Pruning
shopper.webhooks.prune.failed_after_days90Age in days at which the other deliveries, then the events, are pruned

shopper.cart

config/shopper/cart.php sets the cart calculation, the session, the cart lifetime and the cart models, see Cart Configuration.

KeyDefaultEnvDescription
shopper.cart.pipelines.cartthe 5 built-in steps: CalculateLines, ApplyAutomaticPromotions, ApplyDiscounts, CalculateTax, CalculatePipeline classes that compute the cart totals, in order, see Default Pipeline and Custom Pipeline
shopper.cart.max_promotions5Most promotions applied to one cart, see Maximum Stacked Promotions
shopper.cart.session.keyshopper_cartSession key that holds the ID of the visitor's cart, see Session Management
shopper.cart.session.auto_createfalsetrue makes Cart::current() create a cart when the session has none
shopper.cart.abandoned_after_minutes60Minutes without activity before a cart counts as abandoned, see Abandoned Carts
shopper.cart.totals_ttl_minutes15Minutes totals() returns the stored totals before it computes them again, see Stored Totals
shopper.cart.prune_after_days30Age in days of the open carts the daily shopper:prune-carts deletes, see Pruning
shopper.cart.models.cartShopper\Cart\Models\CartCart model, see Model Swapping
shopper.cart.models.cart_lineShopper\Cart\Models\CartLineCart line model

shopper.payment

config/shopper/payment.php sets the reconciliation of payments with the providers, see Payments Configuration.

KeyDefaultEnvDescription
shopper.payment.reconciliation.pull_on_completiontruePAYMENT_PULL_ON_COMPLETIONQueues a provider check when a cart completes with its payment still pending, see Reconciling Payments
shopper.payment.reconciliation.scheduletruePAYMENT_RECONCILE_SCHEDULESchedules shopper:payments:reconcile --pull every 15 minutes
shopper.payment.reconciliation.queuenullPAYMENT_RECONCILE_QUEUEQueue of the provider checks. null uses the default queue
shopper.payment.reconciliation.backoff[60, 300, 900]Seconds before each retry of a provider check
shopper.payment.reconciliation.prune_after_days90PAYMENT_WEBHOOK_EVENTS_PRUNE_AFTER_DAYSAge in days at which received provider events are pruned
shopper.payment.reconciliation.orphan_after_minutes30PAYMENT_ORPHAN_AFTER_MINUTESMinutes before a collected payment without an order counts as orphaned, see Orphaned Payments
shopper.payment.reconciliation.orphansalertPAYMENT_ORPHANSalert reports orphaned payments, refund also refunds them

shopper.shipping

config/shopper/shipping.php sets the package units, the quote cache and the tracking sync, see Driver Configuration.

KeyDefaultEnvDescription
shopper.shipping.unitsmetricSHIPPING_UNITSUnits of the packages the Store API builds from a cart: metric (cm, kg) or imperial (in, lb)
shopper.shipping.rates_cache_ttl600SHIPPING_RATES_CACHE_TTLSeconds a live carrier quote stays cached. 0 turns the cache off, see Rate Caching
shopper.shipping.tracking.synctrueSHIPPING_TRACKING_SYNCSchedules shopper:shipments:sync-tracking every 30 minutes, see Tracking Sync
shopper.shipping.tracking.queuenullSHIPPING_TRACKING_QUEUEQueue of the tracking jobs. null uses the default queue
shopper.shipping.tracking.backoff[60, 300, 900]Seconds before each retry of a tracking job

shopper.api

config/shopper/api.php sets what the Store API endpoints return, see Store API Configuration.

KeyDefaultEnvDescription
shopper.api.pagination.per_page15SHOPPER_API_PER_PAGEItems per page when a request sends no page[size], see Pagination
shopper.api.pagination.max_per_page100Largest page[size] accepted
shopper.api.pagination.max_page100Deepest page[number] accepted, see Page Numbers
shopper.api.token_expiration43200SHOPPER_API_TOKEN_EXPIRATIONLifetime of a customer token in minutes (30 days). null or 0 never expires, see Token Expiration
shopper.api.reviews.latest_limit20Number of reviews GET /store/reviews returns, see Latest Reviews
shopper.api.settings.exposethe 15 built-in setting keysStore settings GET /store/settings returns, see Reading the Store Settings and Settings from the Store API
shopper.api.settings.max_age300Seconds set as max-age and s-maxage in the Cache-Control header of GET /store/settings, see Caching the Settings

shopper.http

config/shopper/http.php sets the prefix, the rate limits, the zone and channel resolution and the middleware of the Store API routes.

KeyDefaultEnvDescription
shopper.http.prefixstoreSHOPPER_API_PREFIXPath prefix of every Store API route, see Base URL
shopper.http.rate_limiters.shopper-api120Requests per minute on every public and authenticated route, see Rate Limits
shopper.http.rate_limiters.shopper-api-auth20Requests per minute on the register, login and password reset routes
shopper.http.rate_limiters.shopper-api-checkout30Requests per minute on the cart creation, cart line, promotion, payment and completion routes
shopper.http.rate_limiters.shopper-api-webhook120Requests per minute on the webhook routes
shopper.http.login_failures5Failed logins allowed per email and IP address within a minute, see Failed Logins
shopper.http.zone.resolverShopper\Http\Zone\DefaultZoneResolverClass that resolves the zone of a request, see Custom Resolver
shopper.http.zone.headerX-Shopper-ZoneRequest header that carries the zone code, see Zone
shopper.http.zone.default_codenullSHOPPER_API_DEFAULT_ZONEZone code used when a request sends none
shopper.http.zone.cache_ttl60Seconds a resolved zone stays cached. 0 turns the cache off, see Resolving a Zone
shopper.http.channel.resolverShopper\Http\Channel\DefaultChannelResolverClass that resolves the sales channel of a request, see Custom Resolver
shopper.http.channel.headerX-Shopper-ChannelRequest header that carries the channel slug, see Sales Channel
shopper.http.channel.default_slugnullSHOPPER_API_DEFAULT_CHANNELChannel slug used when a request sends none
shopper.http.channel.cache_ttl60Seconds a resolved channel stays cached. 0 turns the cache off, see The Store API
shopper.http.middleware.store[]Middleware appended to the public route group, see Route Groups
shopper.http.middleware.authenticated[]Middleware appended to the authenticated route group
shopper.http.middleware.webhook[]Middleware appended to the webhook route group

shopper.stripe

config/shopper/stripe.php holds the Stripe credentials and capture method. Publish it with php artisan vendor:publish --tag=shopper-stripe-config, see Stripe Configuration.

KeyDefaultEnvDescription
shopper.stripe.enabledfalsePAYMENT_STRIPE_ENABLEDLists stripe in Payment::configuredDrivers()
shopper.stripe.secret_keynullSTRIPE_SECRET_KEYSecret API key of every call to Stripe. Its prefix sets the test mode
shopper.stripe.publishable_keynullSTRIPE_PUBLISHABLE_KEYPublishable key returned to the storefront with each payment, for Stripe.js
shopper.stripe.webhook_secretnullSTRIPE_WEBHOOK_SECRETSigning secret that verifies each Stripe event, see Webhooks
shopper.stripe.capture_methodmanualSTRIPE_CAPTURE_METHODmanual authorizes the card at checkout and captures later, automatic captures at once, see Capture Method

shopper.fedex

config/shopper/fedex.php holds the FedEx credentials. Publish it with php artisan vendor:publish --tag=shopper-fedex-config, see FedEx Credentials.

KeyDefaultEnvDescription
shopper.fedex.enabledfalseSHIPPING_FEDEX_ENABLEDLists fedex in Shipping::configuredDrivers(). Live rates depend on the credentials only, see Driver Configuration
shopper.fedex.sandboxfalseSHIPPING_SANDBOXSends requests to the FedEx sandbox. The variable is shared with UPS and USPS, see Sandbox Mode
shopper.fedex.client_idnullFEDEX_CLIENT_IDAPI key of your FedEx project
shopper.fedex.client_secretnullFEDEX_CLIENT_SECRETSecret key of your FedEx project
shopper.fedex.account_numbernullFEDEX_ACCOUNT_NUMBERFedEx account the rates are quoted against

shopper.ups

config/shopper/ups.php holds the UPS credentials. Publish it with php artisan vendor:publish --tag=shopper-ups-config, see UPS Credentials.

KeyDefaultEnvDescription
shopper.ups.enabledfalseSHIPPING_UPS_ENABLEDLists ups in Shipping::configuredDrivers(). Live rates depend on the credentials only, see Driver Configuration
shopper.ups.sandboxfalseSHIPPING_SANDBOXSends requests to the UPS sandbox. The variable is shared with FedEx and USPS, see Sandbox Mode
shopper.ups.client_idnullUPS_CLIENT_IDClient ID of your UPS app
shopper.ups.client_secretnullUPS_CLIENT_SECRETClient secret of your UPS app
shopper.ups.user_idnullUPS_USER_IDUser ID of your UPS account
shopper.ups.account_numbernullUPS_ACCOUNT_NUMBERUPS account number, sent as the shipper number

shopper.usps

config/shopper/usps.php holds the USPS credentials. Publish it with php artisan vendor:publish --tag=shopper-usps-config, see USPS Credentials.

KeyDefaultEnvDescription
shopper.usps.enabledfalseSHIPPING_USPS_ENABLEDLists usps in Shipping::configuredDrivers(). Live rates depend on the credentials only, see Driver Configuration
shopper.usps.sandboxfalseSHIPPING_SANDBOXSends requests to the USPS sandbox. The variable is shared with FedEx and UPS, see Sandbox Mode
shopper.usps.client_idnullUSPS_CLIENT_IDConsumer key of your USPS app
shopper.usps.client_secretnullUSPS_CLIENT_SECRETConsumer secret of your USPS app

config/sidebar.php sets the cache, the size and the breadcrumbs of the sidebar. Publish it with php artisan vendor:publish --tag=sidebar-config, see Sidebar Configuration.

KeyDefaultEnvDescription
sidebar.cache.methodnullnull builds the sidebar on every request, static caches one copy for every user, user-based one copy per user, see Caching
sidebar.cache.duration1440Minutes a cached sidebar is kept
sidebar.width15remWidth of the expanded sidebar, see Dimensions
sidebar.collapsed_width4.5remWidth of the collapsed sidebar
sidebar.breakpoint1024Viewport width in pixels below which the sidebar works as a drawer, see Responsive Breakpoint
sidebar.collapsibletruefalse stops the sidebar from collapsing to icons, see Collapsible
sidebar.breadcrumbs.viewsidebar::breadcrumbsBlade view of the breadcrumb trail. Shopper sets it to shopper::components.breadcrumbs when it registers, see Breadcrumbs

Last updated on

Edit on GitHub