Magento settings

Every setting on the Magento order, shipment, inventory and credit Configurations, what it does and when to change it.

The Magento connector imports orders and credit memos from Magento, and sends shipments and stock levels back. Its settings live on four Configurations: Magento Order, Magento Shipment, Magento Inventory and Magento Credit.

Order import: what gets imported

These settings are on the Magento Order Configuration.

Setting	What it does	Values / default	When to change it
Setup date `setupDate`	Only orders created on or after this date are imported, so historical orders aren't pulled in at go-live.	Date. Set automatically when the Integration is first configured.	Not normally changed afterwards.
Last import date `lastImportDate`	The import watermark. Each run fetches only orders modified after it, and it moves forward after each run.	Date and time. Managed by the system.	Don't edit it by hand.
Statuses to import `statusesToImport`	Only orders in one of these Magento statuses are processed.	List of statuses. Default `["processing"]`.	Add statuses if orders should be picked up earlier or later in Magento's workflow.
Fulfilled status `fulfilledStatus`	The Magento order status that means an order has been fulfilled. Orders in this status are treated as fulfilled when imported.	A Magento status.	Set it to the status your shop uses for fulfilled orders.

Order import: customers and fulfilment

Setting	What it does	Values / default	When to change it
Guest customer `guestPartyId`	The Party assigned to guest orders (placed without a Magento account).	A Party ID.	Set it if your shop allows guest checkout.
Payment method customers `paymentMethodPartyMap`	Maps Magento payment method codes to Party IDs, so orders paid a certain way go to a specific customer.	Dictionary of payment method code to Party ID.	Use it to segment orders by payment type, for example a marketplace or trade-account payment method.
Use email as customer identifier `useEmailAsPartyIdentifier`	Adds the customer's email address as a customer identifier, so the target system can match customers by email.	`true` or `false`. Not set means email isn't used.	Turn on when customers are best matched by email.
Customer custom attribute identification `customerCustomAttributeIdentification`	Rules for identifying the Party from Magento customer custom attributes. Each rule names a `customAttributeCode` (the attribute to read from the customer record) and a `partyIdentifierType` (what the value represents, for example `email` or `account_number`).	List of rules.	Use it when trade customers carry an account number or similar in a custom attribute.
Fulfilment location `fulfillmentLocationId`	The fulfilment Location assigned to every imported order.	A Location ID.	Set it to the warehouse that fulfils Magento orders.

Order import: lines and amounts

Setting	What it does	Values / default	When to change it
Resolve product options `resolveProductOptions`	Looks up each ordered product's custom options in Magento so the bare option and value IDs on the line can be resolved to names and values. See Product options.	`true` or `false`. Default `false`.	Turn on for personalised or configurable products whose options matter downstream.
Product types to expand `productTypesImportChildren`	Magento product types whose child or component products are imported as individual lines.	List of product types. Default `["bundle"]`.	Change it if other composite product types should be expanded, or bundles shouldn't be.
Use base currency values `useBaseValues`	Uses base currency amounts rather than display currency amounts, for consistent currency handling across store views and currencies.	`true` or `false`. Default `true`.	Turn off only if you need the display currency amounts.

Order import: metadata and tags

Setting	What it does	Values / default	When to change it
Key-value collection name `keyValueCollectionName`	The name of a custom key-value metadata collection on the Magento order. Read together with the two settings below to extract custom order metadata.	Text.	Set it if an extension stores order metadata as a key-value collection.
Key field name `keyValueCollectionKeyName`	The field in that collection that holds the metadata keys.	Text.	Set it with `keyValueCollectionName`.
Value field name `keyValueCollectionValueName`	The field in that collection that holds the metadata values.	Text.	Set it with `keyValueCollectionName`.
Shipping instructions key `keyValueCollectionKeyShippingInstructions`	The key in the collection whose value holds shipping instructions. When set, that value becomes the order's shipping instructions.	Text.	Set it when delivery instructions are stored in the collection.
Tag generation `documentLevelTagGeneration`	Rules for creating tags from Magento order fields, to categorise or classify orders.	List of rules.	Use it to carry an order field into a tag that a target tag map can read.
Advanced tag generation `documentLevelAdvancedTagGeneration`	Advanced tag rules supporting complex conditional logic and transformations.	List of rules.	Use it when simple tag rules can't reach or transform the value you need.

Product options

Magento records the custom options chosen on an order line as an option ID and an option value ID, with no names. With resolveProductOptions on, the options are looked up and imported as line options carrying both the resolved name and value and the original Magento IDs. Each option is also recorded as two tags:

Tag	Example
`magento:product_option:<name>:<value>`	`magento:product_option:Rope Colour:Red`
`magento:product_option_<name>:<value>`	`magento:product_option_Rope Colour:Red`

The second form puts the option's name in the tag key, so you can match tags for one option directly. Colons in an option's name are removed from the key.

Good to know

Resolving options costs one extra Magento API call per distinct product on the orders being imported, which is why it's off by default. Results are cached for the run, so a product ordered several times is looked up once. With the setting off, the raw option and value IDs are still recorded on the line options; only the names, values and tags are left out.

Shipments

These settings are on the Magento Shipment Configuration.

Setting	What it does	Values / default	When to change it
Append comment `appendComment`	Adds a comment to the Magento shipment.	`true` or `false`.	Turn on to add shipment information to the record in Magento.
Comment `comment`	The fixed comment text added when `appendComment` is on.	Text.	Set it with `appendComment`.
Default carrier code `defaultCarrierCode`	The carrier code set on the Magento shipment when the fulfilment data doesn't provide one, so every shipment has a carrier.	A Magento carrier code.	Set it if your warehouse doesn't always send a carrier.
Notify customer `notify`	Magento sends the customer a shipment notification email when the shipment is updated.	`true` or `false`. Not set means no email.	Turn on if Magento should send the despatch email.

Inventory

These settings are on the Magento Inventory Configuration.

Setting	What it does	Values / default	When to change it
Default source code `defaultSourceCode`	The Magento inventory source that receives the stock updates.	A Magento source code.	Set it to the source your shop sells from.
Update products one at a time `useSingleProductUpdate`	Updates each product individually rather than in bulk. Slower, but useful where bulk operations are constrained.	`true` or `false`.	Turn on if bulk updates fail on your Magento setup.
Use bulk endpoint `useBulkEndpoint`	Uses Magento's bulk inventory update endpoint instead of individual API calls. Generally faster for many products.	`true` or `false`.	Turn on for large catalogues.
Rate limit: requests `rateLimitPermitLimit`	The maximum number of API requests allowed in each rate limit window.	Number.	Lower it if Magento or its host throttles requests.
Rate limit: window `rateLimitWindow`	The length of the rate limit window. Requests beyond `rateLimitPermitLimit` in the window are throttled.	Duration, for example `00:01:00` for one minute.	Set it with `rateLimitPermitLimit`.
Custom attribute tag maps `customAttributeTagMaps`	Rules that read Magento product custom attributes and turn them into tags. Each rule has an `attributeCode` (the attribute to read), `valueIsLabel` (use the attribute's display label rather than the raw stored value) and a `tagMap` (patterns mapping attribute values to tag values, with a default when none match).	List of rules.	Use it when a product attribute should drive behaviour downstream.

Credit memos

These settings are on the Magento Credit Configuration.

Setting	What it does	Values / default	When to change it
Setup date `setupDate`	Only credit memos created on or after this date are imported.	Date. Set automatically when the Integration is first configured.	Not normally changed afterwards.
Last import date `lastImportDate`	The import watermark for credit memos.	Date and time. Managed by the system.	Don't edit it by hand.
Import delay `importDelay`	Waits this long before importing a credit memo, so other systems can change it first.	Duration, for example `00:05:00` for five minutes.	Add a delay if credit memos are often edited just after creation.
Use base currency values `useBaseValues`	Uses base currency amounts rather than display currency amounts for credit memos.	`true` or `false`.	Keep it consistent with the order Configuration.