GET

Get Checkout


Retrieves a checkout.

Permissions
Manage eCommerce - all permissions
Read eCommerce - all read permissions
Manage Stores - all permissions
Read Stores - all read permissions
Manage Orders
Read Orders
Manage Restaurants - all permissions
Learn more about app permissions.
Endpoint
GET
https://www.wixapis.com/ecom/v1/checkouts/{id}

Path Params
idstringRequired

Checkout ID.

Response Object
checkoutCheckout

The requested checkout.

Get Checkout
Request
cURL
curl -X GET \ 'https://www.wixapis.com/ecom/v1/checkouts/d0d530f0-45d9-4c2c-bd71-8ab07a058472' \ -H 'Content-Type: application/json' \ -H 'Authorization: <AUTH>'
Response
JSON
{ "checkout": { "id": "d0d530f0-45d9-4c2c-bd71-8ab07a058472", "lineItems": [ { "id": "00000000-0000-0000-0000-000000000001", "quantity": 1, "catalogReference": { "catalogItemId": "df19c1f7-07d8-a265-42f8-e8dfa824cc6e", "appId": "215238eb-22a5-4c36-9e7b-e7c08025e04e", "options": { "variantId": "e62fee23-7878-437a-bf0e-292f17d11cb5" } }, "productName": { "original": "Shoe", "translated": "Shoe" }, "url": { "relativePath": "/product-page/shoe", "url": "https://example.wixsite.com" }, "price": { "amount": "85.00", "convertedAmount": "85.00", "formattedAmount": "$85.00", "formattedConvertedAmount": "$85.00" }, "lineItemPrice": { "amount": "85.00", "convertedAmount": "85.00", "formattedAmount": "$85.00", "formattedConvertedAmount": "$85.00" }, "fullPrice": { "amount": "85.00", "convertedAmount": "85.00", "formattedAmount": "$85.00", "formattedConvertedAmount": "$85.00" }, "priceBeforeDiscounts": { "amount": "85.00", "convertedAmount": "85.00", "formattedAmount": "$85.00", "formattedConvertedAmount": "$85.00" }, "totalPriceAfterTax": { "amount": "85.00", "convertedAmount": "85.00", "formattedAmount": "$85.00", "formattedConvertedAmount": "$85.00" }, "totalPriceBeforeTax": { "amount": "85.00", "convertedAmount": "85.00", "formattedAmount": "$85.00", "formattedConvertedAmount": "$85.00" }, "taxDetails": { "taxableAmount": { "amount": "85.00", "convertedAmount": "85.00", "formattedAmount": "$85.00", "formattedConvertedAmount": "$85.00" }, "taxRate": "0", "totalTax": { "amount": "0", "convertedAmount": "0", "formattedAmount": "$0.00", "formattedConvertedAmount": "$0.00" }, "rateBreakdown": [] }, "discount": { "amount": "0", "convertedAmount": "0", "formattedAmount": "$0.00", "formattedConvertedAmount": "$0.00" }, "descriptionLines": [ { "name": { "original": "Color", "translated": "Color" }, "colorInfo": { "original": "Black", "translated": "Black", "code": "#000" } } ], "media": { "id": "3c76e2_bf235c38610f4d2a905db71095b351cf~mv2.jpg", "url": "https://static.wixstatic.com/media/3c76e2_bf235c38610f4d2a905db71095b351cf~mv2.jpg", "height": 1000, "width": 1000 }, "availability": { "status": "AVAILABLE", "quantityAvailable": 30 }, "physicalProperties": { "sku": "364215376135191", "shippable": true }, "couponScopes": [ { "namespace": "stores", "group": { "name": "collection", "entityId": "00000000-000000-000000-000000000001" } }, { "namespace": "stores", "group": { "name": "product", "entityId": "df19c1f7-07d8-a265-42f8-e8dfa824cc6e" } } ], "itemType": { "preset": "PHYSICAL" }, "paymentOption": "FULL_PAYMENT_ONLINE", "rootCatalogItemId": "df19c1f7-07d8-a265-42f8-e8dfa824cc6e" }, { "id": "00000000-0000-0000-0000-000000000002", "quantity": 1, "catalogReference": { "catalogItemId": "c8539b66-7a44-fe18-affc-afec4be8562a", "appId": "215238eb-22a5-4c36-9e7b-e7c08025e04e" }, "productName": { "original": "Shirt", "translated": "Shirt" }, "url": { "relativePath": "/product-page/shirt", "url": "https://example.wixsite.com" }, "price": { "amount": "10.00", "convertedAmount": "10.00", "formattedAmount": "$10.00", "formattedConvertedAmount": "$10.00" }, "lineItemPrice": { "amount": "10.00", "convertedAmount": "10.00", "formattedAmount": "$10.00", "formattedConvertedAmount": "$10.00" }, "fullPrice": { "amount": "10.00", "convertedAmount": "10.00", "formattedAmount": "$10.00", "formattedConvertedAmount": "$10.00" }, "priceBeforeDiscounts": { "amount": "10.00", "convertedAmount": "10.00", "formattedAmount": "$10.00", "formattedConvertedAmount": "$10.00" }, "totalPriceAfterTax": { "amount": "0.0", "convertedAmount": "0.0", "formattedAmount": "$0.00", "formattedConvertedAmount": "$0.00" }, "totalPriceBeforeTax": { "amount": "0.0", "convertedAmount": "0.0", "formattedAmount": "$0.00", "formattedConvertedAmount": "$0.00" }, "taxDetails": { "taxableAmount": { "amount": "0.0", "convertedAmount": "0.0", "formattedAmount": "$0.00", "formattedConvertedAmount": "$0.00" }, "taxRate": "0", "totalTax": { "amount": "0", "convertedAmount": "0", "formattedAmount": "$0.00", "formattedConvertedAmount": "$0.00" }, "rateBreakdown": [] }, "discount": { "amount": "10.0", "convertedAmount": "10.0", "formattedAmount": "$10.00", "formattedConvertedAmount": "$10.00" }, "descriptionLines": [], "media": { "id": "3c76e2_c5331f937348492a97df87b0a3b34ea4~mv2.jpg", "url": "https://static.wixstatic.com/media/3c76e2_c5331f937348492a97df87b0a3b34ea4~mv2.jpg", "height": 1000, "width": 1000 }, "availability": { "status": "AVAILABLE" }, "physicalProperties": { "sku": "364115376135191", "shippable": true }, "couponScopes": [ { "namespace": "stores", "group": { "name": "collection", "entityId": "00000000-000000-000000-000000000001" } }, { "namespace": "stores", "group": { "name": "product", "entityId": "c8539b66-7a44-fe18-affc-afec4be8562a" } } ], "itemType": { "preset": "PHYSICAL" }, "paymentOption": "FULL_PAYMENT_ONLINE", "rootCatalogItemId": "c8539b66-7a44-fe18-affc-afec4be8562a" } ], "billingInfo": { "address": {} }, "shippingInfo": { "shippingDestination": { "address": {} }, "carrierServiceOptions": [] }, "buyerInfo": { "email": "janedoe@gmail.com" }, "conversionCurrency": "USD", "priceSummary": { "subtotal": { "amount": "95.00", "convertedAmount": "95.00", "formattedAmount": "$95.00", "formattedConvertedAmount": "$95.00" }, "shipping": { "amount": "0", "convertedAmount": "0", "formattedAmount": "$0.00", "formattedConvertedAmount": "$0.00" }, "tax": { "amount": "0", "convertedAmount": "0", "formattedAmount": "$0.00", "formattedConvertedAmount": "$0.00" }, "discount": { "amount": "10.0", "convertedAmount": "10.0", "formattedAmount": "$10.00", "formattedConvertedAmount": "$10.00" }, "total": { "amount": "85.00", "convertedAmount": "85.00", "formattedAmount": "$85.00", "formattedConvertedAmount": "$85.00" }, "additionalFees": { "amount": "0", "convertedAmount": "0", "formattedAmount": "$0.00", "formattedConvertedAmount": "$0.00" } }, "calculationErrors": { "orderValidationErrors": [] }, "appliedDiscounts": [ { "discountType": "GLOBAL", "lineItemIds": [], "coupon": { "id": "fbb94b06-7447-4161-9c48-59bfcdc39e77", "code": "SUMMERSALE10", "amount": { "amount": "10.0", "convertedAmount": "10.0", "formattedAmount": "$10.00", "formattedConvertedAmount": "$10.00" }, "name": "SUMMERSALE10", "couponType": "MoneyOff" } } ], "customFields": [], "weightUnit": "KG", "currency": "USD", "channelType": "WEB", "siteLanguage": "en", "buyerLanguage": "en", "completed": false, "taxIncludedInPrice": false, "createdBy": { "userId": "c43190d2-eea3-493e-b6e8-f146850c6873" }, "createdDate": "2022-12-12T10:46:41.754Z", "updatedDate": "2022-12-12T10:46:41.754Z", "payNow": { "subtotal": { "amount": "95.00", "convertedAmount": "95.00", "formattedAmount": "$95.00", "formattedConvertedAmount": "$95.00" }, "shipping": { "amount": "0", "convertedAmount": "0", "formattedAmount": "$0.00", "formattedConvertedAmount": "$0.00" }, "tax": { "amount": "0", "convertedAmount": "0", "formattedAmount": "$0.00", "formattedConvertedAmount": "$0.00" }, "discount": { "amount": "10.0", "convertedAmount": "10.0", "formattedAmount": "$10.00", "formattedConvertedAmount": "$10.00" }, "total": { "amount": "85.00", "convertedAmount": "85.00", "formattedAmount": "$85.00", "formattedConvertedAmount": "$85.00" }, "additionalFees": { "amount": "0", "convertedAmount": "0", "formattedAmount": "$0.00", "formattedConvertedAmount": "$0.00" } }, "payLater": { "subtotal": { "amount": "0", "convertedAmount": "0", "formattedAmount": "$0.00", "formattedConvertedAmount": "$0.00" }, "shipping": { "amount": "0", "convertedAmount": "0", "formattedAmount": "$0.00", "formattedConvertedAmount": "$0.00" }, "tax": { "amount": "0", "convertedAmount": "0", "formattedAmount": "$0.00", "formattedConvertedAmount": "$0.00" }, "discount": { "amount": "0", "convertedAmount": "0", "formattedAmount": "$0.00", "formattedConvertedAmount": "$0.00" }, "total": { "amount": "0", "convertedAmount": "0", "formattedAmount": "$0.00", "formattedConvertedAmount": "$0.00" }, "additionalFees": { "amount": "0", "convertedAmount": "0", "formattedAmount": "$0.00", "formattedConvertedAmount": "$0.00" } }, "additionalFees": [], "cartId": "b7b79cdb-5ff5-4ce8-8b64-0e28b1ea7a95" } }
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?