Basic information
POST /{shopId}/carts/{cartId}/coupon
Applies a coupon code on a cart which results in creating a couponLineItem and a link to remove the coupon.
URI parameters
Name | Type | Description |
---|---|---|
shopId |
string |
The unique identifier of the shop. Required:
true
Example:
DemoShop
|
cartId |
string |
The unique identifier of the cart. Required:
true
Example:
5858FD17-147C-661C-9C33-D5809AB3C8BA
|
Request body
Media type application/x-www-form-urlencoded
Name | Type | Description |
---|---|---|
code |
string |
The coupon code, e.g. PJFNYX8WZU97. Required:
true
|
Response attributes
Name | Type | Description |
---|---|---|
|
object of cart |
Response
HTTP 200
Media type application/json
{ "cartId": "5858EDDD-18DF-8D31-502D-D5809AB37DF1", "billingAddress": null, "shippingAddress": null, "lineItemContainer": { "grandTotal": { "taxType": "GROSS", "formatted": "8.69 €", "amount": 8.69, "currency": "EUR" }, "totalBeforeTax": { "taxType": "NET", "formatted": "7.30 €", "amount": 7.3, "currency": "EUR" }, "totalTax": { "taxType": "NONE", "formatted": "1.39 €", "amount": 1.39, "currency": "EUR" }, "lineItemsSubTotal": { "taxType": "GROSS", "formatted": "12.99 €", "amount": 12.99, "currency": "EUR" }, "productLineItems": [ { "lineItemId": "5858EDE0-6E6D-DBC6-A97B-D5809AB37DD9", "sku": "Acc-001", "name": "Connector 6.3mm", "productId": "54E72E1F-746A-8B6E-8E41-0A0C05E64669", "quantity": { "amount": 1, "unit": "yd³" }, "lineItemPrice": { "taxType": "GROSS", "formatted": "12.99 €", "amount": 12.99, "currency": "EUR" }, "singleItemPrice": { "taxType": "GROSS", "formatted": "12.99 €", "amount": 12.99, "currency": "EUR" }, "lineItemCouponDiscount": { "taxType": "GROSS", "formatted": "1.70 €", "amount": 1.7, "currency": "EUR" }, "images": [ { "url": "https://pm.epages.com/WebRoot/Store/Shops/apidocu/54E7/2E1F/746A/8B6E/8E41/0A0C/05E6/4669/acc6_h.jpg", "classifier": "HotDeal", "isZoomEnabled": false, "width": 0, "height": 0, "fileSize": 0 }, { "url": "https://pm.epages.com/WebRoot/Store/Shops/apidocu/54E7/2E1F/746A/8B6E/8E41/0A0C/05E6/4669/acc6.jpg", "classifier": "Large", "isZoomEnabled": false, "width": 0, "height": 0, "fileSize": 0 }, { "url": "https://pm.epages.com/WebRoot/Store/Shops/apidocu/54E7/2E1F/746A/8B6E/8E41/0A0C/05E6/4669/acc6_m.jpg", "classifier": "Medium", "isZoomEnabled": false, "width": 0, "height": 0, "fileSize": 0 }, { "url": "https://pm.epages.com/WebRoot/Store/Shops/apidocu/54E7/2E1F/746A/8B6E/8E41/0A0C/05E6/4669/acc6_s.jpg", "classifier": "Small", "isZoomEnabled": false, "width": 0, "height": 0, "fileSize": 0 }, { "url": "https://pm.epages.com/WebRoot/Store/Shops/apidocu/54E7/2E1F/746A/8B6E/8E41/0A0C/05E6/4669/acc6_xs.jpg", "classifier": "Thumbnail", "isZoomEnabled": false, "width": 0, "height": 0, "fileSize": 0 } ], "additionalInformation": { "bulkPriceInfo": [ { "quantity": { "amount": 1, "unit": "piece(s)" }, "price": { "taxType": "GROSS", "formatted": "9.00 €", "amount": 9, "currency": "EUR" }, "basePrice": null, "priceSavings": { "percent": { "formatted": "10 %", "percentage": 10.0 }, "regularBulkPrice": { "taxType": "GROSS", "formatted": "10.00 €", "amount": 10, "currency": "EUR" } } } ] }, "links": [ { "rel": "product", "href": "https://pm.epages.com/rs/shops/apidocu/products/54E72E1F-746A-8B6E-8E41-0A0C05E64669" }, { "rel": "taxClass", "href": "https://pm.epages.com/rs/shops/apidocu/tax-classes/5446685F-A8AF-0E18-9B4F-D5809AB30FBF" } ], "variationString": null, "essentialFeatures": null, "taxClass": { "taxClassId": "5446685F-A8AF-0E18-9B4F-D5809AB30FBF", "name": "standard", "percentage": 19 }, "deliveryWeight": { "amount": 50, "unit": "oz" }, "energyLabelsString": "C", "energyLabelsMaxEfficiencyString": "A+++", "energyLabelSourceFile": "https://pm.epages.com/WebRoot/Store/Shops/apidocu/Products/be_40401/label-1-9dee85f24e1.png", "productDataSheetSourceFile": "https://pm.epages.com/WebRoot/Store/Shops/apidocu/Products/be_40401/data.pdf" } ], "couponLineItem": { "couponLineItemId": "5858F55B-0C82-4C2C-A435-D5809AB3C878", "couponCampaignId": "5936D13B-4C3A-6CC4-233F-AC17320912BE", "lineItemPrice": { "taxType": "NONE", "formatted": "-12.99 €", "amount": -12.99, "currency": "EUR" }, "validationErrors": [ "LineItemsSubTotalTooSmall" ] }, "shippingPrice": { "taxType": "GROSS", "formatted": "8.69 €", "amount": 8.69, "currency": "EUR" }, "deposits": [], "ecoParticipations": [], "shippingOptions": [], "basketDiscount": { "links": [] } }, "shippingData": { "shippingMethod": { "id": "5171DD86-C077-0726-C448-AC14145F9026", "name": "Standard delivery" }, "price": { "taxType": "GROSS", "formatted": "8.69 €", "amount": 8.69, "currency": "EUR" }, "taxes": [ { "taxClass": { "taxClassId": "5446685F-A8AF-0E18-9B4F-D5809AB30FBF", "name": "standard", "percentage": 19 }, "price": { "taxType": "NONE", "formatted": "1.39 €", "amount": 1.39, "currency": "EUR" } } ] }, "paymentData": { "paymentMethod": { "id": "5171DD89-6DE5-E758-E046-AC14145F9009", "name": "PayPal", "providerName": "PayPal", "additionalData": null }, "transactionId": "7PM024488F971832G", "price": { "taxType": "GROSS", "formatted": "0.00 €", "amount": 0, "currency": "EUR" }, "status": null, "taxes": null }, "minimumCart": { "status": true, "code": "SumDiscount", "amount": null }, "pickupToken": "NDJjOWYxOTM0MDFlODJlZmZjYzRhYzIyZDY5ZTg3MzQ1YWI2MzYzYjFkODAwNGE1ZDZhOWUxZTdhNWI2NGM4Zl8xNDgyMjI0OTg4", "creationDate": "2018-12-17T21:07:29Z", "checkoutUrl": "https://pm.epages.com/epages/apidocu.sf/?ObjectPath=/Shops/apidocu/AnonymousUsers/1/Baskets/46072&ChangeAction=PickupBasket&PickupToken=NDJjOWYxOTM0MDFlODJlZmZjYzRhYzIyZDY5ZTg3MzQ1YWI2MzYzYjFkODAwNGE1ZDZhOWUxZTdhNWI2NGM4Zl8xNDgyMjI0OTg4", "registerSessionUrl": "https://pm.epages.com/epages/apidocu.sf/?ObjectPath=/Shops/apidocu/AnonymousUsers/2/Baskets/46072&ChangeAction=PickupBasket&PickupToken=NTRjZWJmNjdhNzNlYTUzNDAxZTgyZTc4ODYwYTliMDUxMDIzNDQ2OWY2NWQ5NWRmN2Q2YmVjZjVjNzljOTQ2N18xNDgyMjI3OTE3", "cartValidation": { "possibleShippingMethods" : [ "Standard delivery", "Express delivery", "Customer pickup" ] }, "potentialBasketDiscounts": [ { "absolute": { "taxType": "GROSS", "formatted": "10.00 €", "amount": 10, "currency": "EUR" }, "minimumAmount": { "taxType": "GROSS", "formatted": "30.00 €", "amount": 30, "currency": "EUR" }, "percent": null }, { "absolute": null, "minimumAmount": { "taxType": "GROSS", "formatted": "50.00 €", "amount": 50, "currency": "EUR" }, "percent": { "percentage": 10.0, "formatted": "10 %" } } ], "links": [ { "rel": "self", "href": "https://pm.epages.com/rs/shops/apidocu/carts/5858EDDD-18DF-8D31-502D-D5809AB37DF1" }, { "rel": "shipping-method", "href": "https://pm.epages.com/rs/shops/apidocu/shipping-methods/5171DD86-C077-0726-C448-AC14145F9026" }, { "rel": "remove-coupon", "href": "https://pm.epages.com/rs/shops/apidocu/carts/5858EDDD-18DF-8D31-502D-D5809AB37DF1/coupon/5858F55B-0C82-4C2C-A435-D5809AB3C878" } ] }