Skip to main content

Catalogs

A Catalog is mainly a group of Products. It is owned by a Supplier and the products prices can vary depending on the Store context.

Catalog methods​

Returns a list of all Catalogs flagged as external matching some specified search criteria.

Method​

GET/api/externals/v1/catalogs

Arguments​

  • winLangID (long): Windows Language Identifier of the resulting data
  • storeID (long): ID of the Store owning the searched Catalogs
  • supplierID (long): ID of the Supplier of the searched Catalogs
  • internalCode (string): Internal code of the searched Catalogs
  • code (string): Code of the searched Catalogs
  • keyword (string): Searched keyword
  • minDate (datetime): Minimum date of the searched Catalogs
  • maxDate (datetime): Maximum date of the searched Catalogs
  • dateKind (string): Type of date used by the minDate and/or maxDate arguments. Allowed values: "CreationDate", "LastModificationDate"
  • showExternalOnly (boolean, true): If true, returns only external catalogs
  • idsOnly (boolean, true): If true, returns only a set of Catalog IDs
  • detailedView (boolean, false): If true, returns additional information about the matching Catalogs (e.g. "coefficients", "attachments")

Body​

(none)

Response​

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

{
  "catalogs": [
    { 
      "id": long, 
      "name": string,
      "internalCode": string,
      "supplierID": long,
      "startingDate": datetime,
      "endingDate": datetime,
      "catalogTypeID": long, // 0: Furniture / 1: Household appliances/ 2: Accessories/ 3: Service / 4: Decoration / 5: Cupboard / 6: Options/ 7: Cupboard front/ 8: Installation
      "coefficients": {
        "salesCoefficient": double,
        "purchaseCoefficient": double,
        "profitCorrectionCoefficient": double
      }, 
      "attachments": [
        {
          "id": long,
          "url": string,
          "description": string,
          "fileTypeID": int,
          "fileAssociateTypeID": int,
          "creationDate": datetime
        }
      ], 
      "notes": string,
      "creationDate": datetime,
      "modificationDate": datetime
    }
  ],
  "winLangID": long,
  "success": boolean,
  "message": string,
  "rowCount": long
}

Details​

Returns the details of the Catalog which catalogID is provided in the URL.

Method​

GET/api/externals/v1/catalogs/{catalogID}

Arguments​

  • catalogID (long): (provided in the path): ID of the Catalog to be returned
  • winLangID (long): Windows Language Identifier of the resulting data
  • storeID (long): ID of the Store owning the searched Catalog
  • detailedView (boolean, false): If true, returns additional information about the matching Catalog (e.g. "coefficients", "attachments")

Body​

(none)

Response​

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

Catalog additional methods​

Products​

Returns a list of all Products owned by the Catalog which catalogID is provided in the URL and matching some specified search criteria.

Method​

GET/api/externals/v1/catalogs/{catalogID}/products

Arguments​

  • catalogID (long): (provided in the path): ID of the Catalog owning the searched Products
  • winLangID (long): Windows Language Identifier of the resulting data
  • storeID (long): ID of the Store owning the searched Products
  • internalCode (string): Internal code of the searched Products
  • code (string): Code of the searched Products
  • keyword (string): Searched keyword
  • minDate (datetime): Minimum date of the searched Products
  • maxDate (datetime): Maximum date of the searched Products
  • dateKind (string): Type of date used by the minDate and/or maxDate arguments. Allowed values: "CreationDate", "LastModificationDate"
  • idsOnly (boolean, true): If true, returns only a set of Product IDs
  • detailedView (boolean, false): If true, returns additional information about the matching Products (e.g. "attachments")

Body​

(none)

Response​

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