This is a developer preview of Kubbos API. It's in beta, so it's subject to changes. If you need any of the "Coming soon" API services documented as soon as possible. Contact Us!

#suppliers.list
#suppliers.findById
#suppliers.create
#suppliers.update
#suppliers.delete

suppliers.list

Request

{
/* — search criteria (optional) — */
"companyNumber":"",       // Numeric
"companyName":"",
"tradeName":"",
"taxIDNumber":"",
"street1":"",
"street2":"",
"country":"",             // id value from countries.listForSelect
"state":"",               // id value from states.listForSelect
"city":"",
"postalCode":"",
"phone":"",
"phone2":"",
"fax":"",
"marketID":"",           // id value from markets.list 
"areaID":"",             // id value from areas.list
"paymentTypeID":"",      // id value from paymentType.list
"dueTypeID":"",          // id value from dueDateTypes.list
"typeID":"",             // id value from supplierTypes.list
"remarks":""
}

Response

{
    "data":     {
        "result":         [
                        {
                "equivalenceSurchageEnabled": false,
                "version": 1,
                "street1": "C/ del Peso 25, bajo",
                "id": "11552",
                "paymentTypeID": 900,
                "companyID": 11552,
                "marketID": 167,
                "dueTypeID": 1260000001008,
                "areaID": 156,
                "name": "Hidra Plus, S.A.",
                "tradeName": "HidraPlus",
                "companyName": "Hidra Plus, S.A.",
                "number": 2,
                "companyNumber": 2,
                "country": "España",
                "city": "Bilbao",
                "email": "info@hidraplus.com",
                "taxIDNumber": "G-45454511",
                "URL": "www.hidraplus.com",
                "state": "Vizcaya",
                "phone": "944.123.456",
                "nameSupplierType": "Homologado",
                "lastEvaluationDate": "17/01/2011 00:00:00",
                "lastEvaluationDateShort": "17/01/2011",
                "lastEvaluationMark": 3,
                "lastEvaluationMarkLongDescription": "3 - Excepcional"
            },
                        {
                "equivalenceSurchageEnabled": false,
                "version": 1,
                "street1": "Polígono Industrial EL PLA",
                "street2": "(Nave 13)",
                "postalCode": "08980",
                "id": "11551",
                "paymentTypeID": 900,
                "companyID": 11551,
                "marketID": 167,
                "dueTypeID": 1260000001007,
                "areaID": 159,
                "name": "Grifos UR, S.A",
                "tradeName": "Grifursa",
                "companyName": "Grifos UR, S.A",
                "number": 1,
                "companyNumber": 1,
                "country": "España",
                "city": "Sant Feliu de Llobregat",
                "email": "contact@grifursa.es",
                "fax": "93.666.777",
                "taxIDNumber": "B-211112245",
                "URL": "www.grifursa.es",
                "state": "Barcelona",
                "phone": "93.555.666",
                "nameSupplierType": "Homologado",
                "lastEvaluationDate": "17/01/2011 00:00:00",
                "lastEvaluationDateShort": "17/01/2011",
                "lastEvaluationMark": 2,
                "lastEvaluationMarkLongDescription": "2 - Normal"
            }
        ],
        "total": 2
    },
    "success": true
}

suppliers.findById

suppliers.findById

Request

{"id": "11551"}

Response

{
    "data":     {
        "equivalenceSurchageEnabled": false,
        "version": 1,
        "street1": "Polígono Industrial EL PLA",
        "street2": "(Nave 13)",
        "postalCode": "08980",
        "id": "11551",
        "paymentTypeID": 900,
        "companyID": 11551,
        "marketID": 167,
        "typeID": 1260000000042,
        "dueTypeID": 1260000001007,
        "lastEvaluationID": 1260000000028,
        "areaID": 159,
        "name": "Grifos UR, S.A",
        "tradeName": "Grifursa",
        "companyName": "Grifos UR, S.A",
        "number": 1,
        "companyNumber": 1,
        "country": "ESP",
        "countryDescription": "España",
        "city": "Sant Feliu de Llobregat",
        "email": "contact@grifursa.es",
        "fax": "93.666.777",
        "taxIDNumber": "B-211112245",
        "URL": "www.grifursa.es",
        "state": "8",
        "stateDescription": "Barcelona",
        "phone": "93.555.666",
        "lastEvaluationDate": "17/01/2011 00:00:00",
        "lastEvaluationDateShort": "17/01/2011"
    },
    "success": true
}

suppliers.create

Request

{
"companyNumber": " ",             // If empty, a new one autonumeric is assigned
"companyName": "Grifos UR, S.A",  // *Required
"tradeName": "Grifursa",
"taxIDNumber": "B-211112245",
"street1": "Polígono Industrial EL PLA",
"street2": "(Nave 13)",
"country": "ESP",                 // id value from countries.listForSelect
"state": "8",                     // id value from states.listForSelect
"city": "Sant Feliu de Llobregat",
"postalCode": "08980",
"phone": "93.555.666",
"phone2": " ",
"fax": "93.666.777",
"email": "contact@grifursa.es",
"URL": "www.grifursa.es",
"marketID": "167",                // id value from markets.list 
"areaID": "159",                  // id value from areas.list
"carrierID": " ",                 // id value from carriers.list
"freights": " ",                  // values: 1=Prepaid shipment, 2=Collect on Delivery
"typeID": "1260000000042",        // id value from supplierTypes.list
"remarks": " ",
"paymentTypeID": "900",           // id value from paymentType.list
"dueTypeID": "1260000001007",     // id value from dueDateTypes.list
"monthlyPaymentDay": " ",
"equivalenceSurchageEnabled": "false"  
} 

Response

{
    "data":     {
        "errors": [],
        "messages": [        {
            "description": "Operación realizada correctamente",
            "id": "operation_success"
        }],
        "warns": []
    },
    "id": "11551",
    "success": true,
    "version": 0
}

suppliers.update

Request

{
"companyName": "Grifos UR, S.A",  // *Required
"tradeName": "Grifursa",
"taxIDNumber": "B-211112245",
"street1": "Polígono Industrial EL PLA",
"street2": "(Nave 13)",
"country": "ESP",                 // id value from countries.listForSelect
"state": "8",                     // id value from states.listForSelect
"city": "Sant Feliu de Llobregat",
"postalCode": "08980",
"phone": "93.555.666",
"phone2": " ",
"fax": "93.666.777",
"email": "contact@grifursa.es",
"URL": "www.grifursa.es",
"marketID": "167",                // id value from markets.list 
"areaID": "159",                  // id value from areas.list
"carrierID": "22",                // id value from carriers.list
"freights": " ",                  // values: 1=Prepaid shipment, 2=Collect on Delivery
"typeID": "1260000000042",        // id value from supplierTypes.list
"remarks": " ",
"paymentTypeID": "900",           // id value from paymentType.list
"dueTypeID": "1260000001007",     // id value from dueDateTypes.list
"monthlyPaymentDay": "10",
"equivalenceSurchageEnabled": "true",
"id": "11551",
"version": 0
} 

Response

{
    "data":     {
        "errors": [],
        "messages": [        {
            "description": "Operación realizada correctamente",
            "id": "operation_success"
        }],
        "warns": []
    },
    "id": "11551",
    "success": true,
    "version": 1
}

suppliers.delete

Request

{
"id": "11551",
"version": 1
} 

Response

{
    "data":     {
        "errors": [],
        "messages": [        {
            "description": "Operación realizada correctamente",
            "id": "operation_success"
        }],
        "warns": []
    },
    "id": "11551",
    "success": true,
    "version": 1
}
  • No labels