Tax Config

WIP: A summary needs to be written for Tax Config

GET/v3/tax_config

Find Tax Config

Find the latest Tax Config for a location

Query String parameters

  • Name
    locationId
    Type
    string
    Description
    the id for the location

Produces

The response content type: application/json

200 Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if success = false
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message
  • Name
    data
    Type
    object Required
    Description
    TaxConfig schema

Properties for data object

  • Name
    id
    Type
    string Required
    Description
  • Name
    meta
    Type
    object Required
    Description
    the metadata about the most recent change to the row
  • Name
    metadata
    Type
    object
    Description
    metadata reserved for customers to control
  • Name
    createdDate
    Type
    string Required
    Description
  • Name
    updatedDate
    Type
    string Required
    Description
  • Name
    companyId
    Type
    string Required
    Description
  • Name
    locationId
    Type
    string Required
    Description
  • Name
    epaPercent
    Type
    number Required
    Description
  • Name
    epaTaxable
    Type
    boolean Required
    Description
    US specific
  • Name
    epaTaxableGST
    Type
    boolean Required
    Description
    CA specific
  • Name
    epaTaxableHST
    Type
    boolean Required
    Description
    CA specific
  • Name
    epaTaxablePST
    Type
    boolean Required
    Description
    CA specific
  • Name
    gstPercent
    Type
    number Required
    Description
    CA specific
  • Name
    hstPercent
    Type
    number Required
    Description
    CA specific
  • Name
    hash
    Type
    string Required
    Description
  • Name
    includeEpaOnLabor
    Type
    boolean Required
    Description
  • Name
    includeEpaOnParts
    Type
    boolean Required
    Description
  • Name
    laborShopSupplies
    Type
    boolean Required
    Description
  • Name
    laborTaxable
    Type
    boolean Required
    Description
    US specific
  • Name
    laborTaxableGST
    Type
    boolean Required
    Description
    CA specific
  • Name
    laborTaxableHST
    Type
    boolean Required
    Description
    CA specific
  • Name
    laborTaxablePST
    Type
    boolean Required
    Description
    CA specific
  • Name
    partShopSupplies
    Type
    boolean Required
    Description
  • Name
    partTaxable
    Type
    boolean Required
    Description
    US specific
  • Name
    partTaxableGST
    Type
    boolean Required
    Description
    CA specific
  • Name
    partTaxableHST
    Type
    boolean Required
    Description
    CA specific
  • Name
    partTaxablePST
    Type
    boolean Required
    Description
    CA specific
  • Name
    priceCalculatorVersion
    Type
    number Required
    Description
  • Name
    pstPercent
    Type
    number Required
    Description
    CA specific
  • Name
    rateId
    Type
    string Required
    Description
  • Name
    shopSuppliesConfig
    Type
    one of: NoCap, OrderCap Required
    Description
  • Name
    shopSuppliesMaxCapCents
    Type
    integer Required
    Description
  • Name
    shopSuppliesMaxCapServicePercent
    Type
    number Required
    Description
  • Name
    shopSuppliesServiceCents
    Type
    integer Required
    Description
  • Name
    shopSuppliesServicePercent
    Type
    number Required
    Description
  • Name
    shopSuppliesServiceType
    Type
    one of: Percent, FixedCents Required
    Description
  • Name
    shopSuppliesTaxable
    Type
    boolean Required
    Description
    US specific
  • Name
    shopSuppliesTaxableGST
    Type
    boolean Required
    Description
    CA specific
  • Name
    shopSuppliesTaxableHST
    Type
    boolean Required
    Description
    CA specific
  • Name
    shopSuppliesTaxablePST
    Type
    boolean Required
    Description
    CA specific
  • Name
    subcontractTaxable
    Type
    boolean Required
    Description
    US specific
  • Name
    subcontractTaxableGST
    Type
    boolean Required
    Description
    CA specific
  • Name
    subcontractTaxableHST
    Type
    boolean Required
    Description
    CA specific
  • Name
    subcontractTaxablePST
    Type
    boolean Required
    Description
    CA specific
  • Name
    taxPercent
    Type
    number Required
    Description
    US specific
  • Name
    taxSystem
    Type
    one of: US, CA, MX Required
    Description
  • Name
    version
    Type
    integer Required
    Description

Properties for meta object

  • Name
    userId
    Type
    string
    Description
    the user id that made the most recent change
  • Name
    sessionId
    Type
    string
    Description
    the session id for the most recent change
  • Name
    version
    Type
    number
    Description
    a monotonically increasing number for the most recent change

4xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    object
    Description
    An optional object containing relevant error data
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

5xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    object
    Description
    An optional object containing relevant error data
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

Example Request

GET
/v3/tax_config
curl https://api.shopmonkey.cloud/v3/tax_config \
  -H "Authorization: Bearer ${SM_TOKEN}"

Example Response
application/json

{
  "success": true,
  "data": {
    "id": "id",
    "meta": {
      "userId": "userId",
      "sessionId": "sessionId",
      "version": 1
    },
    "createdDate": "createdDate",
    "updatedDate": null,
    "companyId": "companyId",
    "locationId": "locationId",
    "epaPercent": 1,
    "epaTaxable": true,
    "hstPercent": 1,
    "gstPercent": 1,
    "hash": "hash",
    "includeEpaOnLabor": true,
    "includeEpaOnParts": true,
    "laborShopSupplies": true,
    "laborTaxable": true,
    "partShopSupplies": true,
    "partTaxable": true,
    "priceCalculatorVersion": 1,
    "pstPercent": 1,
    "rateId": "rateId",
    "shopSuppliesConfig": "shopSuppliesConfig",
    "shopSuppliesMaxCapCents": 1,
    "shopSuppliesMaxCapServicePercent": 1,
    "shopSuppliesServiceCents": 1,
    "shopSuppliesServicePercent": 1,
    "shopSuppliesServiceType": "shopSuppliesServiceType",
    "shopSuppliesTaxable": true,
    "subcontractTaxable": true,
    "taxPercent": 1,
    "taxSystem": "taxSystem",
    "version": 1
  }
}
GET/v3/tax_config/:id

Find Tax Config By ID

Find a tax config given an id

URL parameters

  • Name
    id
    Type
    string Required
    Description
    the id of the tax config to find

Query String parameters

  • Name
    locationId
    Type
    string
    Description
    the id for the location

Produces

The response content type: application/json

200 Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if success = false
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message
  • Name
    data
    Type
    object Required
    Description
    TaxConfig schema

Properties for data object

  • Name
    id
    Type
    string Required
    Description
  • Name
    meta
    Type
    object Required
    Description
    the metadata about the most recent change to the row
  • Name
    metadata
    Type
    object
    Description
    metadata reserved for customers to control
  • Name
    createdDate
    Type
    string Required
    Description
  • Name
    updatedDate
    Type
    string Required
    Description
  • Name
    companyId
    Type
    string Required
    Description
  • Name
    locationId
    Type
    string Required
    Description
  • Name
    epaPercent
    Type
    number Required
    Description
  • Name
    epaTaxable
    Type
    boolean Required
    Description
    US specific
  • Name
    epaTaxableGST
    Type
    boolean Required
    Description
    CA specific
  • Name
    epaTaxableHST
    Type
    boolean Required
    Description
    CA specific
  • Name
    epaTaxablePST
    Type
    boolean Required
    Description
    CA specific
  • Name
    gstPercent
    Type
    number Required
    Description
    CA specific
  • Name
    hstPercent
    Type
    number Required
    Description
    CA specific
  • Name
    hash
    Type
    string Required
    Description
  • Name
    includeEpaOnLabor
    Type
    boolean Required
    Description
  • Name
    includeEpaOnParts
    Type
    boolean Required
    Description
  • Name
    laborShopSupplies
    Type
    boolean Required
    Description
  • Name
    laborTaxable
    Type
    boolean Required
    Description
    US specific
  • Name
    laborTaxableGST
    Type
    boolean Required
    Description
    CA specific
  • Name
    laborTaxableHST
    Type
    boolean Required
    Description
    CA specific
  • Name
    laborTaxablePST
    Type
    boolean Required
    Description
    CA specific
  • Name
    partShopSupplies
    Type
    boolean Required
    Description
  • Name
    partTaxable
    Type
    boolean Required
    Description
    US specific
  • Name
    partTaxableGST
    Type
    boolean Required
    Description
    CA specific
  • Name
    partTaxableHST
    Type
    boolean Required
    Description
    CA specific
  • Name
    partTaxablePST
    Type
    boolean Required
    Description
    CA specific
  • Name
    priceCalculatorVersion
    Type
    number Required
    Description
  • Name
    pstPercent
    Type
    number Required
    Description
    CA specific
  • Name
    rateId
    Type
    string Required
    Description
  • Name
    shopSuppliesConfig
    Type
    one of: NoCap, OrderCap Required
    Description
  • Name
    shopSuppliesMaxCapCents
    Type
    integer Required
    Description
  • Name
    shopSuppliesMaxCapServicePercent
    Type
    number Required
    Description
  • Name
    shopSuppliesServiceCents
    Type
    integer Required
    Description
  • Name
    shopSuppliesServicePercent
    Type
    number Required
    Description
  • Name
    shopSuppliesServiceType
    Type
    one of: Percent, FixedCents Required
    Description
  • Name
    shopSuppliesTaxable
    Type
    boolean Required
    Description
    US specific
  • Name
    shopSuppliesTaxableGST
    Type
    boolean Required
    Description
    CA specific
  • Name
    shopSuppliesTaxableHST
    Type
    boolean Required
    Description
    CA specific
  • Name
    shopSuppliesTaxablePST
    Type
    boolean Required
    Description
    CA specific
  • Name
    subcontractTaxable
    Type
    boolean Required
    Description
    US specific
  • Name
    subcontractTaxableGST
    Type
    boolean Required
    Description
    CA specific
  • Name
    subcontractTaxableHST
    Type
    boolean Required
    Description
    CA specific
  • Name
    subcontractTaxablePST
    Type
    boolean Required
    Description
    CA specific
  • Name
    taxPercent
    Type
    number Required
    Description
    US specific
  • Name
    taxSystem
    Type
    one of: US, CA, MX Required
    Description
  • Name
    version
    Type
    integer Required
    Description

Properties for meta object

  • Name
    userId
    Type
    string
    Description
    the user id that made the most recent change
  • Name
    sessionId
    Type
    string
    Description
    the session id for the most recent change
  • Name
    version
    Type
    number
    Description
    a monotonically increasing number for the most recent change

4xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    object
    Description
    An optional object containing relevant error data
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

5xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    object
    Description
    An optional object containing relevant error data
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

Example Request

GET
/v3/tax_config/:id
curl https://api.shopmonkey.cloud/v3/tax_config/:id \
  -H "Authorization: Bearer ${SM_TOKEN}"

Example Response
application/json

{
  "success": true,
  "data": {
    "id": "id",
    "meta": {
      "userId": "userId",
      "sessionId": "sessionId",
      "version": 1
    },
    "createdDate": "createdDate",
    "updatedDate": null,
    "companyId": "companyId",
    "locationId": "locationId",
    "epaPercent": 1,
    "epaTaxable": true,
    "hstPercent": 1,
    "gstPercent": 1,
    "hash": "hash",
    "includeEpaOnLabor": true,
    "includeEpaOnParts": true,
    "laborShopSupplies": true,
    "laborTaxable": true,
    "partShopSupplies": true,
    "partTaxable": true,
    "priceCalculatorVersion": 1,
    "pstPercent": 1,
    "rateId": "rateId",
    "shopSuppliesConfig": "shopSuppliesConfig",
    "shopSuppliesMaxCapCents": 1,
    "shopSuppliesMaxCapServicePercent": 1,
    "shopSuppliesServiceCents": 1,
    "shopSuppliesServicePercent": 1,
    "shopSuppliesServiceType": "shopSuppliesServiceType",
    "shopSuppliesTaxable": true,
    "subcontractTaxable": true,
    "taxPercent": 1,
    "taxSystem": "taxSystem",
    "version": 1
  }
}
PUT/v3/tax_config

Create Tax Config

Create a new version of the Tax Config

Query String parameters

  • Name
    locationId
    Type
    string Required
    Description

Body parameters

Consumes

The following content type is required: application/json

  • Name
    epaPercent
    Type
    number
    Description
  • Name
    epaTaxable
    Type
    boolean
    Description
    US specific
  • Name
    epaTaxableGST
    Type
    boolean
    Description
    CA specific
  • Name
    epaTaxableHST
    Type
    boolean
    Description
    CA specific
  • Name
    epaTaxablePST
    Type
    boolean
    Description
    CA specific
  • Name
    gstPercent
    Type
    number
    Description
    CA specific
  • Name
    hstPercent
    Type
    number
    Description
    CA specific
  • Name
    includeEpaOnLabor
    Type
    boolean
    Description
  • Name
    includeEpaOnParts
    Type
    boolean
    Description
  • Name
    laborShopSupplies
    Type
    boolean
    Description
  • Name
    laborTaxable
    Type
    boolean
    Description
    US specific
  • Name
    laborTaxableGST
    Type
    boolean
    Description
    CA specific
  • Name
    laborTaxableHST
    Type
    boolean
    Description
    CA specific
  • Name
    laborTaxablePST
    Type
    boolean
    Description
    CA specific
  • Name
    partShopSupplies
    Type
    boolean
    Description
  • Name
    partTaxable
    Type
    boolean
    Description
    US specific
  • Name
    partTaxableGST
    Type
    boolean
    Description
    CA specific
  • Name
    partTaxableHST
    Type
    boolean
    Description
    CA specific
  • Name
    partTaxablePST
    Type
    boolean
    Description
    CA specific
  • Name
    pstPercent
    Type
    number
    Description
    CA specific
  • Name
    shopSuppliesConfig
    Type
    one of: NoCap, OrderCap
    Description
  • Name
    shopSuppliesMaxCapCents
    Type
    integer
    Description
  • Name
    shopSuppliesMaxCapServicePercent
    Type
    number
    Description
  • Name
    shopSuppliesServiceCents
    Type
    integer
    Description
  • Name
    shopSuppliesServicePercent
    Type
    number
    Description
  • Name
    shopSuppliesServiceType
    Type
    one of: Percent, FixedCents
    Description
  • Name
    shopSuppliesTaxable
    Type
    boolean
    Description
    US specific
  • Name
    shopSuppliesTaxableGST
    Type
    boolean
    Description
    CA specific
  • Name
    shopSuppliesTaxableHST
    Type
    boolean
    Description
    CA specific
  • Name
    shopSuppliesTaxablePST
    Type
    boolean
    Description
    CA specific
  • Name
    subcontractTaxable
    Type
    boolean
    Description
    US specific
  • Name
    subcontractTaxableGST
    Type
    boolean
    Description
    CA specific
  • Name
    subcontractTaxableHST
    Type
    boolean
    Description
    CA specific
  • Name
    subcontractTaxablePST
    Type
    boolean
    Description
    CA specific
  • Name
    taxPercent
    Type
    number
    Description
    US specific
  • Name
    version
    Type
    integer
    Description
  • Name
    rateId
    Type
    string
    Description

Produces

The response content type: application/json

200 Response

  • Name
    data
    Type
    object
    Description
  • Name
    success
    Type
    boolean Required
    Description

Properties for data object

  • Name
    id
    Type
    string Required
    Description
    the id for the object

4xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    object
    Description
    An optional object containing relevant error data
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

5xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    object
    Description
    An optional object containing relevant error data
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

Example Request
application/json

PUT
/v3/tax_config
curl https://api.shopmonkey.cloud/v3/tax_config \
  -H "Authorization: Bearer ${SM_TOKEN}" \
  -X PUT -H 'Content-Type: application/json' \
  --data '{}'

Example Response
application/json

{
  "success": true
}
POST/v3/tax_config/order/:orderId

Create New Tax Config For Order

Creates and assigns a new Tax Config for an order. Used for order-specific tax overrides

URL parameters

  • Name
    orderId
    Type
    string Required
    Description
    the order id to associate with the new tax config

Query String parameters

  • Name
    locationId
    Type
    string Required
    Description

Body parameters

Consumes

The following content type is required: application/json

  • Name
    epaPercent
    Type
    number
    Description
  • Name
    epaTaxable
    Type
    boolean
    Description
    US specific
  • Name
    epaTaxableGST
    Type
    boolean
    Description
    CA specific
  • Name
    epaTaxableHST
    Type
    boolean
    Description
    CA specific
  • Name
    epaTaxablePST
    Type
    boolean
    Description
    CA specific
  • Name
    gstPercent
    Type
    number
    Description
    CA specific
  • Name
    hstPercent
    Type
    number
    Description
    CA specific
  • Name
    includeEpaOnLabor
    Type
    boolean
    Description
  • Name
    includeEpaOnParts
    Type
    boolean
    Description
  • Name
    laborShopSupplies
    Type
    boolean
    Description
  • Name
    laborTaxable
    Type
    boolean
    Description
    US specific
  • Name
    laborTaxableGST
    Type
    boolean
    Description
    CA specific
  • Name
    laborTaxableHST
    Type
    boolean
    Description
    CA specific
  • Name
    laborTaxablePST
    Type
    boolean
    Description
    CA specific
  • Name
    partShopSupplies
    Type
    boolean
    Description
  • Name
    partTaxable
    Type
    boolean
    Description
    US specific
  • Name
    partTaxableGST
    Type
    boolean
    Description
    CA specific
  • Name
    partTaxableHST
    Type
    boolean
    Description
    CA specific
  • Name
    partTaxablePST
    Type
    boolean
    Description
    CA specific
  • Name
    pstPercent
    Type
    number
    Description
    CA specific
  • Name
    shopSuppliesConfig
    Type
    one of: NoCap, OrderCap
    Description
  • Name
    shopSuppliesMaxCapCents
    Type
    integer
    Description
  • Name
    shopSuppliesMaxCapServicePercent
    Type
    number
    Description
  • Name
    shopSuppliesServiceCents
    Type
    integer
    Description
  • Name
    shopSuppliesServicePercent
    Type
    number
    Description
  • Name
    shopSuppliesServiceType
    Type
    one of: Percent, FixedCents
    Description
  • Name
    shopSuppliesTaxable
    Type
    boolean
    Description
    US specific
  • Name
    shopSuppliesTaxableGST
    Type
    boolean
    Description
    CA specific
  • Name
    shopSuppliesTaxableHST
    Type
    boolean
    Description
    CA specific
  • Name
    shopSuppliesTaxablePST
    Type
    boolean
    Description
    CA specific
  • Name
    subcontractTaxable
    Type
    boolean
    Description
    US specific
  • Name
    subcontractTaxableGST
    Type
    boolean
    Description
    CA specific
  • Name
    subcontractTaxableHST
    Type
    boolean
    Description
    CA specific
  • Name
    subcontractTaxablePST
    Type
    boolean
    Description
    CA specific
  • Name
    taxPercent
    Type
    number
    Description
    US specific
  • Name
    version
    Type
    integer
    Description
  • Name
    rateId
    Type
    string
    Description

Produces

The response content type: application/json

200 Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if success = false
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message
  • Name
    data
    Type
    object Required
    Description
    TaxConfig schema

Properties for data object

  • Name
    id
    Type
    string Required
    Description
  • Name
    createdDate
    Type
    string Required
    Description
  • Name
    updatedDate
    Type
    string Required
    Description
  • Name
    companyId
    Type
    string Required
    Description
  • Name
    locationId
    Type
    string Required
    Description
  • Name
    epaPercent
    Type
    number Required
    Description
  • Name
    epaTaxable
    Type
    boolean Required
    Description
    US specific
  • Name
    epaTaxableGST
    Type
    boolean Required
    Description
    CA specific
  • Name
    epaTaxableHST
    Type
    boolean Required
    Description
    CA specific
  • Name
    epaTaxablePST
    Type
    boolean Required
    Description
    CA specific
  • Name
    gstPercent
    Type
    number Required
    Description
    CA specific
  • Name
    hstPercent
    Type
    number Required
    Description
    CA specific
  • Name
    hash
    Type
    string Required
    Description
  • Name
    includeEpaOnLabor
    Type
    boolean Required
    Description
  • Name
    includeEpaOnParts
    Type
    boolean Required
    Description
  • Name
    laborShopSupplies
    Type
    boolean Required
    Description
  • Name
    laborTaxable
    Type
    boolean Required
    Description
    US specific
  • Name
    laborTaxableGST
    Type
    boolean Required
    Description
    CA specific
  • Name
    laborTaxableHST
    Type
    boolean Required
    Description
    CA specific
  • Name
    laborTaxablePST
    Type
    boolean Required
    Description
    CA specific
  • Name
    partShopSupplies
    Type
    boolean Required
    Description
  • Name
    partTaxable
    Type
    boolean Required
    Description
    US specific
  • Name
    partTaxableGST
    Type
    boolean Required
    Description
    CA specific
  • Name
    partTaxableHST
    Type
    boolean Required
    Description
    CA specific
  • Name
    partTaxablePST
    Type
    boolean Required
    Description
    CA specific
  • Name
    priceCalculatorVersion
    Type
    number Required
    Description
  • Name
    pstPercent
    Type
    number Required
    Description
    CA specific
  • Name
    rateId
    Type
    string Required
    Description
  • Name
    shopSuppliesConfig
    Type
    one of: NoCap, OrderCap Required
    Description
  • Name
    shopSuppliesMaxCapCents
    Type
    integer Required
    Description
  • Name
    shopSuppliesMaxCapServicePercent
    Type
    number Required
    Description
  • Name
    shopSuppliesServiceCents
    Type
    integer Required
    Description
  • Name
    shopSuppliesServicePercent
    Type
    number Required
    Description
  • Name
    shopSuppliesServiceType
    Type
    one of: Percent, FixedCents Required
    Description
  • Name
    shopSuppliesTaxable
    Type
    boolean Required
    Description
    US specific
  • Name
    shopSuppliesTaxableGST
    Type
    boolean Required
    Description
    CA specific
  • Name
    shopSuppliesTaxableHST
    Type
    boolean Required
    Description
    CA specific
  • Name
    shopSuppliesTaxablePST
    Type
    boolean Required
    Description
    CA specific
  • Name
    subcontractTaxable
    Type
    boolean Required
    Description
    US specific
  • Name
    subcontractTaxableGST
    Type
    boolean Required
    Description
    CA specific
  • Name
    subcontractTaxableHST
    Type
    boolean Required
    Description
    CA specific
  • Name
    subcontractTaxablePST
    Type
    boolean Required
    Description
    CA specific
  • Name
    taxPercent
    Type
    number Required
    Description
    US specific
  • Name
    taxSystem
    Type
    one of: US, CA, MX Required
    Description
  • Name
    version
    Type
    integer Required
    Description

4xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    object
    Description
    An optional object containing relevant error data
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

5xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    object
    Description
    An optional object containing relevant error data
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

Example Request
application/json

POST
/v3/tax_config/order/:orderId
curl https://api.shopmonkey.cloud/v3/tax_config/order/:orderId \
  -H "Authorization: Bearer ${SM_TOKEN}" \
  -H 'Content-Type: application/json' \
  --data '{}'

Example Response
application/json

{
  "success": true
}