POST api/Relation?companyCode={companyCode}

Get Relations

Request Information

URI Parameters

Name	Description	Type	Additional information
companyCode	Company Identifier	string	Required

Body Parameters

List of Relation Identifiers

Collection of string

Request Formats

application/json, text/json

Sample:

[
  "string 1",
  "string 2"
]

application/xml, text/xml

Sample:

<ArrayOfString xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <string>string 1</string>
  <string>string 2</string>
</ArrayOfString>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Response message with requested Relation items. HttpStatusCode.Conflict when user isn't connected to Company

GetRelationMessageResponse

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

Response Formats

application/json, text/json

Sample:

{
  "Header": {
    "Version": "string 1",
    "Identification": "string 2",
    "Sender": "string 3"
  },
  "Relations": [
    {
      "CompanyIdentifier": "string 1",
      "CreationTime": "2025-12-06T03:58:04.9525806+01:00",
      "LastModificationTime": "2025-12-06T03:58:04.9525806+01:00",
      "LastModificationTimeSpecified": true,
      "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"
    },
    {
      "CompanyIdentifier": "string 1",
      "CreationTime": "2025-12-06T03:58:04.9525806+01:00",
      "LastModificationTime": "2025-12-06T03:58:04.9525806+01:00",
      "LastModificationTimeSpecified": true,
      "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:

<GetRelationMessageResponse 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>
    <RelationGetItem>
      <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>
      <CompanyIdentifier>string 1</CompanyIdentifier>
      <CreationTime>2025-12-06T03:58:04.9525806+01:00</CreationTime>
      <LastModificationTime>2025-12-06T03:58:04.9525806+01:00</LastModificationTime>
      <LastModificationTimeSpecified>true</LastModificationTimeSpecified>
    </RelationGetItem>
    <RelationGetItem>
      <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>
      <CompanyIdentifier>string 1</CompanyIdentifier>
      <CreationTime>2025-12-06T03:58:04.9525806+01:00</CreationTime>
      <LastModificationTime>2025-12-06T03:58:04.9525806+01:00</LastModificationTime>
      <LastModificationTimeSpecified>true</LastModificationTimeSpecified>
    </RelationGetItem>
  </Relations>
  <Footer>
    <TotalRecords>1</TotalRecords>
    <Records>2</Records>
  </Footer>
</GetRelationMessageResponse>