Bulk Add Tax Items to Cart

POST https://useast.api.elasticpath.com/v2/carts/:cartID/taxes

note

A cart item can only have a maximum of five tax items.

Errors

422 Unprocessable Entity

In this example, when options.add_all_or_nothing is set to true and if one of cart items is not found or has reached its maximum tax item limit, the following error response is returned:

{
            "status": 422,
            "title": "Add all or nothing.",
            "detail": "Add all or nothing set to (true). Could not bulk add tax items to cart."
        }

In this example, if you add more than five tax items to the same cart item, the following error response is returned:

{
            "status": 422,
            "title": "Tax item not added to cart item.",
            "detail": "Cannot exceed tax item limit of (5) on cart item.",
            "meta": {
                "id": "f88e6370-cb35-40b2-a998-c759f31dec0a"
            }
        }

404

In this example, if there is a mismatch between cart_item/custom_item and the relationships.item.data.type specified in the bulk add tax item, the following error response is returned:

{
    "data": [],
    "errors": [
        {
            "status": 404,
            "title": "Tax item not added to cart item.",
            "detail": "Mismatch between bulk tax item type(cart_item) and cart item type(custom_item).",
            "meta": {
                "id": "56aab5d1-1dd4-45ed-88ed-4d0cc396b62d"
            }
        },
        {
            "status": 404,
            "title": "Tax item not added to cart item.",
            "detail": "Mismatch between bulk tax item type(cart_item) and cart item type(custom_item).",
            "meta": {
                "id": "56aab5d1-1dd4-45ed-88ed-4d0cc396b62d"
            }
        }
    ]
}

Request

Path Parameters

cartID stringrequired

The unique identifier of the cart.

application/json

Body

data object[]

options object

Responses

Response Headers

application/json

Schema
Example (auto)

Schema

data object[]

options object

{
  "data": [
    {
      "code": "string",
      "jurisdiction": "string",
      "name": "string",
      "rate": 0,
      "amount": 0,
      "type": "string",
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "relationships": {
        "order": {
          "data": {
            "type": "string",
            "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
          }
        }
      }
    }
  ],
  "options": {
    "add_all_or_nothing": true
  }
}

Unauthorized

application/json

Schema
Example (auto)
Example

Schema

detailstring

statusstring

titlestring

[
  null
]

{
  "errors": {
    "status": 401,
    "title": "Unauthorized"
  }
}

Authorization: http

name: bearerAuthtype: httpscheme: bearer

HTTPCLIENT
RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://useast.api.elasticpath.com/v2/carts/:cartID/taxes");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var content = new StringContent("{\n  \"data\": [\n    {\n      \"code\": \"string\",\n      \"jurisdiction\": \"string\",\n      \"name\": \"string\",\n      \"rate\": 0,\n      \"amount\": 0,\n      \"type\": \"string\",\n      \"relationships\": {\n        \"order\": {\n          \"data\": {\n            \"type\": \"string\",\n            \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n          }\n        }\n      }\n    }\n  ],\n  \"options\": {\n    \"add_all_or_nothing\": true\n  }\n}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

ResponseClear

Click the Send API Request button above and see the response here!

Bulk Add Tax Items to Cart

https://useast.api.elasticpath.com/v2/carts/:cartID/taxes

Errors​

Request​