Viskan API documentation

Appearance

Find orders

GET
/order-management/order/orders
Required scope: order:read

Searches for orders in the system.

Parameters ​

Query parameters

countryCode  string
Multivalued
Filter on delivery country of order (ISO 3166-1 alpha-2 standard format). For example countryCode=SE&countryCode=NO.
customFieldValue  string
Multivalued
An optional filter on one/many custom field values. For example customFieldValue=22468-15267-80&customFieldValue=22468-15267-81
customerId  integer
An optional filter on customer id. Mutually exclusive with customer number. For example customerId=1234
Default value: -1
customerNumber  string
An optional filter on customer number. Mutually exclusive with customer id. For example customerNumber=8564
deliveryMethodId  integer
Multivalued
An optional filter on one/many delivery method id(s), matched against deliveryMethod.deliveryMethodId. For example deliveryMethodId=19&deliveryMethodId=20
deliveryMethodName  string
Multivalued
An optional filter on one/many delivery method name(s), matched against deliveryMethod.deliveryMethodName. For example deliveryMethodName=MyPack&deliveryMethodName=InStore
externalDeliveryMethodCode  string
Multivalued
An optional filter on one/many external delivery method code(s), matched against deliveryMethod.externalDeliveryMethodCode. This is not the delivery method name. For example externalDeliveryMethodCode=HOME-01&externalDeliveryMethodCode=STORE-01

NOTE! The payment method filters (id, name and external code) and the delivery method filters (id, name and external code) are separate filters. Values within one filter are combined with OR, and different filters are combined with AND, like all other filters.

externalPaymentMethodCode  string
Multivalued
An optional filter on one/many external payment method code(s), matched against paymentMethod.externalPaymentMethodCode. This is not the payment method name. For example externalPaymentMethodCode=INVOICE-30&externalPaymentMethodCode=CARD
includeCanceledRows  boolean
An optional filter on whether or not to include canceled order rows.
methodOfArrival  string
Multivalued
An optional filter on one/many method of arrivals. For example methodOfArrivals=A09
modifiedAfter  string
Filter on last modification date. Useful for getting delta-changes.
multiBrandId  integer
An optional filter on the multibrand (concept) the customer belongs to.
Default value: -1
orderId  integer
Multivalued
An optional filter on one/many orderId. For example orderId=123&orderId=789
orderNumber  string
Multivalued
An optional filter on one/many orderNumber For example orderNumber=abc&orderNumber=xyz
page  integer
The page to search for.
Default value: 1
paymentMethodId  integer
Multivalued
An optional filter on one/many payment method id(s), matched against paymentMethod.paymentMethodId. For example paymentMethodId=1&paymentMethodId=4
paymentMethodName  string
Multivalued
An optional filter on one/many payment method name(s), matched against paymentMethod.paymentMethodName. For example paymentMethodName=Klarna&paymentMethodName=Swish
processChain  string
Filter on current order processChain. For example processChain=OUTORDER_CANCEL. The use of this filter is contingent upon the approval of Viskan.
processStatus  string
Multivalued
Filter on current order processStatus. For example processStatus=STARTED&processStatus=DONE. The use of this filter is contingent upon the approval of Viskan.
purchaseNumber  string
An optional filter on a single purchasenumber. For example purchaseNumber=1234
resultsPerPage  integer
The number of results per page.
searchId  string
The search ID to use for continued pages. Not usable together with any of the filters. More details.
status  enum
Multivalued
Filter on current order status. For example status=CREATED&status=DELIVERED.
Enum: CANCELEDDELIVERY_CREATEDFULLY_DELIVEREDPART_DELIVEREDPLACED
webStoreNumber  string
Multivalued
An optional filter on one/many web store(s) where the order was placed. Only applicable for web orders, subscription based orders and physical store orders are not supported by this filter. For example webStoreNumber=888

Response ​

The search was successful.