Commerce Layer

Commerce Layer tax_rules API

resource type

GitHub OpenAPI

Documentation

📖
Documentation
https://docs.commercelayer.io/core/
📖
Documentation
https://docs.commercelayer.io/core-api-reference/
📖
Documentation
https://docs.commercelayer.io/core/api-specification
📖
Authentication
https://docs.commercelayer.io/core/authentication
📖
RateLimits
https://docs.commercelayer.io/core/rate-limits
📖
Documentation
https://docs.commercelayer.io/core/event-stream-hub
📖
Documentation
https://docs.commercelayer.io/provisioning
📖
Documentation
https://docs.commercelayer.io/provisioning-api-reference/
📖
Documentation
https://docs.commercelayer.io/metrics/welcome
📖
Documentation
https://docs.commercelayer.io/metrics/getting-started/api-specification

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/commerce-layer/refs/heads/main/openapi/commerce-layer-tax-rules-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/commerce-layer/refs/heads/main/json-schema/commerce-layer-order-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/commerce-layer/refs/heads/main/json-schema/commerce-layer-sku-schema.json

Other Resources

🔗
Webhooks
https://docs.commercelayer.io/core/real-time-webhooks
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/commerce-layer/refs/heads/main/json-ld/commerce-layer-context.jsonld
🔗
GraphQL
https://raw.githubusercontent.com/api-evangelist/commerce-layer/refs/heads/main/graphql/commerce-layer-graphql.md

OpenAPI Specification

commerce-layer-tax-rules-api-openapi.yml Raw ↑ 
openapi: 3.1.0
info:
  title: Commerce Layer addresses tax_rules API
  version: 7.10.1
  contact:
    name: API Support
    url: https://commercelayer.io
    email: support@commercelayer.io
  description: Headless Commerce for Global Brands.
servers:
- url: https://{your_organization_slug}.commercelayer.io/api
  description: API
- url: https://core.commercelayer.io/users/sign_in
  description: Sign in
- url: https://docs.commercelayer.io/api
  description: API reference
security:
- bearerAuth: []
tags:
- name: tax_rules
  description: resource type
paths:
  /manual_tax_calculators/{manualTaxCalculatorId}/tax_rules:
    get:
      operationId: GET/manualTaxCalculatorId/tax_rules
      summary: Retrieve the tax rules associated to the manual tax calculator
      description: Retrieve the tax rules associated to the manual tax calculator
      tags:
      - tax_rules
      parameters:
      - name: manualTaxCalculatorId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      responses:
        '200':
          description: The tax_rules associated to the manual tax calculator
  /tax_rules:
    get:
      operationId: GET/tax_rules
      summary: List all tax rules
      description: List all tax rules
      tags:
      - tax_rules
      responses:
        '200':
          description: A list of tax rule objects
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/taxRuleResponseList'
    post:
      operationId: POST/tax_rules
      summary: Create a tax rule
      description: Create a tax rule
      tags:
      - tax_rules
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/taxRuleCreate'
      responses:
        '201':
          description: The created tax rule object
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/taxRuleResponse'
  /tax_rules/{taxRuleId}:
    get:
      operationId: GET/tax_rules/taxRuleId
      summary: Retrieve a tax rule
      description: Retrieve a tax rule
      tags:
      - tax_rules
      parameters:
      - name: taxRuleId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      responses:
        '200':
          description: The tax rule object
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/taxRuleResponse'
    patch:
      operationId: PATCH/tax_rules/taxRuleId
      summary: Update a tax rule
      description: Update a tax rule
      tags:
      - tax_rules
      parameters:
      - name: taxRuleId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/taxRuleUpdate'
      responses:
        '200':
          description: The updated tax rule object
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/taxRuleResponse'
    delete:
      operationId: DELETE/tax_rules/taxRuleId
      summary: Delete a tax rule
      description: Delete a tax rule
      tags:
      - tax_rules
      parameters:
      - name: taxRuleId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      responses:
        '204':
          description: No content
components:
  schemas:
    taxRuleCreate:
      required:
      - data
      type: object
      properties:
        data:
          type: object
          required:
          - type
          - attributes
          properties:
            type:
              type: string
              description: The resource's type
              enum:
              - tax_rules
            attributes:
              type: object
              properties:
                name:
                  type: string
                  description: The tax rule internal name.
                  example: Fixed 22%
                tax_rate:
                  type: number
                  description: The tax rate for this rule.
                  example: 0.22
                freight_taxable:
                  type: boolean
                  description: Indicates if the freight is taxable.
                  example: false
                payment_method_taxable:
                  type: boolean
                  description: Indicates if the payment method is taxable.
                  example: false
                gift_card_taxable:
                  type: boolean
                  description: Indicates if gift cards are taxable.
                  example: false
                adjustment_taxable:
                  type: boolean
                  description: Indicates if adjustemnts are taxable.
                  example: false
                country_code_regex:
                  type: string
                  description: The regex that will be evaluated to match the shipping address country code, max size is 5000.
                  example: AT|BE|BG|CZ|DK|EE|DE|HU|LV|LT
                not_country_code_regex:
                  type: string
                  description: The regex that will be evaluated as negative match for the shipping address country code, max size is 5000.
                  example: AT|BE|BG|CZ|DK|EE|DE
                state_code_regex:
                  type: string
                  description: The regex that will be evaluated to match the shipping address state code, max size is 5000.
                  example: A[KLRZ]|C[AOT]|D[CE]|FL
                not_state_code_regex:
                  type: string
                  description: The regex that will be evaluated as negative match for the shipping address state code, max size is 5000.
                  example: A[KLRZ]|C[AOT]
                zip_code_regex:
                  type: string
                  description: The regex that will be evaluated to match the shipping address zip code, max size is 5000.
                  example: (?i)(JE1|JE2|JE3|JE4|JE5)
                not_zip_code_regex:
                  type: string
                  description: The regex that will be evaluated as negative match for the shipping zip country code, max size is 5000.
                  example: (?i)(JE1|JE2|JE3)
                reference:
                  type: string
                  description: A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.
                  example: ANY-EXTERNAL-REFEFERNCE
                reference_origin:
                  type: string
                  description: Any identifier of the third party system that defines the reference code.
                  example: ANY-EXTERNAL-REFEFERNCE-ORIGIN
                metadata:
                  type: object
                  description: Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.
                  example:
                    foo: bar
              required:
              - name
            relationships:
              type: object
              properties:
                manual_tax_calculator:
                  required:
                  - data
                  type: object
                  properties:
                    data:
                      type: object
                      properties:
                        type:
                          type: string
                          description: The resource's type
                          enum:
                          - manual_tax_calculators
                        id:
                          type: string
                          description: Unique identifier for the resource (hash).
                          example: XAyRWNUzyN
              required:
              - manual_tax_calculator
    taxRule:
      properties:
        data:
          properties:
            attributes:
              type: object
              properties:
                name:
                  type: string
                  description: The tax rule internal name.
                  example: Fixed 22%
                  nullable: false
                tax_rate:
                  type: number
                  description: The tax rate for this rule.
                  example: 0.22
                  nullable: true
                freight_taxable:
                  type: boolean
                  description: Indicates if the freight is taxable.
                  example: false
                  nullable: true
                payment_method_taxable:
                  type: boolean
                  description: Indicates if the payment method is taxable.
                  example: false
                  nullable: true
                gift_card_taxable:
                  type: boolean
                  description: Indicates if gift cards are taxable.
                  example: false
                  nullable: true
                adjustment_taxable:
                  type: boolean
                  description: Indicates if adjustemnts are taxable.
                  example: false
                  nullable: true
                breakdown:
                  type: object
                  description: The breakdown for this tax rule (if calculated).
                  example:
                    '41':
                      tax_rate: 0.22
                  nullable: true
                country_code_regex:
                  type: string
                  description: The regex that will be evaluated to match the shipping address country code, max size is 5000.
                  example: AT|BE|BG|CZ|DK|EE|DE|HU|LV|LT
                  nullable: true
                not_country_code_regex:
                  type: string
                  description: The regex that will be evaluated as negative match for the shipping address country code, max size is 5000.
                  example: AT|BE|BG|CZ|DK|EE|DE
                  nullable: true
                state_code_regex:
                  type: string
                  description: The regex that will be evaluated to match the shipping address state code, max size is 5000.
                  example: A[KLRZ]|C[AOT]|D[CE]|FL
                  nullable: true
                not_state_code_regex:
                  type: string
                  description: The regex that will be evaluated as negative match for the shipping address state code, max size is 5000.
                  example: A[KLRZ]|C[AOT]
                  nullable: true
                zip_code_regex:
                  type: string
                  description: The regex that will be evaluated to match the shipping address zip code, max size is 5000.
                  example: (?i)(JE1|JE2|JE3|JE4|JE5)
                  nullable: true
                not_zip_code_regex:
                  type: string
                  description: The regex that will be evaluated as negative match for the shipping zip country code, max size is 5000.
                  example: (?i)(JE1|JE2|JE3)
                  nullable: true
                created_at:
                  type: string
                  description: Time at which the resource was created.
                  example: '2018-01-01T12:00:00.000Z'
                  nullable: false
                updated_at:
                  type: string
                  description: Time at which the resource was last updated.
                  example: '2018-01-01T12:00:00.000Z'
                  nullable: false
                reference:
                  type: string
                  description: A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.
                  example: ANY-EXTERNAL-REFEFERNCE
                  nullable: true
                reference_origin:
                  type: string
                  description: Any identifier of the third party system that defines the reference code.
                  example: ANY-EXTERNAL-REFEFERNCE-ORIGIN
                  nullable: true
                metadata:
                  type: object
                  description: Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.
                  example:
                    foo: bar
                  nullable: true
    taxRuleResponse:
      type: object
      properties:
        data:
          type: object
          properties:
            id:
              type: string
              description: Unique identifier for the resource (hash).
              example: XAyRWNUzyN
            type:
              type: string
              description: The resource's type
              enum:
              - tax_rules
            links:
              type: object
              properties:
                self:
                  type: string
                  description: URL
            attributes:
              $ref: '#/components/schemas/taxRule/properties/data/properties/attributes'
            relationships:
              type: object
              properties:
                manual_tax_calculator:
                  type: object
                  properties:
                    links:
                      type: object
                      properties:
                        self:
                          type: string
                          description: URL
                        related:
                          type: string
                          description: URL
                    data:
                      type: object
                      properties:
                        type:
                          type: string
                          description: The resource's type
                          enum:
                          - manual_tax_calculator
                        id:
                          type: string
                          description: The resource ID
                event_stores:
                  type: object
                  properties:
                    links:
                      type: object
                      properties:
                        self:
                          type: string
                          description: URL
                        related:
                          type: string
                          description: URL
                    data:
                      type: object
                      properties:
                        type:
                          type: string
                          description: The resource's type
                          enum:
                          - event_stores
                        id:
                          type: string
                          description: The resource ID
    taxRuleResponseList:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/taxRuleResponse/properties/data'
    taxRuleUpdate:
      required:
      - data
      type: object
      properties:
        data:
          type: object
          required:
          - type
          - id
          - attributes
          properties:
            type:
              type: string
              description: The resource's type
              enum:
              - tax_rules
            id:
              type: string
              description: Unique identifier for the resource (hash).
              example: XAyRWNUzyN
            attributes:
              type: object
              properties:
                name:
                  type: string
                  description: The tax rule internal name.
                  example: Fixed 22%
                  nullable: false
                tax_rate:
                  type: number
                  description: The tax rate for this rule.
                  example: 0.22
                  nullable: true
                freight_taxable:
                  type: boolean
                  description: Indicates if the freight is taxable.
                  example: false
                  nullable: false
                payment_method_taxable:
                  type: boolean
                  description: Indicates if the payment method is taxable.
                  example: false
                  nullable: false
                gift_card_taxable:
                  type: boolean
                  description: Indicates if gift cards are taxable.
                  example: false
                  nullable: false
                adjustment_taxable:
                  type: boolean
                  description: Indicates if adjustemnts are taxable.
                  example: false
                  nullable: false
                country_code_regex:
                  type: string
                  description: The regex that will be evaluated to match the shipping address country code, max size is 5000.
                  example: AT|BE|BG|CZ|DK|EE|DE|HU|LV|LT
                  nullable: true
                not_country_code_regex:
                  type: string
                  description: The regex that will be evaluated as negative match for the shipping address country code, max size is 5000.
                  example: AT|BE|BG|CZ|DK|EE|DE
                  nullable: true
                state_code_regex:
                  type: string
                  description: The regex that will be evaluated to match the shipping address state code, max size is 5000.
                  example: A[KLRZ]|C[AOT]|D[CE]|FL
                  nullable: true
                not_state_code_regex:
                  type: string
                  description: The regex that will be evaluated as negative match for the shipping address state code, max size is 5000.
                  example: A[KLRZ]|C[AOT]
                  nullable: true
                zip_code_regex:
                  type: string
                  description: The regex that will be evaluated to match the shipping address zip code, max size is 5000.
                  example: (?i)(JE1|JE2|JE3|JE4|JE5)
                  nullable: true
                not_zip_code_regex:
                  type: string
                  description: The regex that will be evaluated as negative match for the shipping zip country code, max size is 5000.
                  example: (?i)(JE1|JE2|JE3)
                  nullable: true
                reference:
                  type: string
                  description: A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.
                  example: ANY-EXTERNAL-REFEFERNCE
                  nullable: true
                reference_origin:
                  type: string
                  description: Any identifier of the third party system that defines the reference code.
                  example: ANY-EXTERNAL-REFEFERNCE-ORIGIN
                  nullable: true
                metadata:
                  type: object
                  description: Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.
                  example:
                    foo: bar
                  nullable: true
            relationships:
              type: object
              properties:
                manual_tax_calculator:
                  required:
                  - data
                  type: object
                  properties:
                    data:
                      type: object
                      properties:
                        type:
                          type: string
                          description: The resource's type
                          enum:
                          - manual_tax_calculators
                        id:
                          type: string
                          description: Unique identifier for the resource (hash).
                          example: XAyRWNUzyN
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT