POST api/Layaways/Insert
Inserts a layaway entry
Request Information
URI Parameters
None.
Body Parameters
EskimoClassLibraries.clsLayaway| Name | Description | Type | Additional information |
|---|---|---|---|
| TillNumber | integer |
Required |
|
| SourceCodeID | integer |
None. |
|
| MailOrderValues | EskimoClassLibraries.clsPreSaleMOBase |
None. |
|
| LayawaySource | EskimoClassLibraries.clsLayaway+LayawaySourceEnum |
None. |
|
| ID | integer |
None. |
|
| StoreID | string |
Required String length: inclusive between 3 and 3 |
|
| DateStored |
The date the layaway was created |
date |
None. |
| OperatorID |
The ID of the sales clerk (or operator) that performed the layaway |
string |
None. |
| Products | Collection of EskimoClassLibraries.clsPreSaleItemBase |
Required |
|
| CustomerID |
The Customer ID selected against the sale. |
string |
None. |
Request Formats
application/json, text/json
Sample:
{
"TillNumber": 1,
"SourceCodeID": 1,
"MailOrderValues": {
"Notes": "sample string 1",
"DeliveryNotes": "sample string 2",
"DeliveryAddressRef": "sample string 3",
"ShippingRateID": 4,
"ShippingValue": 5.0,
"OrderStatus": 6,
"RequestedDeliveryDate": "2025-11-04T03:38:55.8754631+00:00",
"ClickAndCollectShop": "sample string 8"
},
"LayawaySource": 0,
"ID": 1,
"StoreID": "sample string 2",
"DateStored": "2025-11-04T03:38:55.8754631+00:00",
"OperatorID": "sample string 4",
"Products": [
{
"OriginalOrderDetailID": 1,
"DepositAmount": 1.0,
"CustomerAction": 1,
"AdminOverrides": [
{
"PermID": 1,
"AdminOperatorID": "sample string 2",
"Timestamp": "2025-11-04T03:38:55.8754631+00:00"
},
{
"PermID": 1,
"AdminOperatorID": "sample string 2",
"Timestamp": "2025-11-04T03:38:55.8754631+00:00"
}
],
"LineID": 2,
"KitProductType": 1,
"KitParentLine": 1,
"RefundDetails": {
"OriginalSalesRef": "sample string 1",
"OriginalSalesLine": 2
},
"VatID": 1,
"PLU": "sample string 3",
"Qty": 4,
"UnitPrice": 2.5,
"FreeText": "sample string 5",
"LineDiscount": 6.0,
"LineDiscountPromo": 7.0,
"Description": "sample string 8",
"GiftCardDetails": {
"Activated": true,
"CardNumber": "sample string 2",
"CardSerial": "sample string 3",
"Reference": "sample string 4",
"Balance": 5.0,
"ExpiryDate": "2025-11-04T03:38:55.8754631+00:00"
},
"NoDiscountAllowed": true,
"LinePrice": 10.0
},
{
"OriginalOrderDetailID": 1,
"DepositAmount": 1.0,
"CustomerAction": 1,
"AdminOverrides": [
{
"PermID": 1,
"AdminOperatorID": "sample string 2",
"Timestamp": "2025-11-04T03:38:55.8754631+00:00"
},
{
"PermID": 1,
"AdminOperatorID": "sample string 2",
"Timestamp": "2025-11-04T03:38:55.8754631+00:00"
}
],
"LineID": 2,
"KitProductType": 1,
"KitParentLine": 1,
"RefundDetails": {
"OriginalSalesRef": "sample string 1",
"OriginalSalesLine": 2
},
"VatID": 1,
"PLU": "sample string 3",
"Qty": 4,
"UnitPrice": 2.5,
"FreeText": "sample string 5",
"LineDiscount": 6.0,
"LineDiscountPromo": 7.0,
"Description": "sample string 8",
"GiftCardDetails": {
"Activated": true,
"CardNumber": "sample string 2",
"CardSerial": "sample string 3",
"Reference": "sample string 4",
"Balance": 5.0,
"ExpiryDate": "2025-11-04T03:38:55.8754631+00:00"
},
"NoDiscountAllowed": true,
"LinePrice": 10.0
}
],
"CustomerID": "sample string 5"
}
application/xml, text/xml
Sample:
<clsLayaway xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EskimoClassLibraries">
<CustomerID>sample string 5</CustomerID>
<DateStored>2025-11-04T03:38:55.8754631+00:00</DateStored>
<ID>1</ID>
<OperatorID>sample string 4</OperatorID>
<Products>
<clsPreSaleItemBase>
<Description>sample string 8</Description>
<FreeText>sample string 5</FreeText>
<GiftCardDetails>
<Balance>5</Balance>
<CardNumber>sample string 2</CardNumber>
<CardSerial>sample string 3</CardSerial>
<ExpiryDate>2025-11-04T03:38:55.8754631+00:00</ExpiryDate>
<Reference>sample string 4</Reference>
<Activated>true</Activated>
</GiftCardDetails>
<LineDiscount>6</LineDiscount>
<LineDiscountPromo>7</LineDiscountPromo>
<LinePrice>10</LinePrice>
<NoDiscountAllowed>true</NoDiscountAllowed>
<PLU>sample string 3</PLU>
<Qty>4</Qty>
<AdminOverrides>
<clsAdminOverride>
<AdminOperatorID>sample string 2</AdminOperatorID>
<PermID>1</PermID>
<Timestamp>2025-11-04T03:38:55.8754631+00:00</Timestamp>
</clsAdminOverride>
<clsAdminOverride>
<AdminOperatorID>sample string 2</AdminOperatorID>
<PermID>1</PermID>
<Timestamp>2025-11-04T03:38:55.8754631+00:00</Timestamp>
</clsAdminOverride>
</AdminOverrides>
<CustomerAction>1</CustomerAction>
<DepositAmount>1</DepositAmount>
<KitParentLine>1</KitParentLine>
<KitProductType>FixedHeader</KitProductType>
<LineID>2</LineID>
<RefundDetails>
<OriginalSalesLine>2</OriginalSalesLine>
<OriginalSalesRef>sample string 1</OriginalSalesRef>
</RefundDetails>
<VatID>1</VatID>
<OriginalOrderDetailID>1</OriginalOrderDetailID>
</clsPreSaleItemBase>
<clsPreSaleItemBase>
<Description>sample string 8</Description>
<FreeText>sample string 5</FreeText>
<GiftCardDetails>
<Balance>5</Balance>
<CardNumber>sample string 2</CardNumber>
<CardSerial>sample string 3</CardSerial>
<ExpiryDate>2025-11-04T03:38:55.8754631+00:00</ExpiryDate>
<Reference>sample string 4</Reference>
<Activated>true</Activated>
</GiftCardDetails>
<LineDiscount>6</LineDiscount>
<LineDiscountPromo>7</LineDiscountPromo>
<LinePrice>10</LinePrice>
<NoDiscountAllowed>true</NoDiscountAllowed>
<PLU>sample string 3</PLU>
<Qty>4</Qty>
<AdminOverrides>
<clsAdminOverride>
<AdminOperatorID>sample string 2</AdminOperatorID>
<PermID>1</PermID>
<Timestamp>2025-11-04T03:38:55.8754631+00:00</Timestamp>
</clsAdminOverride>
<clsAdminOverride>
<AdminOperatorID>sample string 2</AdminOperatorID>
<PermID>1</PermID>
<Timestamp>2025-11-04T03:38:55.8754631+00:00</Timestamp>
</clsAdminOverride>
</AdminOverrides>
<CustomerAction>1</CustomerAction>
<DepositAmount>1</DepositAmount>
<KitParentLine>1</KitParentLine>
<KitProductType>FixedHeader</KitProductType>
<LineID>2</LineID>
<RefundDetails>
<OriginalSalesLine>2</OriginalSalesLine>
<OriginalSalesRef>sample string 1</OriginalSalesRef>
</RefundDetails>
<VatID>1</VatID>
<OriginalOrderDetailID>1</OriginalOrderDetailID>
</clsPreSaleItemBase>
</Products>
<StoreID>sample string 2</StoreID>
<LayawaySource>Default</LayawaySource>
<MailOrderValues>
<ClickAndCollectShop>sample string 8</ClickAndCollectShop>
<DeliveryAddressRef>sample string 3</DeliveryAddressRef>
<DeliveryNotes>sample string 2</DeliveryNotes>
<Notes>sample string 1</Notes>
<OrderStatus>6</OrderStatus>
<RequestedDeliveryDate>2025-11-04T03:38:55.8754631+00:00</RequestedDeliveryDate>
<ShippingRateID>4</ShippingRateID>
<ShippingValue>5</ShippingValue>
</MailOrderValues>
<SourceCodeID>1</SourceCodeID>
<TillNumber>1</TillNumber>
</clsLayaway>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
integerResponse Formats
application/json, text/json
Sample:
1
application/xml, text/xml
Sample:
<int xmlns="http://schemas.microsoft.com/2003/10/Serialization/">1</int>