POST api/Sales/SaleReturnItems

Request Information

URI Parameters

None.

Body Parameters

EskimoClassLibraries.SaleReturnArguments
NameDescriptionTypeAdditional information
SaleReference

The reference of the original sale. If this originated from Eskimo, it will be in the format SSS-T-RRRRRR where S=Store Number, T=Till Number, R=Receipt Number

 string

None.
Line

Optional. Used mainly if scanning a gift receipt where only one of the lines from the original sale is present on the receipt.

 integer

None.
TillNumber

integer

Required
StoreNumber

string

Required

String length: inclusive between 3 and 3

Request Formats

application/json, text/json

Sample: 
{
  "SaleReference": "sample string 1",
  "Line": 1,
  "TillNumber": 2,
  "StoreNumber": "sample string 3"
}

application/xml, text/xml

Sample: 
<SaleReturnArguments xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EskimoClassLibraries">
  <Line>1</Line>
  <SaleReference>sample string 1</SaleReference>
  <StoreNumber>sample string 3</StoreNumber>
  <TillNumber>2</TillNumber>
</SaleReturnArguments>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

EskimoClassLibraries.clsSalesReturn
NameDescriptionTypeAdditional information
SaleDate

date

None.
Lines

Collection of EskimoClassLibraries.clsSalesReturnLine

None.
CarriageLine

EskimoClassLibraries.clsSalesCarriageReturnLine

None.

Response Formats

application/json, text/json

Sample: 
{
  "SaleDate": "2025-01-18T03:45:28.4231473+00:00",
  "Lines": [
    {
      "PLU": "sample string 1",
      "OriginalOrderQty": 2,
      "QtyRefunded": 3,
      "UnitWeight": 1.0,
      "SaleReference": "sample string 4",
      "Line": 5,
      "Description": "sample string 6",
      "UnitPricePaid": 7.0,
      "OtherInfo": "sample string 8",
      "VatID": 9
    },
    {
      "PLU": "sample string 1",
      "OriginalOrderQty": 2,
      "QtyRefunded": 3,
      "UnitWeight": 1.0,
      "SaleReference": "sample string 4",
      "Line": 5,
      "Description": "sample string 6",
      "UnitPricePaid": 7.0,
      "OtherInfo": "sample string 8",
      "VatID": 9
    }
  ],
  "CarriageLine": {
    "AmountRefunded": 1.0,
    "Description": "sample string 2",
    "UnitPricePaid": 3.0,
    "OtherInfo": "sample string 4",
    "VatID": 5
  }
}

application/xml, text/xml

Sample: 
<clsSalesReturn xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EskimoClassLibraries">
  <CarriageLine>
    <Description>sample string 2</Description>
    <OtherInfo>sample string 4</OtherInfo>
    <UnitPricePaid>3</UnitPricePaid>
    <VatID>5</VatID>
    <AmountRefunded>1</AmountRefunded>
  </CarriageLine>
  <Lines>
    <clsSalesReturnLine>
      <Description>sample string 6</Description>
      <OtherInfo>sample string 8</OtherInfo>
      <UnitPricePaid>7</UnitPricePaid>
      <VatID>9</VatID>
      <Line>5</Line>
      <OriginalOrderQty>2</OriginalOrderQty>
      <PLU>sample string 1</PLU>
      <QtyRefunded>3</QtyRefunded>
      <SaleReference>sample string 4</SaleReference>
      <UnitWeight>1</UnitWeight>
    </clsSalesReturnLine>
    <clsSalesReturnLine>
      <Description>sample string 6</Description>
      <OtherInfo>sample string 8</OtherInfo>
      <UnitPricePaid>7</UnitPricePaid>
      <VatID>9</VatID>
      <Line>5</Line>
      <OriginalOrderQty>2</OriginalOrderQty>
      <PLU>sample string 1</PLU>
      <QtyRefunded>3</QtyRefunded>
      <SaleReference>sample string 4</SaleReference>
      <UnitWeight>1</UnitWeight>
    </clsSalesReturnLine>
  </Lines>
  <SaleDate>2025-01-18T03:45:28.4231473+00:00</SaleDate>
</clsSalesReturn>