Update Existing Supplier

The following section includes sample REST and SOAP XML request call as well as the XML response.

Required values to identify match

  • Legal Name
  • Address

Update Existing Supplier Web Service Request

REST

Copy
[{
        "correlationID": "1",
        "entity": {
            "objectType": "Supplier",
            "parent": "331676",
            "values": {
                "LegalName": {
                    "value": {
                        "value": "1 Day Sign Shop"
                    }
                }
            },
            "references": {
                "CustomerSourceSystem": {
                    "references": [{
                            "target": "SystemX",
                            "targetType": "entity",
                            "values": {
                                "SourceRecordID": {
                                    "values": [{
                                            "value": "23156-71588"
                                        }
                                    ]
                                }
                            }
                        }
                    ]
                }
            },
            "dataContainers": {
                "MainAddressDataContainer": {
                    "dataContainers": [{
                            "values": {
                                "InputStreet": {
                                    "value": {
                                        "value": "5945 Mission Gorge Rd # 6"
                                    }
                                },

                                "InputCountry": {
                                    "value": {
                                        "value": "US"
                                    }
                                },
                                "InputCity": {
                                    "value": {
                                        "value": "San Diego"
                                    }
                                },
                                "InputState": {
                                    "value": {
                                        "value": "CA"
                                    }
                                },
                                "InputZip": {
                                    "value": {
                                        "value": "92120"
                                    }
                                }
                            }
                        }

                    ]
                }
            }
        }
    }
]

SOAP

Copy
<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>SupplierRequest</webserviceConfigurationID>
         <matchAndMergeRecord CorrelationID="9">
            <ns1:Entity ParentID="331676" UserTypeID="Supplier">
               <step:Name></step:Name>
               <step:Entity/>
               <step:EntityCrossReference Type="CustomerSourceSystem" EntityID="SystemX">
                  <step:MetaData>
                     <step:Value AttributeID="SourceRecordID">23156-71588</step:Value>
                  </step:MetaData>
               </step:EntityCrossReference>
               <step:Values>
                  <step:Value AttributeID="LegalName">1 Day Sign Shop</step:Value>
               </step:Values>
               <step:DataContainers>
                  <step:DataContainer Type="MainAddressDataContainer">
                     <step:Values>
                        <step:Value AttributeID="InputStreet">5945 Mission Gorge Rd # 6</step:Value>
                        <step:Value AttributeID="InputCity">San Diego</step:Value>
                        <step:Value AttributeID="InputCountry">US</step:Value>
                        <step:Value AttributeID="InputState">CA</step:Value>
                        <step:Value AttributeID="InputZip">92120</step:Value>
                     </step:Values>
                  </step:DataContainer>
               </step:DataContainers>
            </ns1:Entity>
         </matchAndMergeRecord>
      </ns:matchAndMergeRequest>
   </soapenv:Body>
</soapenv:Envelope>

Update Existing Supplier Web Service Response

REST

Copy
{
  "matchAndMergeGeneralExecutionReport": {
    "httpStatus": 200,
    "message": null,
    "httpReason": "OK"
  },
  "matchAndMergeResponses": [
    {
      "correlationID": "1",
      "status": "PROCESSED",
      "potentialDuplicates": [],
      "matchAndMergeExecutionReport": {
        "operation": "UPDATE",
        "errorMessage": null,
        "rejectedByBusinessCondition": [],
        "rejectedByPotentialDuplicates": false
      },
      "entity": {
        "id": "373717",
        "name": null,
        "objectType": "Supplier",
        "parent": "331676",
        "values": {
          "LegalName": {
            "calculated": false,
            "contextLocal": true,
            "value": {
              "value": "1 Day Sign Shop",
              "valueId": null,
              "unit": null
            }
          }
        },
        "references": {
          "CustomerSourceSystem": {
            "references": [
              {
                "contextLocal": true,
                "target": "SystemX",
                "targetType": "entity",
                "values": {
                  "SourceRecordID": {
                    "contextLocal": true,
                    "values": [
                      {
                        "value": "23156-71588",
                        "valueId": null,
                        "unit": null
                      }
                    ]
                  }
                },
                "entity": null
              }
            ]
          }
        },
        "dataContainers": {
          "MainAddressDataContainer": {
            "dataContainer": {
              "values": {
                "InputStreet": {
                  "calculated": false,
                  "contextLocal": true,
                  "value": {
                    "value": "5945 Mission Gorge Rd # 6",
                    "valueId": null,
                    "unit": null
                  }
                },
                "InputCountry": {
                  "calculated": false,
                  "contextLocal": true,
                  "value": {
                    "value": "US",
                    "valueId": null,
                    "unit": null
                  }
                },
                "InputState": {
                  "calculated": false,
                  "contextLocal": true,
                  "value": {
                    "value": "CA",
                    "valueId": null,
                    "unit": null
                  }
                },
                "InputCity": {
                  "calculated": false,
                  "contextLocal": true,
                  "value": {
                    "value": "San Diego",
                    "valueId": null,
                    "unit": null
                  }
                },
                "InputZip": {
                  "calculated": false,
                  "contextLocal": true,
                  "value": {
                    "value": "92120",
                    "valueId": null,
                    "unit": null
                  }
                },
                "CalcFormattedAddress": {
                  "calculated": true,
                  "contextLocal": true,
                  "value": {
                    "value": "5945 Mission Gorge Rd # 6\nSan Diego, CA, 92120\nUS",
                    "valueId": null,
                    "unit": null
                  }
                }
              },
              "references": {}
            }
          }
        }
      }
    }
  ]
}

SOAP

Copy
<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:matchAndMergeExecutionReport>
               <ns2:operation>UPDATE</ns2:operation>
            </ns2:matchAndMergeExecutionReport>
            <ns2:Entity UserTypeID="Supplier" ID="373717" ParentID="331676">
               <ns3:EntityCrossReference EntityID="SystemX" Type="CustomerSourceSystem">
                  <ns3:MetaData>
                     <ns3:MultiValue AttributeID="SourceRecordID">
                        <ns3:Value>23156-71588</ns3:Value>
                     </ns3:MultiValue>
                  </ns3:MetaData>
               </ns3:EntityCrossReference>
               <ns3:Values>
                  <ns3:Value AttributeID="LegalName">1 Day Sign Shop</ns3:Value>
               </ns3:Values>
               <ns3:DataContainers>
                  <ns3:DataContainer Type="MainAddressDataContainer" ID="379748">
                     <ns3:Values>
                        <ns3:Value AttributeID="InputStreet">5945 Mission Gorge Rd # 6</ns3:Value>
                        <ns3:Value AttributeID="InputCountry">US</ns3:Value>
                        <ns3:Value AttributeID="InputState">CA</ns3:Value>
                        <ns3:Value AttributeID="InputCity">San Diego</ns3:Value>
                        <ns3:Value AttributeID="InputZip">92120</ns3:Value>
                        <ns3:Value Derived="true" AttributeID="CalcFormattedAddress">5945 Mission Gorge Rd # 6
San Diego, CA, 92120
US</ns3:Value>
                     </ns3:Values>
                  </ns3:DataContainer>
               </ns3:DataContainers>
            </ns2:Entity>
         </matchAndMergeRecord>
      </ns5:matchAndMergeResponse>
   </S:Body>
</S:Envelope>