Returns a single Option Value 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.optionValues.show({
bearer_token: '7381273269536713689562374856'
id: '1'
})
Creates a new Option Value 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.optionValues.create({
bearer_token: '7381273269536713689562374856',
option_value: {
name: 'red',
presentation: 'Red',
public_metadata: {},
private_metadata: {}
}
})
Update selected Option Value. See api docs.
Required token: Bearer token
Success response schema: Success schema
Failure response schema: Error schema
Example:
const response = await client.optionValues.update({
bearer_token: '7381273269536713689562374856',
id: '1',
option_value: {
name: 'red',
presentation: 'Red',
public_metadata: {},
private_metadata: {}
}
})
This endpoint removes the specified Option Value. See api docs.
Required token: Bearer token
Success response schema: Success schema
Failure response schema: Error schema
Example:
const response = await client.optionValues.remove({
bearer_token: '7381273269536713689562374856',
id: '1'
})
Protected
spreeOptional
tokens: ITokenOptional
params: anyOptional
responseParsing: ResponseParsingProtected
classifyProtected
processProtected
processProtected
spreeGenerated using TypeDoc
Returns a list of all Option Values. See api docs.
Required token: Bearer token
Success response schema: Success schema
Failure response schema: Error schema
Example: