This guide describes the configuration steps to add a supplier to an existing IOM shop instance. It is addressed to IOM operators (e.g., an IOM administrator who has access to the whole system).
A questionnaire guides the target group to collect the necessary information in the run of the supplier configuration.
This guide does not cover any kind of supplier approval processes. So there is no documentation of the following configuration tables in this document:
|COD||Cash on delivery|
|DO||Data Object - used as persistence entities to represent stored values in the database|
|DOSE||Dynamic Order Supplier Evaluation|
|EOL||End Of Life - the sale or support of goods and services is terminated|
|IOM||The abbreviation for Intershop Order Management|
|OMS||The abbreviation for Order Management System, the technical name of IOM|
|OMT||The abbreviation for Order Management Tool, the graphical management tool of the IOM|
|RMA||Return Merchandise Authorization / Return Material Authorization|
To follow this guide and to do the supplier on-boarding by yourself, you need good experience with SQL, XML, and CSV. A good understanding of the retailing model between the shop and the new supplier is helpful.
An essential parameter for the supplier configuration is the OMS internal ID of the OMS shop instance to which the new supplier should be connected. From now on this ID will be identified by
|Does the supplier support order responses?|
Does the supplier use the OMS ShopService to submit response messages?
|Does the supplier use the OMS ShopService to submit dispatch messages (delivery notifications)?|
|Does the supplier use the OMS ReturnService to submit return messages?|
|Does the retailer / shop use the supplier for drop shipment?|
|Does the retailer / shop allow the splitting of an order into multiple shipments?|
|Does the supplier support the payment method COD in relation to the retailer / shop?|
|Does the shop system use the OMS feature to select a supplier with the order submission (shop system to OMS)? If TRUE, the configuration value (Shop2SupplierDO property "Guide - IOM Supplier Onboarding 2.0#shopSupplierName") has to be agreed with the shop system.|
|Which return reasons does the supplier use?|
Does the supplier use own identifiers / names for return reasons in the communicating with the OMS?
|Does the shop / retailer support an RMA process? If TRUE|
|Which reduction reasons (name / identifier) does the retailer / shop use?|
Which reduction reasons (name / identifier) does the supplier use?
What is the mapping of the reduction reasons between retailer / shop and supplier?
Should the inventory of a product set to 0, if a product is not longer included in the import data files?
Requires that the property "checkMissingInLastDatapack" at the product import configuration is set to TRUE.
|If the order includes coupons, should these be transmitted to the supplier?|
This chapter describes the configuration at the OMS database to add a new supplier to an existing and already configured OMS shop instance. The sections in this chapter are corresponding to the configuration tables.
The main entity of the supplier configuration is the database table oms.“SupplierDO”. All other supplier related configurations refer to this table.
|id||ID / primary key - from now on this ID will be identified by ||5000|
|active||Indicates enabled / disabled suppliers||TRUE|
|contentSupplier||Indicates if the supplier is a content provider for product data - should be FALSE||FALSE|
|countryCodeDefRef||Country code used in the IOM interfaces - should be 1 (ISO 3166-1 alpha-2) |
- reference to oms."CountryCodeDefDO"
|countryDefRef||Country of the supplier - reference to oms."CountryCodeDefDO"||29|
Specifies the time by which an order must be submitted to the supplier to guarantee the minimum delivery time.
If the cutoff time already passed when the DOSE process for an order takes place, the planned delivery date is increased by one day.
|deliveringSupplier||States whether a supplier delivers goods.|
If FALSE, this supplier is not considered in the order assignment for a shop (DOSE process).
|legal||Indicates if the Supplier is a concrete supplier, or is used only for configuration purposes - should be TRUE||TRUE|
|modificationDate||Time stamp of the last modification - should be updated with each change||now()|
|name||Name of supplier||SIM Flagship store - North|
Name of supplier, as used by the supplier itself
|SIM - North|
Indicates whether the supplier supports reservations - should be FALSE
Reservations are currently not supported by the IOM
|Indicates whether the supplier supports order responses (IOM ShopService method storeResponse) - If FALSE, the data determined by the DOSE process (INITIAL-response) are immediately assumed. Otherwise the OMS waits for a response message of the supplier.||FALSE|
Indicates whether the supplier can handle only one position per product. - If TRUE, the OMS combines positions with the same product to one position and sums up their quantities (for the order placement message to the supplier).
|internalSupplierName||Name of the supplier for OMS internal technical purpose||simwarehouse_north|
Reference to a parent supplier (oms."Guide - IOM Supplier Onboarding 2.0#SupplierDO".id).
Contrarily to shop inheritances that affect many features, supplier inheritance is only used for users and roles assignments:
|cleanParentOnImport||If TRUE, any existing values of EAN and manufacturerArticleNo are set to null at master products (variation masters) after an IOM product import.||TRUE|
|ignoreAdditionalPositions||Specifies the handling of additional order positions in messages from the supplier.|
If TRUE, the OMS should ignore additional positions.
If FALSE, the OMS throws an InvalidReferenceException in case of an additional order position.
Removed with IOM 2.2
Delay of message processing. Such a delay enables the cancellation of business messages like dispatches etc. before the processing has begun.
Currently this functionality is only used for messages from the OMT.
|Type of supplier - possible values are:||2|
INSERT INTO oms."SupplierDO"( "id", "active", "contentSupplier", "countryCodeDefRef", "countryDefRef", "cutOffTime", "deliveringSupplier", "legal", "modificationDate", "name", "supplierName", "supportsReservation", "supportsResponse", "singlePositionArticle", "internalSupplierName", "parentSupplierRef", "cleanParentOnImport", "ignoreAdditionalPositions", "configurationUseCaseDefRef", "businessObjectProcessingDelay", "supplierTypeDefRef") VALUES (5000, TRUE, FALSE, 1, 29, '14:30', TRUE, TRUE, now(), 'SIM Flagship store - North', 'SIM - North', FALSE, FALSE, TRUE, 'simwarehouse_north', 5, TRUE, TRUE, null, '15m', 2);
INSERT INTO oms."SupplierDO"( "id", "active", "contentSupplier", "countryCodeDefRef", "countryDefRef", "cutOffTime", "deliveringSupplier", "legal", "modificationDate", "name", "supplierName", "supportsReservation", "supportsResponse", "singlePositionArticle", "internalSupplierName", "parentSupplierRef", "cleanParentOnImport", "ignoreAdditionalPositions", "businessObjectProcessingDelay", "supplierTypeDefRef") VALUES (5000, TRUE, FALSE, 1, 29, '14:30', TRUE, TRUE, now(), 'SIM Flagship store - North', 'SIM - North', FALSE, FALSE, TRUE, 'simwarehouse_north', null, TRUE, TRUE, '15m', 2);
The database table oms."Shop2SupplierDO" includes the relationship between an OMS shop instance and an OMS supplier entity. It is the glue for the shop supplier relationship.
|id||ID / primary key||15000|
|active||Indicates enabled / disabled shop to supplier relationships||TRUE|
|modificationDate||Time stamp of the last modification - should be updated with each change||now()|
The supplier holds a reservation for the shop for this number of days - should be 0
Reservations are currently not supported by the IOM.
User account of the shop system for the placement of supplier response, dispatch, and return messages from the OMS to the shop system - set only if required.
Password of the above mentioned user account at the shop system - set only if required.
Name (identifier) of the supplier as called by the the shop system - mandatory but no constraint at the DB
|SIM supplier - North|
Indicates the allowance of the retailer / shop to split an order into multiple shipments.
User account of the supplier system for the placement of order messages from the OMS to the supplier system - set only if required.
Password of the above mentioned user account at the supplier system - set only if required.
Name (identifier) of the retailer / shop as called by the the supplier.
|shopRef||Reference to the OMS shop instance - references oms."ShopDO" - $shopId||10000|
|supplierRef||Reference to the OMS supplier instance - references oms."SupplierDO" - $supplierId||5000|
Indicates whether existing order coupons (oms.”OrderCouponDO”) are sent to the supplier alongside with the order.
Indicates whether the supplier supports payment method COD in relation to the retailer / shop.
|eolDetectionTimeInterval||Specifies the time in minutes to determine when a product that was not available at the last successfully imported dynamic data file (see Guide - IOM Supplier Onboarding 2.0#Product import) is set to EOL by the OMS. |
Specifies whether to set the inventory of a product to 0 if the product is no longer included in the product data files from the supplier. This determination is made only when the property "checkMissingInLastDatapack" at the import configuration (see product."ImportConfigurationDO") for the related supplier is set to TRUE.
Specifies the delivery charge, which has been agreed between the retailer / shop and the supplier. This delivery charge is used in the optional OMS sales price calculation.
Indicates if the supplier provides drop shipment for the retailer / shop. This property has an impact on business processes. If the property Guide - IOM Supplier Onboarding 2.0#supplierTypeDefRef = 3 of the related supplier, then this property should be TRUE.
Specifies the carrier, which is used in the return processes between this shop and this supplier.- references oms."CarrierDO"
Lead code of the supplier at the carrier for the return label
Indicates whether the product number of the supplier (see Product Import) should be used as the shop product number.
Only useful if property Guide - IOM Supplier Onboarding 2.0#useSupplierArticleNoAsShopArticleNo is TRUE.