List all purchase orders - LogicTrade API

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:

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

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

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

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