List products

Retrieve a list of products for the organization order by UpdatedAt.

Query parameters

NameDescription
fields string

A comma separated list of fields to include in the response. Possible values are Name,ProductNumber,Quantity,Unit,AccountNumber,BaseAmountValue,BaseAmountValueInclVat,TotalAmount,TotalAmountInclVat,ExternalReference,CreatedAt,UpdatedAt and DeletedAt. Notice that it's not case sensitive, the property name will be returned the way you request it. If left empty it defaults to Name and ProductGuid.

Default value is Name,ProductGuid

freeTextSearch string

A free text search performed on Name and ProductNumber. Can be left empty.

queryFilter string

Filter specific for products. Filtering can be applied to following fields: Name, ProductNumber, ExternalReference. See API documentation for filtering format. If left empty no filtering is applied.

changesSince string

[Generic Filter Option] Only return products that was created, deleted or updated at or after given time. If left empty, this filter will not be applied, and products will be returned regardless of change history. The time must be UTC and in the format 'YYYY-MM-DDTHH:mm:ssZ' example: '2015-08-18T06:36:22Z'.

deletedOnly boolean

[Generic Filter Option] Only select deleted products. If left empty, will default to false.

Default value is False

page integer

The 0-based page number

Default value is 0

pageSize integer

The maximum number of items to include in a page. Maximum 1000.

Default value is 100

organizationId string

Returns

200 (OK) Returns a collection of products (with only the requested fields).

NameDescription
Collection Product[] Show model
NameDescription
CreatedAt date

Time at which the Product was created

UpdatedAt date

Time at which the Product was last updated

DeletedAt date

Time at which the Product was deleted

ProductGuid globally unique identifier

Our Guid

BaseAmountValueInclVat decimal number

Amount incl. VAT

TotalAmount decimal number

Sum amount for the product excl. VAT (base amount X quanity)

TotalAmountInclVat decimal number

Sum amount for the product incl. VAT (base amount incl VAT X quanity)

ProductNumber string

Number of the product (Varekode)

Name string

Product name

BaseAmountValue decimal number

Amount excl. VAT

Quantity decimal number

Quantity

AccountNumber integer

Account number

Unit string

Product unit. Available unit types: hours, parts, km, day, week, month, kilogram, cubicMetre, set, litre, box, case, carton, metre, package, shipment, squareMetre, session, tonne.

ExternalReference string

Your external id This can be used for ID'ing in external apps/services e.g. a web shop. The maximum length is 128 characters

Comment string

Comment for the product. The comment will be shown on invoices with the product by default.

Collection containing the result of the request.

Pagination PaginationDetails Show model
NameDescription
MaxPageSizeAllowed integer

Maximum number of result pr. page.

PageSize integer

Number of result pr. page.

Result integer

Number of results returned in the collection.

ResultWithoutFilter integer

Result count before pagination.

Page integer

The 0-based page number.

Pagination information.

v1/{organizationId}/products?fields={fields}&freeTextSearch={freeTextSearch}&queryFilter={queryFilter}&changesSince={changesSince}&deletedOnly={deletedOnly}&page={page}&pageSize={pageSize}

Response Formats

{
  "Collection": [
    {
      "CreatedAt": "2019-07-23T08:52:18.5262113Z",
      "UpdatedAt": "2019-07-23T08:52:18.5262113Z",
      "DeletedAt": "2019-07-23T08:52:18.5262113Z",
      "ProductGuid": "aa61d312-b929-4543-9cf1-77ff2cda0b00",
      "BaseAmountValueInclVat": 25.0,
      "TotalAmount": 100.0,
      "TotalAmountInclVat": 125.0,
      "ProductNumber": "sample string 4",
      "Name": "skrewdriver",
      "BaseAmountValue": 20.0,
      "Quantity": 5.0,
      "AccountNumber": 1000,
      "Unit": "parts",
      "ExternalReference": "Fx. WebShopID:42",
      "Comment": "Mix in a highball glass with ice."
    },
    {
      "CreatedAt": "2019-07-23T08:52:18.5262113Z",
      "UpdatedAt": "2019-07-23T08:52:18.5262113Z",
      "DeletedAt": "2019-07-23T08:52:18.5262113Z",
      "ProductGuid": "aa61d312-b929-4543-9cf1-77ff2cda0b00",
      "BaseAmountValueInclVat": 25.0,
      "TotalAmount": 100.0,
      "TotalAmountInclVat": 125.0,
      "ProductNumber": "sample string 4",
      "Name": "skrewdriver",
      "BaseAmountValue": 20.0,
      "Quantity": 5.0,
      "AccountNumber": 1000,
      "Unit": "parts",
      "ExternalReference": "Fx. WebShopID:42",
      "Comment": "Mix in a highball glass with ice."
    }
  ],
  "Pagination": {
    "MaxPageSizeAllowed": 0,
    "PageSize": 0,
    "Result": 0,
    "ResultWithoutFilter": 0,
    "Page": 0
  }
}