POST api/delivery/confirmproductdelivery

Confirm delivery for a Product.

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
orderedProductId	integer	None.
orderId	integer	Required
productId	integer	Required
siteId	integer	Required
quantityDelivered	integer	Required
deliveredPrice	decimal number	Required
deliveredSupplierId	integer	Required

Request Formats

application/json, text/json

Sample:

{
  "orderedProductId": 1,
  "orderId": 1,
  "productId": 1,
  "siteId": 1,
  "quantityDelivered": 1,
  "deliveredPrice": 1.0,
  "deliveredSupplierId": 1
}

application/xml, text/xml

Sample:

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

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 'Product'.

multipart/form-data

Sample:

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

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

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

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

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

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

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

1
--MultipartDataMediaFormatterBoundary1q2w3e--

Response Information

Resource Description

ResponseOfProduct

Name	Type	Additional information
Message	string	None.
Success	boolean	None.
StatusCode	HttpStatusCode	None.
Data	Product	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": 1,
    "productId": 1,
    "siteId": 1,
    "quantityDelivered": 1,
    "deliveredPrice": 1.0,
    "deliveredSupplierId": 1
  },
  "errors": {
    "sample string 1": [
      "sample string 1",
      "sample string 2"
    ],
    "sample string 2": [
      "sample string 1",
      "sample string 2"
    ]
  }
}

application/xml, text/xml

Sample:

<ResponseOfProducthpmiEZBz 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.Request.Delivery">
    <d2p1:DeliveredPrice>1</d2p1:DeliveredPrice>
    <d2p1:DeliveredSupplierId>1</d2p1:DeliveredSupplierId>
    <d2p1:OrderId>1</d2p1:OrderId>
    <d2p1:OrderedProductId>1</d2p1:OrderedProductId>
    <d2p1:ProductId>1</d2p1:ProductId>
    <d2p1:QuantityDelivered>1</d2p1:QuantityDelivered>
    <d2p1:SiteId>1</d2p1:SiteId>
  </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>
</ResponseOfProducthpmiEZBz>

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.OrderedProductId"

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

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

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

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

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

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

1
--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--