--- title: "GetOrdersById" method: POST path: "/api/Orders/GetOrdersById" tags: ["Orders"] --- # GetOrdersById `POST /api/Orders/GetOrdersById` Retrieves the order detail list for a list of order id identifiers (pkOrderId) For working with open orders recommended to use OpenOrders/GetOpenOrdersDetails Permissions Required: GlobalPermissions.OrderBook.ViewOrderDetailsNode Rate limit: 250 / minute ## Request body - OrdersGetOrdersByIdRequest - `pkOrderIds` string[] — List of order ids (pkOrderId) ## Response `200` OK - OrderDetails[] - `OrderId` string, uuid — Order ID (pkOrderId) - `NumOrderId` integer — Linnworks order number - `Processed` boolean — If order is processed - `ProcessedDateTime` string, date-time — Date and time when order was processed - `FulfilmentLocationId` string, uuid — Location ID - `GeneralInfo` OrderGeneralInfo — BasicOrderGeneralInfo - `Status` integer — Order Status (0 = UNPAID, 1 = PAID, 2 = RETURN, 3 = PENDING, 4 = RESEND) - `StatusDescription` string, nullable — Description of the order status - `LabelPrinted` boolean — Is label printed? - `LabelError` string, nullable — Is there a label error? - `InvoicePrinted` boolean — Is invoice printed? - `InvoicePrintError` string, nullable — Is there a invoice print error? - `PickListPrinted` boolean — Is pick list printed? - `PickListPrintError` string, nullable — Is there a pick list print error? - `NotesCount` integer — Quantity of order notes - `Marker` integer — Order marker (0 = NOT TAG, 1 = Tag 1, 2 = Tag 2, 3 = Tag 3, 4 = Tag 4, 5 = Tag 5, 6 = Tag 6, 7 = Parked) - `Identifiers` BasicIdentifier[], nullable — Order identifiers. [Prime | Scheduled] - `Tag` string, nullable — Internal tag for identification purposes - `Name` string, nullable — Display name for the identifier - `ReferenceNum` string, nullable — Order reference number (Channel defined) - `SecondaryReference` string, nullable — An additional reference number for the order (Used by some channels) - `ExternalReferenceNum` string, nullable — This is an additional reference number from the sales channel, typically used by eBay - `ReceivedDate` string, date-time — The date and time at which the order was placed on the sales channel - `Source` string, nullable — Order ChannelName/Source (e.g. EBAY) - `SubSource` string, nullable — Order SubSource (e.g. EBAY1) - `DespatchByDate` string, date-time — Despatch by Date - `ScheduledDelivery` ScheduledDelivery — ScheduledDelivery - `From` string, date-time, nullable — The start of requested delivery - `To` string, date-time, nullable — The end of requested delivery - `HasScheduledDelivery` boolean — Does the order have scheduled delivery dates? - `NumItems` integer — Quantity of order items - `StockAllocationType` 'NotAllocated' | 'Insuffient' | 'Partial' | 'Full' | 'OverAllocated' — StockAllocationType - `ShippingInfo` OrderShippingInfo — OrderShippingInfo - `Vendor` string, nullable — Courier name (e.g. Royal Mail) - `PostalServiceId` string, uuid — Postal service ID - `PostalServiceName` string, nullable — Postal service name (e.g. Next day delivery) - `TotalWeight` number, double — Order total weight - `ItemWeight` number, double — Order item weight - `PackageCategoryId` string, uuid — Package category ID - `PackageCategory` string, nullable — Package category name - `PackageTypeId` string, uuid, nullable — Package type ID - `PackageType` string, nullable — Package type name - `TrackingNumber` string, nullable — Order tracking number provided by courier - `ManualAdjust` boolean — If there is an adjustment to shipping cost was made - `CustomerInfo` OrderCustomerInfo — OrderCustomerInfo - `ChannelBuyerName` string, nullable — Username of customer (Comes from channel) - `Address` ShippingAddress — BillingAddress - `Address1` string, nullable — First line of customer address. - `Address2` string, nullable — Second line of customer address. - `Address3` string, nullable — Third line of customer address. - `Town` string, nullable — Customer's town. - `Region` string, nullable — Customer's region. - `PostCode` string, nullable — Customer's postcode. - `Country` string, nullable — Customer's country. - `CountryId` string, uuid — Customer's country id. - `FullName` string, nullable — Customer's first and second name. - `Company` string, nullable — Customer's company name. - `PhoneNumber` string, nullable — Customer's telephone number. - `EmailAddress` string, nullable — Customer's email address. - `BillingAddress` union — Customer billing address - BillingAddress — BillingAddress - `Address1` string, nullable — First line of customer address. - `Address2` string, nullable — Second line of customer address. - `Address3` string, nullable — Third line of customer address. - `Town` string, nullable — Customer's town. - `Region` string, nullable — Customer's region. - `PostCode` string, nullable — Customer's postcode. - `Country` string, nullable — Customer's country. - `CountryId` string, uuid — Customer's country id. - `FullName` string, nullable — Customer's first and second name. - `Company` string, nullable — Customer's company name. - `PhoneNumber` string, nullable — Customer's telephone number. - `EmailAddress` string, nullable — Customer's email address. - ShippingAddress — BillingAddress - `Address1` string, nullable — First line of customer address. - `Address2` string, nullable — Second line of customer address. - `Address3` string, nullable — Third line of customer address. - `Town` string, nullable — Customer's town. - `Region` string, nullable — Customer's region. - `PostCode` string, nullable — Customer's postcode. - `Country` string, nullable — Customer's country. - `CountryId` string, uuid — Customer's country id. - `FullName` string, nullable — Customer's first and second name. - `Company` string, nullable — Customer's company name. - `PhoneNumber` string, nullable — Customer's telephone number. - `EmailAddress` string, nullable — Customer's email address. - `TaxId` string, nullable — Buyer's tax number. - `TotalsInfo` OrderTotalsInfo — OrderTotalsInfo - `Subtotal` number, double — Order subtotal - `PostageCost` number, double — Order postage cost - `PostageCostExTax` number, double — Order postage cost ex. tax - `Tax` number, double — Tax - `TotalCharge` number, double — Total charge - `PaymentMethod` string, nullable — Payment method - `PaymentMethodId` string, uuid — Payment method ID - `TotalDiscount` number, double — Total discount applied to the order - `Currency` string, nullable — Order currency - `CountryTaxRate` number, double — Country tax rate - `ConversionRate` number, double — Currency conversion rate. Set at point of save by the currency - `ExtendedProperties` ExtendedProperty[] — Extended properties of an order - `RowId` string, uuid — Record row ID - `Name` string, nullable — Extended property name - `Value` string, nullable — Extended property value - `Type` string, nullable — Extended property type - `FolderName` string[] — Folder names assigned to an order - `Items` OrderItem[] — List of order items - `RowId` string, uuid — Record row ID - `StockItemId` string, uuid — Stock Item ID - `IsService` boolean — Is the item a service? - `IsUnlinked` boolean — Is the item unlinked? - `Quantity` integer — Quantity - `Notes` OrderNote[] — List of order notes - `OrderNoteId` string, uuid — Order note ID - `NoteDate` string, date-time — Date and time when note was added - `Internal` boolean — Order note type (Internal or External) - `Note` string, nullable — Note's text - `CreatedBy` string, nullable — User that created note - `NoteTypeId` integer, nullable — Type of note such as "Processing Note". Non specific note types can be set to null. - `PaidDateTime` string, date-time — Date and time when the order was marked as paid - `TaxId` string — Buyer's tax number. --- [API](https://skmtc.net/linnworks/apis/authenticate-api.md) · [All operations](https://skmtc.net/linnworks/apis/authenticate-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/linnworks/authenticate-api/versions/0123569a22fb/schema)