POST v1/Returns

Add a new OrderReturn.

Request Information

Requires Authorization!

URI Parameters

None.

Body Parameters

The OrderReturn data

Name	Type	Additional information
CustomerComment	string	Max length: 2147483647
OrderReturnRows	Collection of OrderReturnRow	None.
Params	Collection of ReturnParameter	None.
CustomStatusId	integer	None.
Id	integer	Must be 0
MainStatusId	integer	None.
OrderId	integer	Required
ReceivedDate	date	None.
ClosedTimestamp	date	None.
FollowUpTimestamp	date	None.
ReturnCode	string	Required Max length: 50
WarehouseId	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
    },
    {
      "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
    }
  ],
  "Params": [
    {
      "Key": "sample string 1",
      "Value": "sample string 2",
      "DataType": 0
    },
    {
      "Key": "sample string 1",
      "Value": "sample string 2",
      "DataType": 0
    }
  ],
  "CustomStatusId": 1,
  "Id": 4,
  "MainStatusId": 1,
  "OrderId": 5,
  "ReceivedDate": "2021-12-02T20:19:37.7791155+01:00",
  "ClosedTimestamp": "2021-12-02T20:19:37.7791155+01:00",
  "FollowUpTimestamp": "2021-12-02T20:19:37.7791155+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>2021-12-02T20:19:37.7791155+01:00</ReceivedDate>
  <ClosedTimestamp>2021-12-02T20:19:37.7791155+01:00</ClosedTimestamp>
  <FollowUpTimestamp>2021-12-02T20:19:37.7791155+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>
    </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>
    </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	Type	Additional information
CustomStatus	OrderReturnStatus	None.
CustomerComment	string	Max length: 2147483647
MainStatus	OrderReturnStatus	None.
OrderReturnRows	Collection of OrderReturnRow	None.
Params	Collection of ReturnParameter	None.
ChangedTimestamp	date	Required
CreatedTimestamp	date	Required
CustomStatusId	integer	None.
Id	integer	Must be 0
MainStatusId	integer	None.
OrderId	integer	Required
ReceivedDate	date	None.
ClosedTimestamp	date	None.
FollowUpTimestamp	date	None.
ReturnCode	string	Required Max length: 50
WarehouseId	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
    },
    {
      "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
    }
  ],
  "Params": [
    {
      "Key": "sample string 1",
      "Value": "sample string 2",
      "DataType": 0
    },
    {
      "Key": "sample string 1",
      "Value": "sample string 2",
      "DataType": 0
    }
  ],
  "ChangedTimestamp": "2021-12-02T20:19:37.7947305+01:00",
  "CreatedTimestamp": "2021-12-02T20:19:37.7947305+01:00",
  "CustomStatusId": 1,
  "Id": 4,
  "MainStatusId": 1,
  "OrderId": 5,
  "ReceivedDate": "2021-12-02T20:19:37.7947305+01:00",
  "ClosedTimestamp": "2021-12-02T20:19:37.7947305+01:00",
  "FollowUpTimestamp": "2021-12-02T20:19:37.7947305+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>2021-12-02T20:19:37.7947305+01:00</ChangedTimestamp>
  <CreatedTimestamp>2021-12-02T20:19:37.7947305+01:00</CreatedTimestamp>
  <CustomStatusId>1</CustomStatusId>
  <Id>4</Id>
  <MainStatusId>1</MainStatusId>
  <OrderId>5</OrderId>
  <ReceivedDate>2021-12-02T20:19:37.7947305+01:00</ReceivedDate>
  <ClosedTimestamp>2021-12-02T20:19:37.7947305+01:00</ClosedTimestamp>
  <FollowUpTimestamp>2021-12-02T20:19:37.7947305+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>
    </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>
    </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>