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

Retrieve a purchase orders by id

GET
/rest/v1/purchaseorders/{id}
Returns the purchase orders 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 order.

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/' \
--header 'api-key;'

Responses

🟢200OK
application/json
Body
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
id
integer 
read-onlyrequired
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.
origin
object 
optional
The origin of the purchase order.
id
integer 
optional
The unique identifier of the origin.
code
string 
optional
description
string 
optional
comment
object 
optional
Comments related to the order.
intern
string 
optional
The comments intended for internal use only.
extern
string 
optional
The comments intended for the customer.
lines
array [object {13}] 
required
The purchase order lines.
id
integer 
read-onlyrequired
The unique identifier of the order line.
lineNumber
integer 
optional
The line number of the order (this also determines the order of the order lines).
code
string 
optional
The product code for this order line.
description
string 
optional
The description of the order line.
customerReference
string 
optional
The reference to the customer placing the order for the product.
quantity
number <double>
optional
The quantity orderd by the customer.
partPrice
number <double>
optional
The unit price of the product.
discount
number <double>
optional
The percentage discount.
linePrice
number <double>
read-onlyoptional
The linePrice of the order
comment
object 
optional
Comments related to the order line.
configuration
object 
optional
The configuration of the product chosen for the order line.
confirmation
object 
optional
The confirmation details of the purchase order line.
delivery
object 
optional
Delivery information relevant to the order.
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
{
  "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"
}
🟠403Forbidden
🟠404Record Not Found
Modified at 2024-07-30 06:28:16
Previous
List all purchase orders
Next
Create a purchase order