Servers Playground How we check Add a server Log in

Smaregi MCP by usefulapi

Working · 1.8 s

io.usefulapi/smaregiv1.1.0 Domain verified

Read Smaregi stores, products, customers, stock and transactions; manage customers, products, stock.

Commerce

Source Website Registry entry

Maintain this server? Claim it

Try it

Call this server's tools from your browser. Nothing to install.

https://smaregi.usefulapi.io/mcp

Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.

Tool list from our last check. Connect live to refresh it.

smaregi_adjust_stock Destructive

WRITE: add (positive) or subtract (negative) a quantity to the stock of one product in one store. Not idempotent: a repeat applies the change again. POST /stock/{product_id}/add.

store_idstring, required

Numeric Smaregi id (string or number).

product_idstring, required

Numeric Smaregi id (string or number).

stock_amountinteger, required

The change: +5 adds five, -3 removes three.

memostring

Note stored in the stock history.

The server marks this tool as destructive. Running it may delete or overwrite data on the server or in any account you connected with your headers.

I understand, run it anyway

Smaregi MCP by usefulapi MCP server | mcptry

Tools (20)

smaregi_adjust_stock

WRITE: add (positive) or subtract (negative) a quantity to the stock of one product in one store. Not idempotent: a repeat applies the change again. POST /stock/{product_id}/add.

destructive

Argument	Type	Description
memo	string	Note stored in the stock history.
store_id*	any	Numeric Smaregi id (string or number).
product_id*	any	Numeric Smaregi id (string or number).
stock_amount*	integer	The change: +5 adds five, -3 removes three.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "product_id",
    "store_id",
    "stock_amount"
  ],
  "properties": {
    "memo": {
      "type": "string",
      "maxLength": 200,
      "description": "Note stored in the stock history."
    },
    "store_id": {
      "anyOf": [
        {
          "type": "string",
          "pattern": "^[0-9]{1,18}$"
        },
        {
          "type": "integer",
          "maximum": 9007199254740991,
          "exclusiveMinimum": 0
        }
      ],
      "description": "Numeric Smaregi id (string or number)."
    },
    "product_id": {
      "anyOf": [
        {
          "type": "string",
          "pattern": "^[0-9]{1,18}$"
        },
        {
          "type": "integer",
          "maximum": 9007199254740991,
          "exclusiveMinimum": 0
        }
      ],
      "description": "Numeric Smaregi id (string or number)."
    },
    "stock_amount": {
      "type": "integer",
      "maximum": 1000000000,
      "minimum": -1000000000,
      "description": "The change: +5 adds five, -3 removes three."
    }
  }
}

smaregi_create_customer

WRITE: create a customer (member). customerCode, firstName and lastName are required; the contract's own required-column settings may demand more. Not idempotent: calling twice with a different code creates two customers. POST /customers.

Argument	Type	Description
sex	any	Sex: 0 = unknown, 1 = male, 2 = female.
note	any	Note.
rank	any	Member rank.
note2	any	Second note.
status	any	Member status: 0 = active, 1 = suspended, 2 = card lost, 3 = withdrawn, 4 = merged.
address	any	Address.
storeId	any	Store id the customer belongs to.
lastKana	any	Last name, kana.
lastName*	any	Last name.
postCode	any	Postal code.

smaregi_create_product

WRITE: create a product. categoryId, productName and price are required. Not idempotent. POST /products.

Argument	Type	Description
tag	any	Tag.
url	any	Product URL.
cost	any	Unit cost.
size	any	Size.
color	any	Color.
price*	any	Selling price.
division	any	Product division: 0 = normal (default), 1 = prepaid multi-use ticket (only contracts with that feature), 2 = option product.
catchCopy	any	Catch copy.
groupCode	any	Group code.
categoryId*	any	Category id (smaregi_list_categories).
description	any

smaregi_get_category

One product category by id. GET /categories/{category_id}.

read-only

Argument	Type	Description
fields	string	Comma-separated top-level field names to return (e.g. productId,productName); fewer fields = smaller replies.
category_id*	any	Numeric Smaregi id (string or number).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "category_id"
  ],
  "properties": {
    "fields": {
      "type": "string",
      "pattern": "^[A-Za-z][A-Za-z0-9]*(,[A-Za-z][A-Za-z0-9]*)*$",
      "maxLength": 500,
      "description": "Comma-separated top-level field names to return (e.g. productId,productName); fewer fields = smaller replies."
    },
    "category_id": {
      "anyOf": [
        {
          "type": "string",
          "pattern": "^[0-9]{1,18}$"
        },
        {
          "type": "integer",
          "maximum": 9007199254740991,
          "exclusiveMinimum": 0
        }
      ],
      "description": "Numeric Smaregi id (string or number)."
    }
  }
}

smaregi_get_customer

One customer by id, optionally with the contract's custom fields. Contains personal data. GET /customers/{customer_id}.

read-only

Argument	Type	Description
fields	string	Comma-separated top-level field names to return (e.g. productId,productName); fewer fields = smaller replies.
customer_id*	any	Numeric Smaregi id (string or number).
with_custom_fields	boolean	Add the custom field values.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "customer_id"
  ],
  "properties": {
    "fields": {
      "type": "string",
      "pattern": "^[A-Za-z][A-Za-z0-9]*(,[A-Za-z][A-Za-z0-9]*)*$",
      "maxLength": 500,
      "description": "Comma-separated top-level field names to return (e.g. productId,productName); fewer fields = smaller replies."
    },
    "customer_id": {
      "anyOf": [
        {
          "type": "string",
          "pattern": "^[0-9]{1,18}$"
        },
        {
          "type": "integer",
          "maximum": 9007199254740991,
          "exclusiveMinimum": 0
        }
      ],
      "description": "Numeric Smaregi id (string or number)."
    },
    "with_custom_fields": {
      "type": "boolean",
      "description": "Add the custom field values."
    }
  }
}

smaregi_get_product

One product by id, optionally with store prices, bundled items, store assignments, reserved stock, attribute items and order settings. GET /products/{product_id}.

read-only

Argument	Type	Description
product_id*	any	Numeric Smaregi id (string or number).
with_prices	boolean	Add the store/period-specific prices.
with_stores	boolean	Add the store assignments.
with_order_setting	boolean	Add the ordering settings.
with_reserve_items	boolean	Add the free-form reserve items.
with_attribute_items	boolean	Add the attribute items.
with_inventory_reservations	boolean	Add the inventory reservations.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "product_id"
  ],
  "properties": {
    "product_id": {
      "anyOf": [
        {
          "type": "string",
          "pattern": "^[0-9]{1,18}$"
        },
        {
          "type": "integer",
          "maximum": 9007199254740991,
          "exclusiveMinimum": 0
        }
      ],
      "description": "Numeric Smaregi id (string or number)."
    },
    "with_prices": {
      "type": "boolean",
      "description": "Add the store/period-specific prices."
    },
    "with_stores": {
      "type": "boolean",
      "description": "Add the store assignments."
    },
    "with_order_setting": {
      "type": "boolean",
      "description": "Add the ordering settings."
    },
    "with_reserve_items": {
      "type": "boolean",
      "description": "Add the free-form reserve items."
    },
    "with_attribute_items": {
      "type": "boolean",
      "description": "Add the attribute items."
    },
    "with_inventory_reservations": {
      "type": "boolean",
      "description": "Add the inventory reservations."
    }
  }
}

smaregi_get_staff

One staff member by id. GET /staffs/{staff_id}.

read-only

Argument	Type	Description
fields	string	Comma-separated top-level field names to return (e.g. productId,productName); fewer fields = smaller replies.
staff_id*	any	Numeric Smaregi id (string or number).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "staff_id"
  ],
  "properties": {
    "fields": {
      "type": "string",
      "pattern": "^[A-Za-z][A-Za-z0-9]*(,[A-Za-z][A-Za-z0-9]*)*$",
      "maxLength": 500,
      "description": "Comma-separated top-level field names to return (e.g. productId,productName); fewer fields = smaller replies."
    },
    "staff_id": {
      "anyOf": [
        {
          "type": "string",
          "pattern": "^[0-9]{1,18}$"
        },
        {
          "type": "integer",
          "maximum": 9007199254740991,
          "exclusiveMinimum": 0
        }
      ],
      "description": "Numeric Smaregi id (string or number)."
    }
  }
}

smaregi_get_store

One store by id. GET /stores/{store_id}.

read-only

Argument	Type	Description
fields	string	Comma-separated top-level field names to return (e.g. productId,productName); fewer fields = smaller replies.
store_id*	any	Numeric Smaregi id (string or number).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "store_id"
  ],
  "properties": {
    "fields": {
      "type": "string",
      "pattern": "^[A-Za-z][A-Za-z0-9]*(,[A-Za-z][A-Za-z0-9]*)*$",
      "maxLength": 500,
      "description": "Comma-separated top-level field names to return (e.g. productId,productName); fewer fields = smaller replies."
    },
    "store_id": {
      "anyOf": [
        {
          "type": "string",
          "pattern": "^[0-9]{1,18}$"
        },
        {
          "type": "integer",
          "maximum": 9007199254740991,
          "exclusiveMinimum": 0
        }
      ],
      "description": "Numeric Smaregi id (string or number)."
    }
  }
}

smaregi_get_transaction

One transaction (receipt) by its transaction id (transactionHeadId), optionally with line items, discounts and payments. Contains personal data. GET /transactions/{transaction_id}.

read-only

Argument	Type	Description
with_details	boolean	Add the line items.
with_payments	boolean	Add the payments.
transaction_id*	any	The transactionHeadId.
with_discounts	boolean	Add the discounts.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "transaction_id"
  ],
  "properties": {
    "with_details": {
      "type": "boolean",
      "description": "Add the line items."
    },
    "with_payments": {
      "type": "boolean",
      "description": "Add the payments."
    },
    "transaction_id": {
      "anyOf": [
        {
          "type": "string",
          "pattern": "^[0-9]{1,18}$"
        },
        {
          "type": "integer",
          "maximum": 9007199254740991,
          "exclusiveMinimum": 0
        }
      ],
      "description": "The transactionHeadId."
    },
    "with_discounts": {
      "type": "boolean",
      "description": "Add the discounts."
    }
  }
}

smaregi_list_categories

List product categories (departments): id, code, name, parent, level. Use the ids when creating or filtering products. GET /categories.

read-only

Argument	Type	Description
page	integer	Page number, from 1 (default 1). Pass the previous reply's next_page.
sort	string	Sort order: comma-separated field names, ':desc' for descending (e.g. updDateTime:desc).
limit	integer	Results per page, 1-500 (default 50).
fields	string	Comma-separated top-level field names to return (e.g. productId,productName); fewer fields = smaller replies.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "page": {
      "type": "integer",
      "maximum": 100000,
      "description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
      "exclusiveMinimum": 0
    },
    "sort": {
      "type": "string",
      "pattern": "^[A-Za-z][A-Za-z0-9]*(:desc)?(,[A-Za-z][A-Za-z0-9]*(:desc)?)*$",
      "maxLength": 200,
      "description": "Sort order: comma-separated field names, ':desc' for descending (e.g. updDateTime:desc)."
    },
    "limit": {
      "type": "integer",
      "maximum": 500,
      "description": "Results per page, 1-500 (default 50).",
      "exclusiveMinimum": 0
    },
    "fields": {
      "type": "string",
      "pattern": "^[A-Za-z][A-Za-z0-9]*(,[A-Za-z][A-Za-z0-9]*)*$",
      "maxLength": 500,
      "description": "Comma-separated top-level field names to return (e.g. productId,productName); fewer fields = smaller replies."
    }
  }
}

smaregi_list_customers

List customers (members): id, code, number, name, phone, e-mail, address. Smaregi cannot search by name, phone or e-mail: filter by customer code, member number, id range or update time, or page through. Contains shoppers' personal data. GET /customers.

read-only

Argument	Type	Description
page	integer	Page number, from 1 (default 1). Pass the previous reply's next_page.
sort	string	Sort order: comma-separated field names, ':desc' for descending (e.g. updDateTime:desc).
limit	integer	Results per page, 1-500 (default 50).
fields	string	Comma-separated top-level field names to return (e.g. productId,productName); fewer fields = smaller replies.
updated_to	string	Only customers changed at or before this date-time (31 days at most).
customer_no	string	Only the customer with this member number.
updated_from	string	Only customers changed at or after this date-time (ISO 8601 with timezone).
customer_code	string

smaregi_list_products

List products with id, category, code, name, price, cost and update time. Filter by category, code, group code, display flag or update time (a 31-day maximum range). GET /products.

read-only

Argument	Type	Description
page	integer	Page number, from 1 (default 1). Pass the previous reply's next_page.
sort	string	Sort order: comma-separated field names, ':desc' for descending (e.g. updDateTime:desc).
limit	integer	Results per page, 1-500 (default 50).
fields	string	Comma-separated top-level field names to return (e.g. productId,productName); fewer fields = smaller replies.
group_code	string	Only products with this group code.
updated_to	string	Only products changed at or before this date-time (the range may span 31 days at most).
category_id	any	Only products of this category id.
display_flag	string	1 = shown on the register, 0 = hidden.

smaregi_list_staffs

List staff members: id, code, name, role, e-mail. Passwords are never returned. GET /staffs.

read-only

Argument	Type	Description
page	integer	Page number, from 1 (default 1). Pass the previous reply's next_page.
sort	string	Sort order: comma-separated field names, ':desc' for descending (e.g. updDateTime:desc).
limit	integer	Results per page, 1-500 (default 50).
fields	string	Comma-separated top-level field names to return (e.g. productId,productName); fewer fields = smaller replies.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "page": {
      "type": "integer",
      "maximum": 100000,
      "description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
      "exclusiveMinimum": 0
    },
    "sort": {
      "type": "string",
      "pattern": "^[A-Za-z][A-Za-z0-9]*(:desc)?(,[A-Za-z][A-Za-z0-9]*(:desc)?)*$",
      "maxLength": 200,
      "description": "Sort order: comma-separated field names, ':desc' for descending (e.g. updDateTime:desc)."
    },
    "limit": {
      "type": "integer",
      "maximum": 500,
      "description": "Results per page, 1-500 (default 50).",
      "exclusiveMinimum": 0
    },
    "fields": {
      "type": "string",
      "pattern": "^[A-Za-z][A-Za-z0-9]*(,[A-Za-z][A-Za-z0-9]*)*$",
      "maxLength": 500,
      "description": "Comma-separated top-level field names to return (e.g. productId,productName); fewer fields = smaller replies."
    }
  }
}

smaregi_list_stock

List stock levels per store and product (stockAmount, reserved amount). Filter by store or product. Smaregi only lists a product once its quantity has changed at least once. An update-time filter needs both bounds (31 days at most). GET /stock.

read-only

Argument	Type	Description
page	integer	Page number, from 1 (default 1). Pass the previous reply's next_page.
sort	string	Sort order: comma-separated field names, ':desc' for descending (e.g. updDateTime:desc).
limit	integer	Results per page, 1-500 (default 50).
fields	string	Comma-separated top-level field names to return (e.g. productId,productName); fewer fields = smaller replies.
store_id	any	Only this store id.
product_id	any	Only this product id.
updated_to	string	Only stock changed at or before this date-time (give updated_from as well).
updated_from	string	Only stock changed at or after this date-time (give updated_to as well).

smaregi_list_stock_changes

The stock change history of one product in one store: date, amount, division (sale, purchase, transfer, adjustment...). GET /stock/changes/{product_id}/{store_id}.

read-only

Argument	Type	Description
page	integer	Page number, from 1 (default 1). Pass the previous reply's next_page.
sort	string	Sort order: comma-separated field names, ':desc' for descending (e.g. updDateTime:desc).
limit	integer	Results per page, 1-500 (default 50).
fields	string	Comma-separated top-level field names to return (e.g. productId,productName); fewer fields = smaller replies.
store_id*	any	Numeric Smaregi id (string or number).
product_id*	any	Numeric Smaregi id (string or number).
target_date	string	Only changes of this target date, as Smaregi formats it (yyyy-mm-dd).
stock_division	string	Only changes of this stock division code.

smaregi_list_stores

List the stores (shops) of the Smaregi contract: id, code, name, address, phone. Use the ids to filter stock and transactions. GET /stores.

read-only

Argument	Type	Description
page	integer	Page number, from 1 (default 1). Pass the previous reply's next_page.
sort	string	Sort order: comma-separated field names, ':desc' for descending (e.g. updDateTime:desc).
limit	integer	Results per page, 1-500 (default 50).
fields	string	Comma-separated top-level field names to return (e.g. productId,productName); fewer fields = smaller replies.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "page": {
      "type": "integer",
      "maximum": 100000,
      "description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
      "exclusiveMinimum": 0
    },
    "sort": {
      "type": "string",
      "pattern": "^[A-Za-z][A-Za-z0-9]*(:desc)?(,[A-Za-z][A-Za-z0-9]*(:desc)?)*$",
      "maxLength": 200,
      "description": "Sort order: comma-separated field names, ':desc' for descending (e.g. updDateTime:desc)."
    },
    "limit": {
      "type": "integer",
      "maximum": 500,
      "description": "Results per page, 1-500 (default 50).",
      "exclusiveMinimum": 0
    },
    "fields": {
      "type": "string",
      "pattern": "^[A-Za-z][A-Za-z0-9]*(,[A-Za-z][A-Za-z0-9]*)*$",
      "maxLength": 500,
      "description": "Comma-separated top-level field names to return (e.g. productId,productName); fewer fields = smaller replies."
    }
  }
}

smaregi_list_transactions

List sales transactions (receipts) in a time window of at most 31 days: id, date-time, division (1 = normal sale, 2 = deposit, 3 = withdrawal...), store, terminal, customer, totals. Optionally with the line items (limit 100 then). Contains shoppers' personal data. GET /transactions.

read-only

Argument	Type	Description
to*	string	End of the window (at most 31 days after from).
from*	string	Start of the window: transaction date-time (when Smaregi received it), ISO 8601 with timezone.
page	integer	Page number, from 1 (default 1). Pass the previous reply's next_page.
sort	string	Sort order: comma-separated field names, ':desc' for descending (e.g. updDateTime:desc).
limit	integer	Results per page, 1-500 (default 50).
fields	string	Comma-separated top-level field names to return (e.g. productId,productName); fewer fields = smaller replies.
store_id	any	Only this store id.
with_details

smaregi_set_stock

WRITE: set the absolute stock quantity of one product in one store, replacing the current quantity. Use smaregi_adjust_stock for a relative change. PATCH /stock/{product_id}.

destructive

Argument	Type	Description
memo	string	Note stored in the stock history.
store_id*	any	Numeric Smaregi id (string or number).
product_id*	any	Numeric Smaregi id (string or number).
stock_amount*	integer	The new quantity.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "product_id",
    "store_id",
    "stock_amount"
  ],
  "properties": {
    "memo": {
      "type": "string",
      "maxLength": 200,
      "description": "Note stored in the stock history."
    },
    "store_id": {
      "anyOf": [
        {
          "type": "string",
          "pattern": "^[0-9]{1,18}$"
        },
        {
          "type": "integer",
          "maximum": 9007199254740991,
          "exclusiveMinimum": 0
        }
      ],
      "description": "Numeric Smaregi id (string or number)."
    },
    "product_id": {
      "anyOf": [
        {
          "type": "string",
          "pattern": "^[0-9]{1,18}$"
        },
        {
          "type": "integer",
          "maximum": 9007199254740991,
          "exclusiveMinimum": 0
        }
      ],
      "description": "Numeric Smaregi id (string or number)."
    },
    "stock_amount": {
      "type": "integer",
      "maximum": 1000000000,
      "minimum": -1000000000,
      "description": "The new quantity."
    }
  }
}

smaregi_update_customer

WRITE: change fields of one customer (only the fields you pass are changed). Overwrites the old values. PATCH /customers/{customer_id}.

destructive

Argument	Type	Description
sex	any	Sex: 0 = unknown, 1 = male, 2 = female.
note	any	Note.
rank	any	Member rank.
note2	any	Second note.
status	any	Member status: 0 = active, 1 = suspended, 2 = card lost, 3 = withdrawn, 4 = merged.
address	any	Address.
storeId	any	Store id the customer belongs to.
lastKana	any	Last name, kana.
lastName	any	Last name.
postCode	any	Postal code.

smaregi_update_product

WRITE: change fields of one product (only the fields you pass are changed), for example its price or name. Overwrites the old values. PATCH /products/{product_id}.

destructive

Argument	Type	Description
tag	any	Tag.
url	any	Product URL.
cost	any	Unit cost.
size	any	Size.
color	any	Color.
price	any	Selling price.
division	any	Product division: 0 = normal (default), 1 = prepaid multi-use ticket (only contracts with that feature), 2 = option product.
catchCopy	any	Catch copy.
groupCode	any	Group code.
categoryId	any	Category (department) id, see smaregi_list_categories.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "customerCode",
    "firstName",
    "lastName"
  ],
  "properties": {
    "sex": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2000
        },
        {
          "type": "number"
        }
      ],
      "description": "Sex: 0 = unknown, 1 = male, 2 = female."
    },
    "note": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2000
        },
        {
          "type": "number"
        }
      ],
      "description": "Note."
    },
    "rank": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2000
        },
        {
          "type": "number"
        }
      ],
      "description": "Member rank."
    },
    "note2": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2000
        },
        {
          "type": "number"
        }
      ],
      "description": "Second note."
    },
    "status": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2000
        },
        {
          "type": "number"
        }
      ],
      "description": "Member status: 0 = active, 1 = suspended, 2 = card lost, 3 = withdrawn, 4 = merged."
    },
    "address": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2000
        },
        {
          "type": "number"
        }
      ],
      "description": "Address."
    },
    "storeId": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2000
        },
        {
          "type": "number"
        }
      ],
      "description": "Store id the customer belongs to."
    },
    "lastKana": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2000
        },
        {
          "type": "number"
        }
      ],
      "description": "Last name, kana."
    },
    "lastName": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2000
        },
        {
          "type": "number"
        }
      ],
      "description": "Last name."
    },
    "postCode": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2000
        },
        {
          "type": "number"
        }
      ],
      "description": "Postal code."
    },
    "birthDate": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2000
        },
        {
          "type": "number"
        }
      ],
      "description": "Birth date, yyyy-mm-dd."
    },
    "entryDate": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2000
        },
        {
          "type": "number"
        }
      ],
      "description": "Enrollment (membership start) date, yyyy-mm-dd; some contracts require it when creating a customer."
    },
    "faxNumber": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2000
        },
        {
          "type": "number"
        }
      ],
      "description": "Fax number."
    },
    "firstKana": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2000
        },
        {
          "type": "number"
        }
      ],
      "description": "First name, kana."
    },
    "firstName": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2000
        },
        {
          "type": "number"
        }
      ],
      "description": "First name."
    },
    "customerNo": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2000
        },
        {
          "type": "number"
        }
      ],
      "description": "Customer / member number."
    },
    "companyName": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2000
        },
        {
          "type": "number"
        }
      ],
      "description": "Company name."
    },
    "mailAddress": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2000
        },
        {
          "type": "number"
        }
      ],
      "description": "E-mail address."
    },
    "phoneNumber": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2000
        },
        {
          "type": "number"
        }
      ],
      "description": "Phone number."
    },
    "customerCode": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2000
        },
        {
          "type": "number"
        }
      ],
      "description": "Customer code (unique per contract)."
    },
    "mobileNumber": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2000
        },
        {
          "type": "number"
        }
      ],
      "description": "Mobile number."
    },
    "departmentName": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2000
        },
        {
          "type": "number"
        }
      ],
      "description": "Department name."
    },
    "mailReceiveFlag": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2000
        },
        {
          "type": "number"
        }
      ],
      "description": "Whether the customer accepts guidance mail: 0 = refuse, 1 = allow (default)."
    },
    "pointExpireDate": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2000
        },
        {
          "type": "number"
        }
      ],
      "description": "Point expiry date, yyyy-mm-dd; some contracts require it when creating a customer."
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "categoryId",
    "productName",
    "price"
  ],
  "properties": {
    "tag": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2000
        },
        {
          "type": "number"
        }
      ],
      "description": "Tag."
    },
    "url": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2000
        },
        {
          "type": "number"
        }
      ],
      "description": "Product URL."
    },
    "cost": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2000
        },
        {
          "type": "number"
        }
      ],
      "description": "Unit cost."
    },
    "size": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2000
        },
        {
          "type": "number"
        }
      ],
      "description": "Size."
    },
    "color": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2000
        },
        {
          "type": "number"
        }
      ],
      "description": "Color."
    },
    "price": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2000
        },
        {
          "type": "number"
        }
      ],
      "description": "Selling price."
    },
    "division": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2000
        },
        {
          "type": "number"
        }
      ],
      "description": "Product division: 0 = normal (default), 1 = prepaid multi-use ticket (only contracts with that feature), 2 = option product."
    },
    "catchCopy": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2000
        },
        {
          "type": "number"
        }
      ],
      "description": "Catch copy."
    },
    "groupCode": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2000
        },
        {
          "type": "number"
        }
      ],
      "description": "Group code."
    },
    "categoryId": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2000
        },
        {
          "type": "number"
        }
      ],
      "description": "Category id (smaregi_list_categories)."
    },
    "description": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2000
        },
        {
          "type": "number"
        }
      ],
      "description": "Description."
    },
    "displayFlag": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2000
        },
        {
          "type": "number"
        }
      ],
      "description": "Show on the register (0 = hidden, 1 = shown)."
    },
    "productCode": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2000
        },
        {
          "type": "number"
        }
      ],
      "description": "Product code (unique per contract)."
    },
    "productKana": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2000
        },
        {
          "type": "number"
        }
      ],
      "description": "Product name, kana."
    },
    "productName": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2000
        },
        {
          "type": "number"
        }
      ],
      "description": "Product name."
    },
    "taxDivision": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2000
        },
        {
          "type": "number"
        }
      ],
      "description": "Tax division code (0 = tax included, 1 = tax excluded, 2 = tax free)."
    },
    "customerPrice": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2000
        },
        {
          "type": "number"
        }
      ],
      "description": "Member price."
    },
    "salesDivision": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2000
        },
        {
          "type": "number"
        }
      ],
      "description": "Sales accounting: 0 = counted in sales (default), 1 = excluded from sales totals. Does not control whether the product can be sold; use displayFlag to hide it from the register."
    },
    "supplierProductNo": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2000
        },
        {
          "type": "number"
        }
      ],
      "description": "Supplier's product number."
    },
    "productPriceDivision": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2000
        },
        {
          "type": "number"
        }
      ],
      "description": "Price division: 1 = standard price (default), 2 = open price."
    },
    "stockControlDivision": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2000
        },
        {
          "type": "number"
        }
      ],
      "description": "Stock control: 0 = stock is managed (default), 1 = stock is not managed."
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "page": {
      "type": "integer",
      "maximum": 100000,
      "description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
      "exclusiveMinimum": 0
    },
    "sort": {
      "type": "string",
      "pattern": "^[A-Za-z][A-Za-z0-9]*(:desc)?(,[A-Za-z][A-Za-z0-9]*(:desc)?)*$",
      "maxLength": 200,
      "description": "Sort order: comma-separated field names, ':desc' for descending (e.g. updDateTime:desc)."
    },
    "limit": {
      "type": "integer",
      "maximum": 500,
      "description": "Results per page, 1-500 (default 50).",
      "exclusiveMinimum": 0
    },
    "fields": {
      "type": "string",
      "pattern": "^[A-Za-z][A-Za-z0-9]*(,[A-Za-z][A-Za-z0-9]*)*$",
      "maxLength": 500,
      "description": "Comma-separated top-level field names to return (e.g. productId,productName); fewer fields = smaller replies."
    },
    "updated_to": {
      "type": "string",
      "description": "Only customers changed at or before this date-time (31 days at most)."
    },
    "customer_no": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "Only the customer with this member number."
    },
    "updated_from": {
      "type": "string",
      "description": "Only customers changed at or after this date-time (ISO 8601 with timezone)."
    },
    "customer_code": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "Only the customer with this exact customer code."
    },
    "customer_id_to": {
      "anyOf": [
        {
          "type": "string",
          "pattern": "^[0-9]{1,18}$"
        },
        {
          "type": "integer",
          "maximum": 9007199254740991,
          "exclusiveMinimum": 0
        }
      ],
      "description": "Only customers with an id at or below this."
    },
    "customer_id_from": {
      "anyOf": [
        {
          "type": "string",
          "pattern": "^[0-9]{1,18}$"
        },
        {
          "type": "integer",
          "maximum": 9007199254740991,
          "exclusiveMinimum": 0
        }
      ],
      "description": "Only customers with an id at or above this."
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "page": {
      "type": "integer",
      "maximum": 100000,
      "description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
      "exclusiveMinimum": 0
    },
    "sort": {
      "type": "string",
      "pattern": "^[A-Za-z][A-Za-z0-9]*(:desc)?(,[A-Za-z][A-Za-z0-9]*(:desc)?)*$",
      "maxLength": 200,
      "description": "Sort order: comma-separated field names, ':desc' for descending (e.g. updDateTime:desc)."
    },
    "limit": {
      "type": "integer",
      "maximum": 500,
      "description": "Results per page, 1-500 (default 50).",
      "exclusiveMinimum": 0
    },
    "fields": {
      "type": "string",
      "pattern": "^[A-Za-z][A-Za-z0-9]*(,[A-Za-z][A-Za-z0-9]*)*$",
      "maxLength": 500,
      "description": "Comma-separated top-level field names to return (e.g. productId,productName); fewer fields = smaller replies."
    },
    "group_code": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "Only products with this group code."
    },
    "updated_to": {
      "type": "string",
      "description": "Only products changed at or before this date-time (the range may span 31 days at most)."
    },
    "category_id": {
      "anyOf": [
        {
          "type": "string",
          "pattern": "^[0-9]{1,18}$"
        },
        {
          "type": "integer",
          "maximum": 9007199254740991,
          "exclusiveMinimum": 0
        }
      ],
      "description": "Only products of this category id."
    },
    "display_flag": {
      "enum": [
        "0",
        "1"
      ],
      "type": "string",
      "description": "1 = shown on the register, 0 = hidden."
    },
    "product_code": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "Only the product with this exact product code."
    },
    "updated_from": {
      "type": "string",
      "description": "Only products changed at or after this date-time (ISO 8601 with timezone)."
    },
    "supplier_product_no": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "Only products with this supplier product number."
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "product_id",
    "store_id"
  ],
  "properties": {
    "page": {
      "type": "integer",
      "maximum": 100000,
      "description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
      "exclusiveMinimum": 0
    },
    "sort": {
      "type": "string",
      "pattern": "^[A-Za-z][A-Za-z0-9]*(:desc)?(,[A-Za-z][A-Za-z0-9]*(:desc)?)*$",
      "maxLength": 200,
      "description": "Sort order: comma-separated field names, ':desc' for descending (e.g. updDateTime:desc)."
    },
    "limit": {
      "type": "integer",
      "maximum": 500,
      "description": "Results per page, 1-500 (default 50).",
      "exclusiveMinimum": 0
    },
    "fields": {
      "type": "string",
      "pattern": "^[A-Za-z][A-Za-z0-9]*(,[A-Za-z][A-Za-z0-9]*)*$",
      "maxLength": 500,
      "description": "Comma-separated top-level field names to return (e.g. productId,productName); fewer fields = smaller replies."
    },
    "store_id": {
      "anyOf": [
        {
          "type": "string",
          "pattern": "^[0-9]{1,18}$"
        },
        {
          "type": "integer",
          "maximum": 9007199254740991,
          "exclusiveMinimum": 0
        }
      ],
      "description": "Numeric Smaregi id (string or number)."
    },
    "product_id": {
      "anyOf": [
        {
          "type": "string",
          "pattern": "^[0-9]{1,18}$"
        },
        {
          "type": "integer",
          "maximum": 9007199254740991,
          "exclusiveMinimum": 0
        }
      ],
      "description": "Numeric Smaregi id (string or number)."
    },
    "target_date": {
      "type": "string",
      "maxLength": 40,
      "minLength": 1,
      "description": "Only changes of this target date, as Smaregi formats it (yyyy-mm-dd)."
    },
    "stock_division": {
      "type": "string",
      "maxLength": 10,
      "minLength": 1,
      "description": "Only changes of this stock division code."
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "from",
    "to"
  ],
  "properties": {
    "to": {
      "type": "string",
      "description": "End of the window (at most 31 days after from)."
    },
    "from": {
      "type": "string",
      "description": "Start of the window: transaction date-time (when Smaregi received it), ISO 8601 with timezone."
    },
    "page": {
      "type": "integer",
      "maximum": 100000,
      "description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
      "exclusiveMinimum": 0
    },
    "sort": {
      "type": "string",
      "pattern": "^[A-Za-z][A-Za-z0-9]*(:desc)?(,[A-Za-z][A-Za-z0-9]*(:desc)?)*$",
      "maxLength": 200,
      "description": "Sort order: comma-separated field names, ':desc' for descending (e.g. updDateTime:desc)."
    },
    "limit": {
      "type": "integer",
      "maximum": 500,
      "description": "Results per page, 1-500 (default 50).",
      "exclusiveMinimum": 0
    },
    "fields": {
      "type": "string",
      "pattern": "^[A-Za-z][A-Za-z0-9]*(,[A-Za-z][A-Za-z0-9]*)*$",
      "maxLength": 500,
      "description": "Comma-separated top-level field names to return (e.g. productId,productName); fewer fields = smaller replies."
    },
    "store_id": {
      "anyOf": [
        {
          "type": "string",
          "pattern": "^[0-9]{1,18}$"
        },
        {
          "type": "integer",
          "maximum": 9007199254740991,
          "exclusiveMinimum": 0
        }
      ],
      "description": "Only this store id."
    },
    "with_details": {
      "enum": [
        "none",
        "summary",
        "all"
      ],
      "type": "string",
      "description": "Add the line items: none (default), summary or all. Any other value than none caps limit at 100."
    },
    "customer_code": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "Only this customer code."
    },
    "transaction_uuid": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "Only the transaction with this receipt number."
    },
    "transaction_head_division": {
      "enum": [
        "1",
        "2",
        "3",
        "4",
        "5",
        "6",
        "7",
        "8",
        "9",
        "11",
        "13",
        "14",
        "15",
        "16"
      ],
      "type": "string",
      "description": "Transaction division: 1 normal sale, 2 deposit, 3 withdrawal, 4 advance payment, 5 advance refund, 6 points added, 7 points deducted, 8 points expired, 9 coupon ticket, 11 tip, 13 miles added, 14 miles deducted, 15 value card deposit, 16 receipt."
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "customer_id"
  ],
  "properties": {
    "sex": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2000
        },
        {
          "type": "number"
        }
      ],
      "description": "Sex: 0 = unknown, 1 = male, 2 = female."
    },
    "note": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2000
        },
        {
          "type": "number"
        }
      ],
      "description": "Note."
    },
    "rank": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2000
        },
        {
          "type": "number"
        }
      ],
      "description": "Member rank."
    },
    "note2": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2000
        },
        {
          "type": "number"
        }
      ],
      "description": "Second note."
    },
    "status": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2000
        },
        {
          "type": "number"
        }
      ],
      "description": "Member status: 0 = active, 1 = suspended, 2 = card lost, 3 = withdrawn, 4 = merged."
    },
    "address": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2000
        },
        {
          "type": "number"
        }
      ],
      "description": "Address."
    },
    "storeId": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2000
        },
        {
          "type": "number"
        }
      ],
      "description": "Store id the customer belongs to."
    },
    "lastKana": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2000
        },
        {
          "type": "number"
        }
      ],
      "description": "Last name, kana."
    },
    "lastName": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2000
        },
        {
          "type": "number"
        }
      ],
      "description": "Last name."
    },
    "postCode": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2000
        },
        {
          "type": "number"
        }
      ],
      "description": "Postal code."
    },
    "birthDate": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2000
        },
        {
          "type": "number"
        }
      ],
      "description": "Birth date, yyyy-mm-dd."
    },
    "entryDate": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2000
        },
        {
          "type": "number"
        }
      ],
      "description": "Enrollment (membership start) date, yyyy-mm-dd; some contracts require it when creating a customer."
    },
    "faxNumber": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2000
        },
        {
          "type": "number"
        }
      ],
      "description": "Fax number."
    },
    "firstKana": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2000
        },
        {
          "type": "number"
        }
      ],
      "description": "First name, kana."
    },
    "firstName": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2000
        },
        {
          "type": "number"
        }
      ],
      "description": "First name."
    },
    "customerNo": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2000
        },
        {
          "type": "number"
        }
      ],
      "description": "Customer / member number."
    },
    "companyName": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2000
        },
        {
          "type": "number"
        }
      ],
      "description": "Company name."
    },
    "customer_id": {
      "anyOf": [
        {
          "type": "string",
          "pattern": "^[0-9]{1,18}$"
        },
        {
          "type": "integer",
          "maximum": 9007199254740991,
          "exclusiveMinimum": 0
        }
      ],
      "description": "Numeric Smaregi id (string or number)."
    },
    "mailAddress": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2000
        },
        {
          "type": "number"
        }
      ],
      "description": "E-mail address."
    },
    "phoneNumber": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2000
        },
        {
          "type": "number"
        }
      ],
      "description": "Phone number."
    },
    "customerCode": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2000
        },
        {
          "type": "number"
        }
      ],
      "description": "Customer code (unique per contract)."
    },
    "mobileNumber": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2000
        },
        {
          "type": "number"
        }
      ],
      "description": "Mobile number."
    },
    "departmentName": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2000
        },
        {
          "type": "number"
        }
      ],
      "description": "Department name."
    },
    "mailReceiveFlag": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2000
        },
        {
          "type": "number"
        }
      ],
      "description": "Whether the customer accepts guidance mail: 0 = refuse, 1 = allow (default)."
    },
    "pointExpireDate": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2000
        },
        {
          "type": "number"
        }
      ],
      "description": "Point expiry date, yyyy-mm-dd; some contracts require it when creating a customer."
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "product_id"
  ],
  "properties": {
    "tag": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2000
        },
        {
          "type": "number"
        }
      ],
      "description": "Tag."
    },
    "url": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2000
        },
        {
          "type": "number"
        }
      ],
      "description": "Product URL."
    },
    "cost": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2000
        },
        {
          "type": "number"
        }
      ],
      "description": "Unit cost."
    },
    "size": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2000
        },
        {
          "type": "number"
        }
      ],
      "description": "Size."
    },
    "color": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2000
        },
        {
          "type": "number"
        }
      ],
      "description": "Color."
    },
    "price": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2000
        },
        {
          "type": "number"
        }
      ],
      "description": "Selling price."
    },
    "division": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2000
        },
        {
          "type": "number"
        }
      ],
      "description": "Product division: 0 = normal (default), 1 = prepaid multi-use ticket (only contracts with that feature), 2 = option product."
    },
    "catchCopy": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2000
        },
        {
          "type": "number"
        }
      ],
      "description": "Catch copy."
    },
    "groupCode": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2000
        },
        {
          "type": "number"
        }
      ],
      "description": "Group code."
    },
    "categoryId": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2000
        },
        {
          "type": "number"
        }
      ],
      "description": "Category (department) id, see smaregi_list_categories."
    },
    "product_id": {
      "anyOf": [
        {
          "type": "string",
          "pattern": "^[0-9]{1,18}$"
        },
        {
          "type": "integer",
          "maximum": 9007199254740991,
          "exclusiveMinimum": 0
        }
      ],
      "description": "Numeric Smaregi id (string or number)."
    },
    "description": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2000
        },
        {
          "type": "number"
        }
      ],
      "description": "Description."
    },
    "displayFlag": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2000
        },
        {
          "type": "number"
        }
      ],
      "description": "Show on the register (0 = hidden, 1 = shown)."
    },
    "productCode": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2000
        },
        {
          "type": "number"
        }
      ],
      "description": "Product code (unique per contract)."
    },
    "productKana": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2000
        },
        {
          "type": "number"
        }
      ],
      "description": "Product name, kana."
    },
    "productName": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2000
        },
        {
          "type": "number"
        }
      ],
      "description": "Product name."
    },
    "taxDivision": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2000
        },
        {
          "type": "number"
        }
      ],
      "description": "Tax division code (0 = tax included, 1 = tax excluded, 2 = tax free)."
    },
    "customerPrice": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2000
        },
        {
          "type": "number"
        }
      ],
      "description": "Member price."
    },
    "salesDivision": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2000
        },
        {
          "type": "number"
        }
      ],
      "description": "Sales accounting: 0 = counted in sales (default), 1 = excluded from sales totals. Does not control whether the product can be sold; use displayFlag to hide it from the register."
    },
    "supplierProductNo": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2000
        },
        {
          "type": "number"
        }
      ],
      "description": "Supplier's product number."
    },
    "productPriceDivision": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2000
        },
        {
          "type": "number"
        }
      ],
      "description": "Price division: 1 = standard price (default), 2 = open price."
    },
    "stockControlDivision": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2000
        },
        {
          "type": "number"
        }
      ],
      "description": "Stock control: 0 = stock is managed (default), 1 = stock is not managed."
    }
  }
}