Skip to main content

Suppliers

A Supplier is a customer. It can be assigned a set of Projects and/or Documents, and also a set of Events.

Supplier methods​

Returns a list of all Supplier matching some specified search criteria.

Method​

GET/api/externals/v1/suppliers

Arguments​

  • winLangID (long): Windows Language Identifier of the resulting data
  • internalCode (string): Internal code of the searched Supplier
  • code (string): Code of the searched Suppliers
  • emailAddress (string): Email address of the searched Suppliers
  • keyword (string): Searched keyword
  • isActive (boolean, true): If true, returns only active Supplier
  • kind (int): Kind of supplier (0 : supplier / 7 : platform / 8 : installer / 10 : provider / 11 : transporteur)
  • idsOnly (boolean, true): If true, returns only a set of Supplier IDs
  • detailedView (boolean, false): If true, returns additional information about the matching Suppliers (e.g. "deliveryAddresses", "billingAddress")

Body​

(none)

Response​

The search service returns a JSON message with the list of items matching the specified search criteria:

{
  "contacts": [
    { 
      "id": long, 
      "storeID": long,
      "winLangID": long,
      "internalCode": string,
      "code": string,
      "title": string,
      "firstName": string,
      "lastName": string,
      "companyName": string,
      "mobilePhone": string,
      "homePhone": string,
      "emailAddress": string,
      "isSubjectToTax1": boolean,
      "isSubjectToTax2": boolean,
      "isSubjectToTax3": boolean,
      "isSubjectToTaxDEEE": boolean,
      "isSubjectToTaxDEA": boolean,
      "mainAddress": {
        "street1": string,
        "street2": string,
        "street3": string,
        "zipCode": string,
        "city": string,
        "countryCode": string
      },
      "deliveryAddresses": [
        {
          "title": string,
          "firstName": string,
          "lastName": string,
          "companyName": string,
          "street1": string,
          "street2": string,
          "street3": string,
          "zipCode": string,
          "city": string,
          "countryCode": string
        }
      ],
      "billingAddress": {
        "title": string,
        "firstName": string,
        "lastName": string,
        "companyName": string,
        "street1": string,
        "street2": string,
        "street3": string,
        "zipCode": string,
        "city": string,
        "countryCode": string
      },
      "creationDate": datetime,
      "modificationDate": datetime,
      "defaultDelivery": int, // 0 : To Store / 1 : To platform / 2 : To Customer
      "useEDI": boolean, 
      "isActive": boolean,
      "kind": int // 0 : supplier / 7 : platform / 8 : installer / 10 : provider / 11 : transporteur
    }
  ]
  "winLangID": long,
  "success": boolean,
  "message": string,
  "rowCount": long
}

Details​

Returns the details of the Supplier which supplierID is provided in the URL.

Method​

GET/api/externals/v1/suppliers/{supplierID}

Arguments​

  • supplierID (long): (provided in the path): ID of the Supplier to be returned
  • winLangID (long): Windows Language Identifier of the resulting data
  • detailedView (boolean, false): If true, returns additional information about the matching Supplier (e.g. "deliveryAddresses", "billingAddress")

Body​

(none)

Response​

Same format as the one returned by the « Supplier search » method.