docs.remarkable.net
Orders

Get Orders

Get Orders via JSON. Authorize with query auth

GET/v1/batches/orders
AuthorizationBasic <token>

Basic Authorization header using the Bearer scheme.

In: header

Authorization<token>

JWT Authorization header using the Bearer scheme.

In: header

Query Parameters

siteId?integer
Formatint32
skip?integer
Formatint32
take?integer
Formatint32
startDate?string
endDate?string
includeExported?boolean
clientStatusIds?array<string>

Response Body

curl -X GET "https://loading/v1/batches/orders?siteId=0&skip=0&take=0&startDate=string&endDate=string&includeExported=true&clientStatusIds=string"
{
  "total": 0,
  "orders": [
    {
      "orderReference": "string",
      "dateCreated": "2019-08-24T14:15:22Z",
      "statusTitle": "string",
      "clientOrderStatusId": "string",
      "total": 0.1,
      "deliveryTotal": 0.1,
      "itemTotal": 0.1,
      "discountTotal": 0.1,
      "itemQuantity": 0,
      "shippingTitle": "string",
      "clientShippingOptionId": "string",
      "currencyIso": "string",
      "orderLines": [
        {
          "productTitle": "string",
          "imageUrl": "string",
          "stockTitle": "string",
          "quantity": 0,
          "itemPrice": 0.1,
          "productCode": "string",
          "itemDiscount": 0.1,
          "clientProductId": "string",
          "rrp": 0.1,
          "orderLineId": 0,
          "stockCode": "string",
          "productUrl": "string",
          "clientOrderLineId": "string"
        }
      ],
      "billingAddress": {
        "firstName": "string",
        "lastName": "string",
        "addressLine1": "string",
        "addressLine2": "string",
        "addressLine3": "string",
        "city": "string",
        "county": "string",
        "companyName": "string",
        "postCode": "string",
        "countryIso": "string",
        "title": "string"
      },
      "deliveryAddress": {
        "firstName": "string",
        "lastName": "string",
        "addressLine1": "string",
        "addressLine2": "string",
        "addressLine3": "string",
        "city": "string",
        "county": "string",
        "companyName": "string",
        "postCode": "string",
        "countryIso": "string",
        "title": "string"
      },
      "customer": {
        "title": "string",
        "firstName": "string",
        "lastName": "string",
        "contactNumber": "string",
        "email": "string",
        "clientCustomerId": "string"
      },
      "payments": [
        {
          "paymentProvider": "string",
          "vpsTxId": "string",
          "total": 0.1,
          "paymentDate": "2019-08-24T14:15:22Z",
          "currencyIso": "string",
          "type": "string",
          "result": "string",
          "additionalData": {
            "property1": "string",
            "property2": "string"
          }
        }
      ]
    }
  ]
}
{
  "succeeded": true,
  "errors": [
    {
      "message": "string"
    }
  ]
}
{
  "message": "string",
  "code": 0
}
{
  "succeeded": true,
  "errors": [
    {
      "message": "string"
    }
  ]
}

How is this guide?