Planet OMS

Configuration fields

• Webstore code

Code specifying the webstore used in Planet's OMS backoffice. It can be defined in the backoffice under OMS > Sales contexts.

• Scenario

It allows to select from 3 different scenarios specifying which of Planet's OMS shipping methods will be used in your shop.

• Only Click And Collect

Only click and collect method will be available in your shop.

• Only Unified Stock

Only at home deliveries will be available in your shop.

• FULL OMS (Click And Collect and Unified Stock)

Both click and collect and at home deliveries will be available in your shop.

• Shopware shipping method for Click And Collect

Select between shopware shipping methods which will be reserved for the click and collect method.

• Enable logs

If enabled the plugin will log every important action inside the project folder /var/log/PlanetUnifiedCommerce.

• Enable Widget in PDP

Shows the promises widget in the product detail page.

• Enable Widget Reservation (EBooking) in PDP

Shows the button for the eBooking functionality to reserve a product in the product detail page.

• Product promise in cart

Shows the product promise under each product in the cart page.

• Delivery promise in cart

Shows the delivery promise in the cart page under the summary pannel.

• Delivery promise in checkout

Shows the delivery promise as selectable shipping method in the checkout confirm page under the shipping method section.

• Proximis URL

Enter the Planet’s OMS domain which will be the URL used by the Proximis API.

• StoreFront API KEY

Enter the API key used for the Proximis Storefront v2 API. A key can be generated using the Planet OMS backoffice under Technique > API Keys.

• Test Storefront API connection

Button to check whether the Proximis Storefront v2 API key entered is valid and whether a connection to the API can be established.

• Data Hub API KEY

Enter the API key used for the Proximis Data Hub API. A key can be generated using the Planet OMS backoffice under Technique > API Keys.

• Test DataHub API connection

Button to check whether the Proximis Data Hub API key entered is valid and whether a connection to the API can be established.

• SFTP Host

Enter the domain of the SFTP Host.

• SFTP Catalogue synchronization folder

Enter the path that will be used to synchronise the catalogue via SFTP.

• SFTP Port

Enter the port used for SFTP connection.

• SFTP User

Enter the user used for SFTP authentication.

• SFTP Password

Enter the password used for SFTP authentication.

• Test SFTP connection

Button to check whether an SFTP connection can be established with the entered host.

• Sync products

Enables product synchronisation when synchronising the catalogue with the Planet’s OMS.

• Sync product prices

Enables product prices synchronisation when synchronising the catalogue with the Planet’s OMS.

• Sync product media

Enables product media synchronisation when synchronising the catalogue with the Planet’s OMS.

• Sync data attributes

Enables properties synchronisation when synchronising the catalogue with the Planet’s OMS.

• Sync brands

Enables manufactures synchronisation when synchronising the catalogue with the Planet’s OMS.

• Price calculation

Select whether the price calculation should be net or gross when synchronising the catalogue with Planet's OMS.

• Synchronize Orders

Enables the synchronisation of orders with Planet's OMS.

• Synchronize Order Statuses

Enables the synchronisation of order statuses with Planet's OMS.

• Send email on status change

Enables e-mail notification when the status of an order changes in the Planet’s OMS.

Custom Fields

Follows the list of custom fields defined as entity - custom field name:

• Currency - OMS code

Used to associate Shopware currencies with Planet’s OMS pricing areas. 

Pricing area synchronization codes can be setup in Planet’s OMS backoffice under Commerce > Checkout > Pricing areas.

• Tax - OMS code

Used to associate Shopware taxes with Planet’s OMS taxes. this field must contain both tax code and tax category separated by a colon. 

I.E. TVAFR:N

Tax synchronization codes can be setup in Planet’s OMS backoffice under Commerce > Checkout > Taxes.

• PropertyGroup - OMS code

Used to associate Shopware property groups with Planet’s OMS attributes and axes. 

Attributes synchronization code can be setup in Planet’s OMS backoffice under Administration > Data enrichment > Attributes.

Axes synchronization code can be setup in Planet’s OMS backoffice under Catalogue > Products > Axis.

N.B. Any shopware property group should be associate with both Planet’s OMS attribute and axes.

• ShippingMethod - OMS code

Used to associate Shopware shipping methods with Planet’s OMS shipping methods. 

Shipping method synchronization code can be setup in Planet’s OMS backoffice under Commerce > Checkout > Shipping Methods.

N.B. Any Shopware shipping method which have this field set will no longer be used as standard shipping method.

• Product - OMS typology code

Used to associate Shopware products with Planet’s OMS typologies.

Typologies synchronization codes can be setup in Planet’s OMS backoffice under Administration > Data enrichment > Typologies.

For more information visit: https://www.weareplanet.com/order-management-system
For more information visit our website: https://www.weareplanet.com