Skip to main content
Version: 2.0.0

Settings

Open Settings → Plugins → Foxpost (or the Foxpost → Settings control panel nav item once the plugin is enabled). Settings are organised into tabs; the shared General, Details, Table Rates, and Restrictions tabs come from yStore's common shipping-method settings (price, free-shipping threshold, visibility, payment-method restrictions) and apply to Foxpost the same way they apply to other shipping plugins.

API

FieldDescription
Sandbox modeSends all API traffic to Foxpost's test environment instead of production. Use this while validating credentials, labels, and tracking before going live.
API UsernameFoxpost API username.
API PasswordFoxpost API password.
API Key (x-api-key)Foxpost API key, sent as the x-api-key header on every request.

Use Test Connection (top of the settings page) after entering credentials to verify them against Foxpost before saving -- it calls the API immediately and reports whether the credentials are valid.

Shipping

FieldDescription
Auto-sync shipmentsWhen enabled, a Foxpost shipment is created automatically as orders change status, instead of relying on the manual "create shipment" action on the order edit page.
Tracking update interval (hours)How often the scheduled task refreshes tracking status for open shipments; 0 disables the scheduled refresh (tracking can still be refreshed manually or via the console command).
Foxpost Account Address (Sender)Pick a sender address already stored in the connected Foxpost account (see Addresses). Takes precedence over the manual sender fields below when set.
Sender Name, Phone, Email, ZIP Code, City, Street & House NumberManual sender address, used only when no Foxpost Account Address is selected. Sent as the sender on every shipment; an incomplete sender address will cause label generation to fail.

Labels

FieldDescription
Default Label FormatA6, A7, 85×85 (thermal), or A4 (multi-label) -- the label size requested when a format isn't explicitly given at download time.
Default Parcel SizeXSXL, or unset, used as the parcel size hint for new shipments.

Returns

FieldDescription
Enable ReturnsTurns on the FoxPost Return action menu on the order edit page.
Return AddressWhich Foxpost Account Address (see Addresses) to use as the return address for returns created through the order edit page.

Addresses

Manages the address book stored in the connected Foxpost account -- list, add, or remove addresses (with a name, type such as HQ/SITE/RETURN, contact details, and postal address). These account addresses are what the Foxpost Account Address (Sender) field (Shipping tab) and Return Address field (Returns tab) pick from; the tab itself has no separate settings to save.

Widget

Controls the checkout-facing map/list picker (see How it works):

FieldDescription
Display Discounted ParcelsIncludes parcel lockers running a Foxpost discount promotion in the widget results.
Display MapShows the map widget at all; when off, only the in-page list picker is available.
ThemeLight or Dark -- passed through to the map widget iframe.
LanguageWidget display language (currently Hungarian or English).
Show Map on Desktop / Tablet / MobilePer-device toggle for whether the map widget renders on that viewport.
Map Height (Desktop / Tablet / Mobile)Pixel height of the map widget iframe for that viewport, used only when the map is shown on it.

Where this is used

  • API, Shipping, and Labels settings apply to every shipment created, whether triggered manually or automatically.
  • Returns settings only take effect once Enable Returns is on.
  • Addresses only matters when a Foxpost Account Address is selected as the sender (Shipping tab) or the return address (Returns tab).
  • Widget settings only affect stores where Foxpost is an active/visible shipping method at checkout.
  • See the Foxpost overview for end-to-end examples covering automatic shipment creation with locker checkout, and creating a return from the order edit page.