API – ProductTag
ProductTagCount[GET]
The ProductTagCount operation counts the number of product tags
Input
The operation takes the following input:
- an authentication key (see Authentication for details)
Validation
The following validation will determine whether the operation succeeds:
- the authentication key must be valid (see Authentication for details)
The product READ permission is required to perform this operation.
Output
An integer containing the total number of product tags in the shop
Request and response format
ProductTagPageCount[GET]
The ProductTagPageCount operation counts the number of pages a specific pagesize will generate
Input
The operation takes the following input:
- an authentication key (see Authentication for details)
- pagesize
Validation
The following validation will determine whether the operation succeeds:
- the authentication key must be valid (see Authentication for details)
- pagesize must be a valid integer
The product READ permission is required to perform this operation.
Output
An integer containing number of pages
Request and response format
DeleteProductTag[DELETE]
The DeleteProductTag operation deletes a product tag from the shop based on a unique product tag id.
Input
The operation takes the following input:
- an authentication key (see Authentication for details)
- an id for the product tag
Validation
The following validation will determine whether the operation succeeds:
- the authentication key must be valid (see Authentication for details)
- the tag id cannot be null
The product DELETE permission is required to perform this operation.
Output
When successful the operation returns true.
Request and response format
CreateProductTag[POST]
The CreateProductTag operation creates a new product tag in the shop.
Input
The operation takes the following input:
- an authentication key (see Authentication for details)
- a product tag
- id properties of the dto will be replaced with autogenerated id’s
Validation
The following validation will determine whether the operation succeeds:
- the authentication key must be valid (see Authentication for details)
The product CREATE permission is required to perform this operation.
Output
When successful the operation returns the created product tag.
Request and response format
UpdateProductTag[PUT]
The UpdateProductTag operation updates an existing product tag in the shop.
Input
The operation takes the following input:
- an authentication key (see Authentication for details)
- a product tag
Validation
The following validation will determine whether the operation succeeds:
- the authentication key must be valid (see Authentication for details)
The product UPDATE permission is required to perform this operation.
Output
When successful the operation returns the updated product tag.
Request and response format
AssignTagValueToProduct[PUT]
The AssignTagValueToProduct operation assigns a specific tag value to a product .
Input
The operation takes the following input:
- an authentication key (see Authentication for details)
- a tagvalue id
- a product number
Validation
The following validation will determine whether the operation succeeds:
- the authentication key must be valid (see Authentication for details)
- a valid productnumber must be specified
- a valid tagvalue id must be specified
The product UPDATE permission is required to perform this operation.
Output
When successful the operation returns true
Request and response format
