LogicTrade API
  1. Sales order
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
        • 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
      • 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
        GET
      • Retrieve an orders by id
        GET
      • Create an order
        POST
      • Update an order
        PUT
    • 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. Sales order

List all orders

GET
/rest/v1/orders
Returns a list of your orders. The orders are returned sorted by id, with the most recent order 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
number
string 
optional
Search for a specific order based on the provided number.
Example:
V24000001
reference
string 
optional
Search for a specific order based on the provided reference.
webshopNumber
string 
optional
Search for a specific order based on the provided webshop number.
originCode
string 
optional
Search for all orders based on the provided origin code.
customerNumber
string 
optional
Search for a specific quote based on the provided customer number.
Example:
R000000009
modifiedAfter
string <date-time>
optional
Search for all sales orders 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/orders?pageSize=100&pageNumber=1&number=V24000001&reference=&webshopNumber&originCode=&customerNumber=R000000009&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 {21}] 
required
id
integer 
read-onlyrequired
The unique identifier of the order.
number
string 
optional
The unique number with which the order can be found.
reference
string 
optional
The customer reference of the order.
salesMan
string 
read-onlyoptional
The salesperson who handled the order.
date
string <date>
The date of the order
optional
The date when the order was created.
status
string 
read-onlyoptional
The status of the order.
externNumber
string 
optional
The unique number of the order in your system.
totalAmount
number <double>
read-onlyoptional
The total amount of the order (calculated field).
stockStatus
string 
optional
This indicates the stock status of the order line. The possible values are: none, partial, and complete.
deliveryStatus
string 
optional
This indicates the delivery status of the order line. The possible values are: none, partial, and complete.
invoiceStatus
string 
optional
This indicates the invoice status of the order line. The possible values are: none, partial, and complete.
customer
object (Customer) 
required
The customer for whom the order is made.
delivery
object 
required
Delivery information relevant to the order.
origin
object 
optional
The origin of the order.
webshop
object 
optional
Webshop information from the order.
quote
object 
optional
If the order is created from a quotation, the details of the quotation will be listed here.
payments
array [object {3}] 
optional
The payments for the order.
comment
object 
optional
Comments related to the order.
lines
array [object {14}] 
required
The order lines.
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": 100,
    "totalPages": 1
  },
  "results": [
    {
      "id": 4,
      "number": "V24000001",
      "reference": "",
      "salesMan": "LogicTrade",
      "date": "2024-03-24T13:43:57.083",
      "status": "Definitief",
      "externNumber": "",
      "totalAmount": 0,
      "customer": {
        "id": 13,
        "number": "R000000008",
        "gender": "Man",
        "title": "Dhr.",
        "initials": "J.",
        "firstName": "Jan",
        "infix": "",
        "lastName": "Jansen",
        "companyName": "",
        "phoneNumber": "",
        "mobileNumber": "06-12345678",
        "email": "jan@jansen.com",
        "remark": "",
        "address": {
          "street": "Weth. Buitenhuisstraat",
          "houseNumber": "2b",
          "zipCode": "7951 SM",
          "city": "Staphorst",
          "country": "NL"
        }
      },
      "delivery": {
        "type": "Bezorgen+montage",
        "expectedDate": null,
        "address": {
          "street": "Weth. Buitenhuisstraat",
          "houseNumber": "2b",
          "zipCode": "7951 SM",
          "city": "Staphorst",
          "country": "NL"
        }
      },
      "origin": {
        "code": "WIN",
        "description": "Winkel"
      },
      "webshop": {
        "number": "",
        "url": ""
      },
      "payments": [],
      "comment": {
        "intern": "",
        "extern": ""
      },
      "lines": [
        {
          "id": 3,
          "lineNumber": 10,
          "code": "LT00000043",
          "description": "Barstoelen",
          "quantity": 3,
          "partPrice": 123,
          "discount": 0,
          "linePrice": 369,
          "vat": 21,
          "comment": {
            "intern": "",
            "extern": ""
          }
        }
      ]
    },
    {
      "id": 8,
      "number": "V24000002",
      "reference": "",
      "salesMan": "LogicTrade",
      "date": "2024-03-24T14:14:56.357",
      "status": "Definitief",
      "externNumber": "",
      "totalAmount": 0,
      "customer": {
        "id": 16,
        "number": "R00000011",
        "gender": "Vrouw",
        "title": "Mevr.",
        "initials": "J",
        "firstName": "Janneke",
        "infix": "",
        "lastName": "Jansen",
        "companyName": "",
        "phoneNumber": "",
        "mobileNumber": "",
        "email": "",
        "remark": "",
        "address": {
          "street": "Weth. Buitenhuisstraat",
          "houseNumber": "2b",
          "zipCode": "7951 SM",
          "city": "Staphorst",
          "country": "NL"
        }
      },
      "delivery": {
        "type": "Bezorgen+montage",
        "expectedDate": null,
        "address": {
          "street": "Weth. Buitenhuisstraat",
          "houseNumber": "2b",
          "zipCode": "7951 SM",
          "city": "Staphorst",
          "country": "NL"
        }
      },
      "origin": {
        "code": "WIN",
        "description": "Winkel"
      },
      "webshop": {
        "number": "",
        "url": ""
      },
      "payments": [],
      "comment": {
        "intern": "",
        "extern": ""
      },
      "lines": [
        {
          "id": 6,
          "lineNumber": 10,
          "code": "LT00000004",
          "description": "Karpetten / Vloerkleden",
          "quantity": 1,
          "partPrice": 123,
          "discount": 0,
          "linePrice": 123,
          "vat": 21,
          "comment": {
            "intern": "",
            "extern": ""
          }
        }
      ]
    }
  ]
}
🟢204No Content
🟠403Forbidden
🟠422Parameter Error
Modified at 2025-01-07 12:43:58
Previous
Sales order
Next
Retrieve an orders by id