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

List all purchase orders

GET
/rest/v1/purchaseorders
Returns a list of your purchase 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:
I24000001
reference
string 
optional
Search for a specific order based on the provided reference.
origenCode
string 
optional
Search for all orders based on the provided origin code.
supplierNumber
string 
optional
Search for a specific purchase order based on the provided supllier number.
Example:
R000000009
modifiedAfter
string <date-time>
optional
Search for all purchase 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/purchaseorders?pageSize=100&pageNumber=1&number=I24000001&reference=&origenCode=&supplierNumber=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 {12}] 
required
id
integer 
read-onlyrequired
The unique identifier of the purchase order.
number
string 
optional
The unique number with which the purchase order can be found.
reference
string 
optional
The customer reference of the purchase 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 purchase order.
supplier
object 
optional
The supplier of the purchase order
origin
object 
optional
The origin of the purchase order.
comment
object 
optional
Comments related to the order.
lines
array [object {13}] 
required
The purchase order lines.
totalPrice
number <double>
read-onlyoptional
The total amount of the purchase order (calculated field).
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": 0,
        "pageNumber": 0,
        "pageSize": 0,
        "totalPages": 0
    },
    "results": [
        {
            "id": 0,
            "number": "string",
            "reference": "string",
            "date": "2019-08-24",
            "status": "string",
            "supplier": {
                "id": 0,
                "number": "string",
                "companyName": "string",
                "phoneNumber": "string",
                "mobileNumber": "string",
                "email": "string",
                "remark": "string",
                "leadTimeInWeeks": 0,
                "address": {
                    "name": "string",
                    "street": "string",
                    "houseNumber": "string",
                    "zipCode": "string",
                    "city": "string",
                    "country": "string",
                    "phoneNumber": "string"
                },
                "ibanNumber": "string",
                "bicCode": "string",
                "cocNumber": "string",
                "modifiedDate": "2019-08-24T14:15:22Z",
                "createdDate": "2019-08-24T14:15:22Z"
            },
            "origin": {
                "id": 0,
                "code": "string",
                "description": "string"
            },
            "comment": {
                "intern": "string",
                "extern": "string"
            },
            "lines": [
                {
                    "id": 0,
                    "lineNumber": 0,
                    "code": "string",
                    "description": "string",
                    "customerReference": "string",
                    "quantity": 0,
                    "partPrice": 0,
                    "discount": 0,
                    "linePrice": 0,
                    "comment": {
                        "intern": "string",
                        "extern": "string"
                    },
                    "configuration": {
                        "id": 0,
                        "items": [
                            {
                                "option": "string",
                                "optionBarcode": "string",
                                "optionCode": "string",
                                "value": "string",
                                "valueBarcode": "string",
                                "valueCode": "string"
                            }
                        ]
                    },
                    "confirmation": {
                        "confirmed": true,
                        "date": "2019-08-24",
                        "number": "string"
                    },
                    "delivery": {
                        "expectedDate": "string",
                        "confirmedDeliveryDate": "2019-08-24T14:15:22Z"
                    }
                }
            ],
            "totalPrice": 0,
            "modifiedDate": "2019-08-24T14:15:22Z",
            "createdDate": "2019-08-24T14:15:22Z"
        }
    ]
}
🟢204No Content
🟠403Forbidden
🟠422Parameter Error
Modified at 2024-07-30 06:27:52
Previous
Purchase order
Next
Retrieve a purchase orders by id