YQueue DocsDevelopers

Schema

Tax Request

On edit, omitted top-level properties retain their existing values.

  • Catalog

Overview

object · 5 properties · 0 required

Properties

name

string
Min length 1
Max length 255

tags

allOf

UUIDs of tags to associate with the tax.

All of

All of 1

reference

References Catalog UUID List.

calculation

object

Taxes use percentage calculations and do not support percentage caps.

Nested properties

type

string Required

Allowed values

percentage

percentage

string Required

A percentage between 0.1 and 100 inclusive, with at most one decimal place.

Pattern ^((0\.[1-9])|([1-9]([0-9])?(\.[0-9])?)|100)$

percentage_cap

null

product_group

string | null

The UUID of a product group owned by the merchant. On edit, omit this property to retain the existing product group or supply `null` to remove it.

Format uuid
Nullable Yes

availability

reference

References Availability Request.

Used by

Raw YAML
Download source
title: Tax Request
x-tags:
  - Catalog
type: object
description: On edit, omitted top-level properties retain their existing values.
properties:
  name:
    type: string
    minLength: 1
    maxLength: 255
  tags:
    allOf:
      - $ref: ./CatalogUuidList.yaml
    description: UUIDs of tags to associate with the tax.
  calculation:
    type: object
    description: Taxes use percentage calculations and do not support percentage caps.
    required:
      - type
      - percentage
    properties:
      type:
        type: string
        enum:
          - percentage
      percentage:
        type: string
        pattern: '^((0\.[1-9])|([1-9]([0-9])?(\.[0-9])?)|100)$'
        description: A percentage between 0.1 and 100 inclusive, with at most one decimal place.
      percentage_cap:
        type: 'null'
        default: null
  product_group:
    type:
      - string
      - 'null'
    format: uuid
    description: The UUID of a product group owned by the merchant. On edit, omit this property to retain the existing product group or supply `null` to remove it.
  availability:
    $ref: ./AvailabilityRequest.yaml

Search documentation

Search across this documentation site.