POST api/delivery/createdeliveryproduct

Create a new delivery product.

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
siteId	integer	Required
orderId	integer	Required
productId	integer	Required
supplierId	integer	Required
deliveredPrice	decimal number	Required
deliveredQuantity	integer	Required

Request Formats

application/json, text/json

Sample:

{
  "siteId": 1,
  "orderId": 1,
  "productId": 1,
  "supplierId": 1,
  "deliveredPrice": 1.0,
  "deliveredQuantity": 1
}

application/xml, text/xml

Sample:

<CreateOrderProduct xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TillApi.DTOs.Request.Delivery">
  <DeliveredPrice>1</DeliveredPrice>
  <DeliveredQuantity>1</DeliveredQuantity>
  <OrderId>1</OrderId>
  <OrderedProductId>1</OrderedProductId>
  <ProductId>1</ProductId>
  <SiteId>1</SiteId>
  <SupplierId>1</SupplierId>
</CreateOrderProduct>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'CreateOrderProduct'.

multipart/form-data

Sample:

--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="SiteId"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="OrderId"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="ProductId"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="SupplierId"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="DeliveredPrice"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="DeliveredQuantity"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="OrderedProductId"

1
--MultipartDataMediaFormatterBoundary1q2w3e--

Response Information

Resource Description

ResponseOfOrderProduct

Name	Type	Additional information
Message	string	None.
Success	boolean	None.
StatusCode	HttpStatusCode	None.
Data	OrderProduct	None.
Errors	Dictionary of string [key] and Collection of string [value]	None.

Response Formats

application/json, text/json

Sample:

{
  "message": "sample string 1",
  "success": true,
  "statusCode": 100,
  "data": {
    "orderedProductId": 1,
    "orderId": 2,
    "quantityOrdered": 1,
    "orderedPrice": 1.0,
    "orderedInvoicePrice": 1.0,
    "quantityDelivered": 1.0,
    "deliveredPrice": 1.0,
    "deliveredBy": "sample string 3",
    "deliveredDate": "2025-12-06T03:14:35.6407455+00:00",
    "deliveredSupplier": {
      "key": 1,
      "value": "sample string 1"
    },
    "supplierNotes": {
      "1": "sample string 2",
      "3": "sample string 4"
    },
    "allSuppliers": {
      "1": "sample string 2",
      "3": "sample string 4"
    },
    "createdBy": "sample string 4",
    "createDate": "2025-12-06T03:14:35.642737+00:00",
    "dateReviewed": "2025-12-06T03:14:35.642737+00:00",
    "orderStatusId": 6,
    "isVariance": true,
    "productId": 8,
    "productName": "sample string 9",
    "categoryId": 10,
    "category": "sample string 11",
    "barcodeNumbers": {
      "1": "sample string 1"
    },
    "volume": "sample string 13",
    "unitId": 14,
    "unitMetric": "sample string 15",
    "packaged": true,
    "quantityPerPackage": 17,
    "sites": {
      "1": "sample string 1"
    },
    "suppliers": {
      "1": "sample string 1"
    },
    "tags": "sample string 18",
    "requiresVat": true,
    "weighedOnDelivery": true,
    "storageUrl": "sample string 19"
  },
  "errors": {
    "sample string 1": [
      "sample string 1",
      "sample string 2"
    ],
    "sample string 2": [
      "sample string 1",
      "sample string 2"
    ]
  }
}

application/xml, text/xml

Sample:

<ResponseOfOrderProductvhWbQmEI xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TillApi.DTOs.Response">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/TillApi.DTOs.Response.Delivery">
    <d2p1:BarcodeId>1</d2p1:BarcodeId>
    <d2p1:BarcodeNumber>sample string 12</d2p1:BarcodeNumber>
    <d2p1:BarcodeNumbers xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfNullableOfintstringRDHGY3MA>
        <d3p1:Key>1</d3p1:Key>
        <d3p1:Value>sample string 1</d3p1:Value>
      </d3p1:KeyValueOfNullableOfintstringRDHGY3MA>
    </d2p1:BarcodeNumbers>
    <d2p1:Category>sample string 11</d2p1:Category>
    <d2p1:Category_Id>10</d2p1:Category_Id>
    <d2p1:ImageUrl>sample string 19</d2p1:ImageUrl>
    <d2p1:Packaged>true</d2p1:Packaged>
    <d2p1:Product_Id>8</d2p1:Product_Id>
    <d2p1:Product_Name>sample string 9</d2p1:Product_Name>
    <d2p1:Quantity_Per_Package>17</d2p1:Quantity_Per_Package>
    <d2p1:RequiresVat>true</d2p1:RequiresVat>
    <d2p1:Site_Id>1</d2p1:Site_Id>
    <d2p1:Site_Name>sample string 21</d2p1:Site_Name>
    <d2p1:Sites xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfNullableOfintstringRDHGY3MA>
        <d3p1:Key>1</d3p1:Key>
        <d3p1:Value>sample string 1</d3p1:Value>
      </d3p1:KeyValueOfNullableOfintstringRDHGY3MA>
    </d2p1:Sites>
    <d2p1:Supplier_Id>1</d2p1:Supplier_Id>
    <d2p1:Supplier_Name>sample string 20</d2p1:Supplier_Name>
    <d2p1:Suppliers xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfNullableOfintstringRDHGY3MA>
        <d3p1:Key>1</d3p1:Key>
        <d3p1:Value>sample string 1</d3p1:Value>
      </d3p1:KeyValueOfNullableOfintstringRDHGY3MA>
    </d2p1:Suppliers>
    <d2p1:Tags>sample string 18</d2p1:Tags>
    <d2p1:Unit_Id>14</d2p1:Unit_Id>
    <d2p1:Unit_Metric>sample string 15</d2p1:Unit_Metric>
    <d2p1:Volume>sample string 13</d2p1:Volume>
    <d2p1:WeighedOnDelivery>true</d2p1:WeighedOnDelivery>
    <d2p1:AllSuppliers xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfintstring>
        <d3p1:Key>1</d3p1:Key>
        <d3p1:Value>sample string 2</d3p1:Value>
      </d3p1:KeyValueOfintstring>
      <d3p1:KeyValueOfintstring>
        <d3p1:Key>3</d3p1:Key>
        <d3p1:Value>sample string 4</d3p1:Value>
      </d3p1:KeyValueOfintstring>
    </d2p1:AllSuppliers>
    <d2p1:Create_Date>2025-12-06T03:14:35.642737+00:00</d2p1:Create_Date>
    <d2p1:Created_By>sample string 4</d2p1:Created_By>
    <d2p1:Date_Delivered>2025-12-06T03:14:35.6407455+00:00</d2p1:Date_Delivered>
    <d2p1:Date_Reviewed>2025-12-06T03:14:35.642737+00:00</d2p1:Date_Reviewed>
    <d2p1:DeliveredSupplier xmlns:d3p1="http://schemas.datacontract.org/2004/07/System.Collections.Generic">
      <d3p1:key>1</d3p1:key>
      <d3p1:value>sample string 1</d3p1:value>
    </d2p1:DeliveredSupplier>
    <d2p1:Delivered_By>sample string 3</d2p1:Delivered_By>
    <d2p1:Delivered_Price>1</d2p1:Delivered_Price>
    <d2p1:Id>1</d2p1:Id>
    <d2p1:IsVariance>true</d2p1:IsVariance>
    <d2p1:Order_Id>2</d2p1:Order_Id>
    <d2p1:Order_Status_Id>6</d2p1:Order_Status_Id>
    <d2p1:Ordered_Invoice_Price>1</d2p1:Ordered_Invoice_Price>
    <d2p1:Ordered_Price>1</d2p1:Ordered_Price>
    <d2p1:Quantity_Delivered>1</d2p1:Quantity_Delivered>
    <d2p1:Quantity_Ordered>1</d2p1:Quantity_Ordered>
    <d2p1:SupplierNotes xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfintstring>
        <d3p1:Key>1</d3p1:Key>
        <d3p1:Value>sample string 2</d3p1:Value>
      </d3p1:KeyValueOfintstring>
      <d3p1:KeyValueOfintstring>
        <d3p1:Key>3</d3p1:Key>
        <d3p1:Value>sample string 4</d3p1:Value>
      </d3p1:KeyValueOfintstring>
    </d2p1:SupplierNotes>
  </Data>
  <Errors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringArrayOfstringty7Ep6D1>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>
        <d2p1:string>sample string 1</d2p1:string>
        <d2p1:string>sample string 2</d2p1:string>
      </d2p1:Value>
    </d2p1:KeyValueOfstringArrayOfstringty7Ep6D1>
    <d2p1:KeyValueOfstringArrayOfstringty7Ep6D1>
      <d2p1:Key>sample string 2</d2p1:Key>
      <d2p1:Value>
        <d2p1:string>sample string 1</d2p1:string>
        <d2p1:string>sample string 2</d2p1:string>
      </d2p1:Value>
    </d2p1:KeyValueOfstringArrayOfstringty7Ep6D1>
  </Errors>
  <Message>sample string 1</Message>
  <StatusCode>Continue</StatusCode>
  <Success>true</Success>
</ResponseOfOrderProductvhWbQmEI>

multipart/form-data

Sample:

--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Message"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Success"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="StatusCode"

Continue
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data.Id"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data.Order_Id"

2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data.Quantity_Ordered"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data.Ordered_Price"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data.Ordered_Invoice_Price"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data.Quantity_Delivered"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data.Delivered_Price"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data.Delivered_By"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data.Date_Delivered"

2025-12-06T03:14:35.6407455+00:00
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data.DeliveredSupplier.Key"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data.DeliveredSupplier.Value"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data.SupplierNotes[0].Key"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data.SupplierNotes[0].Value"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data.SupplierNotes[1].Key"

3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data.SupplierNotes[1].Value"

sample string 4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data.AllSuppliers[0].Key"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data.AllSuppliers[0].Value"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data.AllSuppliers[1].Key"

3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data.AllSuppliers[1].Value"

sample string 4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data.Created_By"

sample string 4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data.Create_Date"

2025-12-06T03:14:35.6427370+00:00
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data.Date_Reviewed"

2025-12-06T03:14:35.6427370+00:00
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data.Order_Status_Id"

6
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data.IsVariance"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data.Product_Id"

8
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data.Product_Name"

sample string 9
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data.Category_Id"

10
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data.Category"

sample string 11
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data.BarcodeNumbers[0].Key"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data.BarcodeNumbers[0].Value"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data.BarcodeNumber"

sample string 12
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data.BarcodeId"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data.Volume"

sample string 13
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data.Unit_Id"

14
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data.Unit_Metric"

sample string 15
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data.Packaged"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data.Quantity_Per_Package"

17
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data.Sites[0].Key"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data.Sites[0].Value"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data.Suppliers[0].Key"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data.Suppliers[0].Value"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data.Tags"

sample string 18
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data.RequiresVat"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data.WeighedOnDelivery"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data.ImageUrl"

sample string 19
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data.Supplier_Id"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data.Supplier_Name"

sample string 20
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data.Site_Id"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data.Site_Name"

sample string 21
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Errors[0].Key"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Errors[0].Value[0]"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Errors[0].Value[1]"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Errors[1].Key"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Errors[1].Value[0]"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Errors[1].Value[1]"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e--