Returns a single Store Credit 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.storeCreditCategories.show({
bearer_token: '7381273269536713689562374856'
id: '1'
})
Creates a new Store Credit 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.storeCreditCategories.create({
bearer_token: '7381273269536713689562374856',
store_credit_category: {
name: 'refunded'
}
})
Update selected Store Credit Category. See api docs.
Required token: Bearer token
Success response schema: Success schema
Failure response schema: Error schema
Example:
const response = await client.storeCreditCategories.update({
bearer_token: '7381273269536713689562374856',
id: '1',
store_credit_category: {
name: 'refunded'
}
})
This endpoint removes the specified Store Credit Category. See api docs.
Required token: Bearer token
Success response schema: Success schema
Failure response schema: Error schema
Example:
const response = await client.storeCreditCategories.remove({
bearer_token: '7381273269536713689562374856',
id: '1'
})
Protected
spreeOptional
tokens: ITokenOptional
params: anyOptional
responseParsing: ResponseParsingProtected
classifyProtected
processProtected
processProtected
spreeGenerated using TypeDoc
Returns a list of Store Credit Categories. See api docs.
Required token: Bearer token
Success response schema: Success schema
Failure response schema: Error schema
Example: