POST api/sales/WebBasket

Sends payment the payment information into the database

Request Information

URI Parameters

None.

Body Parameters

WebBasketModel
NameDescriptionTypeAdditional information
MarinaCode

Marina code where the basket should be posted

 string

None.
AccountCode

Account code the basket is for, either an AccountCode or BoatNo must be specified

 string

None.
BoatNo

Boat number linked to the basket, either an AccountCode or BoatNo must be specified

 integer

None.
PaymentValue

Value of the payment taken

 decimal number

None.
PaymentRef

Reference for the payment

 string

None.
PaymentSuccessful

Indicates if the payment was successful

 boolean

None.
PaymentMessage

Message to associate with the payment

 string

None.
PaymentType

Payment type code

 string

None.
WebBasketItems

List of WebBasketItems in the basket

 Collection of WebBasketItemModel

None.

Request Formats

application/json, text/json

Sample: 
{
  "marinaCode": "sample string 1",
  "accountCode": "sample string 2",
  "boatNo": 1,
  "paymentValue": 3.0,
  "paymentRef": "sample string 4",
  "paymentSuccessful": true,
  "paymentMessage": "sample string 6",
  "paymentType": "sample string 7",
  "webBasketItems": [
    {
      "productCode": "sample string 1",
      "benefitPackageId": 1,
      "quantity": 2.0,
      "totalValue": 3.0,
      "pointsUsed": 1
    },
    {
      "productCode": "sample string 1",
      "benefitPackageId": 1,
      "quantity": 2.0,
      "totalValue": 3.0,
      "pointsUsed": 1
    }
  ]
}

multipart/form-data

Sample: 
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="MarinaCode"

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

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="BoatNo"

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

3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="PaymentRef"

sample string 4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="PaymentSuccessful"

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

sample string 6
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="PaymentType"

sample string 7
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="WebBasketItems[0].ProductCode"

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

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="WebBasketItems[0].Quantity"

2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="WebBasketItems[0].TotalValue"

3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="WebBasketItems[0].PointsUsed"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="WebBasketItems[1].ProductCode"

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

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="WebBasketItems[1].Quantity"

2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="WebBasketItems[1].TotalValue"

3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="WebBasketItems[1].PointsUsed"

1
--MultipartDataMediaFormatterBoundary1q2w3e--

Response Information

Resource Description

string

Response Formats

application/json, text/json

Sample: 
"sample string 1"

multipart/form-data

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

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e--