Orders | Analytics

Search and filtering of analytics order lines

post/api/AnalyticsOrders/Search

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/AnalyticsOrders/Search
  • Auth: API key in header Authorization

Request body

pageinteger

Page number of the search results.

takeinteger

Number of records to retrieve per page.

sortOrderstring nullable

Sort order

languagestring nullable

Language filter

storeIdsstring[] nullable

Store IDs filter

warehouseCodesstring[] nullable

Warehouse codes filter

pickupWarehouseCodesstring[] nullable

Pickup warehouse codes filter

countryNamesstring[] nullable

Country name filter

postalCodesstring[] nullable

Postal code filter

citysstring[] nullable

City filter

marketIdsstring[] nullable

Market IDs filter

currenciesstring[] nullable

Currency filter

shippingMethodNamesstring[] nullable

Shipping method name filter

customerNamesstring[] nullable

Customer name filter

supplierNamesstring[] nullable

Supplier name filter

shipmentDeliveryTypesstring[] nullable

Shipment delivery types filter (Pickup / Delivery)

brandsstring[] nullable

Brand filter

sizesstring[] nullable

Size filter

colorsstring[] nullable

Color filter

productTypesstring[] nullable

Product type filter

productIdsstring[] nullable

Product ID filter

productNamesstring[] nullable

Product name filter

parentIdsstring[] nullable

Parent ID filter

productGendersstring[] nullable

Gender filter

productCategorystring[] nullable

Product category name filter

salesPersonIdsstring[] nullable

Sales person ID filter

salesPersonNamesstring[] nullable

Sales person name filter

mainProductCategorystring[] nullable

Main product category filter

eanCodesstring[] nullable

EAN / GTIN filter

skuIdsstring[] nullable

SkuID filter

customerIdsstring[] nullable

Customer ID filter

orderIdsstring[] nullable

Order ID filter

orderStatusesstring[] nullable

Order status filter

orderLineDeliveryStatusesstring[] nullable

Order line delivery status filter

orderTypesstring[] nullable

Order type filter

orderNumbersstring[] nullable

Order number filter

paymentStatusesstring[] nullable

Payment status filter

paymentMethodNamesstring[] nullable

Payment method name filter

promotionNamesstring[] nullable

Promotion name filter

contactPersonEmailsstring[] nullable

Contact person e-mail filter

contactPersonPhonesstring[] nullable

Contact person phone filter

createdFromstring date-time nullable

Created date from filter (orders crated after given date)

createdTostring date-time nullable

Created date to filter (orders created before given date)

completedFromstring date-time nullable

Completed date from filter (orders completed after given date)

completedTostring date-time nullable

Completed date to filter (orders completed before given date)

groupBystring nullable

Group by (Property name from AnalyticsOrderLine. E.g. "MainCategory", "SalesPersonName", "ProductName", etc...)

includeShippingboolean

Include shipping order lines

includeReturnsboolean

Include return order lines

includeOrderLinesboolean nullable

Include order lines (default true)

isOrderPropertiesIncludedboolean

Include order information

isProductPropertiesIncludedboolean

Include product information

isCustomerPropertiesIncludedboolean

Include customer information

isPaymentPropertiesIncludedboolean

Include payment information

isShipmentPropertiesIncludedboolean

Include shipment information

isStorePropertiesIncludedboolean

Include store information

isWarehousePropertiesIncludedboolean

Include warehouse information

isPromotionPropertiesIncludedboolean

Include promotion information

isSupplierPropertiesIncludedboolean

Include supplier information

isShippingAddressPropertiesIncludedboolean

Include shipping address information

isInvoiceAddressPropertiesIncludedboolean

Include invoice address information

isContactPersonIncludedboolean

Include order contact person information

isOrderDefaultPropertiesIncludedboolean

Include default properties from the order (Default property items are configurable in the configuration)

searchTextstring nullable

Free text search

Response

Success

totalHitsinteger

Total number of hits

scrollIdstring nullable

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

isValidboolean

Deprecated

Changes

No recorded changes to this operation across all 1 revision of this API.