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
      • References
        • Get the product references
      • Compositions
        • Get product compositions
    • 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

Retrieve a product by id

GET
/rest/v1/products/{id}
Returns the product object for a valid id.

Request

Authorization
Add parameter in header
api-key
Example:
api-key: ********************
Path Params
id
string 
required
The id of the product
Query Params
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/?includeImplementations' \
--header 'api-key;'

Responses

🟢200OK
application/json
Body
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.
id
integer 
optional
The unique identifier of the group.
parentId
integer 
optional
The id of the parent group.
code
string 
optional
The code of the group.
description
string 
optional
The description of the group.
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
id
number 
optional
The unique identifier of the sales group.
code
string 
optional
The unique code with of the sales group.
description
string 
optional
The description of the sales group
vat
object 
optional
The VAT of the product
id
integer 
optional
The unique identifier of the VAT
code
string 
optional
The unique code of the VAT
description
string 
optional
The discription of the VAT (high/low/none)
supplier
object 
optional
Purchase information of the product.
code
string 
optional
The product code used by the default supplier.
discription
string 
optional
The description used by the de default supplier
purchasePrice
number 
optional
The current purchase price from the default supplier.
leadTimeInWeeks
integer 
optional
The lead time in weeks for this product of the default supplier.
supplier
object (Supplier) 
optional
The default supplier of the product.
images
array [object {4}] 
optional
Images associated with the product.
id
integer 
optional
The unique identifier of the image..
name
string 
optional
The name of the image.
url
string 
optional
The URL where the image can be downloaded.
sequence
integer 
optional
The order in which the images are displayed.
attributes
array [object {8}] 
optional
Additional product attributes
id
integer 
optional
group
object 
optional
The category under which the additional product feature falls.
type
string 
optional
The field type (select from list/text/number) of an additional product attribute.
name
string 
optional
The name of the additional product attribute.
suffix
string 
optional
The suffix of the additional product attribute.
code
string 
optional
The unique code of the additional product attribute.
sequence
integer 
optional
The order in which the attribute is displayed.
values
array [object {3}] 
optional
The values associated with the additional product attribute.
implementations
array [object {5}] 
optional
Implementations of the article are only displayed if the parameter includeImplementations is set to true.
id
integer 
optional
The unique identifier of the implementation.
number
string 
optional
The number of the implementation.
invalid
boolean 
optional
This indicates that the configuration of the implementation is invalid. Check the implementation in LogicTrade for more information.
barcode
string 
optional
The unique barcode for the implementation.
configuration
object 
optional
The configuration associated with the implementation.
sellable
enum<string> 
optional
Whether the product is saleable (yes, no or only when the product is in stock).
Allowed values:
YesStockonlyNo
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
{
    "id": 114,
    "code": "LT00000083",
    "name": "De Slûs bank",
    "description": "",
    "barcode": "9900000002527",
    "unit": "stuks",
    "height": 120,
    "width": 80,
    "length": 100,
    "depth": 0,
    "weight": 1.5,
    "configurable": true,
    "groups": [
        {
            "id": 159,
            "parentId": 0,
            "code": "",
            "description": "Meubels"
        },
        {
            "id": 160,
            "parentId": 159,
            "code": "",
            "description": "Banken"
        },
        {
            "id": 225,
            "parentId": 0,
            "code": "DEMO",
            "description": "Demo artikelen"
        }
    ],
    "volume": 960000,
    "packages": 0,
    "startDate": null,
    "endDate": null,
    "webshop": false,
    "salesPrice": 1000,
    "salesGroup": {
        "id": 70,
        "code": "",
        "description": "Banken Meubels"
    },
    "vat": {
        "id": 1,
        "code": "H",
        "description": "BTW Hoog"
    },
    "supplier": {
        "code": "",
        "description": "",
        "purchasePrice": 0,
        "supplier": {
            "id": 49,
            "number": "R00020002",
            "companyName": "Trendy Meubels NV",
            "phoneNumber": "0109876543",
            "mobileNumber": "",
            "email": "sales@trendymeubels.nl",
            "remark": "",
            "ibanNumber": "",
            "bicCode": "",
            "cocNumber": "76543210",
            "deliveryWeeks": 0,
            "address": {
                "street": "Handelsstraat",
                "houseNumber": "5",
                "zipCode": "5678 CD",
                "city": "Rotterdam",
                "country": "NL"
            }
        }
    },
    "images": [
        {
            "id": 46,
            "url": "https://api.logictrade.cloud/rest/v1/images/7c98f7ed-d6a0-4a6e-b7f0-7faceda38744/d40c4a01-80de-4006-bd7e-2f64fd34ee97",
            "sequence": 10
        }
    ],
    "attributes": [
        {
            "id": 38,
            "group": {
                "code": "",
                "name": "Meubels"
            },
            "type": "Select",
            "name": "Kleur",
            "code": "",
            "sequence": 10,
            "values": [
                {
                    "id": 3,
                    "code": "",
                    "value": "Blauw"
                }
            ]
        },
        {
            "id": 41,
            "group": {
                "code": "",
                "name": "Meubels"
            },
            "type": "Select",
            "name": "Materiaal",
            "code": "",
            "sequence": 20,
            "values": [
                {
                    "id": 4,
                    "code": "",
                    "value": "Acryl"
                }
            ]
        },
        {
            "id": 44,
            "group": {
                "code": "",
                "name": "Meubels"
            },
            "type": "Select",
            "name": "Diepte ",
            "code": "",
            "sequence": 50,
            "values": [
                {
                    "id": 5,
                    "code": "",
                    "value": "149"
                }
            ]
        },
        {
            "id": 55,
            "group": {
                "code": "",
                "name": "Meubels"
            },
            "type": "Select",
            "name": "Rugleuning",
            "code": "",
            "sequence": 150,
            "values": [
                {
                    "id": 6,
                    "code": "",
                    "value": "Niet verstelbaar"
                }
            ]
        },
        {
            "id": 57,
            "group": {
                "code": "",
                "name": "Meubels"
            },
            "type": "Select",
            "name": "Draaibaar",
            "code": "",
            "sequence": 170,
            "values": [
                {
                    "id": 7,
                    "code": "",
                    "value": "nee"
                }
            ]
        }
    ],
    "sellable": "StockOnly",
    "modifiedDate": "2024-11-07T13:32:40.593",
    "createdDate": "2024-10-21T13:39:02.183"
}
🟠403Forbidden
🟠404Record Not Found
Modified at 2025-04-01 13:51:35
Previous
List all products
Next
Create a product