Returns a single Zone 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.zones.show({
bearer_token: '7381273269536713689562374856'
id: '1'
})
Creates a new Zone 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.zones.create({
bearer_token: '7381273269536713689562374856',
zone: {
name: 'EU',
description: 'All countries in the EU',
default_tax: true,
kind: 'state'
}
})
Update selected Zone. See api docs.
Required token: Bearer token
Success response schema: Success schema
Failure response schema: Error schema
Example:
const response = await client.zones.update({
bearer_token: '7381273269536713689562374856',
id: '1',
zone: {
name: 'EU',
description: 'All countries in the EU',
default_tax: true,
kind: 'state'
}
})
This endpoint removes the specified Zone. See api docs.
Required token: Bearer token
Success response schema: Success schema
Failure response schema: Error schema
Example:
const response = await client.zones.remove({
bearer_token: '7381273269536713689562374856',
id: '1'
})
Protected
spreeOptional
tokens: ITokenOptional
params: anyOptional
responseParsing: ResponseParsingProtected
classifyProtected
processProtected
processProtected
spreeGenerated using TypeDoc
Returns a list of Zones. See api docs.
Required token: Bearer token
Success response schema: Success schema
Failure response schema: Error schema
Example: