GET api/v1/products

Gets a list of products

Request Information

URI Parameters

Name Description Type Additional information
ProductID Search by the product's ID. Uses SQL Like method integer No additional information available.
Name Search by the product's name. Uses SQL Like method string No additional information available.
ReferenceList Search by a list of references Array of string No additional information available.
JoinRefAndNameResults True se for para juntar resultados de pesquisa por referência e nome (útil para lookups) boolean No additional information available.
Ordering ProductOrderOptions No additional information available.
Desc boolean No additional information available.
Skip How many items you want to skip. Usually we skip the item amount we already have integer No additional information available.
Take Number of items you want per page integer Range: inclusive between 0 and 50

Response Information

Resource Description

No information available

Name Description Type Additional information
ProductID ID of the Product integer No additional information available.
Reference Reference of the product string No additional information available.
TaxID Product tax ID integer No additional information available.
Name Product display name. Can be null string No additional information available.
ApplyRetention Checks if the product applies retention boolean No additional information available.
ProductType Product type ProductType No additional information available.
StandardCost Buy price without taxes decimal number No additional information available.
SellPrice Sell price without taxes decimal number No additional information available.
DiscountRate Rate of the product discount decimal number No additional information available.
DiscontinuedDate Date when the product was discontinued, if it's the case date No additional information available.
StockQuantity Stock quantity decimal number No additional information available.
Tax Product tax information SimpleTaxInfo No additional information available.
MeasurementUnit Product measurement unit MeasurementUnitInfo No additional information available.

Response Formats

application/json, text/json

Sample:
                    
[
  {
    "productID": 1,
    "reference": "sample string 2",
    "taxID": 3,
    "name": "sample string 4",
    "applyRetention": true,
    "productType": 0,
    "standardCost": 6.0,
    "sellPrice": 7.0,
    "discountRate": 8.0,
    "discontinuedDate": "2021-10-25T15:48:13.3666294+01:00",
    "stockQuantity": 9.0,
    "tax": {
      "taxID": 1,
      "name": "sample string 2",
      "taxRate": 3.0
    },
    "measurementUnit": {
      "unitID": 1,
      "name": "sample string 2",
      "abbreviation": "sample string 3",
      "isActive": true
    }
  },
  {
    "productID": 1,
    "reference": "sample string 2",
    "taxID": 3,
    "name": "sample string 4",
    "applyRetention": true,
    "productType": 0,
    "standardCost": 6.0,
    "sellPrice": 7.0,
    "discountRate": 8.0,
    "discontinuedDate": "2021-10-25T15:48:13.3666294+01:00",
    "stockQuantity": 9.0,
    "tax": {
      "taxID": 1,
      "name": "sample string 2",
      "taxRate": 3.0
    },
    "measurementUnit": {
      "unitID": 1,
      "name": "sample string 2",
      "abbreviation": "sample string 3",
      "isActive": true
    }
  }
]