API Docs | Products | Tajima Software Solutions Inc.

With the /products endpoint user can manage the database products

GET /api/Products/GetProductsByCategory Get products info for a specified product category.
Request Example 
/api/Products/GetProductsByCategory?productCategory=Category1
productCategory parameter is required, leave empty to get all
Response Example 
A list of products:
[
    {
        "Name": "string",
        "Code": "string",
        "OrderType":"string",
        "SKU": "string",
        "MaxWidth": 0,
        "MaxHeight": 0,
        "Description": "string",
        "Instructions": "string",
        "ProductCategoryName": "string",
        "LocationGroups": [
            {
                "Name": "string",
                "Locations": [
                    {
                        "LocationName": "string",
                        "X": 0,
                        "Y": 0,
                        "OffsetX": 0,
                        "OffsetY": 0,
                        "CenteredX": true/false,
                        ...                        
                    },
                    {...}
                ]
            },
            {...}
        ],
        ...
    },
    {...}
]

For more details on products attributes please refer to Product Attributes
GET /api/Products/GetProductInfo Get info for a specified product.
Request Example 
/api/Products/GetProductInfo?id={productid}&dataView=1
id parameter is required to identify the product, it is the Unique product SKU or code
dataView is optional parameter. Default is 0. Set 1 for basic details
Response Example 
if full details is asked
{
    "Name": "string",
    "Code": "string",
    "OrderType":"string",
    "SKU": "string",
    "MaxWidth": 0,
    "MaxHeight": 0,
    "Description": "string",
    "Instructions": "string",
    "ProductCategoryName": "string","
    "LocationGroups": [
        {
            "Name": "string",
            "Locations": [
                {
                    "LocationName": "string",
                    "X": 0,
                    "Y": 0,
                    "OffsetX": 0,
                    "OffsetY": 0,
                    "CenteredX": true/false,
                    ...
                },
                {...}
            ]
        },
        {...}
    ],
    ...
}

For more details on products attributes please refer to Product Attributes


If basic details is asked:
{
    "Name": "string",
    "Category": "string",
    "Recipe": "string",
    "Locations": [
        {
            "LocationName": "string",
            "DpiX": 0,
            "Width": 0,
            "Height": 0,
            "Y": 0,
            "X": 0,
            "ViewName": "string"
        },
        {...
        }
    ]
}
POST /api/Products/CreateProduct Create a product.
Model Request Example 
{
    "Name": "string",
    "Code": "string",
    "OrderType":"string",
    "SKU": "string",
    "MaxWidth": 0,
    "MaxHeight": 0,
    "Description": "string",
    "Instructions": "string",
    "ProductCategoryName": "string",
    "LocationGroups": [
        {
            "Name": "string",
            "URL": "string",          [if provided it is a url to the related image, accepts png, bmp or jpeg]
            "Locations": [
                {
                    "LocationName": "string",
                    "X": 0,
                    "Y": 0,
                    "OffsetX": 0,
                    "OffsetY": 0,
                    "CenteredX": true/false,
                    ...
                },
                {...}
            ]
        },
        {...}
    ],
    ...
}
  

For more details on products attributes please refer to Product Attributes
You may find all available attributes and distinguish all the Required fields
Stated default values apply on optional fields when not provided
Response Example 
    If the operation is successful an empty response will be returned with status code 201
    Otherwise one or more errors with code and message will be returned with status code 409
PATCH api/Products/PatchProduct Edit a product.
Model Request Example 
/api/Products/PatchProduct?productSKU=SKU
productSKU parameter is required to specify the product to update, it is the old value for product SKU or code
Only provided attributes are updated
{
    "Name": "string",
    "Code": "string",
    "OrderType":"string",
    "SKU": "string",
    "MaxWidth": 0,
    "MaxHeight": 0,
    "Description": "string",
    "Instructions": "string",
    "ProductCategoryName": "string",
    "LocationGroups": [
        {
            "Name": "string",
            "URL": "string",          [if provided it is a url to the related image, accepts png, bmp or jpeg]
            "Locations": [
                {
                    "LocationName": "string",
                    "X": 0,
                    "Y": 0,
                    "OffsetX": 0,
                    "OffsetY": 0,
                    "CenteredX": true/false,
                    ...
                },
                {...}
            ]
        },
        {...}
    ],
    ...
}
  

For more details on products attributes please refer to Product Attributes
Response Example 
    If the operation is successful an empty response will be returned with status code 200
    Otherwise one or more errors with code and message will be returned with status code 409
DELETE /api/Products/Delete Delete a product
Request Example 
    /api/Products/Delete?ProductSKU=sku
            ProductSKU parameter is required to specify the product to delete, it is the old value for product SKU or code
Response Example 
            
    If the operation is successful an empty response will be returned with status code 200
    Otherwise an error will be returned with status code 409
GET /api/Products/GetThumbnail Get a file path or url to product location preview.
Request Example 
/api/Products/GetThumbnail?productSKU=PRODUCT_SKU&locationName=Location_1
Parameters are required, productSKU to identify the product (sku or code) and locationName to identify the location, if empty or not found, the first location is used
Response Example 
"C:\Temp\PulseId\Products\white_f.png"
GET /api/Products/ListProducts Get products info of all products.
Request Example 
/api/Products/ListProducts/?dataView=1
dataView is optional parameter. Default is 0. Set 1 for basic details
Response Example 
if full details is asked
{
    "Name": "string",
    "Code": "string",
    "OrderType":"string",
    "SKU": "string",
    "MaxWidth": 0,
    "MaxHeight": 0,
    "Description": "string",
    "Instructions": "string",
    "ProductCategoryName": "string",
    "LocationGroups": [
        {
            "Name": "string",
            "Locations": [
                {
                    "LocationName": "string",
                    "X": 0,
                    "Y": 0,
                    "OffsetX": 0,
                    "OffsetY": 0,
                    "CenteredX": true/false,
                    ...
                },
                {...}
            ]
        },
        {...}
    ],
    ...
}

For more details on products attributes please refer to Product Attributes


If basic details is asked:
[    
    {
        "Id": "string",
        "Name": "string",
        "Category": "string",
        "Recipe": "string"
    }, 
    {...}
]
GET /api/Products/ListProductsWithPvFile Get products info for print products of specified order type.
Request Example 
/api/Products/ListProductsWithPvFile?type=print-template  
Type parameter is required and should be contained on returned products order type
Returned products contain at least one location with an associated pv file
Response Example 
[
    {
        "Name": "string",
        "Code": "string",
        "OrderType":"string",
        "SKU": "string",
        "MaxWidth": 0,
        "MaxHeight": 0,
        "Description": "string",
        "Instructions": "string",
        "ProductCategoryName": "string",
        "LocationGroups": [
            {
                "Name": "string",
                "Locations": [
                    {
                        "LocationName": "string",
                        "X": 0,
                        "Y": 0,
                        "OffsetX": 0,
                        "OffsetY": 0,
                        "CenteredX": true/false,
                        ...                        
                    },
                    {...}
                ]
            },
            {...}
        ],
        ...
    },
    {...}
]

For more details on products attributes please refer to Product Attributes
GET /api/Products/RenderPv Returns an image of a specified print product.
Request Example 
/api/Products/RenderPv?Code=product1  
Code parameter is required in order to identify the product
Product should contain at least one location with an associated pv file
Response Example 
Returns an image
GET /api/Products/Exists Get if product exists in PulseID.
Request Example 
/api/Products/exists?variantId=variantId&sku=SKU
sku parameter is optional
Response Example 
Returns 200 status if product exists.
Returns 409 status with an error message if product does not exist
GET /api/Products/DistinctLocations return list of production locations.
Request Example 
/api/Products/DistinctLocations
Response Example 
[
    "LocationName1",
    "LocationName2",
    "LocationName3",
    ...
]