POST api/Relation

Add or update Relation

Request Information

URI Parameters

None.

Body Parameters

Sales Order message

Name	Type	Additional information
Header	MessageHeader	None.
Relations	Collection of RelationEx	None.
Footer	MessageFooter	None.

Request Formats

application/json, text/json

Sample:

{
  "Header": {
    "Version": "string 1",
    "Identification": "string 2",
    "Sender": "string 3"
  },
  "Relations": [
    {
      "LinkIfExists": true,
      "UpdateIfExists": true,
      "CompanyIdentifier": "string 3",
      "RelationIdentifier": "string 4",
      "RelationGroupIdentifier": "string 5",
      "FirstName": "string 6",
      "MiddleName": "string 7",
      "LastName": "string 8",
      "FullName": "string 9",
      "Attention": "string 10",
      "Telephone": "string 11",
      "Mobilephone": "string 12",
      "Email": "string 13",
      "Street": "string 14",
      "Address2": "string 15",
      "Address3": "string 16",
      "HouseNumber": "string 17",
      "HouseNumberExtension": "string 18",
      "ZipCode": "string 19",
      "City": "string 20",
      "State": "string 21",
      "CountryCode": "s22",
      "LanguageCode": "s23",
      "VATNumber": "string 24",
      "ConsolidateOrders": true,
      "ConsolidateOrdersSpecified": true,
      "ConsolidateWithDelivery": true,
      "ConsolidateWithDeliverySpecified": true,
      "RelationType": "Customer",
      "BackendRepresentative": "string 27",
      "SendPreShipmentNotifications": true,
      "SendPreShipmentNotificationsSpecified": true,
      "PreferredPickUnitCode": "string 29",
      "PreferredPickUnitOnly": true,
      "PreferredPickUnitOnlySpecified": true,
      "References": [
        {
          "RelationCustomSettingType": 1,
          "Value": "string 2"
        },
        {
          "RelationCustomSettingType": 1,
          "Value": "string 2"
        }
      ],
      "CleanupRelationCustomSettings": true,
      "CleanupRelationCustomSettingsSpecified": true,
      "TemplateRelationIdentifier": "string 32"
    },
    {
      "LinkIfExists": true,
      "UpdateIfExists": true,
      "CompanyIdentifier": "string 3",
      "RelationIdentifier": "string 4",
      "RelationGroupIdentifier": "string 5",
      "FirstName": "string 6",
      "MiddleName": "string 7",
      "LastName": "string 8",
      "FullName": "string 9",
      "Attention": "string 10",
      "Telephone": "string 11",
      "Mobilephone": "string 12",
      "Email": "string 13",
      "Street": "string 14",
      "Address2": "string 15",
      "Address3": "string 16",
      "HouseNumber": "string 17",
      "HouseNumberExtension": "string 18",
      "ZipCode": "string 19",
      "City": "string 20",
      "State": "string 21",
      "CountryCode": "s22",
      "LanguageCode": "s23",
      "VATNumber": "string 24",
      "ConsolidateOrders": true,
      "ConsolidateOrdersSpecified": true,
      "ConsolidateWithDelivery": true,
      "ConsolidateWithDeliverySpecified": true,
      "RelationType": "Customer",
      "BackendRepresentative": "string 27",
      "SendPreShipmentNotifications": true,
      "SendPreShipmentNotificationsSpecified": true,
      "PreferredPickUnitCode": "string 29",
      "PreferredPickUnitOnly": true,
      "PreferredPickUnitOnlySpecified": true,
      "References": [
        {
          "RelationCustomSettingType": 1,
          "Value": "string 2"
        },
        {
          "RelationCustomSettingType": 1,
          "Value": "string 2"
        }
      ],
      "CleanupRelationCustomSettings": true,
      "CleanupRelationCustomSettingsSpecified": true,
      "TemplateRelationIdentifier": "string 32"
    }
  ],
  "Footer": {
    "TotalRecords": 1,
    "Records": 2
  }
}

application/xml, text/xml

Sample:

<PutRelationMessageRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Header>
    <Version>string 1</Version>
    <Identification>string 2</Identification>
    <Sender>string 3</Sender>
  </Header>
  <Relations>
    <RelationEx>
      <RelationIdentifier>string 4</RelationIdentifier>
      <RelationGroupIdentifier>string 5</RelationGroupIdentifier>
      <FirstName>string 6</FirstName>
      <MiddleName>string 7</MiddleName>
      <LastName>string 8</LastName>
      <FullName>string 9</FullName>
      <Attention>string 10</Attention>
      <Telephone>string 11</Telephone>
      <Mobilephone>string 12</Mobilephone>
      <Email>string 13</Email>
      <Street>string 14</Street>
      <Address2>string 15</Address2>
      <Address3>string 16</Address3>
      <HouseNumber>string 17</HouseNumber>
      <HouseNumberExtension>string 18</HouseNumberExtension>
      <ZipCode>string 19</ZipCode>
      <City>string 20</City>
      <State>string 21</State>
      <CountryCode>s22</CountryCode>
      <LanguageCode>s23</LanguageCode>
      <VATNumber>string 24</VATNumber>
      <ConsolidateOrders>true</ConsolidateOrders>
      <ConsolidateOrdersSpecified>true</ConsolidateOrdersSpecified>
      <ConsolidateWithDelivery>true</ConsolidateWithDelivery>
      <ConsolidateWithDeliverySpecified>true</ConsolidateWithDeliverySpecified>
      <RelationType>Customer</RelationType>
      <BackendRepresentative>string 27</BackendRepresentative>
      <SendPreShipmentNotifications>true</SendPreShipmentNotifications>
      <SendPreShipmentNotificationsSpecified>true</SendPreShipmentNotificationsSpecified>
      <PreferredPickUnitCode>string 29</PreferredPickUnitCode>
      <PreferredPickUnitOnly>true</PreferredPickUnitOnly>
      <PreferredPickUnitOnlySpecified>true</PreferredPickUnitOnlySpecified>
      <References>
        <RelationCustomSetting>
          <RelationCustomSettingType>1</RelationCustomSettingType>
          <Value>string 2</Value>
        </RelationCustomSetting>
        <RelationCustomSetting>
          <RelationCustomSettingType>1</RelationCustomSettingType>
          <Value>string 2</Value>
        </RelationCustomSetting>
      </References>
      <CleanupRelationCustomSettings>true</CleanupRelationCustomSettings>
      <CleanupRelationCustomSettingsSpecified>true</CleanupRelationCustomSettingsSpecified>
      <TemplateRelationIdentifier>string 32</TemplateRelationIdentifier>
      <LinkIfExists>true</LinkIfExists>
      <UpdateIfExists>true</UpdateIfExists>
      <CompanyIdentifier>string 3</CompanyIdentifier>
    </RelationEx>
    <RelationEx>
      <RelationIdentifier>string 4</RelationIdentifier>
      <RelationGroupIdentifier>string 5</RelationGroupIdentifier>
      <FirstName>string 6</FirstName>
      <MiddleName>string 7</MiddleName>
      <LastName>string 8</LastName>
      <FullName>string 9</FullName>
      <Attention>string 10</Attention>
      <Telephone>string 11</Telephone>
      <Mobilephone>string 12</Mobilephone>
      <Email>string 13</Email>
      <Street>string 14</Street>
      <Address2>string 15</Address2>
      <Address3>string 16</Address3>
      <HouseNumber>string 17</HouseNumber>
      <HouseNumberExtension>string 18</HouseNumberExtension>
      <ZipCode>string 19</ZipCode>
      <City>string 20</City>
      <State>string 21</State>
      <CountryCode>s22</CountryCode>
      <LanguageCode>s23</LanguageCode>
      <VATNumber>string 24</VATNumber>
      <ConsolidateOrders>true</ConsolidateOrders>
      <ConsolidateOrdersSpecified>true</ConsolidateOrdersSpecified>
      <ConsolidateWithDelivery>true</ConsolidateWithDelivery>
      <ConsolidateWithDeliverySpecified>true</ConsolidateWithDeliverySpecified>
      <RelationType>Customer</RelationType>
      <BackendRepresentative>string 27</BackendRepresentative>
      <SendPreShipmentNotifications>true</SendPreShipmentNotifications>
      <SendPreShipmentNotificationsSpecified>true</SendPreShipmentNotificationsSpecified>
      <PreferredPickUnitCode>string 29</PreferredPickUnitCode>
      <PreferredPickUnitOnly>true</PreferredPickUnitOnly>
      <PreferredPickUnitOnlySpecified>true</PreferredPickUnitOnlySpecified>
      <References>
        <RelationCustomSetting>
          <RelationCustomSettingType>1</RelationCustomSettingType>
          <Value>string 2</Value>
        </RelationCustomSetting>
        <RelationCustomSetting>
          <RelationCustomSettingType>1</RelationCustomSettingType>
          <Value>string 2</Value>
        </RelationCustomSetting>
      </References>
      <CleanupRelationCustomSettings>true</CleanupRelationCustomSettings>
      <CleanupRelationCustomSettingsSpecified>true</CleanupRelationCustomSettingsSpecified>
      <TemplateRelationIdentifier>string 32</TemplateRelationIdentifier>
      <LinkIfExists>true</LinkIfExists>
      <UpdateIfExists>true</UpdateIfExists>
      <CompanyIdentifier>string 3</CompanyIdentifier>
    </RelationEx>
  </Relations>
  <Footer>
    <TotalRecords>1</TotalRecords>
    <Records>2</Records>
  </Footer>
</PutRelationMessageRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Ok: Message with result. Invalid APIKey: HttpStatusCode.Conflict

PutRelationMessageResponse

Name	Type	Additional information
Header	MessageHeader	None.
RelationResult	Collection of RelationResult	None.
Footer	MessageFooter	None.

Response Formats

application/json, text/json

Sample:

{
  "Header": {
    "Version": "string 1",
    "Identification": "string 2",
    "Sender": "string 3"
  },
  "RelationResult": [
    {
      "CompanyIdentifier": "string 1",
      "RelationIdentifier": "string 2",
      "ProcessingStatus": "P",
      "RelationImportResult": "string 3"
    },
    {
      "CompanyIdentifier": "string 1",
      "RelationIdentifier": "string 2",
      "ProcessingStatus": "P",
      "RelationImportResult": "string 3"
    }
  ],
  "Footer": {
    "TotalRecords": 1,
    "Records": 2
  }
}

application/xml, text/xml

Sample:

<PutRelationMessageResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Header>
    <Version>string 1</Version>
    <Identification>string 2</Identification>
    <Sender>string 3</Sender>
  </Header>
  <RelationResult>
    <RelationResult>
      <CompanyIdentifier>string 1</CompanyIdentifier>
      <RelationIdentifier>string 2</RelationIdentifier>
      <ProcessingStatus>P</ProcessingStatus>
      <RelationImportResult>string 3</RelationImportResult>
    </RelationResult>
    <RelationResult>
      <CompanyIdentifier>string 1</CompanyIdentifier>
      <RelationIdentifier>string 2</RelationIdentifier>
      <ProcessingStatus>P</ProcessingStatus>
      <RelationImportResult>string 3</RelationImportResult>
    </RelationResult>
  </RelationResult>
  <Footer>
    <TotalRecords>1</TotalRecords>
    <Records>2</Records>
  </Footer>
</PutRelationMessageResponse>