POST v1/Returns

Add a new OrderReturn.

Request Information

URI Parameters

None.

Body Parameters

The OrderReturn data

Name	Description	Type	Additional information
CustomerComment	Gets or sets the customer comment.	string	Max length: 2147483647
OrderReturnRows	Gets or sets the order rows included in this Return.	Collection of OrderReturnRow	None.
Params	Gets or sets the parameters.	Collection of ReturnParameter	None.
CustomStatusId	Gets or sets the custom status id.	integer	None.
Id	Gets or sets the identifier.	integer	Must be 0 (for insert operations)
MainStatusId	Gets or sets the main status id.	integer	None.
OrderId	Gets or sets the Order identifier.	integer	Required
ReceivedDate	Gets or sets the received date.	date	None.
ClosedTimestamp	Gets or sets the closed timestamp.	date	None.
FollowUpTimestamp	Gets or sets the follow up timestamp.	date	None.
ReturnCode	Gets or sets the return code.	string	Required Max length: 50
WarehouseId	Gets or sets the Warehouse identifier.	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "CustomerComment": "sample string 3",
  "OrderReturnRows": [
    {
      "Id": 1,
      "OrderRowId": 2,
      "ProductCode": "sample string 3",
      "ProductName": "sample string 4",
      "Comment": "sample string 5",
      "CustomerComment": "sample string 6",
      "ReturnedQuantity": 1.0,
      "ApprovedQuantity": 1.0,
      "Resolution": 0,
      "ReturnReasonId": 1,
      "MainReturnRowStatusId": 1,
      "ReturnConditionId": 1,
      "ProductSelectionProductId": 1,
      "SupplierName": "sample string 7",
      "CustomReturnRowStatusId": 1,
      "StockItems": [
        {
          "Id": 1,
          "ProductId": 2,
          "LotNumber": "sample string 3",
          "ExpiryDate": "2026-01-11T16:13:16.1449209+01:00",
          "SerialNumber": "sample string 4"
        },
        {
          "Id": 1,
          "ProductId": 2,
          "LotNumber": "sample string 3",
          "ExpiryDate": "2026-01-11T16:13:16.1449209+01:00",
          "SerialNumber": "sample string 4"
        }
      ]
    },
    {
      "Id": 1,
      "OrderRowId": 2,
      "ProductCode": "sample string 3",
      "ProductName": "sample string 4",
      "Comment": "sample string 5",
      "CustomerComment": "sample string 6",
      "ReturnedQuantity": 1.0,
      "ApprovedQuantity": 1.0,
      "Resolution": 0,
      "ReturnReasonId": 1,
      "MainReturnRowStatusId": 1,
      "ReturnConditionId": 1,
      "ProductSelectionProductId": 1,
      "SupplierName": "sample string 7",
      "CustomReturnRowStatusId": 1,
      "StockItems": [
        {
          "Id": 1,
          "ProductId": 2,
          "LotNumber": "sample string 3",
          "ExpiryDate": "2026-01-11T16:13:16.1449209+01:00",
          "SerialNumber": "sample string 4"
        },
        {
          "Id": 1,
          "ProductId": 2,
          "LotNumber": "sample string 3",
          "ExpiryDate": "2026-01-11T16:13:16.1449209+01:00",
          "SerialNumber": "sample string 4"
        }
      ]
    }
  ],
  "Params": [
    {
      "Key": "sample string 1",
      "Value": "sample string 2",
      "DataType": 0,
      "DataTypeName": "String"
    },
    {
      "Key": "sample string 1",
      "Value": "sample string 2",
      "DataType": 0,
      "DataTypeName": "String"
    }
  ],
  "CustomStatusId": 1,
  "Id": 4,
  "MainStatusId": 1,
  "OrderId": 5,
  "ReceivedDate": "2026-01-11T16:13:16.1449209+01:00",
  "ClosedTimestamp": "2026-01-11T16:13:16.1449209+01:00",
  "FollowUpTimestamp": "2026-01-11T16:13:16.1449209+01:00",
  "ReturnCode": "sample string 6",
  "WarehouseId": 1
}

application/xml, text/xml

Sample:

<OrderReturnChanges xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <CustomStatusId>1</CustomStatusId>
  <Id>4</Id>
  <MainStatusId>1</MainStatusId>
  <OrderId>5</OrderId>
  <ReceivedDate>2026-01-11T16:13:16.1449209+01:00</ReceivedDate>
  <ClosedTimestamp>2026-01-11T16:13:16.1449209+01:00</ClosedTimestamp>
  <FollowUpTimestamp>2026-01-11T16:13:16.1449209+01:00</FollowUpTimestamp>
  <ReturnCode>sample string 6</ReturnCode>
  <WarehouseId>1</WarehouseId>
  <CustomerComment>sample string 3</CustomerComment>
  <OrderReturnRows>
    <OrderReturnRow>
      <Id>1</Id>
      <OrderRowId>2</OrderRowId>
      <ProductCode>sample string 3</ProductCode>
      <ProductName>sample string 4</ProductName>
      <Comment>sample string 5</Comment>
      <CustomerComment>sample string 6</CustomerComment>
      <ReturnedQuantity>1</ReturnedQuantity>
      <ApprovedQuantity>1</ApprovedQuantity>
      <Resolution>Undefined</Resolution>
      <ReturnReasonId>1</ReturnReasonId>
      <MainReturnRowStatusId>1</MainReturnRowStatusId>
      <ReturnConditionId>1</ReturnConditionId>
      <ProductSelectionProductId>1</ProductSelectionProductId>
      <SupplierName>sample string 7</SupplierName>
      <CustomReturnRowStatusId>1</CustomReturnRowStatusId>
      <StockItems>
        <StockItem>
          <Id>1</Id>
          <ProductId>2</ProductId>
          <LotNumber>sample string 3</LotNumber>
          <ExpiryDate>2026-01-11T16:13:16.1449209+01:00</ExpiryDate>
          <SerialNumber>sample string 4</SerialNumber>
        </StockItem>
        <StockItem>
          <Id>1</Id>
          <ProductId>2</ProductId>
          <LotNumber>sample string 3</LotNumber>
          <ExpiryDate>2026-01-11T16:13:16.1449209+01:00</ExpiryDate>
          <SerialNumber>sample string 4</SerialNumber>
        </StockItem>
      </StockItems>
    </OrderReturnRow>
    <OrderReturnRow>
      <Id>1</Id>
      <OrderRowId>2</OrderRowId>
      <ProductCode>sample string 3</ProductCode>
      <ProductName>sample string 4</ProductName>
      <Comment>sample string 5</Comment>
      <CustomerComment>sample string 6</CustomerComment>
      <ReturnedQuantity>1</ReturnedQuantity>
      <ApprovedQuantity>1</ApprovedQuantity>
      <Resolution>Undefined</Resolution>
      <ReturnReasonId>1</ReturnReasonId>
      <MainReturnRowStatusId>1</MainReturnRowStatusId>
      <ReturnConditionId>1</ReturnConditionId>
      <ProductSelectionProductId>1</ProductSelectionProductId>
      <SupplierName>sample string 7</SupplierName>
      <CustomReturnRowStatusId>1</CustomReturnRowStatusId>
      <StockItems>
        <StockItem>
          <Id>1</Id>
          <ProductId>2</ProductId>
          <LotNumber>sample string 3</LotNumber>
          <ExpiryDate>2026-01-11T16:13:16.1449209+01:00</ExpiryDate>
          <SerialNumber>sample string 4</SerialNumber>
        </StockItem>
        <StockItem>
          <Id>1</Id>
          <ProductId>2</ProductId>
          <LotNumber>sample string 3</LotNumber>
          <ExpiryDate>2026-01-11T16:13:16.1449209+01:00</ExpiryDate>
          <SerialNumber>sample string 4</SerialNumber>
        </StockItem>
      </StockItems>
    </OrderReturnRow>
  </OrderReturnRows>
  <Params>
    <Params>
      <Key>sample string 1</Key>
      <Value>sample string 2</Value>
      <DataType>String</DataType>
    </Params>
    <Params>
      <Key>sample string 1</Key>
      <Value>sample string 2</Value>
      <DataType>String</DataType>
    </Params>
  </Params>
</OrderReturnChanges>

Response Information

Resource Description

The OrderReturn object.

OrderReturn

Name	Description	Type	Additional information
CustomStatus	Gets or sets the custom status.	OrderReturnStatus	None.
CustomerComment	Gets or sets the customer comment.	string	Max length: 2147483647
MainStatus	Gets or sets the main status.	OrderReturnStatus	None.
OrderReturnRows	Gets or sets the order rows included in this Return.	Collection of OrderReturnRow	None.
Params	Gets or sets the parameters.	Collection of ReturnParameter	None.
ChangedTimestamp	Gets or sets the changed timestamp.	date	Required
CreatedTimestamp	Gets or sets the created timestamp.	date	Required
CustomStatusId	Gets or sets the custom status id.	integer	None.
Id	Gets or sets the identifier.	integer	Must be 0 (for insert operations)
MainStatusId	Gets or sets the main status id.	integer	None.
OrderId	Gets or sets the Order identifier.	integer	Required
ReceivedDate	Gets or sets the received date.	date	None.
ClosedTimestamp	Gets or sets the closed timestamp.	date	None.
FollowUpTimestamp	Gets or sets the follow up timestamp.	date	None.
ReturnCode	Gets or sets the return code.	string	Required Max length: 50
WarehouseId	Gets or sets the Warehouse identifier.	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "CustomStatus": {
    "Id": 1,
    "BaseStatusId": 2,
    "StatusTypeId": 3,
    "Name": "sample string 4"
  },
  "CustomerComment": "sample string 1",
  "MainStatus": {
    "Id": 1,
    "BaseStatusId": 2,
    "StatusTypeId": 3,
    "Name": "sample string 4"
  },
  "OrderReturnRows": [
    {
      "Id": 1,
      "OrderRowId": 2,
      "ProductCode": "sample string 3",
      "ProductName": "sample string 4",
      "Comment": "sample string 5",
      "CustomerComment": "sample string 6",
      "ReturnedQuantity": 1.0,
      "ApprovedQuantity": 1.0,
      "Resolution": 0,
      "ReturnReasonId": 1,
      "MainReturnRowStatusId": 1,
      "ReturnConditionId": 1,
      "ProductSelectionProductId": 1,
      "SupplierName": "sample string 7",
      "CustomReturnRowStatusId": 1,
      "StockItems": [
        {
          "Id": 1,
          "ProductId": 2,
          "LotNumber": "sample string 3",
          "ExpiryDate": "2026-01-11T16:13:16.1449209+01:00",
          "SerialNumber": "sample string 4"
        },
        {
          "Id": 1,
          "ProductId": 2,
          "LotNumber": "sample string 3",
          "ExpiryDate": "2026-01-11T16:13:16.1449209+01:00",
          "SerialNumber": "sample string 4"
        }
      ]
    },
    {
      "Id": 1,
      "OrderRowId": 2,
      "ProductCode": "sample string 3",
      "ProductName": "sample string 4",
      "Comment": "sample string 5",
      "CustomerComment": "sample string 6",
      "ReturnedQuantity": 1.0,
      "ApprovedQuantity": 1.0,
      "Resolution": 0,
      "ReturnReasonId": 1,
      "MainReturnRowStatusId": 1,
      "ReturnConditionId": 1,
      "ProductSelectionProductId": 1,
      "SupplierName": "sample string 7",
      "CustomReturnRowStatusId": 1,
      "StockItems": [
        {
          "Id": 1,
          "ProductId": 2,
          "LotNumber": "sample string 3",
          "ExpiryDate": "2026-01-11T16:13:16.1449209+01:00",
          "SerialNumber": "sample string 4"
        },
        {
          "Id": 1,
          "ProductId": 2,
          "LotNumber": "sample string 3",
          "ExpiryDate": "2026-01-11T16:13:16.1449209+01:00",
          "SerialNumber": "sample string 4"
        }
      ]
    }
  ],
  "Params": [
    {
      "Key": "sample string 1",
      "Value": "sample string 2",
      "DataType": 0,
      "DataTypeName": "String"
    },
    {
      "Key": "sample string 1",
      "Value": "sample string 2",
      "DataType": 0,
      "DataTypeName": "String"
    }
  ],
  "ChangedTimestamp": "2026-01-11T16:13:16.1449209+01:00",
  "CreatedTimestamp": "2026-01-11T16:13:16.1449209+01:00",
  "CustomStatusId": 1,
  "Id": 4,
  "MainStatusId": 1,
  "OrderId": 5,
  "ReceivedDate": "2026-01-11T16:13:16.1449209+01:00",
  "ClosedTimestamp": "2026-01-11T16:13:16.1449209+01:00",
  "FollowUpTimestamp": "2026-01-11T16:13:16.1449209+01:00",
  "ReturnCode": "sample string 6",
  "WarehouseId": 1
}

application/xml, text/xml

Sample:

<OrderReturn xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ChangedTimestamp>2026-01-11T16:13:16.1449209+01:00</ChangedTimestamp>
  <CreatedTimestamp>2026-01-11T16:13:16.1449209+01:00</CreatedTimestamp>
  <CustomStatusId>1</CustomStatusId>
  <Id>4</Id>
  <MainStatusId>1</MainStatusId>
  <OrderId>5</OrderId>
  <ReceivedDate>2026-01-11T16:13:16.1449209+01:00</ReceivedDate>
  <ClosedTimestamp>2026-01-11T16:13:16.1449209+01:00</ClosedTimestamp>
  <FollowUpTimestamp>2026-01-11T16:13:16.1449209+01:00</FollowUpTimestamp>
  <ReturnCode>sample string 6</ReturnCode>
  <WarehouseId>1</WarehouseId>
  <CustomStatus>
    <Id>1</Id>
    <BaseStatusId>2</BaseStatusId>
    <StatusTypeId>3</StatusTypeId>
    <Name>sample string 4</Name>
  </CustomStatus>
  <CustomerComment>sample string 1</CustomerComment>
  <MainStatus>
    <Id>1</Id>
    <BaseStatusId>2</BaseStatusId>
    <StatusTypeId>3</StatusTypeId>
    <Name>sample string 4</Name>
  </MainStatus>
  <OrderReturnRows>
    <OrderReturnRow>
      <Id>1</Id>
      <OrderRowId>2</OrderRowId>
      <ProductCode>sample string 3</ProductCode>
      <ProductName>sample string 4</ProductName>
      <Comment>sample string 5</Comment>
      <CustomerComment>sample string 6</CustomerComment>
      <ReturnedQuantity>1</ReturnedQuantity>
      <ApprovedQuantity>1</ApprovedQuantity>
      <Resolution>Undefined</Resolution>
      <ReturnReasonId>1</ReturnReasonId>
      <MainReturnRowStatusId>1</MainReturnRowStatusId>
      <ReturnConditionId>1</ReturnConditionId>
      <ProductSelectionProductId>1</ProductSelectionProductId>
      <SupplierName>sample string 7</SupplierName>
      <CustomReturnRowStatusId>1</CustomReturnRowStatusId>
      <StockItems>
        <StockItem>
          <Id>1</Id>
          <ProductId>2</ProductId>
          <LotNumber>sample string 3</LotNumber>
          <ExpiryDate>2026-01-11T16:13:16.1449209+01:00</ExpiryDate>
          <SerialNumber>sample string 4</SerialNumber>
        </StockItem>
        <StockItem>
          <Id>1</Id>
          <ProductId>2</ProductId>
          <LotNumber>sample string 3</LotNumber>
          <ExpiryDate>2026-01-11T16:13:16.1449209+01:00</ExpiryDate>
          <SerialNumber>sample string 4</SerialNumber>
        </StockItem>
      </StockItems>
    </OrderReturnRow>
    <OrderReturnRow>
      <Id>1</Id>
      <OrderRowId>2</OrderRowId>
      <ProductCode>sample string 3</ProductCode>
      <ProductName>sample string 4</ProductName>
      <Comment>sample string 5</Comment>
      <CustomerComment>sample string 6</CustomerComment>
      <ReturnedQuantity>1</ReturnedQuantity>
      <ApprovedQuantity>1</ApprovedQuantity>
      <Resolution>Undefined</Resolution>
      <ReturnReasonId>1</ReturnReasonId>
      <MainReturnRowStatusId>1</MainReturnRowStatusId>
      <ReturnConditionId>1</ReturnConditionId>
      <ProductSelectionProductId>1</ProductSelectionProductId>
      <SupplierName>sample string 7</SupplierName>
      <CustomReturnRowStatusId>1</CustomReturnRowStatusId>
      <StockItems>
        <StockItem>
          <Id>1</Id>
          <ProductId>2</ProductId>
          <LotNumber>sample string 3</LotNumber>
          <ExpiryDate>2026-01-11T16:13:16.1449209+01:00</ExpiryDate>
          <SerialNumber>sample string 4</SerialNumber>
        </StockItem>
        <StockItem>
          <Id>1</Id>
          <ProductId>2</ProductId>
          <LotNumber>sample string 3</LotNumber>
          <ExpiryDate>2026-01-11T16:13:16.1449209+01:00</ExpiryDate>
          <SerialNumber>sample string 4</SerialNumber>
        </StockItem>
      </StockItems>
    </OrderReturnRow>
  </OrderReturnRows>
  <Params>
    <Params>
      <Key>sample string 1</Key>
      <Value>sample string 2</Value>
      <DataType>String</DataType>
    </Params>
    <Params>
      <Key>sample string 1</Key>
      <Value>sample string 2</Value>
      <DataType>String</DataType>
    </Params>
  </Params>
</OrderReturn>