Scroll orders by search
Scrolling is not intended for real time user requests, but rather for processing large amounts of data. Only use scroll endpoints if you intend to fetch all items returned by the search request. Paging (take, page) is disabled for scroll searches. Sample request for a delta query using modified date and filtering on an order type:
POST /api/orders/scroll
{
"ModifiedFrom": "2022-12-24T17:32:28Z",
"OrderType": "ClickAndCollect"
}
Request
- Base URL: https://api.omnium.no (the document declares no server; this is the origin it was published from)
- URL: https://api.omnium.no/api/Orders/Scroll
- Auth: API key in header Authorization
Request body
Order number or order ID
Customer e-mail
Customer phone number
Limit search to selected order statuses
Exclude orders with given statuses
Exclude orders where all shipments has external Ids from given providers
Customer name
Customer Number
Customer Id
Customer Ids
Contact person phone number
Contact person e-mail
Sales channels
Customer contact person
Sales person ID (e-mail of Omnium user)
Orders created from date
Orders created before date
Orders modified from date
Orders modified before date
Orders ready to pick up from date
Orders ready to pick up before date
Orders completed from date
Orders completed before date
Orders with follow-up from date
Orders with follow-up to date
Orders with requested delivery date from
Orders with requested delivery date to
Urgent orders (pick limit or pickup limit exceeded)
Limit search by store IDs
Limit search by market IDs
Limit to single order type. Use OrderTypes instead for filtering by multiple order types.
Limit to orders containing selected product numbers
Limit to order containing selected product serial numbers
Limit to order containing selected product types
Limit to orders containing selected discounts
Free search text
Limit search to inventory status ("InStock", "PartiallyInStock", "NotInStock")
Shipping method name
Shipping method names
Limit search to payment statuses. "Paid", "NotPaid", "PartiallyPaid" and "OverPaid" compare the order total with the authorized amount, so a reservation counts as paid. "Reserved" selects orders where money is still reserved but not captured, and "Captured" orders that are paid with nothing left to capture. Several values are combined with OR.
Filter orders by payment transaction types ("Authorization", "Capture" for instance)
Filter orders by payment transaction status ("Failed" for instance)
Filter orders by payment transaction by date (from)
Filter orders by payment transaction by date (to)
Only show future deliveries (orders with future requested delivery date)
Only show orders with errors
Search orders with payment authorize about to expire
Search orders with external IDs
Search orders with shipment external IDs
Number of orders to take
Page (Fetches from [Page * Take] to [(Page + 1) * Take])
Sort order for the results. Defaults to created date descending. Possible values: CreatedAscending, CreatedDescending, ModifiedAscending, ModifiedDescending, CustomerNameAscending, CustomerNameDescending StatusAscending, StatusDescending, OrderIdAscending, OrderIdDescending, StoreAscending, StoreDescending, TotalAscending, TotalDescending and DocumentID. If you do not care about the order you should use DocumentId
Search orders by project ID
Search orders by subscription ID
Only orders which appear on the pick list.
Set to true to disable facet generation. Disabling facets will improve performance and reduce data payload.
Filter by tags
Filter by excluding tags
Search by order secret key
Limit search to orders with shipments matching given shipment order statuses
Limit to multiple order types
Filter orders containing order lines where IsAwaitingPurchaseOrder matches (true/false)
Response
Search successful, returning orders
Total number of hits
The Scroll ID is used when fetching large amounts of data. Whenever the search results yields a ContinuationToken, the Scroll endpoints should be used to continue fetching documents
Deprecated
Changes
No recorded changes to this operation across all 1 revision of this API.