LogicTrade API
  1. Supplier
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
        GET
      • Retrieve a supplier by id
        GET
      • Create a supplier
        POST
      • Update a supplier
        PUT
      • Remove the supplier
        DELETE
    • Product
      • Product
        • List all products
        • Retrieve a product by id
        • Create a product
        • Remove the products
        • Update a product
        • Search products
      • 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. Supplier

List all suppliers

GET
/rest/v1/suppliers
Returns a list of your suppliers. The suppliers are returned sorted by id, with the most recent supplier 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
name
string 
optional
Search for a specific supplier based on the provided name.
number
string 
optional
Search for a specific supplier based on the provided number.
Example:
R000000009
zipCodeHouseNumber
string 
optional
Search for a specific supplier based on the provided zip code and house number.
city
string 
optional
Search for all suppliers based on the provided city.
phoneNumber
string 
optional
Search for a specific supplier based on the provided phone number.
email
string 
optional
Search for a specific supplier based on the provided email address.
modifiedAfter
string <date-time>
optional
Search for all suppliers that have been modified after the specified timestamp.
Example:
2024-04-12T13:49:51.141Z

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/suppliers?pageSize=100&pageNumber=1&name&number=R000000009&zipCodeHouseNumber=&city&phoneNumber&email&modifiedAfter=2024-04-12T13:49:51.141Z' \
--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 {14}] 
required
id
integer 
required
The unique identifier of the supplier.
number
string 
read-onlyoptional
A unique number with which the supplier can be found.
companyName
string 
required
The supplier's company name.
phoneNumber
string 
optional
The first phone number of the supplier.
mobileNumber
string 
optional
The mobile phone number of the supplier.
email
string 
optional
The e-mail adress of the supplier
remark
string 
optional
Any customer supplier.
leadTimeInWeeks
integer 
optional
The default lead time in weeks of the supplier.
address
object 
optional
The address of the supplier.
ibanNumber
string 
optional
The IBAN number of the supplier
bicCode
string 
optional
The BIC/SWIFT code of the supplier
cocNumber
string 
optional
Chain of Custody Number (KvK number).
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": 13,
            "number": "R0000013",
            "companyName": "LogicTrade",
            "phoneNumber": "088-2400180",
            "email": "info@logictrade.nl",
            "address": {
                "street": "Wethouder Buitenhuisstraat",
                "houseNumber": "2B",
                "zipCode": "7951 SM",
                "city": "Staphorst",
                "country": "NL"
            }
        },
        {
            "id": 14
        }
    ]
}
🟢204No Content
🟠403Forbidden
🟠422Parameter Error
Modified at 2024-07-30 06:23:26
Previous
Supplier
Next
Retrieve a supplier by id