commerce/catalog/storefront/tax

Use the Storefront Tax resource to retrieve tax information from the storefront.Note:  The Storefront Tax resource and its operations are private and limited for use with the Storefront Tax Arc.js actions only.

JSON Example

OrderTaxContext Properties

Property Description
handlingFeeTax

type: decimal

Tax amount applied to the handling fee defined for orders on this site.

itemTaxContexts

type: list of itemTaxContext

Properties of the tax context applicable for line items in an order.

itemTaxContext.id

type: string

Unique identifier of the source property, such as a catalog, discount, order, or email template.

For a product field it will be the name of the field.

For a category ID, must be a positive integer not greater than 2000000. By default, Kibo eCommerce auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the useProvidedId query string in the endpoint. For example, api/commerce/catalog/admin/categories/?useProvidedId=true. Then, use the id property to specify the desired category ID.

For a product attribute it will be the Attribute FQN.

For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, bba0a1a885e2413bb097ceacf7bac366
or
bba0a1a8-85e2-413b-b097-ceacf7bac366.

For email templates, the ID must be one of the following values:
BackInStock
OrderChanged
OrderShipped
OrderFulfillmentDetailsChanged
ShopperLoginCreated
ShopperPasswordReset
ReturnCreated
ReturnAuthorized
ReturnUpdated
ReturnRejected
ReturnCancelled
ReturnClosed
RefundCreated
StoreCreditCreated
StoreCreditUpdated
GiftCardCreated

itemTaxContext.productCode

type: string

The unique, user-defined product code of a product, used throughout Kibo eCommerce to reference and associate to a product.

itemTaxContext.quantity

type: int

The specified quantity of objects and items. This property is used for numerous object types including products, options, components within a product bundle, cart and order items, returned items, shipping line items, items in a digital product. and items associated with types and reservations.

itemTaxContext.shippingTax

type: decimal

Amount of tax applied to shipping costs for line items in and entire orders.

itemTaxContext.tax

type: decimal

The total tax amount applied to the line item in the order, minus any shipping taxes.

itemTaxContext.taxData

type: Mozu.Core.Api.Contracts.Json

Leverage this property within a tax Arc.js action to supplement the tax information for this item or object with custom JSON data.

orderTax

type: decimal

Tax amount applied to the order.

shippingTax

type: decimal

Amount of tax applied to shipping costs for line items in and entire orders.

taxData

type: Mozu.Core.Api.Contracts.Json

Leverage this property within a tax Arc.js action to supplement the tax information for this item or object with custom JSON data.

Operations

Operation Name Request URI Description
EstimateTaxes POST estimate-order%3fresponseFields%3d%7bresponseFields%7d

Retrieves tax information applicable to the site.Note:  The Storefront Tax resource and its operations are private and limited for use with the Storefront Tax Arc.js actions only.