www/apps/resources/references/fulfillment/interfaces/fulfillment.ShippingMethodTaxLineDTO/page.mdx
import { TypeList } from "docs-ui"
The shipping method tax line details.
<TypeList types={[{"name":"id","type":"string","description":"The ID of the tax line","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"string","description":"The code of the tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"number","description":"The rate of the tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"string \| Date","description":"When the tax line was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"string \| Date","description":"When the tax line was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_method","type":"CartShippingMethodDTO","description":"The associated shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"string","description":"The ID of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart_id","type":"string","description":"The ID of the associated cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"string","description":"The name of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"BigNumberValue","description":"The price of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"number","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"BigNumberRawValue","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"BigNumber","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"is_tax_inclusive","type":"boolean","description":"Whether the shipping method price is tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"string \| Date","description":"When the shipping method was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"string \| Date","description":"When the shipping method was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"BigNumberValue","description":"The original total of the cart shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"number","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"BigNumberRawValue","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"BigNumber","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"original_subtotal","type":"BigNumberValue","description":"The original subtotal of the cart shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"number","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"BigNumberRawValue","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"BigNumber","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"original_tax_total","type":"BigNumberValue","description":"The original tax total of the cart shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"number","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"BigNumberRawValue","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"BigNumber","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"total","type":"BigNumberValue","description":"The total of the cart shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"number","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"BigNumberRawValue","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"BigNumber","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"subtotal","type":"BigNumberValue","description":"The subtotal of the cart shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"number","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"BigNumberRawValue","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"BigNumber","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"tax_total","type":"BigNumberValue","description":"The tax total of the cart shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"number","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"BigNumberRawValue","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"BigNumber","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"discount_total","type":"BigNumberValue","description":"The discount total of the cart shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"number","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"BigNumberRawValue","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"BigNumber","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"discount_tax_total","type":"BigNumberValue","description":"The discount tax total of the cart shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"number","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"BigNumberRawValue","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"BigNumber","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"raw_original_total","type":"BigNumberRawValue","description":"The raw original total of the cart shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"string \| number","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"raw_original_subtotal","type":"BigNumberRawValue","description":"The raw original subtotal of the cart shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"string \| number","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"raw_original_tax_total","type":"BigNumberRawValue","description":"The raw original tax total of the cart shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"string \| number","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"raw_total","type":"BigNumberRawValue","description":"The raw total of the cart shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"string \| number","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"raw_subtotal","type":"BigNumberRawValue","description":"The raw subtotal of the cart shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"string \| number","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"raw_tax_total","type":"BigNumberRawValue","description":"The raw tax total of the cart shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"string \| number","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"raw_discount_total","type":"BigNumberRawValue","description":"The raw discount total of the cart shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"string \| number","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"raw_discount_tax_total","type":"BigNumberRawValue","description":"The raw discount tax total of the cart shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"string \| number","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"description","type":"string","description":"The description of the shipping method.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option_id","type":"string","description":"The ID of the shipping option the method was created from.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"Record<string, unknown>","description":"Additional data needed for fulfillment.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"null \| Record<string, unknown>","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_lines","type":"ShippingMethodTaxLineDTO[]","description":"The associated tax lines.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"string","description":"The ID of the tax line","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"string","description":"The code of the tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"number","description":"The rate of the tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"string \| Date","description":"When the tax line was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"string \| Date","description":"When the tax line was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_method","type":"CartShippingMethodDTO","description":"The associated shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_method_id","type":"string","description":"The ID of the associated shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"BigNumberValue","description":"The total tax relative to the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"BigNumberValue","description":"The subtotal tax relative to the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_total","type":"BigNumberRawValue","description":"The raw total tax relative to the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_subtotal","type":"BigNumberRawValue","description":"The raw subtotal tax relative to the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"string","description":"The description of the tax line","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate_id","type":"string","description":"The ID of the associated tax rate.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"string","description":"The ID of the associated provider.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"adjustments","type":"ShippingMethodAdjustmentDTO[]","description":"The associated adjustments.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"string","description":"The ID of the adjustment line","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"BigNumberValue","description":"The amount to adjust the original amount with.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_amount","type":"BigNumberRawValue","description":"The raw amount to adjust the original amount with.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart_id","type":"string","description":"The ID of the associated cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"string \| Date","description":"When the adjustment line was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"string \| Date","description":"When the adjustment line was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_method","type":"CartShippingMethodDTO","description":"The associated shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_method_id","type":"string","description":"The ID of the associated shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"string","description":"The code of the promotion that lead to\nthis adjustment.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"boolean","description":"Whether the adjustment is tax inclusive.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"string","description":"The description of the adjustment line.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"promotion_id","type":"string","description":"The ID of the associated promotion.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"string","description":"The ID of the associated provider.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"shipping_method_id","type":"string","description":"The ID of the associated shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"BigNumberValue","description":"The total tax relative to the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"number","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"BigNumberRawValue","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"string \| number","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"bigNumber","type":"BigNumber","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"subtotal","type":"BigNumberValue","description":"The subtotal tax relative to the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"number","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"BigNumberRawValue","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"string \| number","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"bigNumber","type":"BigNumber","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"raw_total","type":"BigNumberRawValue","description":"The raw total tax relative to the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"string \| number","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"raw_subtotal","type":"BigNumberRawValue","description":"The raw subtotal tax relative to the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"string \| number","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"description","type":"string","description":"The description of the tax line","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate_id","type":"string","description":"The ID of the associated tax rate.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"string","description":"The ID of the associated provider.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="ShippingMethodTaxLineDTO"/>