POST

Add To Checkout


Adds line items to a checkout.

Note: For more information on what to pass to lineItems.catalogReference, see eCommerce Integration in the Wix Stores Catalog API.

Permissions
Manage eCommerce - all permissions
Manage Stores - all permissions
Manage Orders
Manage Restaurants - all permissions
Manage eCommerce - Admin Permissions
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/ecom/v1/checkouts/{id}/add-to-checkout

Path Params
idstringRequired

Checkout ID.

Body Params
lineItemsArray <LineItem>maxItems 100

Catalog line items.


customLineItemsArray <CustomLineItem>betamaxItems 100

Custom line items. Custom line items don't trigger the Catalog service plugin.

To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions". Learn more about permission scopes.

Response Object
checkoutCheckout

Updated checkout.

Request
cURL
curl -X POST \ 'https://www.wixapis.com/ecom/v1/checkouts/050c8248-6c07-45e7-841c-4dcdf6ce8949/add-to-checkout' \ -H 'Content-Type: application/json' \ -H 'Authorization: <AUTH>' \ -d '{ "lineItems": [ { "quantity": 10, "catalogReference": { "catalogItemId": "c8539b66-7a44-fe18-affc-afec4be8562a", "appId": "215238eb-22a5-4c36-9e7b-e7c08025e04e" } } ] }'
Response
JSON
{ "checkout": { "id": "050c8248-6c07-45e7-841c-4dcdf6ce8949", "lineItems": [ { "id": "00000000-0000-0000-0000-000000000001", "quantity": 15, "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://arigold7.wixsite.com/copy-of-ep-tester/product-page/shirt" }, "price": { "amount": "10", "convertedAmount": "10", "formattedAmount": "€10.00", "formattedConvertedAmount": "€10.00" }, "lineItemPrice": { "amount": "150", "convertedAmount": "150", "formattedAmount": "€150.00", "formattedConvertedAmount": "€150.00" }, "fullPrice": { "amount": "10", "convertedAmount": "10", "formattedAmount": "€10.00", "formattedConvertedAmount": "€10.00" }, "priceBeforeDiscounts": { "amount": "10", "convertedAmount": "10", "formattedAmount": "€10.00", "formattedConvertedAmount": "€10.00" }, "totalPriceAfterTax": { "amount": "150", "convertedAmount": "150", "formattedAmount": "€150.00", "formattedConvertedAmount": "€150.00" }, "totalPriceBeforeTax": { "amount": "150", "convertedAmount": "150", "formattedAmount": "€150.00", "formattedConvertedAmount": "€150.00" }, "taxDetails": { "taxableAmount": { "amount": "150", "convertedAmount": "150", "formattedAmount": "€150.00", "formattedConvertedAmount": "€150.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": [], "media": { "id": "3c76e2_c5331f937348492a97df87b0a3b34ea4~mv2.jpg", "url": "https://static.wixstatic.com/media/3c76e2_c5331f937348492a97df87b0a3b34ea4~mv2.jpg", "height": 1000, "width": 1000, "filename": "3c76e2_c5331f937348492a97df87b0a3b34ea4~mv2.jpg" }, "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", "customLineItem": false } ], "shippingInfo": { "carrierServiceOptions": [] }, "buyerInfo": {}, "conversionCurrency": "EUR", "priceSummary": { "subtotal": { "amount": "150", "convertedAmount": "150", "formattedAmount": "€150.00", "formattedConvertedAmount": "€150.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": "150", "convertedAmount": "150", "formattedAmount": "€150.00", "formattedConvertedAmount": "€150.00" }, "additionalFees": { "amount": "0", "convertedAmount": "0", "formattedAmount": "€0.00", "formattedConvertedAmount": "€0.00" } }, "calculationErrors": { "orderValidationErrors": [] }, "appliedDiscounts": [], "customFields": [], "weightUnit": "KG", "currency": "EUR", "channelType": "BACKOFFICE_MERCHANT", "siteLanguage": "en", "buyerLanguage": "en", "completed": false, "taxIncludedInPrice": false, "createdBy": { "userId": "ea3d74df-b7dc-4ca1-a7c9-c416b9017a86" }, "createdDate": "2023-02-26T07:51:14.181Z", "updatedDate": "2023-02-26T07:53:19.633Z", "payNow": { "subtotal": { "amount": "150", "convertedAmount": "150", "formattedAmount": "€150.00", "formattedConvertedAmount": "€150.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": "150", "convertedAmount": "150", "formattedAmount": "€150.00", "formattedConvertedAmount": "€150.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": [], "payNowTotalAfterGiftCard": { "amount": "150", "convertedAmount": "150", "formattedAmount": "€150.00", "formattedConvertedAmount": "€150.00" } } }
Errors
428Failed Precondition

There is 1 error with this status code.

This method may also return standard errors. Learn more about standard Wix errors.

Event TriggersThis method triggers the following events:
Did this help?