Order Collection

GET 
https://api.lochting.com/public/v1/orders

This call will return a JSON object with orders.

info

The structure of prices differs from the New Order endpoint. Prices are enriched with the correct currency name and symbol.

Request

Query Parameters

pagination[page] integer
The page number to retrieve
Default value: 1
pagination[size] integer
The page size (hard limit to 1000)
Default value: 10
sorting[field] string
The field to sort on (createdAt, updatedAt or orderStatus).
Default value: null
sorting[direction] string
The sorting direction (ascending or descending).
Default value: null

Header Parameters

Authorization stringrequired
Example: your-access-token

Responses

200

OK

application/json

Schema

Schema

pagination object
Pagination
pageintegerrequired
Page number
Example: 1
sizeintegerrequired
Page size
Example: 10
totalintegerrequired
Total number of items.
Example: 1
items object[]required
List of items
Array [
orderIdstringrequired
The id of the order, prefixed with order- and followed by a 36 characters long UUID.
Example: order-c7d932c1-84e8-410c-a9b2-18bf739d6b8b
orderNumberstringrequired
Example: W00010
salesChannelIdstringrequired
The id of the sales channel, prefixed with webshop- or device- and followed by a 36 characters long UUID.
Example: webshop-03cac0fc-feaf-5bc5-a3d1-8dc5e80ada46
externalReferenceIdstringrequired
The external reference ID of the integrator
Example: 34
paymentMethodPaymentMethod (string)nullablerequired
The payment method
Possible values: [maestro, bancontact, visa_mastercard, paypal, carte_bleue, offline_payment, payconiq, tyro_mastercard, free]
Example: bancontact
total objectrequired
Total including VAT
amountInCentsintegerrequired
Example: 4000
currency objectrequired
namestringrequired
name of the currency
Example: EUR
symbolstringrequired
unicode symbol of the currency
Example: €
taxes objectrequired
VAT
amountInCentsintegerrequired
Example: 4000
currency objectrequired
namestringrequired
name of the currency
Example: EUR
symbolstringrequired
unicode symbol of the currency
Example: €
shipping objectrequired
Shipping Cost
amountInCentsintegerrequired
Example: 4000
currency objectrequired
namestringrequired
name of the currency
Example: EUR
symbolstringrequired
unicode symbol of the currency
Example: €
discount objectrequired
Discount
amountInCentsintegerrequired
Example: 4000
currency objectrequired
namestringrequired
name of the currency
Example: EUR
symbolstringrequired
unicode symbol of the currency
Example: €
orderStatusOrderStatus (string)required
The order status
Possible values: [pending, paid, readyToPickUpInStore, complete, canceled]
Example: paid
createdAtstringrequired
iso datetime (Y-m-d H:i:s)
Example: 2020-02-28 15:02:11
updatedAtstringnullablerequired
iso datetime (Y-m-d H:i:s)
Example: 2020-02-28 15:02:11
shippingMethodShippingMethod (string)nullablerequired
Possible values: [pickup, locker, localDelivery, serviceDelivery]
Example: pickup
customerEmailAddressstringnullablerequired
Email address of the customer
Example: johndoe@lochting.com
customerFirstNamestringnullablerequired
First name of customer
Example: John
customerLastNamestringnullablerequired
Last name of customer
Example: Doe
]

Example (auto)

{
  "pagination": {
    "page": 1,
    "size": 10
  },
  "total": 1,
  "items": [
    {
      "orderId": "order-c7d932c1-84e8-410c-a9b2-18bf739d6b8b",
      "orderNumber": "W00010",
      "salesChannelId": "webshop-03cac0fc-feaf-5bc5-a3d1-8dc5e80ada46",
      "externalReferenceId": "34",
      "paymentMethod": "bancontact",
      "total": {
        "amountInCents": 4000,
        "currency": {
          "name": "EUR",
          "symbol": "€"
        }
      },
      "taxes": {
        "amountInCents": 4000,
        "currency": {
          "name": "EUR",
          "symbol": "€"
        }
      },
      "shipping": {
        "amountInCents": 4000,
        "currency": {
          "name": "EUR",
          "symbol": "€"
        }
      },
      "discount": {
        "amountInCents": 4000,
        "currency": {
          "name": "EUR",
          "symbol": "€"
        }
      },
      "orderStatus": "paid",
      "createdAt": "2020-02-28 15:02:11",
      "updatedAt": "2020-02-28 15:02:11",
      "shippingMethod": "pickup",
      "customerEmailAddress": "johndoe@lochting.com",
      "customerFirstName": "John",
      "customerLastName": "Doe"
    }
  ]
}

401

Unauthorized

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://api.lochting.com/public/v1/orders");
request.Headers.Add("Accept", "application/json");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

https://api.lochting.com/public/v1

Parameters

Authorization — headerrequired

pagination[page] — query

pagination[size] — query

sorting[field] — query

sorting[direction] — query

ResponseClear

Click the Send API Request button above and see the response here!