Supplier

The Supplier Find Similar call uses the Supplier Matching Algorithm to identify potential duplicate supplier records.

Required values to identify match:

Legal name
Address
Source Record ID

Request

REST

Copy

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
{
    "entity": {
        "dataContainers": {
            "MainAddressDataContainer": {
                "dataContainer": {
                    "values": {
                        "InputCountry": {
                            "value": {
                                "value": "US"
                            }
                        },
                        "InputStreet": {
                            "value": {
                                "value": "3200 Windy Hill rd"
                            }
                        }
                    }
                }
            }
        },
        "objectType": "Supplier",
        "parent": "331676",
        "values": {
            "LegalName": {
                "value": {
                    "value": "Coffee Supplier Inc"
                }
            }
        }
    },
    "maxResults": "5"
}

SOAP

Copy

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://stibo.com/step/ws/matching/1.0" xmlns:ns1="http://stibo.com/step/ws/types/1.0" xmlns:step="http://www.stibosystems.com/step">
   <soapenv:Header/>
   <soapenv:Body>
      <ns:matchAndMergeRequest>
         <accessContext>
            <ns1:userName>stepsys</ns1:userName>
            <ns1:password>stepsys</ns1:password>
            <ns1:contextUrl>step://context?id=Context1</ns1:contextUrl>
         </accessContext>
 <webserviceConfigurationID>Request-Supplier</webserviceConfigurationID>
               <matchAndMergeRecord CorrelationID="9">
                  <ns1:Entity ParentID="331676" UserTypeID="Supplier">
                     <step:Name></step:Name>
                     <step:Entity/>
                     <step:Values>
                        <step:Value AttributeID="LegalName">002 Magazine</step:Value>
                     </step:Values>
                     <step:DataContainers>
                        <step:DataContainer Type="MainAddressDataContainer">
                           <step:Values>
                              <step:Value AttributeID="InputStreet"></step:Value>
                              <step:Value AttributeID="InputCity">Houston</step:Value>
                              <step:Value AttributeID="InputCountry">US</step:Value>
                              <step:Value AttributeID="InputState">TX</step:Value>
                              <step:Value AttributeID="InputZip">77002-2245</step:Value>
                           </step:Values>
                        </step:DataContainer>
                        <step:MultiDataContainer Type="PhoneDataContainer">
                           <step:DataContainer>
                              <step:Values>
                                 <step:Value AttributeID="PhoneNumber"></step:Value>
                              </step:Values>
                           </step:DataContainer>
                        </step:MultiDataContainer>
                        <step:MultiDataContainer Type="EmailDataContainer">
                           <step:DataContainer>
                              <step:Values>
                                 <step:Value AttributeID="EmailField"></step:Value>
                              </step:Values>
                           </step:DataContainer>
                        </step:MultiDataContainer>
                     </step:DataContainers>
                  </ns1:Entity>
               </matchAndMergeRecord>
            </ns:matchAndMergeRequest>
         </soapenv:Body>
</soapenv:Envelope>

Response

REST

Copy

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
{
  "findSimilarExecutionReport": {
    "httpStatus": 200,
    "message": "Found similar records",
    "rejectedByBusinessRuleID": null,
    "businessRuleRejections": [],
    "httpReason": "OK"
  },
  "findSimilarResponses": [
    {
      "rank": 50,
      "entity": {
        "id": "283066",
        "name": "Coffee Supplier Inc",
        "objectType": "Supplier",
        "parent": "331676",
        "values": {
          "LegalName": {
            "calculated": false,
            "contextLocal": true,
            "inherited": null,
            "value": {
              "value": "Coffee Supplier Inc",
              "valueId": null,
              "unit": null
            }
          }
        },
        "references": {
          "CustomerSourceSystem": {
            "references": [
              {
                "contextLocal": true,
                "target": "SystemX",
                "targetType": "entity",
                "values": {
                  "SourceRecordID": {
                    "contextLocal": true,
                    "inherited": null,
                    "values": [
                      {
                        "value": "654-789",
                        "valueId": null,
                        "unit": null
                      }
                    ]
                  }
                },
                "inherited": null,
                "entity": null
              }
            ]
          }
        },
        "dataContainers": {}
      }
    }
  ]
}

SOAP

Copy

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns5:matchAndMergeResponse xmlns:ns2="http://stibo.com/step/ws/types/1.0" xmlns:ns3="http://www.stibosystems.com/step" xmlns:ns4="http://www.stibosystems.com/step/outputtemplate" xmlns:ns5="http://stibo.com/step/ws/matching/1.0">
         <matchAndMergeRecord CorrelationID="9">
            <ns2:status>PROCESSED</ns2:status>
            <ns2:potentialDuplicate>
               <ns2:rank>75.0</ns2:rank>
               <ns2:Entity UserTypeID="Supplier" ID="380879" ParentID="331676">
                  <ns3:EntityCrossReference EntityID="SystemX" Type="CustomerSourceSystem"/>
                  <ns3:Values>
                     <ns3:Value AttributeID="LegalName">002 Magazine</ns3:Value>
                  </ns3:Values>
                  <ns3:DataContainers>
                     <ns3:DataContainer Type="MainAddressDataContainer" ID="380880">
                        <ns3:Values>
                           <ns3:Value AttributeID="InputCountry">US</ns3:Value>
                           <ns3:Value AttributeID="InputState">TX</ns3:Value>
                           <ns3:Value AttributeID="InputCity">Houston</ns3:Value>
                           <ns3:Value AttributeID="InputZip">77002-2245</ns3:Value>
                           <ns3:Value Derived="true" AttributeID="CalcFormattedAddress">[No street]
Houston, TX, 77002-2245
US</ns3:Value>
                        </ns3:Values>
                     </ns3:DataContainer>
                  </ns3:DataContainers>
               </ns2:Entity>
            </ns2:potentialDuplicate>
            <ns2:potentialDuplicate>
               <ns2:rank>75.0</ns2:rank>
               <ns2:Entity UserTypeID="Supplier" ID="373711" ParentID="331676">
                  <ns3:EntityCrossReference EntityID="SystemX" Type="CustomerSourceSystem">
                     <ns3:MetaData>
                        <ns3:MultiValue AttributeID="SourceRecordID">
                           <ns3:Value>34348-69798</ns3:Value>
                        </ns3:MultiValue>
                     </ns3:MetaData>
                  </ns3:EntityCrossReference>
                  <ns3:Values>
                     <ns3:Value AttributeID="LegalName">002 Magazine</ns3:Value>
                  </ns3:Values>
                  <ns3:DataContainers>
                     <ns3:DataContainer Type="MainAddressDataContainer" ID="373712">
                        <ns3:Values>
                           <ns3:Value AttributeID="QualityIndex">A</ns3:Value>
                           <ns3:Value AttributeID="ValidationTime">2021-02-17 11:20:58</ns3:Value>
                           <ns3:Value AttributeID="InputStreet">101 Crawford St</ns3:Value>
                           <ns3:Value AttributeID="StandardizedStreet">101 Crawford St</ns3:Value>
                           <ns3:Value AttributeID="ValidationHash">-1366695206</ns3:Value>
                           <ns3:Value AttributeID="StandardizedCity">Houston</ns3:Value>
                           <ns3:Value AttributeID="ValidationResponse"><![CDATA[Loqate<multisep/>-1366695206<multisep/><lt/>?xml version="1.0" encoding="UTF-8"?<gt/>
<lt/>lqt<gt/>
  <lt/>status<gt/>OK<lt/>/status<gt/>
  <lt/>results<gt/>
    <lt/>result<gt/>
      <lt/>AQI<gt/>A<lt/>/AQI<gt/>
      <lt/>AVC<gt/>V44-I44-P8-100<lt/>/AVC<gt/>
      <lt/>Address1<gt/>101 Crawford St<lt/>/Address1<gt/>
      <lt/>Address2<gt/>Houston TX 77002-2245<lt/>/Address2<gt/>
      <lt/>AdministrativeArea<gt/>TX<lt/>/AdministrativeArea<gt/>
      <lt/>CountryName<gt/>United States<lt/>/CountryName<gt/>
      <lt/>DeliveryAddress<gt/>101 Crawford St<lt/>/DeliveryAddress<gt/>
      <lt/>DeliveryAddress1<gt/>101 Crawford St<lt/>/DeliveryAddress1<gt/>
      <lt/>GeoAccuracy<gt/>P4<lt/>/GeoAccuracy<gt/>
      <lt/>GeoDistance<gt/>0.0<lt/>/GeoDistance<gt/>
      <lt/>HyphenClass<gt/>C<lt/>/HyphenClass<gt/>
      <lt/>ISO3166-2<gt/>US<lt/>/ISO3166-2<gt/>
      <lt/>ISO3166-3<gt/>USA<lt/>/ISO3166-3<gt/>
      <lt/>ISO3166-N<gt/>840<lt/>/ISO3166-N<gt/>
      <lt/>Latitude<gt/>29.760260<lt/>/Latitude<gt/>
      <lt/>Locality<gt/>Houston<lt/>/Locality<gt/>
      <lt/>Longitude<gt/>-95.354410<lt/>/Longitude<gt/>
      <lt/>MatchRuleLabel<gt/>1<lt/>/MatchRuleLabel<gt/>
      <lt/>PostalCode<gt/>77002-2245<lt/>/PostalCode<gt/>
      <lt/>PostalCodePrimary<gt/>77002<lt/>/PostalCodePrimary<gt/>
      <lt/>PostalCodeSecondary<gt/>2245<lt/>/PostalCodeSecondary<gt/>
      <lt/>Premise<gt/>101<lt/>/Premise<gt/>
      <lt/>PremiseNumber<gt/>101<lt/>/PremiseNumber<gt/>
      <lt/>SubAdministrativeArea<gt/>Harris<lt/>/SubAdministrativeArea<gt/>
      <lt/>Thoroughfare<gt/>Crawford St<lt/>/Thoroughfare<gt/>
    <lt/>/result<gt/>
  <lt/>/results<gt/>
<lt/>/lqt<gt/>]]></ns3:Value>
                           <ns3:Value AttributeID="InputZip">77002-2245</ns3:Value>
                           <ns3:Value AttributeID="StandardizedState">TX</ns3:Value>
                           <ns3:Value AttributeID="QualityVerificationCode">V44-I44-P8-100</ns3:Value>
                           <ns3:Value AttributeID="StandardizedCountryISOCode">US</ns3:Value>
                           <ns3:Value AttributeID="StandardizedStreetNumber">101</ns3:Value>
                           <ns3:Value AttributeID="InputState">TX</ns3:Value>
                           <ns3:Value AttributeID="StandardizedZip">77002-2245</ns3:Value>
                           <ns3:Value AttributeID="InputCountry">US</ns3:Value>
                           <ns3:Value AttributeID="InputCity">Houston</ns3:Value>
                           <ns3:Value AttributeID="StandardizedFormattedAddress">101 Crawford St
Houston TX 77002-2245</ns3:Value>
                           <ns3:Value AttributeID="StandardizedCountry">United States</ns3:Value>
                           <ns3:Value AttributeID="StandardizedStreetName">Crawford St</ns3:Value>
                           <ns3:Value Derived="true" AttributeID="CalcFormattedAddress">101 Crawford St
Houston TX 77002-2245
United States</ns3:Value>
                        </ns3:Values>
                     </ns3:DataContainer>
                  </ns3:DataContainers>
               </ns2:Entity>
            </ns2:potentialDuplicate>
            <ns2:potentialDuplicate>
               <ns2:rank>75.0</ns2:rank>
               <ns2:Entity UserTypeID="Supplier" ID="379785" ParentID="331676">
                  <ns3:EntityCrossReference EntityID="SystemX" Type="CustomerSourceSystem"/>
                  <ns3:Values>
                     <ns3:Value AttributeID="LegalName">002 Magazine</ns3:Value>
                  </ns3:Values>
                  <ns3:DataContainers>
                     <ns3:DataContainer Type="MainAddressDataContainer" ID="379786">
                        <ns3:Values>
                           <ns3:Value AttributeID="InputCountry">US</ns3:Value>
                           <ns3:Value AttributeID="InputState">TX</ns3:Value>
                           <ns3:Value AttributeID="InputCity">Houston</ns3:Value>
                           <ns3:Value AttributeID="InputZip">77002-2245</ns3:Value>
                           <ns3:Value Derived="true" AttributeID="CalcFormattedAddress">[No street]
Houston, TX, 77002-2245
US</ns3:Value>
                        </ns3:Values>
                     </ns3:DataContainer>
                  </ns3:DataContainers>
               </ns2:Entity>
            </ns2:potentialDuplicate>
            <ns2:potentialDuplicate>
               <ns2:rank>75.0</ns2:rank>
               <ns2:Entity UserTypeID="Supplier" ID="379787" ParentID="331676">
                  <ns3:EntityCrossReference EntityID="SystemX" Type="CustomerSourceSystem"/>
                  <ns3:Values>
                     <ns3:Value AttributeID="LegalName">002 Magazine</ns3:Value>
                  </ns3:Values>
                  <ns3:DataContainers>
                     <ns3:DataContainer Type="MainAddressDataContainer" ID="379788">
                        <ns3:Values>
                           <ns3:Value AttributeID="InputCountry">US</ns3:Value>
                           <ns3:Value AttributeID="InputState">TX</ns3:Value>
                           <ns3:Value AttributeID="InputCity">Houston</ns3:Value>
                           <ns3:Value AttributeID="InputZip">77002-2245</ns3:Value>
                           <ns3:Value Derived="true" AttributeID="CalcFormattedAddress">[No street]
Houston, TX, 77002-2245
US</ns3:Value>
                        </ns3:Values>
                     </ns3:DataContainer>
                  </ns3:DataContainers>
               </ns2:Entity>
            </ns2:potentialDuplicate>
            <ns2:matchAndMergeExecutionReport>
               <ns2:operation>NEW</ns2:operation>
            </ns2:matchAndMergeExecutionReport>
            <ns2:Entity UserTypeID="Supplier" ID="381382" ParentID="331676">
               <ns3:EntityCrossReference EntityID="SystemX" Type="CustomerSourceSystem"/>
               <ns3:Values>
                  <ns3:Value AttributeID="LegalName">002 Magazine</ns3:Value>
               </ns3:Values>
               <ns3:DataContainers>
                  <ns3:DataContainer Type="MainAddressDataContainer" ID="381383">
                     <ns3:Values>
                        <ns3:Value AttributeID="InputCountry">US</ns3:Value>
                        <ns3:Value AttributeID="InputState">TX</ns3:Value>
                        <ns3:Value AttributeID="InputCity">Houston</ns3:Value>
                        <ns3:Value AttributeID="InputZip">77002-2245</ns3:Value>
                        <ns3:Value Derived="true" AttributeID="CalcFormattedAddress">[No street]
Houston, TX, 77002-2245
US</ns3:Value>
                     </ns3:Values>
                  </ns3:DataContainer>
               </ns3:DataContainers>
            </ns2:Entity>
         </matchAndMergeRecord>
      </ns5:matchAndMergeResponse>
   </S:Body>
</S:Envelope>