Validates cart and returns information related to cart totals, validation messages.
1 min
POST
/api/episerver/v3.0/me/carts/{cartId}/preparecheckout
Path Parameters
- cartIdinteger<int32>requiredDescriptionFormatint32
Header Parameters
- acceptstringDescriptionDefaultapplication/jsonAllowedapplication/jsonapplication/problem+json
Responses
200
- checkoutDescription
- cartcartDescription
- idinteger<int32>DescriptionFormatint32
- namestringrequiredDescription
- customerIdstring<uuid>DescriptionFormatuuid
- marketstringrequiredDescription
- currencystringrequiredDescription
- lastUpdatedstring<date-time>DescriptionFormatdate-time
- shipmentsshipment[]Description
- idinteger<int32>DescriptionFormatint32
- shippingAddressaddressDescription
- firstNamestringDescription
- lastNamestringDescription
- line1stringDescription
- line2stringDescription
- citystringDescription
- countryNamestringDescription
- countryCodestringDescription
- postalCodestringDescription
- regionNamestringDescription
- emailstringDescription
- phoneNumberstringDescription
- namestringDescription
- shippingMethodIdstring<uuid>DescriptionFormatuuid
- lineItemslineItem[]Description
- idinteger<int32>DescriptionFormatint32
- contentIdstring<uuid>DescriptionFormatuuid
- codestringDescription
- placedPricenumber<decimal>DescriptionFormatdecimal
- quantitynumber<decimal>requiredDescriptionFormatdecimal
- displayNamestringDescription
- isGiftbooleanDescription
- paymentspayment[]Description
- amountnumber<decimal>DescriptionFormatdecimal
- authorizationCodestringDescription
- billingAddressaddressDescription
- firstNamestringDescription
- lastNamestringDescription
- line1stringDescription
- line2stringDescription
- citystringDescription
- countryNamestringDescription
- countryCodestringDescription
- postalCodestringDescription
- regionNamestringDescription
- emailstringDescription
- phoneNumberstringDescription
- namestringDescription
- savedBillingAddressNamestringDescription
- customerNamestringDescription
- paymentIdinteger<int32>DescriptionFormatint32
- systemKeywordstringDescription
- paymentTypestringDescription
- providerTransactionIDstringDescription
- statusstringDescription
- transactionIDstringDescription
- transactionTypestringDescription
- validationCodestringDescription
- extendedPropertiesextendedProperty[]Description
- namestringDescription
- valuestringDescription
- couponCodesstring[]Description
- totalstotalsDescription
- totalnumber<decimal>DescriptionFormatdecimal
- subTotalnumber<decimal>DescriptionFormatdecimal
- shippingTotalnumber<decimal>DescriptionFormatdecimal
- handlingTotalnumber<decimal>DescriptionFormatdecimal
- taxTotalnumber<decimal>DescriptionFormatdecimal
- discountTotalnumber<decimal>DescriptionFormatdecimal
- shippingTotalsshippingTotals[]Description
- shipmentIdinteger<int32>DescriptionFormatint32
- shippingCostnumber<decimal>DescriptionFormatdecimal
- shippingTaxnumber<decimal>DescriptionFormatdecimal
- itemsTotalnumber<decimal>DescriptionFormatdecimal
- lineItemPriceslineItemPrices[]Description
- lineItemIdinteger<int32>DescriptionFormatint32
- extendedPricenumber<decimal>DescriptionFormatdecimal
- discountedPricenumber<decimal>DescriptionFormatdecimal
- availableShippingMethodsshippingMethod[]Description
- shipmentIdinteger<int32>DescriptionFormatint32
- idstring<uuid>DescriptionFormatuuid
- displayNamestringDescription
- pricenumber<decimal>DescriptionFormatdecimal
- validationIssueslineItemValidation[]Description
- contentIdstring<uuid>DescriptionFormatuuid
- codestringDescription
- validationIssuesstring[]Description
400
403
404
curl
curl --request POST \
--url /api/episerver/v3.0/me/carts/{cartId}/preparecheckout \
--header 'accept: application/json'javascript
var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
var requestOptions = {
method: 'POST',
headers: myHeaders,
redirect: 'follow'
};
fetch("/api/episerver/v3.0/me/carts/{cartId}/preparecheckout", requestOptions)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));ruby
require "uri"
require "json"
require "net/http"
url = URI("/api/episerver/v3.0/me/carts/{cartId}/preparecheckout")
http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
response = http.request(request)
puts response.read_body
python
import requests
import json
url = "/api/episerver/v3.0/me/carts/{cartId}/preparecheckout"
payload = {}
headers = {
'accept': 'application/json',
'content-type': 'application/json'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)
200
// OK
{
"cart": {
"id": "",
"name": "",
"customerId": "",
"market": "",
"currency": "",
"lastUpdated": "",
"shipments": [
{
"id": "",
"shippingAddress": {
"firstName": "",
"lastName": "",
"line1": "",
"line2": "",
"city": "",
"countryName": "",
"countryCode": "",
"postalCode": "",
"regionName": "",
"email": "",
"phoneNumber": "",
"name": ""
},
"shippingMethodId": "",
"lineItems": [
{
"id": "",
"contentId": "",
"code": "",
"placedPrice": "",
"quantity": "",
"displayName": "",
"isGift": false
}
]
}
],
"payments": [
{
"amount": "",
"authorizationCode": "",
"billingAddress": {
"firstName": "",
"lastName": "",
"line1": "",
"line2": "",
"city": "",
"countryName": "",
"countryCode": "",
"postalCode": "",
"regionName": "",
"email": "",
"phoneNumber": "",
"name": ""
},
"savedBillingAddressName": "",
"customerName": "",
"paymentId": "",
"systemKeyword": "",
"paymentType": "",
"providerTransactionID": "",
"status": "",
"transactionID": "",
"transactionType": "",
"validationCode": "",
"extendedProperties": [
{
"name": "",
"value": ""
}
]
}
],
"couponCodes": [
""
]
},
"totals": {
"total": "",
"subTotal": "",
"shippingTotal": "",
"handlingTotal": "",
"taxTotal": "",
"discountTotal": "",
"shippingTotals": [
{
"shipmentId": "",
"shippingCost": "",
"shippingTax": "",
"itemsTotal": "",
"lineItemPrices": [
{
"lineItemId": "",
"extendedPrice": "",
"discountedPrice": ""
}
]
}
]
},
"availableShippingMethods": [
{
"shipmentId": "",
"id": "",
"displayName": "",
"price": ""
}
],
"validationIssues": [
{
"contentId": "",
"code": "",
"validationIssues": [
""
]
}
]
}400
// Bad Request
403
// Forbidden
404
// Not Found