{ "opencollection": "1.0.0", "info": { "name": "Addresses Introduction Account Addresses Tax Items API", "version": "25.1126.6886238" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Tax Items", "type": "folder" }, "items": [ { "info": { "name": "Add Tax Item to Cart", "type": "http" }, "http": { "method": "POST", "url": "https://useast.api.elasticpath.com/v2/carts/:cartID/items/:cartitemID/taxes", "params": [ { "name": "cartID", "value": "", "type": "path", "description": "The unique identifier of the cart." }, { "name": "cartitemID", "value": "", "type": "path", "description": "The unique identifier of the cart item." } ], "body": { "type": "json", "data": "{}" } }, "docs": "\nUse this endpoint to add a tax item to a cart.\n\n:::note\n\nThere is a soft limit of 5 unique tax items per cart item at any one time.\n\n:::\n" }, { "info": { "name": "Add Tax Item to Bundle Component", "type": "http" }, "http": { "method": "POST", "url": "https://useast.api.elasticpath.com/v2/carts/:cartID/items/:cartitemID/components/:productID/taxes", "params": [ { "name": "cartID", "value": "", "type": "path", "description": "The unique identifier of the cart." }, { "name": "cartitemID", "value": "", "type": "path", "description": "The unique identifier of the cart item." }, { "name": "productID", "value": "", "type": "path", "description": "The unique identifier of the component product within the bundle." } ], "body": { "type": "json", "data": "{}" } }, "docs": "\nUse this endpoint to add a tax item to a specific bundle component (component product) within a cart item.\n\n:::note\n\nThere is a soft limit of 5 unique tax items per component product at any one time.\n\n:::\n" }, { "info": { "name": "Update Tax Item on Bundle Component", "type": "http" }, "http": { "method": "PUT", "url": "https://useast.api.elasticpath.com/v2/carts/:cartID/items/:cartitemID/components/:productID/taxes/:taxitemID", "params": [ { "name": "cartID", "value": "", "type": "path", "description": "The unique identifier of the cart." }, { "name": "cartitemID", "value": "", "type": "path", "description": "The unique identifier of the cart item." }, { "name": "productID", "value": "", "type": "path", "description": "The unique identifier of the component product within the bundle." }, { "name": "taxitemID", "value": "", "type": "path", "description": "The unique identifier of the tax item on the component product." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to update a tax item on a specific bundle component (component product) within a cart item. To change tax value from `rate` to `amount`, set `rate` to `null`, then set `amount` value and vice versa." }, { "info": { "name": "Delete Tax Item from Bundle Component", "type": "http" }, "http": { "method": "DELETE", "url": "https://useast.api.elasticpath.com/v2/carts/:cartID/items/:cartitemID/components/:productID/taxes/:taxitemID", "params": [ { "name": "cartID", "value": "", "type": "path", "description": "The unique identifier of the cart." }, { "name": "cartitemID", "value": "", "type": "path", "description": "The unique identifier of the cart item." }, { "name": "productID", "value": "", "type": "path", "description": "The unique identifier of the component product within the bundle." }, { "name": "taxitemID", "value": "", "type": "path", "description": "The unique identifier of the tax item on the component product." } ] }, "docs": "\nUse this endpoint to delete a tax item from a specific bundle component (component product) within a cart item.\n" }, { "info": { "name": "Bulk Add Tax Items to Cart", "type": "http" }, "http": { "method": "POST", "url": "https://useast.api.elasticpath.com/v2/carts/:cartID/taxes", "params": [ { "name": "cartID", "value": "", "type": "path", "description": "The unique identifier of the cart." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to bulk add tax items to cart items and bundle component products.\n\n:::note\n\nA cart item can only have a maximum of five tax items.\nA bundle component product can only have a maximum of five tax items.\n\n:::\n\n### Bundle Component Taxes\n\nTo add tax items to bundle component products, include a `meta` object with `component_product_id` in each tax item:\n\n```json\n{\n \"data\": [\n {\n \"type\": \"tax_item\",\n \"code\": \"GST\",\n \"name\": \"Goods and Services Tax\",\n \"rate\":" }, { "info": { "name": "Bulk Delete Tax Items from Cart", "type": "http" }, "http": { "method": "DELETE", "url": "https://useast.api.elasticpath.com/v2/carts/:cartID/taxes", "params": [ { "name": "cartID", "value": "", "type": "path", "description": "The unique identifier of the cart." } ] }, "docs": "Use this endpoint to bulk delete all tax items from all cart items and bundle component products in the cart.\n\n:::warning\n\nThis operation will remove ALL tax items from:\n- All cart items in the cart\n- All bundle component products within bundle cart items\n\n:::\n\n### Behavior\n\n- Removes all tax items from every cart item\n- Removes all tax items from every component product in bundle cart items\n- If no tax items exist anywhere in the cart, returns a 404 error\n\n### Errors\n\n`404 Not Found`\n\nIf no tax" }, { "info": { "name": "Update a Tax Item", "type": "http" }, "http": { "method": "PUT", "url": "https://useast.api.elasticpath.com/v2/carts/:cartID/items/:cartitemID/taxes/:taxitemID", "params": [ { "name": "cartID", "value": "", "type": "path", "description": "The unique identifier of the cart." }, { "name": "cartitemID", "value": "", "type": "path", "description": "The unique identifier of the cart item." }, { "name": "taxitemID", "value": "", "type": "path", "description": "The unique identifier of the tax item." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to update a tax item. To change tax value from `rate` to `amount`, set `rate` to `null`, then set `amount` value and vice versa." }, { "info": { "name": "Delete a Tax Item", "type": "http" }, "http": { "method": "DELETE", "url": "https://useast.api.elasticpath.com/v2/carts/:cartID/items/:cartitemID/taxes/:taxitemID", "params": [ { "name": "cartID", "value": "", "type": "path", "description": "The unique identifier of the cart." }, { "name": "cartitemID", "value": "", "type": "path", "description": "The unique identifier of the cart item." }, { "name": "taxitemID", "value": "", "type": "path", "description": "The unique identifier of the tax item." } ] }, "docs": "Use this endpoint to delete a tax item." } ] } ], "bundled": true }