API Documentation

All Products

This route will return all client products where `page` is the pagination number.

This endpoint returns both active and deactivated products.

GET Request

/api/all-products?page=1

{
    "page": 1,
    "total_pages": 1,
    "total_products": 2,
    "products_per_page": 200,
    "all-products": [
        {
            "product_id": "1A",
            "name": "Product 1",
            "url": "https://www.product.com/1",
            "brand": "Brand 1",
            "category_1": "Category 1",
            "category_2": "Category 2",
            "tags": "Tag 1, Tag 2, Tag 3",
            "status": "Avaliable",
            "sell_price": "306.00",
            "cost_price": "429.00"
        },
        {
            "product_id": "2A",
            "name": "Product 2",
            "url": "https://www.product.com/2",
            "brand": "Brand 2",
            "category_1": "Category 1",
            "category_2": "Category 2",
            "tags": "Tag 1, Tag 2, Tag 3",
            "status": "Avaliable",
            "sell_price": "743.00",
            "cost_price": "887.00"
        },
    ],
}

{"Warning":"Bad Request!","Missing/Invalid":"page"}

Please note that all endpoints other than /all-products will return only active products.

Products Search

This route will return all products with `products_id` or `name` like XXX

GET Request

/api/product-search?search-term=XXX

{
    "total_products": 5,
    "products": [
        {
            "product_id": "1A",
            "name": "Product 1",
            "url": "https://www.product.com/1",
            "brand": "Brand 1",
            "category_1": "Category 1",
            "category_2": "Category 2",
            "tags": "Tag 1, Tag 2, Tag 3",
            "status": "Avaliable",
            "sell_price": "306.00",
            "cost_price": "429.00"
        },
        {
            "product_id": "11A",
            "name": "Product 11",
            "url": "https://www.product.com/11",
            "brand": "Brand 11",
            "category_1": "Category 1",
            "category_2": "Category 2",
            "tags": "Tag 1, Tag 2, Tag 3",
            "status": "Avaliable",
            "sell_price": "471.00",
            "cost_price": "343.00"
        },
    ]
}

{"Warning":"Bad Request!","Missing":"search-term"}

Single Product

This route will return a product where {productId} is product id/SKU

GET Request

 /api/product?product_id=XXX

{
    "product": {
        "product_id": "1A",
        "name": "Product 1",
        "url": "https://www.product.com/1",
        "brand": "Brand 1",
        "category_1": "Category 1",
        "category_2": "Category 2",
        "tags": "Tag 1, Tag 2, Tag 3",
        "status": "Avaliable",
        "sell_price": "306.00",
        "cost_price": "429.00",
        "matches": [
            {
                "website": "example.com",
                "url": "https://www.example.com/A4",
                "price": "9.00",
                "product_name": "A4"
            },
            {
                "website": "example.com",
                "url": "https://www.example.com/A5",
                "price": "10.00",
                "product_name": "A5"
            },
        ]
    }
}

{"Warning":"Bad Request!","Missing":"product_id"}

{"Warning":"Not Found!","Invalid":"product_id"}

Add Product

This route will add product. Body must contain the following fields:

product_id must be unique within your account. If you submit a duplicate product_id, the request will be rejected with a conflict error.

• product_id * (string)
• name * (string)
• url (string)
• sell_price * (decimal)
• cost_price (decimal)
• brand (string)
• category_1 (string)
• category_2 (string)
• tags (string)
• status (string)

POST Request

/api/add-product

{"success":true,"message":"Product added successfully! "}

{
    "message":"The product id field is required.",
    "errors":{"product_id":["The product id field is required."]}
}

Bulk Add Product

This route will add bulk products. Body must contain fields in the following format:

product_id must be unique within your account. If you submit a duplicate product_id, the request will be rejected with a conflict error.

• product_id * (string)
• name * (string)
• url (string)
• sell_price * (decimal)
• cost_price (decimal)
• brand (string)
• category_1 (string)
• category_2 (string)
• tags (string)
• status (string)

POST Request

/api/add-bulk-product

JSON format accepted:

{"products": [{"product_id": "1A","name": "Product 1","url": "https://www.your-site.com/product/1","brand": "Brand 1","category_1": "Category 1","category_2": "Category 2","tags": "Tag 1, Tag 2, Tag 3","status": "Avaliable","sell_price": "306.00","cost_price": "429.00"},{"product_id": "11A","name": "Product 11","url": "https://www.your-site.com/product/11A","brand": "Brand 11","category_1": "Category 1","category_2": "Category 2","tags": "Tag 1, Tag 2, Tag 3","status": "Avaliable","sell_price": "471.00","cost_price": "343.00"}]}

{"success":true,"message":"Product added successfully! "}

{
    "success":true,
    "problems": true,
    "message":"Products have been added successfully, but some issues were found.
               Please check /api/products-with-issues and make necessary corrections.
               Thank you!"
}

{
    "message":"Invalid url.",
    "success":false
}

Products with Issue

This route will return all product with issue. It is important to note that these products cannot be matched with until the underlying issues are resolved/edited.

GET Request

/api/products-with-issue

{
    "success": true,
    "products": [
        {
            "product_id": "SKU_8",
            "url": "your-website.com/product/8",
            "issue": "Invalid URL"
        },
        {
            "product_id": "1A",
            "url": "httwww.product.com/11",
            "issue": "Invalid URL"
        }
    ]
}

Edit Product

This route will edit product. Body must contain the following fields:

• product_id * (string)
• name * (string)
• url (string)
• sell_price * (decimal)
• cost_price (decimal)
• brand (string)
• category_1 (string)
• category_2 (string)
• tags (string)
• status (string)

POST Request

/api/edit-product

{"success":true,"message":"The product has been successfully edited."}

{
    "message":"The product id field is required.",
    "errors":{"product_id":["The product id field is required."]}
}

Delete Product

This route will delete product. Body must contain the following fields:

• product_id * (string)

POST Request

/api/delete-product

{"success":true,"message":"Product deleted successfully."}

{
    "message": "The product id field is required.",
    "errors": {"product_id": ["The product id field is required."]}
}

All Matches

This route will return all matches where `page` is the pagination number.

GET Request

/api/all-matches?page=1

{
    "page": 1,
    "total_pages": 1,
    "total_products": 5,
    "products_per_page": 200,
    "all-matches": [
        {
            "match_id": 2,
            "product_id": 1,
            "website": "example.com",
            "url": "https://www.example.com/A2",
            "client_product": {
                "name": "Product 1",
                "url": "https://www.product.com/1",
                "brand": "Brand 1",
                "category_1": "Category 1",
                "category_2": "Category 2",
                "tags": "Tag 1, Tag 2, Tag 3",
                "status": "Avaliable"
            }
        },
        {
            "match_id": 3,
            "product_id": 1,
            "website": "example.com",
            "url": "https://www.example.com/A3",
            "client_product": {
                "name": "Product 1",
                "url": "https://www.product.com/1",
                "brand": "Brand 1",
                "category_1": "Category 1",
                "category_2": "Category 2",
                "tags": "Tag 1, Tag 2, Tag 3",
                "status": "Avaliable"
            }
        },
    ],
}

{"Warning":"Bad Request!","Missing/Invalid":"page"}

Get a Match

This route will return a match where match_id is match id that comes from the API.

GET Request

/api/get-match?match_id=XXX

{
    "match": {
        "match_id": 2,
        "product_id": 1,
        "website": "example.com",
        "url": "https://www.example.com/A2",
        "client_product": {
            "name": "Product 1",
            "url": "https://www.product.com/1",
            "brand": "Brand 1",
            "category_1": "Category 1",
            "category_2": "Category 2",
            "tags": "Tag 1, Tag 2, Tag 3",
            "status": "Avaliable",
            "sell_price": "306.00",
            "cost_price": "429.00"
        }
    }
}

{"Warning":"Bad Request!","Missing":"match_id"}

{"Warning":"Not Found","Missing":"match_id"}

Add Match

This route will add a match. Body must contain the following fields:

• url * (string)
• product_id * (string)

POST Request

/api/add-match

{"success":true,"message":"The match has been successfully added."}

{"Warning":"Not Found","Missing/Invalid":"product_id"}

{
"message": "The product id field is required.",
"errors": {"product_id": ["The product id field is required."]}
}

Note that products with errors in their URL cannot be matched with until the underlying issues are resolved.**

Edit Match

This route will edit a match. Body must contain the following fields:

• match_id * (integer)
• url * (string)

POST Request

/api/edit-match

{"success":true,"message":"The match has been successfully added."}

{
    "message": "The match id field is required",
    "errors": {"product_id": ["The match id field is required"]}
}

Delete Match

This route will delete a match. Body must contain the following fields:

• match_id * (integer)

POST Request

/api/delete-match

{"success":true,"message":"Product deleted successfully. "}

{
    "message": "The match id field is required",
    "errors": {"product_id": ["The match id field is required"]}
}

All Brands

This route will return all brands.

GET Request

/api/all-brands

{
    "total-brands": 3,
    "brands": [
        {
            "brand": "Brand 1"
        },
        {
            "brand": "Brand 2"
        },
        {
            "brand": "Brand 3"
        },
  ]
}

All Categories

This route will return all categories.

GET Request

/api/all-categories

{
    "total-categories": 2,
    "categories": [
       {
            "category_1": "Category 1",
            "category_2": "Category 2"
       },
       {
            "category_1": null,
            "category_2": null
       }
    ]
}

* Field is required