{ "opencollection": "1.0.0", "info": { "name": "Admin Account / Address Cart / Coupons API", "version": "v3" }, "items": [ { "info": { "name": "Cart / Coupons", "type": "folder" }, "items": [ { "info": { "name": "Apply a Coupon Code / Gift Card", "type": "http" }, "http": { "method": "PATCH", "url": "http://{defaultHost}/api/v2/storefront/cart/apply_coupon_code", "params": [ { "name": "include", "value": "line_items,variants,variants.images,billing_address,shipping_address,user,payments,shipments,promotions,gift_card", "type": "query", "description": "Specify the related resources you would like to receive in the response body. [More Information](https://jsonapi.org/format/#fetching-includes)." }, { "name": "fields[cart]", "value": "token,currency,number", "type": "query", "description": "Specify the fields you would like returned in the response body. [More information](https://jsonapi.org/format/#fetching-sparse-fieldsets)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Applies a coupon code or gift card code to the current cart." }, { "info": { "name": "Remove a Coupon / Gift Card", "type": "http" }, "http": { "method": "DELETE", "url": "http://{defaultHost}/api/v2/storefront/cart/remove_coupon_code/:coupon_code", "params": [ { "name": "coupon_code", "value": "DISCOUNT10", "type": "path", "description": "Specify the coupon code or gift card code for removal." }, { "name": "include", "value": "line_items,variants,variants.images,billing_address,shipping_address,user,payments,shipments,promotions,gift_card", "type": "query", "description": "Specify the related resources you would like to receive in the response body. [More Information](https://jsonapi.org/format/#fetching-includes)." }, { "name": "fields[cart]", "value": "token,currency,number", "type": "query", "description": "Specify the fields you would like returned in the response body. [More information](https://jsonapi.org/format/#fetching-sparse-fieldsets)." } ] }, "docs": "Removes a specified coupon code or gift card code from the current cart." }, { "info": { "name": "Remove all Coupons", "type": "http" }, "http": { "method": "DELETE", "url": "http://{defaultHost}/api/v2/storefront/cart/remove_coupon_code", "params": [ { "name": "include", "value": "line_items,variants,variants.images,billing_address,shipping_address,user,payments,shipments,promotions,gift_card", "type": "query", "description": "Specify the related resources you would like to receive in the response body. [More Information](https://jsonapi.org/format/#fetching-includes)." }, { "name": "fields[cart]", "value": "token,currency,number", "type": "query", "description": "Specify the fields you would like returned in the response body. [More information](https://jsonapi.org/format/#fetching-sparse-fieldsets)." } ] }, "docs": "Removes all coupons that have been applied to the current cart." } ] } ], "bundled": true }