/api/v2/orders/{orderId}

GET

https://api-test.spotgo.eu/api/v2/orders/{orderId}

Used to retrieve the information about the extracted data from the document.
If it returns 404 Not Found, this means that the document has not yet been processed.

Request

Path Params

Responses

🟢200OK

text/plain; x-api-version=1.0

Body

🟠400Bad Request

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api-test.spotgo.eu/api/v2/orders/'

Response Example

200 - Order Success Response

[
  {
    "status": "Succeeded",
    "message": "string", // information about errors
    "data": {
      "orderNumber": "OT2352541", // order number usually the one which should be used in invoice
      "orderDate": "2024-01-10",
      "referenceNumber": "2203432, 213312", //Reference number in order level, can be multiple numbers separated by ,
      "sentNumber": "211435423", // SENT Poland number
      "licensePlates": [
        "LM224",
        "JPE235"
      ],
      "trailerTypes": [
        "3" // value from trailer type list
      ],
      "payer": {
        "name": "JSC Payer",
        "vatCode": "LT332443545"
      },
      "customer": {
        "name": "Ikea International",
        "vatCode": "LT2134545341",
        "Country": "LT",
        "PostalCode": "02121",
        "City": "Vilnius",
        "Street": "Birbynių g. 4A",
        "contactPerson": {
          "name": "Krzysztof Jędrzejczyk",
          "email": "k.jedrzejczyk@ikea.lt"
        }
      },
      "customerBranch": {
        "name": "Ikea Vilnius",
        "country": "LT",
        "postalCode": "03534",
        "city": "Vilnius",
        "street": "Apkasu G. 23"
      },
      "carrier": {
        "name": "Truck & Load",
        "vatCode": null,
        "contactPerson": {
          "name": "Petr Svoboda",
          "email": "p.svoboda@truckload.cz"
        }
      },
      "locations": [ // can be multiple locations
        {
          "sequence": 1,
          "type": "Loading",
          "startDate": "2024-01-01T10:00:00",
          "endDate": "2024-01-01T14:00:00",
          "fixTime": true, // true or false or null
          "countryCode": "LT",
          "city": "Vilnius",
          "normalizedCity": "Vilnius",
          "postalCode": "02182",
          "street": "Vikingu g. 1",
          "normalizedStreet": "Vikingu G. 1",
          "name": "IKEA",
          "normalizedName": "IKEA",
          "refrenceNumbers": [
            "4434032",
            "2133221"
          ],
          "notes": "Need booking day before",
          "coordinates": {
            "latitude": 54.651197,
            "longitude": 25.280057
          },
          "cargo": [
            {
              "cargoType": "Furniture", // cargo description can be longer text with dimensions
              "weight": 18000, // weight in kilograms
              "ldm": null,
              "pallets": 33,
              "palletsExchange": false,
              "adr": false,
              "stackable": false,
              "temeratureFrom": null,
              "temeratureTo": null,
              "straps": 12, // betls, straps
              "matts": null,
              "length": 120,
              "width": 80,
              "height": 150,
              "units": "mm", // mm, cm, m sometimes if not provided in document doesn't return at all.
              "volume": 250 // always in cubic meters
            }
          ]
        },
        {
          "sequence": 2,
          "type": "Unloading",
          "startDate": "2024-01-04T09:00:00",
          "countryCode": "DE",
          "city": "Weissenfels",
          "normalizedCity": "Weissenfels",
          "postalCode": "06667",
          "street": "Selauer Strasse 91 b",
          "normalizedStreet": "Selauer Strasse 91 B",
          "name": "IKEA Distribution Services",
          "normalizedName": "IKEA Distribution Services",
          "refrenceNumbers": [],
          "notes": "fix time, ramp 54",
          "coordinates": null,
          "cargo": [
            {
              "cargoType": "Furniture",
              "weight": 18000,
              "ldm": null,
              "pallets": 33,
              "palletsExchange": false,
              "adr": false,
              "stackable": false,
              "temeratureFrom": null,
              "temeratureTo": null,
              "straps": 12,
              "matts": null,
              "volume": 250 // always in cubic meters
            }
          ]
        }
      ],
      "payments": {
        "price": 763.58,
        "basePrice": 350, // Deprecated, use price breakdown
        "additionalCharges": 0, // Deprecated, use price breakdown
        "paymentDays": 30,
        "currency": "EUR",
        "priceBreakdown": [
          {
            "type": "BaseCharge", // BaseCharge, DistanceCharge, Surcharge, WeightCharge
            "amount": 350
          },
          {
            "type": "DistanceCharge",
            "unitPrice": 0.61, // price per kilometer
            "amount": 413.58
          }
        ]
      },
      "comments": "No subcontracting",
      "distance": 1200,
      "invoiceEmail": "invoices@ikea.lt",
      "links": [
        "www.ikea.lt/documents/231231312"
      ],
      "penalties": "If the packaging is not returned within 10 days, a fee of 20 Euros per pallet will be charged.",
      "capabilities": [
        "NeutralCMR",
        "SecureParking",
        "PalletExchange",
        "XLCode",
        "DoubleDeck",
        "GPS",
        "TAPA"
      ],
      "cargoValue": {
        "value": 35000,
        "currency": "EUR"
      }
    },
    "metadata": {
      "OriginalSender": "k.jedrzejczyk@ikea.lt",
      "SenderEmailAddress": "jonas@spotgo.eu",
      "InternalTransactionId": "1221332142s"
    }
  }
]

Modified at 2025-05-29 08:33:29

/api/v1/orders

/api/v1/orders/{orderId}/file