Sign in

v1

latestOpenAPI 3.0.02026-07-266521,3121.2 MB
Orders

GetOrderDetailsByNumOrderId

Retrieves the order detail for a given order numeric id. If not found empty class is returned.
For working with open orders recommended to use OpenOrders/GetOpenOrdersDetails <b>Permissions Required: </b> GlobalPermissions.OrderBook.ViewOrderDetailsNode <b>Rate limit: </b><span style="background-color:#0272d9;color:white;padding:4px 8px;text-align:center;border-radius:5px; font-size: small;"><b>250</b></span> / minute

get/api/Orders/GetOrderDetailsByNumOrderId

Query parameters

OrderIdinteger

Order Id (numeric)

Response

OK

OrderIdstring uuid

Order ID (pkOrderId)

NumOrderIdinteger

Linnworks order number

Processedboolean

If order is processed

ProcessedDateTimestring date-time

Date and time when order was processed

FulfilmentLocationIdstring uuid

Location ID

FolderNamestring[]

Folder names assigned to an order

PaidDateTimestring date-time

Date and time when the order was marked as paid

TaxIdstring

Buyer's tax number.

Example response

{
  "OrderId": "00000000-0000-0000-0000-000000000000",
  "FulfilmentLocationId": "00000000-0000-0000-0000-000000000000"
}