POST api/ReturnOrder?companyCode={companyCode}

Get Return Order Items

Request Information

URI Parameters

Name	Description	Type	Additional information
companyCode	Company Identifier	string	Required

Body Parameters

List of Return Order 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 Return Orders. HttpStatusCode.Conflict when user isn't connected to Company

GetReturnOrderMessageResponse

Name	Description	Type	Additional information
Header	Header item	MessageHeader	None.
ReturnOrders	List of Return Orders	Collection of ReturnOrderResponse	None.
Footer	Footer item	MessageFooter	None.

Response Formats

application/json, text/json

Sample:

{
  "Header": {
    "Version": "string 1",
    "Identification": "string 2",
    "Sender": "string 3"
  },
  "ReturnOrders": [
    {
      "ReturnOrderLines": [
        {
          "ReturnOrderLineStatus": "PendingApproval",
          "CreationTime": "2025-12-06T03:58:05.8305759+01:00",
          "LastModificationTime": "2025-12-06T03:58:05.8305759+01:00",
          "LastModificationTimeSpecified": true,
          "LineIdentifier": 3,
          "ProductIdentifier": "string 4",
          "Quantity": 5,
          "SerialNumber": "string 6",
          "Price": 1.0,
          "PriceSpecified": true,
          "DiscountPercentage": 1.0,
          "DiscountPercentageSpecified": true,
          "Remark": "string 9",
          "PackageType": "string 10",
          "SendCreateNotification": true,
          "DefaultDamageLocationIdentifier": "string 12",
          "DefaultScrapLocationIdentifier": "string 13",
          "DefaultWarehouseZoneIdentifier": "string 14",
          "StockBlockType": "None",
          "StockBlockTypeSpecified": true,
          "References": [
            {
              "PurchaseOrderReferenceType": 1,
              "Value": "string 2"
            },
            {
              "PurchaseOrderReferenceType": 1,
              "Value": "string 2"
            }
          ]
        },
        {
          "ReturnOrderLineStatus": "PendingApproval",
          "CreationTime": "2025-12-06T03:58:05.8305759+01:00",
          "LastModificationTime": "2025-12-06T03:58:05.8305759+01:00",
          "LastModificationTimeSpecified": true,
          "LineIdentifier": 3,
          "ProductIdentifier": "string 4",
          "Quantity": 5,
          "SerialNumber": "string 6",
          "Price": 1.0,
          "PriceSpecified": true,
          "DiscountPercentage": 1.0,
          "DiscountPercentageSpecified": true,
          "Remark": "string 9",
          "PackageType": "string 10",
          "SendCreateNotification": true,
          "DefaultDamageLocationIdentifier": "string 12",
          "DefaultScrapLocationIdentifier": "string 13",
          "DefaultWarehouseZoneIdentifier": "string 14",
          "StockBlockType": "None",
          "StockBlockTypeSpecified": true,
          "References": [
            {
              "PurchaseOrderReferenceType": 1,
              "Value": "string 2"
            },
            {
              "PurchaseOrderReferenceType": 1,
              "Value": "string 2"
            }
          ]
        }
      ],
      "CompanyIdentifier": "string 1",
      "ReturnOrderIdentifier": "string 2",
      "ReturnOrderTypeIdentifier": "string 3",
      "Relation": {
        "LinkIfExists": true,
        "UpdateIfExists": true,
        "RelationIdentifier": "string 3",
        "RelationGroupIdentifier": "string 4",
        "FirstName": "string 5",
        "MiddleName": "string 6",
        "LastName": "string 7",
        "FullName": "string 8",
        "Attention": "string 9",
        "Telephone": "string 10",
        "Mobilephone": "string 11",
        "Email": "string 12",
        "Street": "string 13",
        "Address2": "string 14",
        "Address3": "string 15",
        "HouseNumber": "string 16",
        "HouseNumberExtension": "string 17",
        "ZipCode": "string 18",
        "City": "string 19",
        "State": "string 20",
        "CountryCode": "s21",
        "LanguageCode": "s22",
        "VATNumber": "string 23",
        "ConsolidateOrders": true,
        "ConsolidateOrdersSpecified": true,
        "ConsolidateWithDelivery": true,
        "ConsolidateWithDeliverySpecified": true,
        "RelationType": "Customer",
        "BackendRepresentative": "string 26",
        "SendPreShipmentNotifications": true,
        "SendPreShipmentNotificationsSpecified": true,
        "PreferredPickUnitCode": "string 28",
        "PreferredPickUnitOnly": true,
        "PreferredPickUnitOnlySpecified": true,
        "References": [
          {
            "RelationCustomSettingType": 1,
            "Value": "string 2"
          },
          {
            "RelationCustomSettingType": 1,
            "Value": "string 2"
          }
        ],
        "CleanupRelationCustomSettings": true,
        "CleanupRelationCustomSettingsSpecified": true,
        "TemplateRelationIdentifier": "string 31"
      },
      "Remark": "string 4",
      "Email": "string 5",
      "CustomerReference": "string 6",
      "OrderCostAmount": 1.0,
      "OrderCostAmountSpecified": true,
      "OrderDiscountAmount": 1.0,
      "OrderDiscountAmountSpecified": true,
      "OrderReference": "string 9",
      "WarehouseIdentifier": "string 10",
      "DispatchIdentifier": "string 11"
    },
    {
      "ReturnOrderLines": [
        {
          "ReturnOrderLineStatus": "PendingApproval",
          "CreationTime": "2025-12-06T03:58:05.8305759+01:00",
          "LastModificationTime": "2025-12-06T03:58:05.8305759+01:00",
          "LastModificationTimeSpecified": true,
          "LineIdentifier": 3,
          "ProductIdentifier": "string 4",
          "Quantity": 5,
          "SerialNumber": "string 6",
          "Price": 1.0,
          "PriceSpecified": true,
          "DiscountPercentage": 1.0,
          "DiscountPercentageSpecified": true,
          "Remark": "string 9",
          "PackageType": "string 10",
          "SendCreateNotification": true,
          "DefaultDamageLocationIdentifier": "string 12",
          "DefaultScrapLocationIdentifier": "string 13",
          "DefaultWarehouseZoneIdentifier": "string 14",
          "StockBlockType": "None",
          "StockBlockTypeSpecified": true,
          "References": [
            {
              "PurchaseOrderReferenceType": 1,
              "Value": "string 2"
            },
            {
              "PurchaseOrderReferenceType": 1,
              "Value": "string 2"
            }
          ]
        },
        {
          "ReturnOrderLineStatus": "PendingApproval",
          "CreationTime": "2025-12-06T03:58:05.8305759+01:00",
          "LastModificationTime": "2025-12-06T03:58:05.8305759+01:00",
          "LastModificationTimeSpecified": true,
          "LineIdentifier": 3,
          "ProductIdentifier": "string 4",
          "Quantity": 5,
          "SerialNumber": "string 6",
          "Price": 1.0,
          "PriceSpecified": true,
          "DiscountPercentage": 1.0,
          "DiscountPercentageSpecified": true,
          "Remark": "string 9",
          "PackageType": "string 10",
          "SendCreateNotification": true,
          "DefaultDamageLocationIdentifier": "string 12",
          "DefaultScrapLocationIdentifier": "string 13",
          "DefaultWarehouseZoneIdentifier": "string 14",
          "StockBlockType": "None",
          "StockBlockTypeSpecified": true,
          "References": [
            {
              "PurchaseOrderReferenceType": 1,
              "Value": "string 2"
            },
            {
              "PurchaseOrderReferenceType": 1,
              "Value": "string 2"
            }
          ]
        }
      ],
      "CompanyIdentifier": "string 1",
      "ReturnOrderIdentifier": "string 2",
      "ReturnOrderTypeIdentifier": "string 3",
      "Relation": {
        "LinkIfExists": true,
        "UpdateIfExists": true,
        "RelationIdentifier": "string 3",
        "RelationGroupIdentifier": "string 4",
        "FirstName": "string 5",
        "MiddleName": "string 6",
        "LastName": "string 7",
        "FullName": "string 8",
        "Attention": "string 9",
        "Telephone": "string 10",
        "Mobilephone": "string 11",
        "Email": "string 12",
        "Street": "string 13",
        "Address2": "string 14",
        "Address3": "string 15",
        "HouseNumber": "string 16",
        "HouseNumberExtension": "string 17",
        "ZipCode": "string 18",
        "City": "string 19",
        "State": "string 20",
        "CountryCode": "s21",
        "LanguageCode": "s22",
        "VATNumber": "string 23",
        "ConsolidateOrders": true,
        "ConsolidateOrdersSpecified": true,
        "ConsolidateWithDelivery": true,
        "ConsolidateWithDeliverySpecified": true,
        "RelationType": "Customer",
        "BackendRepresentative": "string 26",
        "SendPreShipmentNotifications": true,
        "SendPreShipmentNotificationsSpecified": true,
        "PreferredPickUnitCode": "string 28",
        "PreferredPickUnitOnly": true,
        "PreferredPickUnitOnlySpecified": true,
        "References": [
          {
            "RelationCustomSettingType": 1,
            "Value": "string 2"
          },
          {
            "RelationCustomSettingType": 1,
            "Value": "string 2"
          }
        ],
        "CleanupRelationCustomSettings": true,
        "CleanupRelationCustomSettingsSpecified": true,
        "TemplateRelationIdentifier": "string 31"
      },
      "Remark": "string 4",
      "Email": "string 5",
      "CustomerReference": "string 6",
      "OrderCostAmount": 1.0,
      "OrderCostAmountSpecified": true,
      "OrderDiscountAmount": 1.0,
      "OrderDiscountAmountSpecified": true,
      "OrderReference": "string 9",
      "WarehouseIdentifier": "string 10",
      "DispatchIdentifier": "string 11"
    }
  ],
  "Footer": {
    "TotalRecords": 1,
    "Records": 2
  }
}

application/xml, text/xml

Sample:

<GetReturnOrderMessageResponse 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>
  <ReturnOrders>
    <ReturnOrderResponse>
      <CompanyIdentifier>string 1</CompanyIdentifier>
      <ReturnOrderIdentifier>string 2</ReturnOrderIdentifier>
      <ReturnOrderTypeIdentifier>string 3</ReturnOrderTypeIdentifier>
      <Relation>
        <RelationIdentifier>string 3</RelationIdentifier>
        <RelationGroupIdentifier>string 4</RelationGroupIdentifier>
        <FirstName>string 5</FirstName>
        <MiddleName>string 6</MiddleName>
        <LastName>string 7</LastName>
        <FullName>string 8</FullName>
        <Attention>string 9</Attention>
        <Telephone>string 10</Telephone>
        <Mobilephone>string 11</Mobilephone>
        <Email>string 12</Email>
        <Street>string 13</Street>
        <Address2>string 14</Address2>
        <Address3>string 15</Address3>
        <HouseNumber>string 16</HouseNumber>
        <HouseNumberExtension>string 17</HouseNumberExtension>
        <ZipCode>string 18</ZipCode>
        <City>string 19</City>
        <State>string 20</State>
        <CountryCode>s21</CountryCode>
        <LanguageCode>s22</LanguageCode>
        <VATNumber>string 23</VATNumber>
        <ConsolidateOrders>true</ConsolidateOrders>
        <ConsolidateOrdersSpecified>true</ConsolidateOrdersSpecified>
        <ConsolidateWithDelivery>true</ConsolidateWithDelivery>
        <ConsolidateWithDeliverySpecified>true</ConsolidateWithDeliverySpecified>
        <RelationType>Customer</RelationType>
        <BackendRepresentative>string 26</BackendRepresentative>
        <SendPreShipmentNotifications>true</SendPreShipmentNotifications>
        <SendPreShipmentNotificationsSpecified>true</SendPreShipmentNotificationsSpecified>
        <PreferredPickUnitCode>string 28</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 31</TemplateRelationIdentifier>
        <LinkIfExists>true</LinkIfExists>
        <UpdateIfExists>true</UpdateIfExists>
      </Relation>
      <Remark>string 4</Remark>
      <Email>string 5</Email>
      <CustomerReference>string 6</CustomerReference>
      <OrderCostAmount>1</OrderCostAmount>
      <OrderCostAmountSpecified>true</OrderCostAmountSpecified>
      <OrderDiscountAmount>1</OrderDiscountAmount>
      <OrderDiscountAmountSpecified>true</OrderDiscountAmountSpecified>
      <OrderReference>string 9</OrderReference>
      <WarehouseIdentifier>string 10</WarehouseIdentifier>
      <DispatchIdentifier>string 11</DispatchIdentifier>
      <ReturnOrderLines>
        <ReturnOrderLineResponse>
          <LineIdentifier>3</LineIdentifier>
          <ProductIdentifier>string 4</ProductIdentifier>
          <Quantity>5</Quantity>
          <SerialNumber>string 6</SerialNumber>
          <Price>1</Price>
          <PriceSpecified>true</PriceSpecified>
          <DiscountPercentage>1</DiscountPercentage>
          <DiscountPercentageSpecified>true</DiscountPercentageSpecified>
          <Remark>string 9</Remark>
          <PackageType>string 10</PackageType>
          <SendCreateNotification>true</SendCreateNotification>
          <DefaultDamageLocationIdentifier>string 12</DefaultDamageLocationIdentifier>
          <DefaultScrapLocationIdentifier>string 13</DefaultScrapLocationIdentifier>
          <DefaultWarehouseZoneIdentifier>string 14</DefaultWarehouseZoneIdentifier>
          <StockBlockType>None</StockBlockType>
          <StockBlockTypeSpecified>true</StockBlockTypeSpecified>
          <References>
            <ReturnOrderLineReference>
              <PurchaseOrderReferenceType>1</PurchaseOrderReferenceType>
              <Value>string 2</Value>
            </ReturnOrderLineReference>
            <ReturnOrderLineReference>
              <PurchaseOrderReferenceType>1</PurchaseOrderReferenceType>
              <Value>string 2</Value>
            </ReturnOrderLineReference>
          </References>
          <ReturnOrderLineStatus>PendingApproval</ReturnOrderLineStatus>
          <CreationTime>2025-12-06T03:58:05.8305759+01:00</CreationTime>
          <LastModificationTime>2025-12-06T03:58:05.8305759+01:00</LastModificationTime>
          <LastModificationTimeSpecified>true</LastModificationTimeSpecified>
        </ReturnOrderLineResponse>
        <ReturnOrderLineResponse>
          <LineIdentifier>3</LineIdentifier>
          <ProductIdentifier>string 4</ProductIdentifier>
          <Quantity>5</Quantity>
          <SerialNumber>string 6</SerialNumber>
          <Price>1</Price>
          <PriceSpecified>true</PriceSpecified>
          <DiscountPercentage>1</DiscountPercentage>
          <DiscountPercentageSpecified>true</DiscountPercentageSpecified>
          <Remark>string 9</Remark>
          <PackageType>string 10</PackageType>
          <SendCreateNotification>true</SendCreateNotification>
          <DefaultDamageLocationIdentifier>string 12</DefaultDamageLocationIdentifier>
          <DefaultScrapLocationIdentifier>string 13</DefaultScrapLocationIdentifier>
          <DefaultWarehouseZoneIdentifier>string 14</DefaultWarehouseZoneIdentifier>
          <StockBlockType>None</StockBlockType>
          <StockBlockTypeSpecified>true</StockBlockTypeSpecified>
          <References>
            <ReturnOrderLineReference>
              <PurchaseOrderReferenceType>1</PurchaseOrderReferenceType>
              <Value>string 2</Value>
            </ReturnOrderLineReference>
            <ReturnOrderLineReference>
              <PurchaseOrderReferenceType>1</PurchaseOrderReferenceType>
              <Value>string 2</Value>
            </ReturnOrderLineReference>
          </References>
          <ReturnOrderLineStatus>PendingApproval</ReturnOrderLineStatus>
          <CreationTime>2025-12-06T03:58:05.8305759+01:00</CreationTime>
          <LastModificationTime>2025-12-06T03:58:05.8305759+01:00</LastModificationTime>
          <LastModificationTimeSpecified>true</LastModificationTimeSpecified>
        </ReturnOrderLineResponse>
      </ReturnOrderLines>
    </ReturnOrderResponse>
    <ReturnOrderResponse>
      <CompanyIdentifier>string 1</CompanyIdentifier>
      <ReturnOrderIdentifier>string 2</ReturnOrderIdentifier>
      <ReturnOrderTypeIdentifier>string 3</ReturnOrderTypeIdentifier>
      <Relation>
        <RelationIdentifier>string 3</RelationIdentifier>
        <RelationGroupIdentifier>string 4</RelationGroupIdentifier>
        <FirstName>string 5</FirstName>
        <MiddleName>string 6</MiddleName>
        <LastName>string 7</LastName>
        <FullName>string 8</FullName>
        <Attention>string 9</Attention>
        <Telephone>string 10</Telephone>
        <Mobilephone>string 11</Mobilephone>
        <Email>string 12</Email>
        <Street>string 13</Street>
        <Address2>string 14</Address2>
        <Address3>string 15</Address3>
        <HouseNumber>string 16</HouseNumber>
        <HouseNumberExtension>string 17</HouseNumberExtension>
        <ZipCode>string 18</ZipCode>
        <City>string 19</City>
        <State>string 20</State>
        <CountryCode>s21</CountryCode>
        <LanguageCode>s22</LanguageCode>
        <VATNumber>string 23</VATNumber>
        <ConsolidateOrders>true</ConsolidateOrders>
        <ConsolidateOrdersSpecified>true</ConsolidateOrdersSpecified>
        <ConsolidateWithDelivery>true</ConsolidateWithDelivery>
        <ConsolidateWithDeliverySpecified>true</ConsolidateWithDeliverySpecified>
        <RelationType>Customer</RelationType>
        <BackendRepresentative>string 26</BackendRepresentative>
        <SendPreShipmentNotifications>true</SendPreShipmentNotifications>
        <SendPreShipmentNotificationsSpecified>true</SendPreShipmentNotificationsSpecified>
        <PreferredPickUnitCode>string 28</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 31</TemplateRelationIdentifier>
        <LinkIfExists>true</LinkIfExists>
        <UpdateIfExists>true</UpdateIfExists>
      </Relation>
      <Remark>string 4</Remark>
      <Email>string 5</Email>
      <CustomerReference>string 6</CustomerReference>
      <OrderCostAmount>1</OrderCostAmount>
      <OrderCostAmountSpecified>true</OrderCostAmountSpecified>
      <OrderDiscountAmount>1</OrderDiscountAmount>
      <OrderDiscountAmountSpecified>true</OrderDiscountAmountSpecified>
      <OrderReference>string 9</OrderReference>
      <WarehouseIdentifier>string 10</WarehouseIdentifier>
      <DispatchIdentifier>string 11</DispatchIdentifier>
      <ReturnOrderLines>
        <ReturnOrderLineResponse>
          <LineIdentifier>3</LineIdentifier>
          <ProductIdentifier>string 4</ProductIdentifier>
          <Quantity>5</Quantity>
          <SerialNumber>string 6</SerialNumber>
          <Price>1</Price>
          <PriceSpecified>true</PriceSpecified>
          <DiscountPercentage>1</DiscountPercentage>
          <DiscountPercentageSpecified>true</DiscountPercentageSpecified>
          <Remark>string 9</Remark>
          <PackageType>string 10</PackageType>
          <SendCreateNotification>true</SendCreateNotification>
          <DefaultDamageLocationIdentifier>string 12</DefaultDamageLocationIdentifier>
          <DefaultScrapLocationIdentifier>string 13</DefaultScrapLocationIdentifier>
          <DefaultWarehouseZoneIdentifier>string 14</DefaultWarehouseZoneIdentifier>
          <StockBlockType>None</StockBlockType>
          <StockBlockTypeSpecified>true</StockBlockTypeSpecified>
          <References>
            <ReturnOrderLineReference>
              <PurchaseOrderReferenceType>1</PurchaseOrderReferenceType>
              <Value>string 2</Value>
            </ReturnOrderLineReference>
            <ReturnOrderLineReference>
              <PurchaseOrderReferenceType>1</PurchaseOrderReferenceType>
              <Value>string 2</Value>
            </ReturnOrderLineReference>
          </References>
          <ReturnOrderLineStatus>PendingApproval</ReturnOrderLineStatus>
          <CreationTime>2025-12-06T03:58:05.8305759+01:00</CreationTime>
          <LastModificationTime>2025-12-06T03:58:05.8305759+01:00</LastModificationTime>
          <LastModificationTimeSpecified>true</LastModificationTimeSpecified>
        </ReturnOrderLineResponse>
        <ReturnOrderLineResponse>
          <LineIdentifier>3</LineIdentifier>
          <ProductIdentifier>string 4</ProductIdentifier>
          <Quantity>5</Quantity>
          <SerialNumber>string 6</SerialNumber>
          <Price>1</Price>
          <PriceSpecified>true</PriceSpecified>
          <DiscountPercentage>1</DiscountPercentage>
          <DiscountPercentageSpecified>true</DiscountPercentageSpecified>
          <Remark>string 9</Remark>
          <PackageType>string 10</PackageType>
          <SendCreateNotification>true</SendCreateNotification>
          <DefaultDamageLocationIdentifier>string 12</DefaultDamageLocationIdentifier>
          <DefaultScrapLocationIdentifier>string 13</DefaultScrapLocationIdentifier>
          <DefaultWarehouseZoneIdentifier>string 14</DefaultWarehouseZoneIdentifier>
          <StockBlockType>None</StockBlockType>
          <StockBlockTypeSpecified>true</StockBlockTypeSpecified>
          <References>
            <ReturnOrderLineReference>
              <PurchaseOrderReferenceType>1</PurchaseOrderReferenceType>
              <Value>string 2</Value>
            </ReturnOrderLineReference>
            <ReturnOrderLineReference>
              <PurchaseOrderReferenceType>1</PurchaseOrderReferenceType>
              <Value>string 2</Value>
            </ReturnOrderLineReference>
          </References>
          <ReturnOrderLineStatus>PendingApproval</ReturnOrderLineStatus>
          <CreationTime>2025-12-06T03:58:05.8305759+01:00</CreationTime>
          <LastModificationTime>2025-12-06T03:58:05.8305759+01:00</LastModificationTime>
          <LastModificationTimeSpecified>true</LastModificationTimeSpecified>
        </ReturnOrderLineResponse>
      </ReturnOrderLines>
    </ReturnOrderResponse>
  </ReturnOrders>
  <Footer>
    <TotalRecords>1</TotalRecords>
    <Records>2</Records>
  </Footer>
</GetReturnOrderMessageResponse>