Getting Started

Catalog Update

Order Management

Total Sales

Suppliers Details

Buyers Details

Catalog Update

Product update

To update a product with all its variables, use the below URL. 

The update process should happen on a frequent basis so the catalog remains updated. 

Prices update link should be requested as following:

Request:

				
					Method: POST
URL: api/v1/supplierApi/supplier/catalog

Body schema:

The Body includes two types of fields: Options and Products.
See below tables for each fields type.

Options: options item

Create : creates new catalog items if they dont exist

Update: updates catalog items if they exist

Delete: deletes all catalog items not listed in the request

Products: products item []

Options item:

Field Name Type Mandatory Field Description
Create Boolean True creates new catalog items if they dont exist
Update Boolean True updates catalog items if they exist
Delete Boolean True deletes all products that has the is_deleted field with true value

Product's items

products items[]

Field Name Type Mandatory Field Description
cat_number String True Catalogic number
name String True Product name
category String false Category
subcategory String false Secondary category
units number True Quantity in units
quantity_in_package Number false Number of units inside every package. Optional - use only if packages are in use.
measurement_unit String True Measurement unit used
duplicates Number False Product duplicates units
is_published String True product availability(false=not available in stock)
is_deleted String True Deleted from catalog
description String false Product description
catalog_price Number false The product's catalog price
customer_number_product_exclusion String[] false A list of customer numbers you want to exclude
product_exclusion_type number false 0 - not excluded - available to everyone
1 - available for all the customers but the custumers in the exclusion list
2 - available only for the customers in the exclusion list

Measurement units specification:

Field Name Type
Units 0
Kg 1
Cm 2
Liters 3
Gr 4
ml 5
Box 6
FLOZ 7
PT 8
Gal 9
OZ 10
LB 11
IN 12
FT 13

Body sample:

Response:

				
					{
    "options": {
        "create": true,
        "Update": true,
        "Delete": true
    },
    "products": [
        {
            "cat_number": "7052009", //code of item
            "name": "קערה לסלט (KTR(",
            "category": "מיכל קר", // label, tag
            "is_deleted": "false",
            "description": "tests",
            "units": 300,
            "quantity_in_package": null,//use only if product is a pacakge
            "measurement_unit": "יחידות", // if not parse set default "יחידות"
            "duplicates": "4",
            "is_published": true //is published for users or not, used for deleting
            // or blocking product usage
        },
        {
            "cat_number": "7052009M",
            "name": "קערה לסלט מארז (KTR(",
            "category": "מיכל קר",
            "units": 300,
            "quantity_in_package": 10,
            "measurement_unit": "מארזים",
            "is_published": false
        }
    ]
}
				
			
				
					{
    "status": "ok",
    "report": {
        "errors": [],
    	"created": [
         	"7052009"
      	],
    	"updated": [
             "7052009M",
 ....
	]
      "Deleted": []
}