Returns a single Tax Category by its ID. See api docs.
Required token: Bearer token
Success response schema: Success schema
Failure response schema: Error schema
Example:
const response = await client.taxCategories.show({
bearer_token: '7381273269536713689562374856'
id: '1'
})
Creates a new Tax Category and returns its attributes. See api docs.
Required token: Bearer token
Success response schema: Success schema
Failure response schema: Error schema
Example:
const response = await client.taxCategories.create({
bearer_token: '7381273269536713689562374856',
tax_category: {
name: 'Clothing',
is_default: true,
tax_code: '1257L',
description: 'Branded clothing'
}
})
Update selected Tax Category. See api docs.
Required token: Bearer token
Success response schema: Success schema
Failure response schema: Error schema
Example:
const response = await client.taxCategories.update({
bearer_token: '7381273269536713689562374856',
id: '1',
tax_category: {
name: 'Clothing',
is_default: true,
tax_code: '1257L',
description: 'Branded clothing'
}
})
This endpoint removes the specified Tax Category. See api docs.
Required token: Bearer token
Success response schema: Success schema
Failure response schema: Error schema
Example:
const response = await client.taxCategories.remove({
bearer_token: '7381273269536713689562374856',
id: '1'
})
Protected
spreeOptional
tokens: ITokenOptional
params: anyOptional
responseParsing: ResponseParsingProtected
classifyProtected
processProtected
processProtected
spreeGenerated using TypeDoc
Returns a list Tax Categories. See api docs.
Required token: Bearer token
Success response schema: Success schema
Failure response schema: Error schema
Example: