Create New Supplier and Contact Person

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

Required values to identify match

  • Legal Name
  • Address
  • First Name
  • Last Name
  • Email
  • Phone

New Supplier and Contact Person Web Service Request

REST

Copy
[
    {
        "correlationID": "50",
        "entity": {
            "objectType": "Supplier",
            "references": {
                "CustomerSourceSystem": {
                    "references": [
                        {
                            "target": "SystemX",
                            "targetType": "entity",
                            "values": {
                                "SourceRecordID": {
                                    "values": [
                                        {
                                            "value": "14678-45125"
                                        }
                                    ]
                                }
                            }
                        }
                    ]
                }
            },
         "dataContainers": {
                "MainAddressDataContainer": {
                    "dataContainers": [
                        {
                            "values": {
                                "InputCountry": {
                                    "value": {
                                        "value": "US"
                                    }
                                },
                                "InputStreet": {
                                    "value": {
                                        "value": "3301 Commerce Dr"
                                    }
                                }
                            }
                        }
                    ]
                }
            },
            "values": {
                "LegalName": {
                    "value": {
                        "value": "Atlanta Journal & Constitution"
                    }
                }
            }
        }
    },
    {
        "correlationID": "51",
        "entity": {
            "objectType": "ContactPerson",
            "references": {
                "ContactPersonSupplier": {
                    "references": [
                        {
                            "entity": {
                                "references": {
                                    "CustomerSourceSystem": {
                                        "references": [
                                            {
                                                "target": "SystemX",
                                                "targetType": "entity",
                                                "values": {
                                                    "SourceRecordID": {
                                                        "values": [
                                                            {
                                                                "value": "14678-45125"
                                                            }
                                                        ]
                                                    }
                                                }
                                            }
                                        ]
                                    }
                                }
                            },
                            "targetType": "entity"
                        }
                    ]
                },
                "CustomerSourceSystem": {
                    "references": [
                        {
                            "target": "SystemY",
                            "targetType": "entity",
                            "values": {
                                "SourceRecordID": {
                                    "values": [
                                        {
                                            "value": "14425-97336"
                                        }
                                    ]
                                }
                            }
                        }
                    ]
                }
            },
         "dataContainers": {
                "EmailDataContainer": {
                    "dataContainers": [
                        {
                            "values": {
                                "EmailField": {
                                    "value": {
                                        "value": "fangorn@hotmail.com"
                                    }
                                },
                                "EmailType": {
                                    "value": {
                                        "value": "Work"
                                    }
                                }
                            }
                        }
                    ]
                },
                "PhoneDataContainer": {
                    "dataContainers": [
                        {
                            "values": {
                                "PhoneNumber": {
                                    "value": {
                                        "value": "439-555-3033"
                                    }
                                },
                                "PhoneType": {
                                    "value": {
                                        "value": "Home"
                                    }
                                }
                            }
                        }
                    ]
                }
            },
            "values": {
                "FirstName": {
                    "value": {
                        "value": "Cheryl"
                    }
                },
                "LastName": {
                    "value": {
                        "value": "Vega"
                    }
                }
            }
        }
    }
]

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>SupplierAndContactRequest</webserviceConfigurationID>
         <!-- First Entity: Supplier -->
         <matchAndMergeRecord CorrelationID="50">
            <ns1:Entity UserTypeID="Supplier">
               <step:Name>Atlanta Journal &amp; Constitution</step:Name>
               <step:Entity/>
               <step:EntityCrossReference Type="CustomerSourceSystem" EntityID="SystemX">
                  <step:MetaData>
                     <step:Value AttributeID="SourceRecordID">14678-45125</step:Value>
                  </step:MetaData>
               </step:EntityCrossReference>
               <step:Values>
                  <step:Value AttributeID="LegalName">Atlanta Journal &amp; Constitution</step:Value>
               </step:Values>
               <step:DataContainers>
                  <step:DataContainer Type="MainAddressDataContainer">
                     <step:Values>
                        <step:Value AttributeID="InputCountry">US</step:Value>
                        <step:Value AttributeID="InputStreet">3301 Commerce Dr</step:Value>
                     </step:Values>
                  </step:DataContainer>
               </step:DataContainers>
            </ns1:Entity>
         </matchAndMergeRecord>
         
         <!-- Second Entity: ContactPerson -->
         <matchAndMergeRecord CorrelationID="51">
            <ns1:Entity UserTypeID="ContactPerson">
               <step:Name>Cheryl Vega</step:Name>
               <step:Entity/>
               
               <!-- Embedded Supplier as ContactPersonSupplier -->
               <step:EntityCrossReference Type="ContactPersonSupplier">
                  <step:Entity UserTypeID="Supplier">
                     <step:Entity/>
                     <step:EntityCrossReference Type="CustomerSourceSystem" EntityID="SystemX">
                        <step:MetaData>
                           <step:Value AttributeID="SourceRecordID">14678-45125</step:Value>
                        </step:MetaData>
                     </step:EntityCrossReference>
                  </step:Entity>
               </step:EntityCrossReference>
               
               <!-- Source system reference for ContactPerson -->
               <step:EntityCrossReference Type="CustomerSourceSystem" EntityID="SystemY">
                  <step:MetaData>
                     <step:Value AttributeID="SourceRecordID">14425-97336</step:Value>
                  </step:MetaData>
               </step:EntityCrossReference>
               
               <step:Values>
                  <step:Value AttributeID="FirstName">Cheryl</step:Value>
                  <step:Value AttributeID="LastName">Vega</step:Value>
               </step:Values>
               <step:DataContainers>
                  <step:MultiDataContainer Type="EmailDataContainer">
                     <step:DataContainer>
                        <step:Values>
                           <step:Value AttributeID="EmailField">fangorn@hotmail.com</step:Value>
                           <step:Value AttributeID="EmailType">Work</step:Value>
                        </step:Values>
                     </step:DataContainer>
                  </step:MultiDataContainer>
                  <step:MultiDataContainer Type="PhoneDataContainer">
                     <step:DataContainer>
                        <step:Values>
                           <step:Value AttributeID="PhoneNumber">439-555-3033</step:Value>
                           <step:Value AttributeID="PhoneType">Home</step:Value>
                        </step:Values>
                     </step:DataContainer>
                  </step:MultiDataContainer>
               </step:DataContainers>
            </ns1:Entity>
         </matchAndMergeRecord>
      </ns:matchAndMergeRequest>
   </soapenv:Body>
</soapenv:Envelope>

New Supplier and Contact Person Web Service Response

REST

Copy
{
  "matchAndMergeGeneralExecutionReport": {
    "httpStatus": 200,
    "message": null,
    "httpReason": "OK"
  },
  "matchAndMergeResponses": [
    {
      "correlationID": "50",
      "status": "PROCESSED",
      "potentialDuplicates": [],
      "matchAndMergeExecutionReport": {
        "operation": "NEW",
        "errorMessage": null,
        "rejectedByBusinessCondition": [],
        "rejectedByPotentialDuplicates": false
      },
      "entity": {
        "id": "832558",
        "name": null,
        "objectType": "Supplier",
        "parent": "331676",
        "values": {
          "LegalName": {
            "calculated": false,
            "contextLocal": true,
            "inherited": null,
            "value": {
              "value": "Atlanta Journal & Constitution",
              "valueId": null,
              "unit": null
            }
          }
        },
        "references": {
          "CustomerSourceSystem": {
            "references": [
              {
                "contextLocal": true,
                "target": "SystemX",
                "targetType": "entity",
                "values": {
                  "SourceRecordID": {
                    "contextLocal": true,
                    "inherited": null,
                    "values": [
                      {
                        "value": "14678-45125",
                        "valueId": null,
                        "unit": null
                      }
                    ]
                  }
                },
                "inherited": null,
                "entity": null
              }
            ]
          }
        },
        "dataContainers": {
          "MainAddressDataContainer": {
            "dataContainer": {
              "values": {
                "InputCountry": {
                  "calculated": false,
                  "contextLocal": true,
                  "inherited": null,
                  "value": {
                    "value": "US",
                    "valueId": null,
                    "unit": null
                  }
                },
                "InputStreet": {
                  "calculated": false,
                  "contextLocal": true,
                  "inherited": null,
                  "value": {
                    "value": "3301 Commerce Dr",
                    "valueId": null,
                    "unit": null
                  }
                }
              },
              "references": {}
            },
            "inherited": null
          }
        }
      }
    },
    {
      "correlationID": "51",
      "status": "PROCESSED",
      "potentialDuplicates": [],
      "matchAndMergeExecutionReport": {
        "operation": "NEW",
        "errorMessage": null,
        "rejectedByBusinessCondition": [],
        "rejectedByPotentialDuplicates": false
      },
      "entity": {
        "id": "832560",
        "name": null,
        "objectType": "ContactPerson",
        "parent": "111660",
        "values": {
          "LastName": {
            "calculated": false,
            "contextLocal": true,
            "inherited": null,
            "value": {
              "value": "Vega",
              "valueId": null,
              "unit": null
            }
          },
          "FirstName": {
            "calculated": false,
            "contextLocal": true,
            "inherited": null,
            "value": {
              "value": "Cheryl",
              "valueId": null,
              "unit": null
            }
          }
        },
        "references": {
          "CustomerSourceSystem": {
            "references": [
              {
                "contextLocal": true,
                "target": "SystemY",
                "targetType": "entity",
                "values": {
                  "SourceRecordID": {
                    "contextLocal": true,
                    "inherited": null,
                    "values": [
                      {
                        "value": "14425-97336",
                        "valueId": null,
                        "unit": null
                      }
                    ]
                  }
                },
                "inherited": null,
                "entity": null
              }
            ]
          }
        },
        "dataContainers": {
          "EmailDataContainer": {
            "dataContainers": [
              {
                "values": {
                  "EmailType": {
                    "calculated": false,
                    "contextLocal": true,
                    "inherited": null,
                    "value": {
                      "value": "Work",
                      "valueId": "Work",
                      "unit": null
                    }
                  },
                  "EmailField": {
                    "calculated": false,
                    "contextLocal": true,
                    "inherited": null,
                    "value": {
                      "value": "fangorn@hotmail.com",
                      "valueId": null,
                      "unit": null
                    }
                  }
                },
                "references": {}
              }
            ],
            "inherited": null
          },
          "PhoneDataContainer": {
            "dataContainers": [
              {
                "values": {
                  "PhoneNumber": {
                    "calculated": false,
                    "contextLocal": true,
                    "inherited": null,
                    "value": {
                      "value": "439-555-3033",
                      "valueId": null,
                      "unit": null
                    }
                  },
                  "PhoneType": {
                    "calculated": false,
                    "contextLocal": true,
                    "inherited": null,
                    "value": {
                      "value": "Home",
                      "valueId": null,
                      "unit": null
                    }
                  }
                },
                "references": {}
              }
            ],
            "inherited": null
          }
        }
      }
    }
  ]
}

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="50">
            <ns2:status>PROCESSED</ns2:status>
            <ns2:matchAndMergeExecutionReport>
               <ns2:operation>NEW</ns2:operation>
            </ns2:matchAndMergeExecutionReport>
            <ns2:Entity ParentID="331676" ID="832612" UserTypeID="Supplier">
               <ns3:Values>
                  <ns3:Value AttributeID="LegalName">Atlanta Journal &amp; Constitution</ns3:Value>
               </ns3:Values>
               <ns3:EntityCrossReference Type="CustomerSourceSystem" EntityID="SystemX">
                  <ns3:MetaData>
                     <ns3:MultiValue AttributeID="SourceRecordID">
                        <ns3:Value>14678-45125</ns3:Value>
                     </ns3:MultiValue>
                  </ns3:MetaData>
               </ns3:EntityCrossReference>
               <ns3:DataContainers>
                  <ns3:DataContainer ID="832613" Type="MainAddressDataContainer">
                     <ns3:Values>
                        <ns3:Value AttributeID="InputCountry">US</ns3:Value>
                        <ns3:Value AttributeID="InputStreet">3301 Commerce Dr</ns3:Value>
                        <ns3:Value AttributeID="CalcFormattedAddress" Derived="true">3301 Commerce Dr
United States</ns3:Value>
                     </ns3:Values>
                  </ns3:DataContainer>
               </ns3:DataContainers>
            </ns2:Entity>
         </matchAndMergeRecord>
         <matchAndMergeRecord CorrelationID="51">
            <ns2:status>PROCESSED</ns2:status>
            <ns2:matchAndMergeExecutionReport>
               <ns2:operation>NEW</ns2:operation>
            </ns2:matchAndMergeExecutionReport>
            <ns2:Entity ParentID="111660" ID="832614" UserTypeID="ContactPerson">
               <ns3:Values>
                  <ns3:Value AttributeID="LastName">Vega</ns3:Value>
                  <ns3:Value AttributeID="FirstName">Cheryl</ns3:Value>
               </ns3:Values>
               <ns3:EntityCrossReference Type="CustomerSourceSystem" EntityID="SystemY">
                  <ns3:MetaData>
                     <ns3:MultiValue AttributeID="SourceRecordID">
                        <ns3:Value>14425-97336</ns3:Value>
                     </ns3:MultiValue>
                  </ns3:MetaData>
               </ns3:EntityCrossReference>
               <ns3:DataContainers>
                  <ns3:MultiDataContainer Type="EmailDataContainer">
                     <ns3:DataContainer ID="832615">
                        <ns3:Values>
                           <ns3:Value AttributeID="EmailType" ID="Work">Work</ns3:Value>
                           <ns3:Value AttributeID="EmailField">fangorn@hotmail.com</ns3:Value>
                        </ns3:Values>
                     </ns3:DataContainer>
                  </ns3:MultiDataContainer>
                  <ns3:MultiDataContainer Type="PhoneDataContainer">
                     <ns3:DataContainer ID="832616">
                        <ns3:Values>
                           <ns3:Value AttributeID="PhoneNumber">439-555-3033</ns3:Value>
                           <ns3:Value AttributeID="PhoneType">Home</ns3:Value>
                        </ns3:Values>
                     </ns3:DataContainer>
                  </ns3:MultiDataContainer>
               </ns3:DataContainers>
            </ns2:Entity>
         </matchAndMergeRecord>
      </ns5:matchAndMergeResponse>
   </S:Body>
</S:Envelope>