---
title: "GetOpenOrders"
method: POST
path: "/api/OpenOrders/GetOpenOrders"
tags: ["OpenOrders"]
---

# GetOpenOrders

`POST /api/OpenOrders/GetOpenOrders`

## Request

- Base URL: `https://eu-ext.linnworks.net`
- URL: `https://eu-ext.linnworks.net/api/OpenOrders/GetOpenOrders`
- Auth: API key in header `Authorization`

<b>Rate limit: </b><span style="background-color:#0272d9;color:white;padding:4px 8px;text-align:center;border-radius:5px; font-size: small;"><b>150</b></span> / minute

## Request body

- GetOpenOrdersRequest
  - `ViewId` integer, required
  - `LocationId` string, uuid, required
  - `EntriesPerPage` integer, required
  - `PageNumber` integer
  - `OrderIds` string[]

## Response `200`

OK

- PostFilterPagedResponseOpenOrder
  - `ResultCountRemovedByPostFilter` integer
  - `PageNumber` integer: Result page number
  - `EntriesPerPage` integer: Result page size, quantity of records per page
  - `TotalEntries` integer: Total records
  - `TotalPages` integer: Total pages
  - `Data` OpenOrder[]
    - `NumOrderId` integer: Linnworks order number
    - `GeneralInfo` OrderGeneralInfo: Order General Info class
      - `Status` integer: Order Status (0 = UNPAID, 1 = PAID,2 = RETURN,3 = PENDING,4 = RESEND)
      - `LabelPrinted` boolean: Is label printed
      - `LabelError` string: Is there a label error
      - `InvoicePrinted` boolean: Is invoice printed
      - `InvoicePrintError` string: Is there invoice print error
      - `PickListPrinted` boolean: Is pick list printed
      - `PickListPrintError` string: Is there pick list print error
      - `IsRuleRun` boolean: If rules engine rule ran on an order
      - `Notes` integer: Quantity of order notes
      - `PartShipped` boolean: If order partly shipped
      - `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)
      - `IsParked` boolean: Is the order parked?
      - `Identifiers` Identifier[]: Order identifiers. [Prime | Scheduled]
        - `IdentifierId` integer: Internal identifier id. Use to update image and name.
        - `IsCustom` boolean: Is the tag user or system defined?
        - `ImageId` string, uuid
        - `ImageUrl` string
        - `Tag` string: Internal tag for identification purposes
        - `Name` string: Name displayed where the tag is used
      - `ReferenceNum` string: Order reference number (Channel defined)
      - `SecondaryReference` string: An additional reference number for the orderr (Used by some channels)
      - `ExternalReferenceNum` string: 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: Order ChannelName/Source (e.g. EBAY)
      - `SubSource` string: Order Subsource (e.g. EBAY1)
      - `SiteCode` string: SiteCode used to differentiate between different sites from a single channel (eg. Amazon UK, Amazon US, Amazon FR...)
      - `HoldOrCancel` boolean: This shows whether the order has been marked as on hold, for processed orders if the order has been cancelled OnHold = 1
      - `DespatchByDate` string, date-time: Despatch by Date
      - `ScheduledDelivery` ScheduledDelivery
        - `From` string, date-time
        - `To` string, date-time
      - `HasScheduledDelivery` boolean
      - `Location` string, uuid: Order location ID
      - `NumItems` integer: Quantity of order items
      - `PickwaveIds` integer[]: All related Pickwave Ids
      - `PIIRedactionDays` integer: Number of days after which an order is processed its pii will be redacted/obfuscate
      - `StockAllocationType` 'NotAllocated' | 'Insuffient' | 'Partial' | 'Full' | 'OverAllocated'
    - `ShippingInfo` OrderShippingInfo
      - `Vendor` string: Courier name (e.g. Royal Mail)
      - `PostalServiceId` string, uuid: Postal service ID
      - `PostalServiceName` string: Postal service name (e.g. Next day delivery)
      - `TotalWeight` number, double: Order total weight
      - `ItemWeight` number, double: If order is processed
      - `PackageCategoryId` string, uuid: Package category ID
      - `PackageCategory` string: Package category name
      - `PackageTypeId` string, uuid: Package type ID
      - `PackageType` string: Package type name
      - `PostageCost` number, double: Order postage cost
      - `PostageCostExTax` number, double: Order postage cost excluding tax
      - `TrackingNumber` string: Order tracking number provided by courier
      - `ManualAdjust` boolean: If there is an adjustment to shipping cost was made
    - `CustomerInfo` OrderCustomerInfo
      - `ChannelBuyerName` string: Username of customer (Comes from channel)
      - `Address` CustomerAddress
        - `EmailAddress` string: Customer's email address.
        - `Address1` string: First line of customer address.
        - `Address2` string: Second line of customer address.
        - `Address3` string: Third line of customer address.
        - `Town` string: Customer's town.
        - `Region` string: Customer's region.
        - `PostCode` string: Customer's postcode.
        - `Country` string: Customer's country.
        - `Continent` string: Customer's continent
        - `FullName` string: Customer's first and second name.
        - `Company` string: Customer's company name.
        - `PhoneNumber` string: Customer's telephone number.
        - `CountryId` string, uuid
      - `BillingAddress` CustomerAddress
        - `EmailAddress` string: Customer's email address.
        - `Address1` string: First line of customer address.
        - `Address2` string: Second line of customer address.
        - `Address3` string: Third line of customer address.
        - `Town` string: Customer's town.
        - `Region` string: Customer's region.
        - `PostCode` string: Customer's postcode.
        - `Country` string: Customer's country.
        - `Continent` string: Customer's continent
        - `FullName` string: Customer's first and second name.
        - `Company` string: Customer's company name.
        - `PhoneNumber` string: Customer's telephone number.
        - `CountryId` string, uuid
    - `TotalsInfo` 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: Payment method
      - `PaymentMethodId` string, uuid: Payment method ID
      - `ProfitMargin` number, double: Profit margin
      - `TotalDiscount` number, double: Total discount applied to the order
      - `Currency` string: Order currency
      - `CountryTaxRate` number, double: Country tax rate
      - `ConversionRate` number, double: Currency conversion rate. Set at point of save by the currency
    - `TaxInfo` OrderTaxInfo
      - `TaxNumber` string: Customer Tax Number
    - `FolderName` string[]: Folder name of an order if any assigned
    - `IsPostFilteredOut` boolean
    - `CanFulfil` boolean
    - `Fulfillment` OrderFulfillmentState
      - `FulfillmentState` 'Unknown' | 'Insufficient_Stock' | 'Insufficient_To_Fulfill_All' | 'Sufficient_Stock'
      - `PurchaseOrderState` 'Insufficient_PO' | 'Sufficient_PO'
    - `Items` OrderItem[]
      - `ItemId` string, uuid: Stock Item ID
      - `ItemNumber` string: Item number as on channel
      - `SKU` string: Product SKU
      - `ItemSource` string: Item source / channel name
      - `Title` string: Item title
      - `Quantity` integer: Quantity
      - `CategoryName` string: Product category
      - `CompositeAvailablity` integer: Composite availability
      - `StockLevelsSpecified` boolean: If stock level specified
      - `OnOrder` integer: Level due in purchase orders
      - `OnPurchaseOrder` OrderItemOnOrder
        - `pkPurchaseItemId` string, uuid: Primary key of the bound
        - `Rowid` string, uuid
        - `pkPurchaseId` string, uuid
        - `ExternalInvoiceNumber` string
        - `fkSupplierId` string, uuid
        - `DateOfDelivery` string, date-time
        - `QuotedDeliveryDate` string, date-time
        - `SupplierName` string
        - `fkLocationId` string, uuid
      - `InOrderBook` integer: Quantity currently in open orders
      - `Level` integer: Current stock level
      - `MinimumLevel` integer: Minimum level
      - `AvailableStock` integer: Currently available stock level (Level-InOrderBook)
      - `PricePerUnit` number, double: Unit price
      - `UnitCost` number, double: Unit cost
      - `DespatchStockUnitCost` number, double: Despatch stock unit cost
      - `Discount` number, double: Percentage (0%, 10%, 20%, etc...)
      - `Tax` number, double: Actual tax value on an item
      - `TaxRate` number, double: Tax rate
      - `Cost` number, double: Total item cost (exc tax)
      - `CostIncTax` number, double: Total item cost (inc tax)
      - `CompositeSubItems` OrderItem[]: List of order items
      - `IsService` boolean: if item is a service
      - `SalesTax` number, double: Sales Tax
      - `TaxCostInclusive` boolean: If tax is included in a cost
      - `PartShipped` boolean: If order is partly shipped
      - `Weight` number, double: Order weight
      - `BarcodeNumber` string: Product barcode
      - `Market` integer: Market
      - `ChannelSKU` string: Channel product SKU
      - `ChannelTitle` string: Channel product title
      - `DiscountValue` number, double
      - `HasImage` boolean: If item got an image
      - `ImageId` string, uuid: Image ID
      - `AdditionalInfo` OrderItemOption[]: List of order item options
        - `pkOptionId` string, uuid: Option ID
        - `Property` string: Option property
        - `Value` string: Value of the option
      - `StockLevelIndicator` integer: Stock level indicator
      - `ShippingCost` number, double: If batch number scan required
      - `PartShippedQty` integer: ShippingCost
      - `ItemName` string: PartShippedQty
      - `BatchNumberScanRequired` boolean: ItemName
      - `SerialNumberScanRequired` boolean: If serial number scan required
      - `BinRack` string: Binrack location
      - `BinRacks` OrderItemBinRack[]: List of BinRacks used for OrderItem
        - `Quantity` integer: Quantity for BinRack per Location
        - `BinRack` string: BinRack
        - `Location` string, uuid: LocationId of the BinRack
        - `BatchId` integer: If the item is batched, identifies the batch number
        - `OrderItemBatchId` integer: If the item is batched, identifies the unique order item batch row
      - `InventoryTrackingType` integer: Identifies whether the item has a sell by date or other defined order in which inventory is to be sold
      - `isBatchedStockItem` boolean: If item has batches
      - `IsWarehouseManaged` boolean
      - `IsUnlinked` boolean
      - `StockItemIntId` integer
      - `Boxes` StockItemBoxConfiguration[]
        - `BoxId` integer: Unique box id.
        - `StockItemIntId` integer
        - `BoxName` string: Box name max 16 characters
        - `Width` number, double: Width of the box
        - `Height` number, double: Height of the box
        - `Length` number, double: Depth of the box
        - `Weight` number, double: Total weight of the box.
        - `ValuePercentage` number, double: Value break down percentage
        - `Barcode` string: Box barcode, max 64 characters.
        - `PackagingTypeId` string, uuid: Packaging type id
        - `LogicalDelete` boolean: IsDeleted flag.
      - `AddedDate` string, date-time
      - `RowId` string, uuid: Record row ID
      - `OrderId` string, uuid: Order ID (pkOrderID)
      - `StockItemId` string, uuid: Stock Item ID
    - `HasItems` boolean
    - `TotalItemsSum` integer
    - `OrderId` string, uuid: Order ID (pkOrderID)

---

[API](https://skmtc.dev/linnworks/apis/open-orders-api.md) - [All operations](https://skmtc.dev/linnworks/apis/open-orders-api/llms.txt) - [OpenAPI document](https://skmtc.dev/linnworks/apis/open-orders-api/revisions/53820660140d?raw)