POST

Remove Line Items


Removes specified line items from a checkout.

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

Path Params
idstringRequired

ID of the checkout to remove line items from.

Body Params
lineItemIdsArray <string>Requiredformat GUIDminItems 1maxItems 300

IDs of the line items to remove from the checkout.

Response Object
checkoutCheckout

Updated checkout after removal of line items.

Remove Line Items Example 1
Request
cURL
curl -X POST 'https://www.wixapis.com/ecom/v1/checkouts/01e8665c-2ce7-458e-a6b4-65befaefa382/remove-line-items' \ -H 'Content-Type: application/json' \ -H 'Authorization: <AUTH>' \ -d '{ "lineItemIds": [ "00000000-0000-0000-0000-000000000001", "00000000-0000-0000-0000-000000000002" ] }'
Response
JSON
{ "checkout": { "id": "01e8665c-2ce7-458e-a6b4-65befaefa382", "lineItems": [ { "id": "00000000-0000-0000-0000-000000000003", "quantity": 6, "catalogReference": { "catalogItemId": "9fe8c5b2-9c94-7153-ebb9-8533695e2b6f", "appId": "215238eb-22a5-4c36-9e7b-e7c08025e04e", "options": { "options": { "Size": "L", "Color": "black" }, "subscriptionOptionId": "adc6be9e-94a5-49e0-8ae2-8d9e248aedb6" } }, "productName": { "original": "Skirt", "translated": "Skirt" }, "url": { "relativePath": "/product-page/skirt", "url": "https://wixsite.com/coffeestore" }, "price": { "amount": "26.4", "convertedAmount": "26.4", "formattedAmount": "$26.40", "formattedConvertedAmount": "$26.40" }, "fullPrice": { "amount": "26.4", "convertedAmount": "26.4", "formattedAmount": "$26.40", "formattedConvertedAmount": "$26.40" }, "totalPriceAfterTax": { "amount": "75.2", "convertedAmount": "75.2", "formattedAmount": "$75.20", "formattedConvertedAmount": "$75.20" }, "totalPriceBeforeTax": { "amount": "62.67", "convertedAmount": "62.67", "formattedAmount": "$62.67", "formattedConvertedAmount": "$62.67" }, "taxDetails": { "taxableAmount": { "amount": "75.2", "convertedAmount": "75.2", "formattedAmount": "$75.20", "formattedConvertedAmount": "$75.20" }, "taxRate": "0.2", "totalTax": { "amount": "12.53", "convertedAmount": "12.53", "formattedAmount": "$12.53", "formattedConvertedAmount": "$12.53" }, "rateBreakdown": [] }, "discount": { "amount": "4", "convertedAmount": "4", "formattedAmount": "$4.00", "formattedConvertedAmount": "$4.00" }, "descriptionLines": [ { "name": { "original": "Size", "translated": "Size" }, "plainText": { "original": "L", "translated": "L" } }, { "name": { "original": "Color", "translated": "Color" }, "colorInfo": { "original": "black", "translated": "black", "code": "#000000" } } ], "media": { "id": "47ab5a_b39cacee052f44ff996325224ebf7aecf002.jpg", "url": "https://static.wixstatic.com/media/47ab5a_b39cacee052f44ff996325224ebf7aecf002.jpg/v1/fit/w_1920,h_1080,q_90/file.jpg", "height": 1080, "width": 1920 }, "availability": { "status": "PARTIALLY_AVAILABLE", "quantityAvailable": 3 }, "physicalProperties": { "sku": "", "shippable": true }, "couponScopes": [ { "namespace": "stores", "group": { "name": "product", "entityId": "9fe8c5b2-9c94-7153-ebb9-8533695e2b6f" } } ], "itemType": { "preset": "PHYSICAL" }, "subscriptionOptionInfo": { "subscriptionSettings": { "frequency": "MONTH", "interval": 1, "autoRenewal": false, "billingCycles": 3 }, "title": { "original": "Skirt of month", "translated": "Skirt of month" }, "description": { "original": "New skirt every month!", "translated": "New skirt every month!" } } } ], "billingInfo": { "address": { "country": "US", "subdivision": "US-ME", "city": "Richmond", "postalCode": "04357", "addressLine": "1772 Fantages Way", "countryFullname": "United States", "subdivisionFullname": "Maine" }, "contactDetails": { "firstName": "John", "lastName": "Doe", "phone": "2075555217" } }, "shippingInfo": { "shippingDestination": { "address": { "country": "US", "subdivision": "US-ME", "city": "Richmond", "postalCode": "04357", "addressLine": "1773 Fantages Way", "countryFullname": "United States", "subdivisionFullname": "Maine" }, "contactDetails": { "firstName": "John1", "lastName": "Doe", "phone": "2075555217" } }, "selectedCarrierServiceOption": { "code": "c0feaab1-60d1-8eed-4283-b3bc10765af9", "title": "standard", "logistics": { "deliveryTime": "" }, "cost": { "totalPriceAfterTax": { "amount": "10", "convertedAmount": "10", "formattedAmount": "$10.00", "formattedConvertedAmount": "$10.00" }, "totalPriceBeforeTax": { "amount": "8.33", "convertedAmount": "8.33", "formattedAmount": "$8.33", "formattedConvertedAmount": "$8.33" }, "taxDetails": { "taxRate": "0.2", "totalTax": { "amount": "1.67", "convertedAmount": "1.67", "formattedAmount": "$1.67", "formattedConvertedAmount": "$1.67" }, "rateBreakdown": [] }, "price": { "amount": "10", "convertedAmount": "10", "formattedAmount": "$10.00", "formattedConvertedAmount": "$10.00" } }, "requestedShippingOption": true, "otherCharges": [], "carrierId": "c8a08776-c095-4dec-8553-8f9698d86adc" }, "region": { "id": "9249fd9c-7424-5ec3-21b6-7c28b8c0b485", "name": "Region 2" }, "carrierServiceOptions": [ { "carrierId": "c8a08776-c095-4dec-8553-8f9698d86adc", "shippingOptions": [ { "code": "c0feaab1-60d1-8eed-4283-b3bc10765af9", "title": "standard", "logistics": { "deliveryTime": "" }, "cost": { "price": { "amount": "10", "convertedAmount": "10", "formattedAmount": "$10.00", "formattedConvertedAmount": "$10.00" }, "otherCharges": [] } }, { "code": "83f392e7-ec2e-4931-9449-7a85b8217704", "title": "qfvbge", "logistics": { "deliveryTime": "", "instructions": "sGW", "pickupDetails": { "address": { "country": "US", "subdivision": "US-ME", "city": "Richmond", "postalCode": "04357", "addressLine": "1773 Fantages Way", "countryFullname": "United States", "subdivisionFullname": "Maine" }, "businessLocation": true } }, "cost": { "price": { "amount": "0", "convertedAmount": "0", "formattedAmount": "$0.00", "formattedConvertedAmount": "$0.00" }, "otherCharges": [] } } ] } ] }, "buyerNote": "wrap it as present", "buyerInfo": { "contactId": "dce53a4b-f07f-4b65-8359-57b11e5a7afc", "email": "janedoe@gmail.com", "visitorId": "9cef4c21-ad14-4a3b-8526-0d8628160965" }, "conversionCurrency": "USD", "priceSummary": { "subtotal": { "amount": "66.67", "convertedAmount": "66.67", "formattedAmount": "$66.67", "formattedConvertedAmount": "$66.67" }, "shipping": { "amount": "8.33", "convertedAmount": "8.33", "formattedAmount": "$8.33", "formattedConvertedAmount": "$8.33" }, "tax": { "amount": "14.2", "convertedAmount": "14.2", "formattedAmount": "$14.20", "formattedConvertedAmount": "$14.20" }, "discount": { "amount": "4", "convertedAmount": "4", "formattedAmount": "$4.00", "formattedConvertedAmount": "$4.00" }, "total": { "amount": "85.2", "convertedAmount": "85.2", "formattedAmount": "$85.20", "formattedConvertedAmount": "$85.20" } }, "calculationErrors": {}, "giftCard": { "id": "f78f162c-b6e9-4230-a97c-fd4c784160c8", "obfuscatedCode": "******lars", "amount": { "amount": "85.2", "convertedAmount": "85.2", "formattedAmount": "$85.20", "formattedConvertedAmount": "$85.20" }, "appId": "ca5af76c-16be-4ff7-96cc-02c0920bce70" }, "appliedDiscounts": [ { "discountType": "GLOBAL", "lineItemIds": [], "coupon": { "id": "bc75c299-bb39-47a1-a0a6-68005011ce14", "code": "summer sale", "amount": { "amount": "4", "convertedAmount": "4", "formattedAmount": "$4.00", "formattedConvertedAmount": "$4.00" }, "name": "summer sale", "couponType": "MoneyOff" } } ], "customFields": [ { "value": "12345", "title": "Tax id", "translatedTitle": "Tax id" } ], "weightUnit": "KG", "taxSummary": { "taxableAmount": { "amount": "62.67", "convertedAmount": "62.67", "formattedAmount": "$62.67", "formattedConvertedAmount": "$62.67" }, "totalTax": { "amount": "14.2", "convertedAmount": "0", "formattedAmount": "", "formattedConvertedAmount": "" }, "manualTaxRate": "0.2", "calculationDetails": { "rateType": "MANUAL_RATE", "manualRateReason": "GLOBAL_SETTING_TO_MANUAL" } }, "currency": "USD", "channelType": "WEB", "siteLanguage": "en", "buyerLanguage": "en", "completed": false, "taxIncludedInPrice": true, "createdBy": { "visitorId": "9cef4c21-ad14-4a3b-8526-0d8628160965" } } }
Errors

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

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