POST api/Orders/InsertReturn

Use this to insert a return for one or more items on an existing order.

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
GoodwillGestureAmount	An amount of money to return to the customer unrelated to carriage or products. This may be to appease an unhappy customer.	decimal number	Range: inclusive between 0 and ∞
CarriageAmountGross		decimal number	Range: inclusive between 0 and ∞
RefundProducts		Collection of EskimoClassLibraries.clsOrderReturnLine	Required
OrderExternalIdentifier		string	None.
ReturnExternalIdentifier		string	None.
ReturnDate		date	None.
Order_ID		integer	None.
OrderType		integer	Required

Request Formats

application/json, text/json

Sample:

{
  "GoodwillGestureAmount": 1.0,
  "CarriageAmountGross": 2.0,
  "RefundProducts": [
    {
      "SKU": "sample string 1",
      "Qty": 2
    },
    {
      "SKU": "sample string 1",
      "Qty": 2
    }
  ],
  "OrderExternalIdentifier": "sample string 3",
  "ReturnExternalIdentifier": "sample string 4",
  "ReturnDate": "2025-11-04T03:38:53.9221391+00:00",
  "Order_ID": 6,
  "OrderType": 7
}

application/xml, text/xml

Sample:

<clsOrderReturn xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EskimoClassLibraries">
  <CarriageAmountGross>2</CarriageAmountGross>
  <GoodwillGestureAmount>1</GoodwillGestureAmount>
  <OrderExternalIdentifier>sample string 3</OrderExternalIdentifier>
  <OrderType>7</OrderType>
  <Order_ID>6</Order_ID>
  <RefundProducts>
    <clsOrderReturnLine>
      <Qty>2</Qty>
      <SKU>sample string 1</SKU>
    </clsOrderReturnLine>
    <clsOrderReturnLine>
      <Qty>2</Qty>
      <SKU>sample string 1</SKU>
    </clsOrderReturnLine>
  </RefundProducts>
  <ReturnDate>2025-11-04T03:38:53.9221391+00:00</ReturnDate>
  <ReturnExternalIdentifier>sample string 4</ReturnExternalIdentifier>
</clsOrderReturn>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

EskimoClassLibraries.clsSaleReference

Name	Description	Type	Additional information
TillNumber		integer	Required
StoreNumber	Shop Code that the sale is assigned to. See api/Shops/All	string	Required String length: inclusive between 3 and 3
ReceiptNumber		integer	Required Range: inclusive between 1 and 2147483647
Orders		Collection of EskimoClassLibraries.OrderReference	None.

Response Formats

application/json, text/json

Sample:

{
  "TillNumber": 1,
  "StoreNumber": "sample string 2",
  "ReceiptNumber": 3,
  "Orders": [
    {
      "ID": 1,
      "OrderType": 2
    },
    {
      "ID": 1,
      "OrderType": 2
    }
  ]
}

application/xml, text/xml

Sample:

<clsSaleReference xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EskimoClassLibraries">
  <Orders>
    <OrderReference>
      <ID>1</ID>
      <OrderType>2</OrderType>
    </OrderReference>
    <OrderReference>
      <ID>1</ID>
      <OrderType>2</OrderType>
    </OrderReference>
  </Orders>
  <ReceiptNumber>3</ReceiptNumber>
  <StoreNumber>sample string 2</StoreNumber>
  <TillNumber>1</TillNumber>
</clsSaleReference>