Personal Library

Kbid	28004F
Last Modified	22-Jun-2020
Added to KB	19-Sep-2016
Public Access	Everyone
Status	Online
Doc Type	Guidelines, Concepts & Cookbooks
Product	IOM 2.0 IOM 2.1

Guide - IOM Supplier Onboarding 2.0

https://support.intershop.com/kb/28004F

Product Version	1.1
Product To Version	2.2
Status	final

1 Introduction

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:

oms."Supplier2ApprovalStateCodeDefDO"
oms."Supplier2ApprovalStateCodeReasonDefDO"
oms."Shop2Supplier2ApprovalTypeDefDO"

IOM Supplier Onboarding

1.1 Glossary

Term	Description
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

1.2 1.2 References

1.3 Prerequisite

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 $shopId.

2 Questionnaire

Question	Relates to
Does the supplier support order responses? Does the supplier use the OMS ShopService to submit response messages?	Response transmission SupplierDO property "supportsResponse"
Does the supplier use the OMS ShopService to submit dispatch messages (delivery notifications)?	Dispatch transmission
Does the supplier use the OMS ReturnService to submit return messages?	Return transmission
Does the retailer / shop use the supplier for drop shipment?	SupplierDO property "supplierTypeDefRef" Shop2SupplierDO property "isDropShipment"
Does the retailer / shop allow the splitting of an order into multiple shipments?	Shop2SupplierDO property "splitShipmentAllowed"
Does the supplier support the payment method COD in relation to the retailer / shop?	Shop2SupplierDO property "supplierSupportsCOD"
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 "shopSupplierName") has to be agreed with the shop system.	Shop2SupplierDO property "shopSupplierName"
Which return reasons does the supplier use? Does the supplier use own identifiers / names for return reasons in the communicating with the OMS?	Supplier2ReturnReasonDefDO
Does the shop / retailer support an RMA process? If TRUE should the OMS create RMA numbers for the supplier? is the RMA number a fix value for the supplier?	Supplier2ReturnTypeDefDO
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?	Shop2Supplier2ReduceReasonDO
Should the inventory of a product set to 0, if a product is not longer included in the import data files? Note Requires that the property "checkMissingInLastDatapack" at the product import configuration is set to TRUE.	Shop2SupplierDO property "resetStockOnImport"
If the order includes coupons, should these be transmitted to the supplier?	Shop2SupplierDO property "sendOrderCoupon"

3 Configuration

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.

3.1 SupplierDO

The main entity of the supplier configuration is the database table oms.“SupplierDO”. All other supplier related configurations refer to this table.

3.1.1 Table structure

Property	Description	Example
id	ID / primary key - from now on this ID will be identified by `$supplierId`	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"	1
countryDefRef	Country of the supplier - reference to oms."CountryCodeDefDO"	29
cutOffTime	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. syntax: hh:mm (24-hour time format)	14:30
deliveringSupplier	States whether a supplier delivers goods. If FALSE, this supplier is not considered in the order assignment for a shop (DOSE process).	TRUE
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
supplierName	Name of supplier, as used by the supplier itself Used by: IOM SOAP Web service ShopService (Response transmission and Dispatch transmission)	SIM - North
supportsReservation	Indicates whether the supplier supports reservations - should be FALSE Note Reservations are currently not supported by the IOM	FALSE
supportsResponse	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
singlePositionArticle	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). Used by: Order placement - OMS to supplier	TRUE
internalSupplierName	Name of the supplier for OMS internal technical purpose syntax: spaces are not allowed and lowercase is recommended	simwarehouse_north
parentSupplierRef	Reference to a parent supplier (oms."SupplierDO".id). Contrarily to shop inheritances that affect many features, supplier inheritance is only used for users and roles assignments: roles granted in a parent supplier are also available in all descendant suppliers.	null
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.	TRUE
configurationUseCaseDefRef	Note Removed with IOM 2.2	5
businessObjectProcessingDelay	Delay of message processing. Such a delay enables the cancellation of business messages like dispatches etc. before the processing has begun. Note Currently this functionality is only used for messages from the OMT. Duration in minutes = m (e.g., 30m) Duration in hours = h (e.g., 1h)	15m
supplierTypeDefRef	Type of supplier - possible values are: 1 = Retailer 2 = Warehouse 3 = Drop shipment	2

3.1.2 Example OMS Version Until 2.1

until OMS 2.1

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);

3.1.3 Example OMS Version 2.2 or Higher

OMS 2.2 or higher

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);

3.2 Shop2SupplierDO

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.

3.2.1 Table structure

Property	Description	Example
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()
reservationTimeInDays	The supplier holds a reservation for the shop for this number of days - should be 0 Note Reservations are currently not supported by the IOM.	0
sendOffTimeInHours	Note Deprecated The column is deprecated - 0 should be used.	0
shopAccount	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. Used by: XML element User at storeResponse XML element User at storeDispatch XML element User at storeReturn	null
shopPassword	Password of the above mentioned user account at the shop system - set only if required. Used by: XML element Password at storeResponse XML element Password at storeDispatch XML element Password at storeReturn	null
shopSupplierName	Name (identifier) of the supplier as called by the the shop system - mandatory but no constraint at the DB Used by: Order placement shop system to OMS (selectedSupplier) OrderStateService method getOrderStateReport (OrderStateReportMapperOutBean) - XML attribut name at element Supplier ReverseService method returnSlipRequest (ReturnRequestResponseMapperOutBean) - XML attribut name at element Supplier Outbound XML messages like response, dispatch, and return from the OMS Document creation (OrderDocumentsMapperBean) - see OrderDocuments.xsd element SupplierData at OrderDocuments attribute shopSupplierName	SIM supplier - North
splitShipmentAllowed	Indicates the allowance of the retailer / shop to split an order into multiple shipments. Used by: Order placement - OMS to supplier (this configuration property is used when no corresponding value at the order is present )	TRUE
supplierAccount	User account of the supplier system for the placement of order messages from the OMS to the supplier system - set only if required. Used by: Order placement - OMS to supplier (Shop2SupplierTransmissionWrapper) XML element User at storeOrder	null
supplierPassword	Password of the above mentioned user account at the supplier system - set only if required. Used by: Order placement - OMS to supplier (Shop2SupplierTransmissionWrapper) XML element Password at storeOrder	null
supplierShopName	Name (identifier) of the retailer / shop as called by the the supplier. Used by: IOM SOAP Web service ShopService (Response transmission and Dispatch transmission) Document creation (OrderDocumentsMapperBean) - see OrderDocuments.xsd element ShopData at OrderDocuments attribute supplierShopName Order placement (FileSenderBean) - OMS to supplier for the wildcard SHOP at the filename	SIM
shopRef	Reference to the OMS shop instance - references oms."ShopDO" - $shopId	10000
supplierRef	Reference to the OMS supplier instance - references oms."SupplierDO" - $supplierId	5000
supplierShopKey	Note Deprecated The column is deprecated - 'null' should be used.	null
sendOrderCoupon	Indicates whether existing order coupons (oms.”OrderCouponDO”) are sent to the supplier alongside with the order. Used by: Order placement - OMS to supplier	FALSE
supplierSupportsCOD	Indicates whether the supplier supports payment method COD in relation to the retailer / shop. If FALSE the supplier is not considered in the DOSE process for orders with payment method COD. Used by: Dynamic Order Supplier Evaluation	FALSE
eolDetectionTimeInterval	Specifies the time in minutes to determine when a product that was not available at the last successfully imported dynamic data file (see Product import) is set to EOL by the OMS. null = The OMS default EOL detection time interval of seven days 0 = The next EOL detection run (triggered by a quartz job) sets the concerned products immediately to EOL Used by: OMS article management - function / stored procedure "product.article_eol_detection"	null
resetStockOnImport	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. Used by: Product Import	FALSE
flatRateShipping	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. This charge is added to the purchase price to determine the selling price. If this property is NULL, 0 is added. Used by: DB function / stored procedure "product.process_salesprice_calculation"	null
isDropShipment	Indicates if the supplier provides drop shipment for the retailer / shop. This property has an impact on business processes. If the property supplierTypeDefRef = 3 of the related supplier, then this property should be TRUE. Used by: This property has an impact on business processes - DropshipperExecutionDeciderBean	FALSE
immaterialArticleUrlValidityDuration	Note Deprecated The column is deprecated - 'null' should be used.	null
returnCarrierRef	Specifies the carrier, which is used in the return processes between this shop and this supplier.- references oms."CarrierDO" Used by: Creation of return label according to the configured carrier	null
leadCode	Lead code of the supplier at the carrier for the return label Used by: creation of return label (complexType "ReturnLabel", element "LeadCode")	null
useSupplierArticleNoAsShopArticleNo	Indicates whether the product number of the supplier (see Product Import) should be used as the shop product number. If TRUE no further mapping of supplier product numbers to shop SKU is necessary. The OMS creates the necessary import file (so-called N-File) during product import processing. Used by: Product Import	FALSE
shopArticleNoPrefix	Only useful if property useSupplierArticleNoAsShopArticleNo is TRUE. The shop product numbers can be created by the OMS using the supplier product numbers enriched with this prefix value. Used by: Product Import	null

Note

A unique constraint ensures that the relationship of a specific shop (property shopRef) to a specific supplier (property supplierRef) only occurs once.
Another unique constraint ensures that for a specific shop (property shopRef) the shop supplier name (property shopSupplierName) only occurs once.
And still another unique constraint ensures that for a specific supplier (property supplierRef) the supplier shop name (property supplierShopName) only occurs once.

3.2.2 Example

INSERT INTO oms."Shop2SupplierDO"(
            "id", "active", "modificationDate", "reservationTimeInDays", "sendOffTimeInHours", 
            "shopAccount", "shopPassword", "shopSupplierName", "splitShipmentAllowed", 
            "supplierAccount", "supplierPassword", "supplierShopName", "shopRef", 
            "supplierRef", "supplierShopKey", "sendOrderCoupon", "supplierSupportsCOD", 
            "eolDetectionTimeInterval", "resetStockOnImport", "flatRateShipping", 
            "isDropShipment", "immaterialArticleUrlValidityDuration", "returnCarrierRef", 
            "leadCode", "useSupplierArticleNoAsShopArticleNo", "shopArticleNoPrefix")
    VALUES (15000, TRUE, now(), 0, 0, 
            null, null, 'SIM supplier - North', FALSE, 
            null, null, 'SIM', 10000, 
            5000, null, FALSE, FALSE, 
            null, FALSE, null, 
            FALSE, null, null, 
            null, FALSE, null);

3.3 Supplier2TaxTypeDefDO

Optional

This configuration is optional.

Use this table to configure, if the supplier insists on its own value for the taxes. If nothing is configured, the OMS internal values are used.

Note

In order to produce a complete match between the shop and the supplier, it is important to know, which tax types the OMS shop instance uses.

select "taxTypeDefRef" from oms."Shop2TaxTypeDefDO" where "shopRef" = $shopId

If there is nothing configured for the related OMS shop instance, you have to find out which OMS internal tax types are used by the shop system.

Used by:

Order placement - OMS to supplier

OMS internal tax types - see oms."TaxTypeDefDO"

ID	taxType
1	NO_TAX
2	VERY_LOW_TAX
3	LOW_TAX
4	INTERMEDIATE_TAX
5	NORMAL_TAX
6	SERVICE

3.3.1 Table Structure

Property	Description	Example
id	ID / primary key	10001
supplierTaxTypeName	Name (identifier) of the tax type as used by the supplier	FULL-TAX
taxTypeDefRef	"supplierTaxTypeName" mapped to an OMS internal tax type - reference to oms."TaxTypeDefDO"	5
supplierRef	Reference to oms."SupplierDO" - $supplierId	5000

Note

A unique constraint ensures that for a specific supplier any tax type occurs only once.

3.3.2 Example

INSERT INTO oms."Supplier2TaxTypeDefDO"(
            "id", "supplierTaxTypeName", "taxTypeDefRef", "supplierRef")
    VALUES (nextval('oms."Supplier2TaxTypeDefDO_id_seq"'), 'FULL-TAX', 5, 5000);

3.4 Supplier2CarrierDO

Optional

This configuration is optional.

Use this table to configure, if the supplier insists on its own values for the carrier. Otherwise the property name from table oms."CarrierDO" must be used.

Used by:

OMS SOAP Web service ShopService method storeDispatch - see Dispatch transmission

3.4.1 Table Structure

Property	Description	Example
id	ID / primary key	10001
supplierCarrierName	name (identifier) of the carrier as used by the supplier	Deutsche Post DHL
carrierRef	"supplierCarrierName" mapped to an OMS internal carrier - reference to oms."CarrierDO"	11
supplierRef	reference to oms."SupplierDO" - $supplierId	5000

Note

A unique constraint ensures that for a specific supplier any carrier name (property supplierCarrierName) occurs only once.

3.4.2 Example

INSERT INTO oms."Supplier2CarrierDO"(
            "id", "supplierCarrierName", "carrierRef", "supplierRef")
    VALUES (nextval('oms."Supplier2CarrierDO_id_seq"'), 'Deutsche Post DHL', 11, 5000);

3.5 Supplier2CountryDefDO

The configuration table oms."Supplier2CountryDefDO" maps the OMS internal countries to supplier specific identifier.

Note

In order to produce a complete match between the shop and the supplier, it is important to know which countries are used by the shop system.

select "countryDefRef" from oms."Shop2CountryDefDO" where "shopRef" = $shopId

If there is nothing configured for the related OMS shop instance, you have to find out which OMS internal countries are used by the shop system.

Used by:

Order placement - OMS to supplier

3.5.1 Table Structure

Property	Description	Example
id	ID / primary key	10001
countryDefRef	"supplierCountryName" and "supplierCurrencyName" mapped to an OMS internal country - reference to oms."CountryDefDO"	9
supplierCountryName	Name (identifier) of the country as used by the supplier	BELGIUM
supplierCurrencyName	Name (identifier) of the currency as used by the supplier	EURO
supplierRef	Reference to oms."SupplierDO" - $supplierId	5000

Note

A unique constraint ensures that for a specific supplier any country occurs only once.

3.5.2 Example

INSERT INTO oms."Supplier2CountryDefDO"(
            "id", "countryDefRef", "supplierCountryName", "supplierCurrencyName", "supplierRef")
    VALUES (nextval('oms."Supplier2CountryDefDO_id_seq"'), 9, 'BELGIUM', 'EURO', 5000);

3.6 SupplierReturnAddressDO

For each configured return type (see Supplier2ReturnTypeDefDO) a return address has to be configured.

A return address specifies the location where a return shipment will be received.

Used by:

OMS SOAP Web service ReverseService method returnSlipRequest
Return label document creation
Shop customer mail service

3.6.1 Table Structure

Property	Description	Example
id	ID / primary key	10001
addressLine1	First address line	Sports In Motion Warehouse
addressLine2	Second address line	c/o Intershop Communications AG
addressLine3	Third address line	Intershop Tower
addressLine4	Fourth address line	07740 Jena
addressLine5	Fifth address line	Germany
supplier2ReturnTypeDefRef	The address belongs to these return type Reference to oms."Supplier2ReturnTypeDefDO"	10001
shop2SupplierRef	Reference to oms."Shop2SupplierDO"	15000

3.6.2 Example

INSERT INTO oms."SupplierReturnAddressDO"(
            "id", "addressLine1", "addressLine2", "addressLine3", "addressLine4", "addressLine5", "supplier2ReturnTypeDefRef", "shop2SupplierRef")
    VALUES (nextval('oms."SupplierReturnAddressDO_id_seq"'), 'Sports In Motion Warehouse', 'c/o Intershop Communications AG', 'Intershop Tower', '07740 Jena', 'Germany', 10001, 15000);

3.7 Supplier2PaymentDefDO

Optional

This configuration is optional.

Use this table to configure, if the supplier insists on its own values for payment methods. Otherwise the property name from table oms."PaymentDefDO" is used.

Used by:

Order placement - OMS to supplier (XML element "Sales" > attribute "method")

3.7.1 Table Structure

Property	Description	Example
id	ID / primary key	10001
paymentDefRef	"supplierPaymentName" mapped to an OMS internal payment method - reference to oms."PaymentDefDO"	10
supplierPaymentName	Name (identifier) of the payment method as used by the supplier	PP
supplierRef	Reference to oms."SupplierDO" - $supplierId	5000

Note

A unique constraint ensures that for a specific supplier any payment method occurs only once.

3.7.2 Example

INSERT INTO oms."Supplier2PaymentDefDO"(
            "id", "paymentDefRef", "supplierPaymentName", "supplierRef")
    VALUES (nextval('oms."Supplier2PaymentDefDO_id_seq"'), 10, 'PP', 5000);

3.8 Supplier2SalesChannelDefDO

Optional

This configuration is optional.

Use this table to configure, if the OMS shop instance uses different sales channels and the supplier requires this information for fulfillment.

Used by:

Order placement - OMS to supplier

3.8.1 Table Structure

Property	Description	Example
id	ID / primary key	10001
salesChannelDefRef	"supplierSalesChannelName" mapped to an OMS internal sales channel - reference to oms."SalesChannelDefDO"	1
supplierSalesChannelName	Name (identifier) of the sales channel as used by the supplier	SALE
supplierRef"	Reference to oms."SupplierDO" - $supplierId	5000

Note

A unique constraint ensures that for a specific supplier any sales channel occurs only once.

3.8.2 Example

INSERT INTO oms."Supplier2SalesChannelDefDO"(
            "id", "salesChannelDefRef", "supplierSalesChannelName", "supplierRef")
    VALUES (nextval('oms."Supplier2SalesChannelDefDO_id_seq"'), 1, 'SALE', 5000);

3.9 SupplierContactDO

Optional

This configuration is optional.

Note

Deprecated
The table is deprecated.

3.10 Supplier2DeliveryFormDefDO

Optional

This configuration is optional.

Contains the name of a delivery form, as used by the supplier, with reference to the OMS internal delivery form.

Used by:

No usage by the OMS itself, but this table can be useful for customization.

OMS internal delivery forms - see oms."DeliveryFormDefDO"

ID	Name
10	Standard
20	Freight forwarding
30	Immaterial goods

3.10.1 Table Structure

Property	Description	Example
id	ID / primary key	10001
deliveryFormDefRef	"supplierDeliveryFormName" mapped to an OMS internal delivery form - reference to oms."DeliveryFormDefDO"	20
supplierDeliveryFormName	Name (identifier) of the delivery form as used by the supplier	FF
supplierRef	Reference to oms."SupplierDO" - $supplierId	5000

Note

A unique constraint ensures that for a specific supplier any delivery form occurs only once.

3.10.2 Example

INSERT INTO oms."Supplier2DeliveryFormDefDO"(
            "id", "deliveryFormDefRef", "supplierDeliveryFormName", "supplierRef")
    VALUES (nextval('oms."Supplier2DeliveryFormDefDO_id_seq"'), 20, 'FF', 5000);

3.11 Supplier2DeliveryOptionDefDO

Optional

This configuration is optional.

Contains the names of delivery options, as used by the supplier, with reference to the OMS internal delivery options.

Used by:

Order placement - OMS to supplier (XML attribute name at element OrderPos > DeliveryOption)

OMS internal delivery options - see oms."DeliveryOptionDefDO"

ID	Name
1	Cash on delivery
2	Island delivery
3	Delivery on Saturday
4	Delivery with gift wrap paper
5	Delivery with special attachment
6	Delivery to container freight station
7	Pick items up in store
8	Night shipping

3.11.1 Table Structure

Property	Description	Example
id	ID / primary key	10001
deliveryOptionDefRef	"supplierDeliveryOptionName" mapped to an OMS internal delivery option - reference to oms."DeliveryOptionDefDO"	8
supplierDeliveryOptionName	name (identifier) of the delivery form as used by the supplier	OVERNIGHT
supplierRef	reference to oms."SupplierDO" - $supplierId	5000

Note

A unique constraint ensures that for a specific supplier any delivery option occurs only once.

3.11.2 Example

INSERT INTO oms."Supplier2DeliveryOptionDefDO"(
            "id", "deliveryOptionDefRef", "supplierDeliveryOptionName", "supplierRef")
    VALUES (nextval('oms."Supplier2DeliveryOptionDefDO_id_seq"'), 8, 'OVERNIGHT', 5000);

3.12 Supplier2DeliveryTypeDefDO

Optional

This configuration is optional.

Note

Deprecated
The table is deprecated.

3.13 Supplier2ResponseTypeDefDO

Optional

This configuration is optional.

Note

Deprecated
The table is deprecated.

3.14 Supplier2ResponseStateCodeDefDO

Optional

This configuration is optional.

This table is relevant if the supplier supports order responses and if the supplier insists on its own values for response state codes. Otherwise the property name from table oms."ResponseStateCodeDefDO" must be used.

Used by:

Response transmission

OMS internal response state codes - see oms."ResponseStateCodeDefDO"

ID	Name
1	Accepted
2	Accepted with change
3	Canceled
4	Unchanged
5	Changed
6	Added

3.14.1 Table Structure

Property	Description	Example
id	ID / primary key	10001
responseStateCodeDefRef	"supplierResponseStateCodeName" mapped to an OMS internal response state code - reference to oms."ResponseStateCodeDefDO"	1
supplierResponseStateCodeName	Name (identifier) of the response state code as used by the supplier	OK
supplierRef	Reference to oms."SupplierDO" - $supplierId	5000

3.14.2 Example

INSERT INTO oms."Supplier2ResponseStateCodeDefDO"(
            "id", "responseStateCodeDefRef", "supplierResponseStateCodeName", "supplierRef")
    VALUES (nextval('oms."Supplier2ResponseStateCodeDefDO_id_seq"'), 1, 'OK', 5000);

3.15 Supplier2ReturnTypeDefDO

This configuration table contains the return types supported by the supplier.

Note

Best practice: at least configure the return type Recall, Return and Inversion.

Used by:

The configuration table oms."SupplierReturnAddressDO"
SOAP Web service ReverseService method returnSlipRequestOMS
SOAP Web service ReverseService method returnSlipRequest

OMS internal return types - see oms."ReturnTypeDefDO"

ID	Name
1	Cancellation
2	Recall
3	Inversion
4	Return
5	Defect

3.15.1 Table Structure

Property	Description	Example
id	ID / primary key	10001
returnTypeDefRef	"supplierReturnTypeName" mapped to an OMS internal return type - reference to oms."ReturnTypeDefDO"	4
supplierReturnTypeName	Name (identifier) of the return type as used by the supplier	RET
supplierRef	Reference to oms."SupplierDO" - $supplierId	5000
rmaNo	Fixed value of a RMA number for the related return type	null
preselected	Indicates if this return type should be pre-selected in the OMT during creation of a return for this supplier. Ensure that only one return type is configured as pre-selected.	TRUE
rmaCodeCounter	Latest generated RMA number - only relevant if OMS generates RMA numbers for the supplier	null
rmaCodeStart	Start value of RMA number - only relevant if OMS generates RMA numbers for the supplier	null
rmaCodeEnd	Maximum value of RMA number - only relevant if OMS generates RMA numbers for the supplier	null
interval	RMA number generating interval - only relevant if OMS generates RMA numbers for the supplier	null
modificationDate	Time stamp of the last modification - should be updated with each change	now()
startDate	Start date of current RMA number generation - only relevant if OMS generates RMA numbers for the supplier	null
minEndDate	Date on which the RMA numbers do not repeat - only relevant if OMS generates RMA numbers for the supplier	null
ejbLookup	Lookup path to the implementation of the RMA number generation. Possibility to register a customized RMA number session bean. If you want to enable the OMS default RMA number generation feature you have to configure: java:global/bakery.base-app- APP_VERSION/bakery.logic-core-APP_VERSION/RMALogicBean!bakery.logic.service.configuration.RMALogicService Example OMS version 1.1.0.0: java:global/bakery.base-app-1.1.0.0-SNAPSHOT/bakery.logic-core-1.1.0.0-SNAPSHOT/RMALogicBean!bakery.logic.service.configuration.RMALogicService	null

3.15.2 Example

INSERT INTO oms."Supplier2ReturnTypeDefDO"(
            "id", "returnTypeDefRef", "supplierReturnTypeName", "supplierRef", 
            "rmaNo", preselected, "rmaCodeCounter", "rmaCodeStart", "rmaCodeEnd", 
            "interval", "modificationDate", "startDate", "minEndDate", "ejbLookup")
    VALUES (nextval('oms."Supplier2ReturnTypeDefDO_id_seq"'), 4, 'RET', 5000, 
            null, TRUE, null, null, null, 
            null, now(), null, null, null);

Note

A unique constraint ensures that for a specific supplier any return type occurs only once.

3.16 Supplier2ReturnReasonDefDO

Optional

This configuration is optional.

This configuration table contains the return reasons supported by the supplier. This table is used only for configuration, if the supplier does not use the OMS internal return reasons.

If nothing is configured, all OMS internal return reasons are possible and displayed in a choice grouped by the return type at the OMT.

Note

You have to configure at least one return reason per configured return type.

Used by:

Return transmission (supplier to OMS)

OMS internal return reasons - see oms."ReturnReasonDefDO"

ID	Name	Description	Return type
1	CAN010	Cancellation on customer demand	Cancellation
2	CAN020	Cancellation due to EOL	Cancellation
3	CAN030	Payment not received	Cancellation
4	CAN031	Leasing denied	Cancellation
5	CAN040	Payment by installment denied	Cancellation
6	CAN050	Purchase on account denied	Cancellation
7	CAN060	Credit card order without feedback	Cancellation
8	CAN070	Credit card order with foreign credit card	Cancellation
9	CAN080	Cancellation due to suspicion of defraud\|	Cancellation
10	CAN090	Cancellation due to erroneous pricing	Cancellation
11	CAN200	Cancellation due to distributor switch	Cancellation
12	CAN990	Other reasons	Cancellation
100	RCL010	Cancellation on customer demand	Recall
101	RCL015	Cancellation on shop demand	Recall
102	RCL020	Cancellation due to EOL	Recall
103	RCL023	Cancellation due to erroneous article assignment	Recall
104	RCL024	Cancellation due to missing sales price	Recall
105	RCL025	Cancellation due to erroneous pricing	Recall
106	RCL030	Erroneous approval	Recall
107	RCL200	Cancellation due to missing distributor assignment	Recall
108	RCL980	Cancellation due to suspicion of defraud	Recall
109	RCL990	Other reasons	Recall
110	RCL300	Cancellation due to an erroneous order	Recall
111	RCL050	Purchase on account denied	Recall
112	RCL040	Approval rejected	Recall
113	RCL400	Cancellation due to erroneous distributor processes	Recall
114	RCL045	Payment not received	Recall
115	RCL041	Approval rejected due to EOL	Recall
116	RCL021	Cancellation due to missing stock	Recall
200	INV010	Refusal of acceptance by consignee	Inversion
201	INV020	Consignee not me	Inversion
202	INV030	Wrong shipping address	Inversion
203	NV040	Loss during shipment	Inversion
204	INV990	Other reasons	Inversion
300	RET010	Return of goods / general	Return
301	RET020	Return of goods because of bad workmanship	Return
302	RET030	Return of goods because of missing product attributes	Return
303	RET040	Return of goods because of better offer	Return
304	RET050	Return of goods because delivery time too long	Return
305	RET060	Defect within return period, DOA	Return
306	RET070	Item incomplete, missing parts	Return
307	RET080	Shop delivered wrong item	Return
308	RET090	Distributor delivers wrong item	Return
309	RET100	Transport damage	Return
310	RET110	Return on goodwill	Return
311	RET120	Unauthorized return	Return
312	RET990	Other reasons	Return
313	RET045	Return of goods because of inadequate price	Return
314	RET046	Return of goods because of wrong price	Return
315	RET055	Return of goods because of duplicate delivery	Return
316	RET075	Order incomplete, missing position	Return
317	RET130	Return of stained goods	Return
318	RET140	Return of goods because customer does not like the design	Return
319	RET150	Return of goods because customer ordered several sizes/colors	Return
320	RET160	Return of goods because customer does not like the material	Return
321	RET170	Return of goods because customer does not like pattern/color	Return
322	RET180	Return of replacement	Return
323	RET190	Return of goods because product does not meet customer expectations	Return
324	RET035	Return of goods because picture differs from item	Return
325	RET057	Return of goods because wrong quantity delivered	Return
326	RET142	Return of goods because item too large/wide	Return
327	RET144	Return of goods because item too small/tight	Return
328	RET145	Return of goods because item too long	Return
329	RET146	Return of goods because item too short	Return
330	RET147	Return of goods because item squeezes	Return
331	RET148	Return of goods because item has too much compression	Return
332	RET149	Return of goods because item has not enough compression	Return
333	RET200	Return rejected	Return
400	DEF010	DOA, replacement through distributor	Defect
401	DEF020	DOA, credit note from distributor	Defect
402	DEF030	DOA, replacement through shop	Defect
403	DEF040	Credit note with 6 months warranty	Defect
404	DEF050	Credit note after 6 months warranty	Defect
405	DEF060	Warranty with repair/replacement through distributor	Defect
406	DEF070	Warranty with repair/replacement through shop	Defect
407	DEF080	Guarantee with credit note	Defect
408	DEF090	Guarantee with repair/replacement	Defect
409	DEF100	Unauthorized return of defective item	Defect
410	DEF990	Other reasons	Defect

3.16.1 Table Structure

Property	Description	Example
id	ID / primary key	10001
returnReasonDefRef	"supplierReturnReasonName" mapped to an OMS internal return reason - reference to oms."ReturnReasonDefDO"	307
supplierReturnReasonName	Name (identifier) of the return reason as used by the supplier	WRONG_ITEM
supplierRef	Reference to oms."SupplierDO" - $supplierId	5000
preselected	Indicates whether this return reason should be pre-selected in the OMT during creation of a return for this supplier. Ensure that only one return reason per return type is configured as pre-selected.	FALSE

3.16.2 Example

INSERT INTO oms."Supplier2ReturnReasonDefDO"(
            "id", "returnReasonDefRef", "supplierReturnReasonName", "supplierRef", "preselected")
    VALUES (nextval('oms."Supplier2ReturnReasonDefDO_id_seq"'), 307, 'WRONG_ITEM', 5000, FALSE);

3.17 Supplier2ReductionUnitDefDO

Optional

This configuration is optional.

Use this table to configure if the property sendOrderCoupon of related Shop2Supplier is TRUE and the supplier insists on its own identifier for reduction units instead of the OMS internal reduction units.

Used by:

Order placement - OMS to supplier (attribute value, key = "couponUnit" at XML element Property with id = "coupon" at position level)

OMS internal reduction units - see oms."ReductionUnitDefDO"

ID	Name
1	Unknown reduction unit
2	Percentage
3	Monetary

3.17.1 Table Structure

Property	Description	Example
id	ID / primary key	10001
reductionUnitDefRef	"supplierReductionUnitName" mapped to an OMS internal reduction unit - reference to oms."ReductionUnitDefDO"	3
supplierReductionUnitName	Name (identifier) of the reduction unit as used by the supplier	MO
supplierRef	Reference to oms."SupplierDO" - $supplierId	5000

Note

A unique constraint ensures that for a specific supplier any reduction unit occurs only once.

3.17.2 Example

INSERT INTO oms."Supplier2ReductionUnitDefDO"(
            "id", "reductionUnitDefRef", "supplierReductionUnitName", "supplierRef")
    VALUES (nextval('oms."Supplier2ReductionUnitDefDO_id_seq"'), 3, 'MO', 5000);

3.18 Shop2Supplier2ReduceReasonDO

The configuration table oms."Shop2Supplier2ReduceReasonDO" contains the reduce reasons for returns agreed between the retailer / shop and the supplier (return reduction matrix).
At least one configuration is required per Shop2Supplier relation.

3.18.1 Table Structure

Property	Description	Example
id	ID / primary key	10001
shopReduceReason	name (identifier) of reduce reason by retailer / shop	default
supplierReduceReason	name (identifier) of reduce reason by supplier	no reduction
shop2SupplierRef	reference to oms."Shop2SupplierDO"	15000
isDefault	Specifies the default value for the OMS. Ensure that only one row per "shop2SupplierRef" has the value TRUE.	TRUE

Note

A unique constraint ensures that a supplier reduce reason exists only once per Shop2Supplier configuration.

3.18.2 Example

INSERT INTO oms."Shop2Supplier2ReduceReasonDO"(
            "id", "shopReduceReason", "supplierReduceReason", "shop2SupplierRef", "isDefault")
    VALUES (nextval('oms."Shop2Supplier2ReduceReasonDO_id_seq"'), 'default', 'no reduction', 15000, TRUE);

4 Product Import

Currently the OMS must know about the products of the supplier which should be sold by a particular shop / retailer. The OMS needs a product import configuration and the relevant product data files from the supplier. The product import process, its files and configuration steps are described in a separate guide. If you are using an OMS until version 2.0 you can find the related information under Guide - IOM Product Import 2.0 otherwise Guide - IOM Product Import 2.2.

5 Order Placement

The order transmission to the supplier takes place via an XML file on a default location. The document IOM ImpEx Export Order for Order Placement describes the data format, file location and the configuration of the order placement.

Note

If you already have configured a partner referrer (oms." PartnerReferrerDO") for the supplier, you have to reuse this instance at the order placement configuration.

The partner referrer ID of the sending OMS shop instance is required for the configuration. Via the following SQL statement you can get this ID:

SELECT "id" FROM oms."PartnerReferrerDO" WHERE "shopRef" = $shopId

6 Response Transmission

Only relevant if the supplier supports order responses.

The OMS SOAP Web service ShopService method storeResponse establishes a synchronous communication channel of response messages from the supplier to the OMS. Alternatively, response messages can be created manually by using the OMT.

The supplier's Web service request must contain the credentials of a user account with the according permission. The OMT provides the necessary functions to create and manage such an OMS user account ("Administration" section "User and Role Management").

You have to create or find a role which includes the right with id = 13 (CREATE_RESPONSE - "Create receipt message". See oms."RightDefDO") to use the method storeResponse. This role must be assigned to the user account you want to use for the SOAP message.

The user to role assignment must be assigned to the related OMS shop instance that is referenced by the response message.

The user to role assignment must also be assigned to the newly configured OMS supplier instance itself.

Note

You can use the same user account and role for response, dispatch, and return transmissions

Some relevant notes to the storeResponse request:

Element User: property "accountName" (oms."UserDO") of the user account which is using this interface
Element Password: the password of the above mentioned user account
The XML element ShopSupplier must reference the related Shop2SupplierDO configuration property supplierShopName
The XML element Supplier must reference the related SupplierDO configuration property supplierName
The attribute name of the XML element Shop must reference the related Shop2SupplierDO configuration property supplierShopName

For detailed information about this interface please refer the interface documentation.

7 Dispatch Transmission

The OMS SOAP Web service ShopService method storeDispatch establishes a synchronous communication channel for response messages from the supplier to the OMS. Alternatively, response messages can be created manually by using the OMT.

You have to create or find a role which includes the right with id = 11 (CREATE_DISPATCH - "Create delivery message". See oms."RightDefDO") to use the method storeDispatch. This role must be assigned to the user account you want to use for the SOAP message.

The user to role assignment must be assigned to the related OMS shop instance that is referenced by the response message.

The user to role assignment must also be assigned to the newly configured OMS supplier instance itself.

Note

You can use the same user account and role for response, dispatch, and return transmissions

Some relevant notes to the storeDispatch request:

Element User: property "accountName" (oms."UserDO") of the user account which is using this interface
Element Password: the password of the above mentioned user account
The XML element ShopSupplier must reference the related Shop2SupplierDO configuration property supplierShopName
The XML element Supplier must reference the related SupplierDO configuration property supplierName
The attribute name of the XML element Shop must reference the related Shop2SupplierDO configuration property supplierShopName

For detailed information about this interface please refer the interface documentation.

8 Return Transmission

The OMS SOAP Web service ReturnService method storeReturn establishes a synchronous communication channel of response messages from the supplier to the OMS. Alternatively, response messages can be created manually by using the OMT.

You have to create or find a role which includes the right with id = 7 (CREATE_RETURN - "Create return message". See oms."RightDefDO") to use the method storeReturn. This role must be assigned to the user account you want to use at the SOAP message.

The user to role assignment must be assigned to the related OMS shop instance that is referenced by the response message.

The user to role assignment must also be assigned to the newly configured OMS supplier instance itself.

Note

You can use the same user account for response, dispatch, and return transmissions

Some relevant notes to the storeReturn request:

Element User: property "accountName" (oms."UserDO") of the user account which is using this interface
Element Password: the password of the above mentioned user account
The XML element ShopSupplier must reference the related Shop2SupplierDO configuration property supplierShopName
The XML element Supplier must reference the related SupplierDO configuration property supplierName
The attribute name of the XML element Shop must reference the related Shop2SupplierDO configuration property supplierShopName
The attribute name of the XML element Supplier should reference the related SupplierDO configuration property supplierName

For detailed information about this interface please refer the interface documentation.

Disclaimer

The information provided in the Knowledge Base may not be applicable to all systems and situations. Intershop Communications will not be liable to any party for any direct or indirect damages resulting from the use of the Customer Support section of the Intershop Corporate Web site, including, without limitation, any lost profits, business interruption, loss of programs or other data on your information handling system.

Guide - IOM Supplier Onboarding 2.0

Table of Contents

1 Introduction

1.1 Glossary

1.2 1.2 References

1.3 Prerequisite

2 Questionnaire

3 Configuration

3.1 SupplierDO

3.1.1 Table structure

3.1.2 Example OMS Version Until 2.1

3.1.3 Example OMS Version 2.2 or Higher

3.2 Shop2SupplierDO

3.2.1 Table structure

3.2.2 Example

3.3 Supplier2TaxTypeDefDO

3.3.1 Table Structure

3.3.2 Example

3.4 Supplier2CarrierDO

3.4.1 Table Structure

3.4.2 Example

3.5 Supplier2CountryDefDO

3.5.1 Table Structure

3.5.2 Example

3.6 SupplierReturnAddressDO

3.6.1 Table Structure

3.6.2 Example

3.7 Supplier2PaymentDefDO

3.7.1 Table Structure

3.7.2 Example

3.8 Supplier2SalesChannelDefDO

3.8.1 Table Structure

3.8.2 Example

3.9 SupplierContactDO

3.10 Supplier2DeliveryFormDefDO

3.10.1 Table Structure

3.10.2 Example

3.11 Supplier2DeliveryOptionDefDO

3.11.1 Table Structure

3.11.2 Example

3.12 Supplier2DeliveryTypeDefDO

3.13 Supplier2ResponseTypeDefDO

3.14 Supplier2ResponseStateCodeDefDO

3.14.1 Table Structure

3.14.2 Example

3.15 Supplier2ReturnTypeDefDO

3.15.1 Table Structure

3.15.2 Example

3.16 Supplier2ReturnReasonDefDO

3.16.1 Table Structure

3.16.2 Example

3.17 Supplier2ReductionUnitDefDO

3.17.1 Table Structure

3.17.2 Example

3.18 Shop2Supplier2ReduceReasonDO

3.18.1 Table Structure

3.18.2 Example

4 Product Import

5 Order Placement

6 Response Transmission

7 Dispatch Transmission

8 Return Transmission

Disclaimer