Docs
Management API
Tax properties

Tax Properties

Include tax properties and product tax properties in tax calculations.

Get Tax Properties

GET /tax/properties

Request

Retrieve all tax properties defined in this store.

Authentication

  • X-Auth-Token in header
    required

Parameters

  • store_hash in path - string
  • id:in in query - array

    ID of tax property. To target multiple tax properties, provide a comma-separated list of IDs such as 12,34,56.

    Type: array[integer]

example

Response

OK

Body

object | application/json
  • data
    array[object]

  • meta
    object

    Response metadata.

example

Update Tax Properties

PUT /tax/properties

Request

Update one or more tax properties. Only fields specified will be adjusted.

Authentication

  • X-Auth-Token in header
    required

Parameters

  • store_hash in path - string
  • Content-Type in header with default of application/json - string
    required

    The MIME type of the request body.

Body

array | application/json
  • id
    integer
    required

    An internal identifier used by other operations.

    Example: 1

  • code
    string

    The unique string programmatically references this unique tax property by the tax provider. Merchants should liaise with their tax provider to explore supported values and functions.

    Example: A-123456789

  • display_name
    string

    The human-readable name for this property. This string will be displayed on the Products screen as a field label.

    Example: Example Tax Property 1

  • description
    string

    Optional. Additional detail about this tax property may help guide merchants. This string will be displayed on the Products screen as a tooltip associated with the relevant field.

    Example: Food Industry

example

Response

OK

Body

object | application/json
  • data
    array[object]

  • meta
    object

    Response metadata.

example

Create Tax Properties

POST /tax/properties

Request

Create one or more tax properties. A code and a display name must be included when creating tax properties.

Authentication

  • X-Auth-Token in header
    required

Parameters

  • store_hash in path - string
  • Content-Type in header with default of application/json - string
    required

    The MIME type of the request body.

Body

array | application/json
  • code
    string
    required

    The unique string programmatically references this unique tax property by the tax provider. Merchants should liaise with their tax provider to explore supported values and functions.

    Example: A-123456789

  • display_name
    string
    required

    The human-readable name for this property. This string will be displayed on the Products screen as a field label.

    Example: Example Tax Property 1

  • description
    string

    Additional detail about this tax property may help guide merchants. This string will be displayed on the Products screen as a tooltip associated with the relevant field.

    Example: Food Industry

example

Response

OK

Body

object | application/json
  • data
    array[object]

  • meta
    object

    Response metadata.

example

Delete Tax Properties

DELETE /tax/properties

Request

Delete one or multiple tax properties. A tax property must have zero usages within product tax properties before you can delete it.

Authentication

  • X-Auth-Token in header
    required

Parameters

  • store_hash in path - string
  • id:in in query - array
    required

    ID of tax property. To target multiple tax properties, provide a comma-separated list of IDs such as 12,34,56.

    Type: array[integer]

example

Response

No Content

Did you find what you were looking for?