LogicTrade API
  1. Product
LogicTrade API
  • Authentication
  • Pagination
  • Rate limits
  • Error codes
  • Changelog
  • Configuration Service
  • Endpoints
    • Authentication
      • Introspection
    • Customer
      • List all customers
      • Retrieve a customer by id
      • Create a customer
      • Update a customer
      • Remove the customer
    • Supplier
      • List all suppliers
      • Retrieve a supplier by id
      • Create a supplier
      • Update a supplier
      • Remove the supplier
    • Product
      • Product
        • List all products
          GET
        • Retrieve a product by id
          GET
        • Create a product
          POST
        • Remove the products
          DELETE
        • Update a product
          PUT
        • Search products
          POST
      • Groups
        • List all product groups
      • Discount
        • List all discounts for products
        • Get all discounts for product by id
        • List all discounts for customers
        • Get all discounts for a customer by id
      • Stock
        • Get stock for products
        • Search stock for products
      • Prices
        • Get product prices
      • Descriptions
        • Get the descriptions for a product
      • Refereces
        • Get the product references
    • Quote
      • List all quotes
      • Retrieve a quote by id
      • Create a quote
      • Update a quote
    • Sales order
      • List all orders
      • Retrieve an orders by id
      • Create an order
      • Update an order
    • Invoice
      • List all invoices
      • Retrieve a invoice by id
      • Create a invoice
      • Update a invoice
    • Delivery
      • Get list of orders that can be delivered
      • Update the order with delivery information
    • Purchase order
      • List all purchase orders
      • Retrieve a purchase orders by id
      • Create a purchase order
      • Update a purchase order
  1. Product

List all products

GET
/rest/v1/products
Returns a list of your products. The products are returned sorted by id, with the most recent product appearing first.

Request

Authorization
Add parameter in header
api-key
Example:
api-key: ********************
Query Params
pageSize
integer 
optional
This specifies the number of objects to returned, ranging between 10 and 100.
Example:
100
pageNumber
integer 
optional
The parameter pageNumber indicates which page of the result should be requested.
Example:
1
code
string 
optional
Search for a specific product based on the provided code.
name
string 
optional
Search for a specific product based on the provided name.
description
string 
optional
Search for a specific product based on the provided description.
barcode
string 
optional
Search for a specific product based on the provided barcode.
groupId
integer 
optional
Search for all products that belong to the specified product group.
groupCode
string 
optional
Search for all products that belong to the specified product group code.
webshop
boolean 
optional
Search all products where the feature ‘webshop’ is set to ‘yes’.
modifiedAfter
string <date-time>
optional
Search for all products that have been modified after the specified timestamp.
includeImplementations
boolean 
optional
With the parameter includeImplementations set to true, the implementations of an article are also included in the response.

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.logictrade.cloud/rest/v1/products?pageSize=100&pageNumber=1&code=&name&description&barcode&groupId&groupCode&webshop&modifiedAfter=&includeImplementations' \
--header 'api-key;'

Responses

🟢200OK
application/json
Body
pagination
object 
optional
totalResults
integer 
optional
The total number of records.
pageNumber
integer 
optional
The current page number.
pageSize
integer 
optional
The number of records returned per page.
totalPages
integer 
optional
The total number of pages.
results
array [object {27}] 
required
id
integer 
read-onlyrequired
The unique identifier of the product.
code
string 
required
The unique code with which the product can be found.
name
string 
required
The name of the product.
description
string 
optional
An additional description for the product
barcode
string 
optional
The barcode of the product.
unit
string 
optional
The unit of the product (pice/m2)
height
number 
optional
The height of the product.
width
number 
optional
The width of the product.
length
number 
optional
The length of the product.
depth
number 
optional
The dept of the product.
weight
number 
optional
The weight of th product.
configurable
boolean 
optional
This indicates whether the item is configurable.
groups
array [object {4}] 
optional
The article groups to which an article belongs.
volume
number 
optional
The volume of the product, often used for transportation purposes.
packages
number 
optional
The number of packages that comprise the product, often used for transportation purposes.
startDate
string <date>
optional
The date when the product becomes available in the assortment.
endDate
string <date>
optional
The date when the product is removed from the assortment.
webshop
boolean 
optional
This indicates whether the product is available for the website.
salesPrice
number <double>
optional
The current selling price of the product.
salesGroup
object 
optional
The sales group of the product, most often used for financial purpose
vat
object 
optional
The VAT of the product
supplier
object 
optional
Purchase information of the product.
images
array [object {4}] 
optional
Images associated with the product.
attributes
array [object {8}] 
optional
Additional product attributes
implementations
array [object {5}] 
optional
Implementations of the article are only displayed if the parameter includeImplementations is set to true.
modifiedDate
string <date-time>
optional
The date on which the entity was last modified.
createdDate
string <date-time>
optional
The date on which the entity was created.
Example
{
  "pagination": {
    "totalResults": 2,
    "pageNumber": 1,
    "pageSize": 10,
    "totalPages": 1
  },
  "results": [
    {
      "id": 29,
      "code": "LT00000001",
      "name": "Verf",
      "description": "Algemeen artikel, pas de omschrijving aan op de offerte of order",
      "barcode": "9900000001742",
      "unit": "stuks",
      "volume": 0,
      "packages": 0,
      "startDate": null,
      "endDate": null,
      "webshop": false,
      "salesPrice": 0,
      "salesGroup": {
        "code": "",
        "description": "Verf"
      },
      "vat": {
        "code": "",
        "description": "BTW Hoog"
      },
      "images": []
    },
    {
      "id": 30,
      "code": "LT00000002",
      "name": "Behang",
      "description": "Algemeen artikel, pas de omschrijving aan op de offerte of order",
      "barcode": "9900000001759",
      "unit": "stuks",
      "volume": 0,
      "packages": 0,
      "startDate": null,
      "endDate": null,
      "webshop": false,
      "salesPrice": 0,
      "salesGroup": {
        "code": "",
        "description": "Behang"
      },
      "vat": {
        "code": "",
        "description": "BTW Hoog"
      },
      "images": []
    }
  ]
}
🟢204No Content
🟠403Forbidden
🟠422Parameter Error
Modified at 2024-12-19 09:03:52
Previous
Product
Next
Retrieve a product by id