01. Products

API Methods:

List:

URL: https://api.socratecloud.com/webapi/rest/product/list/{version}?startRow={0}&endRow={100}&accessToken={access_token}

Method: GET

Available filter parameters:

• Language

• Organization

• Value

  • only from v3: it is allowed to search with "like" function on this parameter. Ex. Value=%25string, in that case the sistem will list all products which contain value like %string%.

• Name

  • only from v3: it is allowed to search with "like" function on this parameter. Ex. Name=%25string, in that case the sistem will list all products which contain name like %string%.

• UPC_SKU

  • only from v3: it is allowed to search with "like" function on this parameter. Ex. UPC_SKU=%25string, in that case the sistem will list all products which contain UPC or SKU like %string%.

• ProductCategory

  • only from v3: it is allowed to search with "like" function on this parameter. Ex. ProductCategory=%25string, in that case the sistem will list all products which belong to ProductCategory like %string%.

• PriceList

• FamilyType

• ProductType

• HasStock

• IsSold

• Active

• CreatedBy

• Tax

• LastModified (UTC time format ISO 8601: yyyy-MM-dd HH:mm:ss Z, max date from Product, Price, Inventory). The sign used for comparison is ”>” (exclusive). Use this filter to get all the products/prices/inventory modified after the date/time value sent in this parameter. (for e g: LastModified=2014-06-13 12:40:00 +0300 if you are in Romania or: LastModified=2014-06-13%2012:40:00%20%2b0300)

• AttributeSet

• Attribute

• AttributeValue

• AttributeValueList

  • The value of this parameter should be provided in the format of a JSON object whose field names are the attribute names on which to filter and the values of the fields are the attribute values on which to filter. If for an attribute it is wanted to filter for many values of the attribute the value of the field should be provided in the form of a JSON array.

  • Ex. 

{

    "attribute_name1":"attribute_value1",                                         --> single attribute value

    "attribute_name2":"attribute_value2",                                         --> single attribute value

    "attribute_name3":["attribute_value3","attribute_value4","attribute_value5"]  --> multiple attribute values

}

• • The filter is applied with logical AND between the values of different attributes and with logical OR between the values of the same attribute.

  • Ex. For the example above JSON will translate to the following filter

    • attribute_name1=attribute_value1 AND attribute_name2=attribute_value2 AND (attribute_name3=attribute_value3 OR attribute_name3=attribute_value4 OR attribute_name3=attribute_value5)

• GuaranteeDaysMin

Return: JSON object with next format:

{

    "data": [

        {

            "Organization": "Demo SRL",

            "Created": "2020-02-27 12:36:31+0000",

            "CreatedBy": "DEMO",

            "Updated": "2022-05-11 12:05:35+0000",

            "UpdatedBy": "DEMO",

            "Value": "030",

            "Name": "PRODUCT 30",

            "Description": null,

            "Help": null,

            "UPC": "030",

            "SKU": "030",

            "Active": true,

            "UOM": "Each",

            "OfferUOM": null,

            "OfferUOMCoef": null,

            "TaxCategory": "TVA",

            "ProductCategory": "FOOD PRODUCTS",

            "ProductSubcategory": null,

            "ProductFamily": "FAMILIE PRODUS TEST_1",

            "FamilyType": "TIP FAMILIE TEST",

            "ProductType": "Item",

            "NetWeight": 0.24,

            "Weight": 0.25,

            "Volume": 1,

            "QtyOnHand": 0,

            "QtyAvailable": 0,

            "HasStock": false,

            "PriceList": "Vanzare RON",

            "PriceListVersion": "Vanzare RON vers1",

            "Currency": "RON",

            "IsTaxIncluded": false,

            "IsSold": true,

            "ListPrice": null,

            "StdPrice": null,

            "Tax": "19%",

            "TaxRate": 19,

            "AttributeSet": "Proprietate Produs 30",

            "attributes": {

                "Proprietate test 1": "white",

                "Proprietate noua 1": "Black"

            },

            "Organization_ID": 1005272,

            "Product_ID": 1121036,

            "TaxCategory_ID": 1000812,

            "UOM_ID": 100,

            "ProductCategory_ID": 1003060,

            "ProductSubcategory_ID": null,

            "ProductFamily_ID": 1001416,

            "IsPurchased": true,

            "IsStocked": true,

            "VersionNo": "2",

            "Classification": "A",

            "DocumentNote": null,

            "GuaranteeDays": 12,

            "AttributeSet_ID": 1001933,

            "Make": "FABRICA TEST",

            "Model": "Model_test",

            "CreatedBy_ID": 1014218,

            "UpdatedBy_ID": 1014218,

            "ProductPurchasings": [],

            "SalesRep": "REPR_NOU",

            "SalesRep_ID": 1030593,

            "SubscriptionType": null,

            "SubscriptionType_ID": null,

            "GuaranteeDaysMin": 5,

    "Discontinued": false

        }

    ],

    "totalRows": 1

}

List full:

URL: https://api.socratecloud.com/webapi/rest/product/full/list/{version}?startRow={0}&endRow={100}&accessToken={access_token}

Method: GET

Available filter parameters:

• Language

• Organization

• Value

  • only from v3: it is allowed to search with "like" function on this parameter. Ex. Value=%25string, in that case the sistem will list all products which contain value like %string%.

• Name

  • only from v3: it is allowed to search with "like" function on this parameter. Ex. Name=%25string, in that case the sistem will list all products which contain name like %string%.

• UPC_SKU

  • only from v3: it is allowed to search with "like" function on this parameter. Ex. UPC_SKU=%25string, in that case the sistem will list all products which contain UPC or SKU like %string%.

• ProductCategory

  • only from v3: it is allowed to search with "like" function on this parameter. Ex. ProductCategory=%25string, in that case the sistem will list all products which belong to ProductCategory like %string%.

• PriceList

• FamilyType

• ProductType

• HasStock

• Active

• CreatedBy

• Tax

• LastModified (UTC time format ISO 8601: yyyy-MM-dd HH:mm:ss Z, max date from Product, Price, Inventory). The sign used for comparison is ”>” (exclusive). Use this filter to get all the products/prices/inventory modified after the date/time value sent in this parameter. (for e g: LastModified=2014-06-13 12:40:00 +0300 if you are in Romania or: LastModified=2014-06-13%2012:40:00%20%2b0300)

• AttributeSet

• Attribute

• AttributeValue

• AttributeValueList

• IsSold

• IsGenerallyValid

• The value of this parameter should be provided in the format of a JSON object whose field names are the attribute names on which to filter and the values of the fields are the attribute values on which to filter. If for an attribute it is wanted to filter for many values of the attribute the value of the field should be provided in the form of a JSON array.

  • Ex. 

{

    "attribute_name1":"attribute_value1",                                          --> single attribute value

    "attribute_name2":"attribute_value2",                                          --> single attribute value

    "attribute_name3":["attribute_value3","attribute_value4","attribute_value5"]   --> multiple attribute values

}

• • The filter is applied with logical AND between the values of different attributes and with logical OR between the values of the same attribute.

  • Ex. For the example above JSON will translate to the following filter

    • attribute_name1=attribute_value1 AND attribute_name2=attribute_value2 AND (attribute_name3=attribute_value3 OR attribute_name3=attribute_value4 OR attribute_name3=attribute_value5)

• GuaranteeDaysMin

Return: JSON object with next format:

{

    "data": [

        {

            "Organization": "DEMO SRL",

            "Created": "2020-02-27 12:36:31+0000",

            "CreatedBy": "User_1",

            "Updated": "2022-05-11 12:05:35+0000",

            "UpdatedBy": "User_1",

            "Value": "030",

            "Name": "PRODUCT 30",

            "Description": null,

            "Help": null,

            "UPC": "030",

            "SKU": "030",

            "Active": true,

            "UOM": "Each",

            "OfferUOM": null,

            "OfferUOMCoef": null,

            "TaxCategory": "TVA",

            "ProductCategory": "FOOD PRODUCTS",

            "ProductSubcategory": null,

            "ProductFamily": "FAMILIE PRODUS TEST_1",

            "FamilyType": "TIP FAMILIE TEST",

            "ProductType": "Item",

            "NetWeight": 0.24,

            "Weight": 0.25,

            "Volume": 1,

            "QtyOnHand": 0,

            "QtyAvailable": 0,

            "HasStock": false,

            "PriceList": "Vanzare RON",

            "PriceListVersion": "Vanzare RON vers1",

            "Currency": "RON",

            "IsTaxIncluded": false,

            "IsSold": true,

            "ListPrice": null,

            "StdPrice": null,

            "Tax": "19%",

            "TaxRate": 19,

            "AttributeSet": "Proprietate Produs 30",

            "attributes": {

                "Proprietate test 1": "white",

                "Proprietate noua 1": "Black"

            },

            "Organization_ID": 1005272,

            "Product_ID": 1121036,

            "TaxCategory_ID": 1000812,

            "UOM_ID": 100,

            "ProductCategory_ID": 1003060,

            "ProductSubcategory_ID": null,

            "ProductFamily_ID": 1001416,

            "IsPurchased": true,

            "IsStocked": true,

            "VersionNo": "2",

            "Classification": "A",

            "DocumentNote": null,

            "GuaranteeDays": 12,

            "AttributeSet_ID": 1001933,

            "Make": "FABRICA TEST",

            "Model": "Model_test",

            "CreatedBy_ID": 1014218,

            "UpdatedBy_ID": 1014218,

            "BPartnerProducts": [

                {

                    "Organization": "DEMO SRL",

                    "Created": "2022-05-12 09:59:41+0000",

                    "CreatedBy": "User_1",

                    "Updated": "2022-05-12 09:59:41+0000",

                    "UpdatedBy": "User_1",

                    "Product": "030",

                    "ProductName": "PRODUCT 30",

                    "ProductUOM": "Each",

                    "BPartner": "CT1",

                    "BPartnerName": "CLIENT TEST 1",

                    "Description": "some_product 030",

                    "Active": true,

                    "IsGenerallyValid": false,

                    "VendorProductNo": "Tcode030",

                    "VendorCategory": null,

                    "Manufacturer": "TestPROD",

                    "QualityRating": 0,

                    "ShelfLifeMinPct": 1,

                    "ShelfLifeMinDays": 20,

                    "OrderUOM": "Each",

                    "OrderUOMCoef": 24,

                    "Order_Min": 48,

                    "ShipUOM": "Bax",

                    "ShipUOMCoef": 48,

                    "InvoiceUOM": "Bax",

                    "InvoiceUOMCoef": 48

                }

            ],

            "ProductPurchasings": [

                {

                    "Organization_ID": 1005272,

                    "Active": true,

                    "Created": "2020-02-27 12:37:34+0000",

                    "CreatedBy": 1014218,

                    "Updated": "2020-02-27 12:37:34+0000",

                    "UpdatedBy": 1014218,

                    "CurrentVendor": true,

                    "UOM_ID": 100,

                    "Currency_ID": 102,

                    "ListPrice": 0,

                    "POPrice": 0,

                    "PriceEffective": null,

                    "LastPOPrice": 0,

                    "LastInvoicePrice": null,

                    "UPC": null,

                    "PartnerCategory": null,

                    "Discontinued": false,

                    "DiscontinuedBy": null,

                    "MinimumOrderQty": 1,

                    "OrderPackQty": 1,

                    "CostPerOrder": null,

                    "ActualDeliveryTime": null,

                    "LeadTime": null,

                    "RoyaltyAmount": null,

                    "Manufacturer": null,

                    "QualityRating": null,

                    "Description": null,

                    "PartnerProductKey": "030",

                    "BPartner_ID": 1018006,

                    "CalendarUpdated": null

                }

            ],

            "SalesRep": "REPR_NOU",

            "SalesRep_ID": 1030593,

            "SubscriptionType": null,

            "SubscriptionType_ID": null,

            "GuaranteeDaysMin": 5,

    "Discontinued": false

        }

    ],

    "totalRows": 1

}

Create:

URL: https://api.socratecloud.com/webapi/rest/product/create/{version}?accessToken={access_token}

Method: POST

Return: product value for success or error message (start with "ERROR: ")

Data format:

{

    "Organization": "Demo SRL",

    "Value": "9865953956",

    "Name": "some_name",

    "Description": null,

    "Help": null,

    "UPC": null,

    "SKU": null,

    "Active": true,

    "UOM": "Each",

    "TaxCategory": "TVA 24%",

    "ProductCategory": "English Book",

    "ProductSubcategory": null,

    "ProductFamily": null,

    "FamilyType": null,

    "ProductType": "Item",

    "NetWeight": 0,

    "Volume": 0,

    "PriceList": null,

    "PriceListVersion": null,

    "ListPrice": null,

    "StdPrice": "100",

    "IsSold": false,

    "AttributeSet": "W&H",

            "attributes": {

                "Width": 10,

                "Height": 25},

   "SalesRep": "AdminTitular",

   "SalesRep_ID": null,

   "SubscriptionType": "Abonament Food",

   "SubscriptionType_ID": 1000006,

   "Model": null,

   "GuaranteeDays": null,

   "GuaranteeDaysMin": 30

}