Skip to main content

Products

A Product is a sellable or purchasable item, with prices and dimensions. It is owned by a Catalog and its prices can vary depending on the Store context.

Product methods​

Returns a list of all Products matching some specified search criteria. The products belong to a catalog flagged as external.

Method​

GET/api/externals/v1/products

Arguments​

  • winLangID (long): Windows Language Identifier of the resulting data
  • catalogID (long): ID of the Catalog owning the searched Products
  • 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​

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

{
  "products": [
    {
      "id": long, 
      "catalogID": long,
      "isActive": boolean,
      "isStored": boolean,
      "code": string,
      "internalCode": string,
      "finish": string,
      "description": string,
      "category": string,
      "categoryGroup": string,
      "width": double,
      "height": double,
      "depth": double,
      "weight": double,
      "volume": double,
      "salesUnitCode": string,
      "purchaseUnitCode": string,
      "unitCostPrice": double,
      "unitSalesPrice": double,
      "defaultTax1Rate": double,
      "defaultTax2Rate": double,
      "isTax2Reducible": boolean,
      "defaultTax2ReducedRate": double,
      "defaultTax3Rate": double,
      "deeeUnitAmount": double,
      "deaUnitAmount": double,
      "deaProductCode": string,
      "deaProductRealUnitCount": double,
      "deaProductIsVariable": boolean,
      "deaIsAFixAmount": boolean,
      "notes": string,
      "attachments": [
        {
          "id": long,
          "url": string,
          "description": string,
          "fileTypeID": int,
          "fileAssociateTypeID": int,
          "creationDate": datetime
        }
      ],
      "creationDate": datetime,
      "modificationDate": datetime
    }
  ],
  "winLangID": long,
  "success": boolean,
  "message": string,
  "rowCount": long
}

Details​

Returns the details of the Product which productID is provided in the URL.

Method​

GET/api/externals/v1/products/{productID}

Arguments​

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

Body​

(none)

Response​

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

Product Category Group methods​

Returns a list of all Product Category Groups matching some specified search criteria.

Method​

GET/api/externals/v1/products/productCategoryGroups

Arguments​

  • winLangID (long): Windows Language Identifier of the resulting data
  • keyword (string): Searched keyword
  • idsOnly (boolean, true): If true, returns only a set of Product Category Group IDs
  • detailedView (boolean, false): If true, returns additional information about the matching Product Category Groups (e.g. "defaultTax1Rate", "defaultTax2Rate", "defaultTax2ReducedRate", "defaultTax3Rate")

Body​

(none)

Response​

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

{
  "productCategoryGroups": [
    {
      "id": long, 
      "description": string,
      "priorityOrder": long,
      "defaultTax1Rate": double,
      "defaultTax2Rate": double,
      "defaultTax2ReducedRate": double,
      "defaultTax3Rate": double
    }
  ],
  "winLangID": long,
  "success": boolean,
  "message": string,
  "rowCount": long
}

Details​

Returns the details of the Product Category Group which productCategoryGroupID is provided in the URL.

Method​

GET/api/externals/v1/products/productCategoryGroups/{productCategoryGroupID}

Arguments​

  • productCategoryGroupID (long): (provided in the path): ID of the Product Category Group to be returned
  • winLangID (long): Windows Language Identifier of the resulting data
  • detailedView (boolean, false): If true, returns additional information about the matching Product Category Group (e.g. "defaultTax1Rate", "defaultTax2Rate", "defaultTax2ReducedRate", "defaultTax3Rate")

Body​

(none)

Response​

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