Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SearchOrders

Search for any type of orders by providing the filter details properties Important search criterias are: OrganizationUnitID, CurrentOrganizationUnitType, OrderID, CustomerID(ClientContext.Type), IsPaid. OrderID and IsPaid are going to be replaced by OrderIDs (and array of IDs) and PaymentStatus (an enum).

E.g. request: { "OrderIDs": [ "orderID1", "orderID2" ], "PaymentStatus": "PaymentStatus", "IsShipped": "isShipped" }

Payment status options: NotPaid = 0, Paid = 1, Partial = 2

Hierarchy

  • SearchOrders

Index

Properties

Properties

Optional CarrierID

CarrierID: undefined | number

Entity type: Carrier

Optional CompanyName

CompanyName: undefined | string

Optional CreatedByID

CreatedByID: undefined | number

Entity type: User

Optional CustomFields

CustomFields: undefined | {}

Optional CustomFieldsByBackendID

CustomFieldsByBackendID: undefined | {}

Optional CustomOrderTypeID

CustomOrderTypeID: undefined | number

Optional CustomStatus

CustomStatus: number[]

Optional CustomerBackendID

CustomerBackendID: undefined | string

Optional CustomerID

CustomerID: undefined | number

Entity type: User

Optional CustomerOrderStatus

CustomerOrderStatus: string[]

Optional CustomerOrderStatusBackendID

CustomerOrderStatusBackendID: string[]

Optional CustomerOrderTypeBackendID

CustomerOrderTypeBackendID: string[]

Optional CustomerReference

CustomerReference: undefined | string

Optional Data

Data: undefined | {}

Optional DiscountIDs

DiscountIDs: number[]

Entity type: Discount

Optional EndConfirmationDate

EndConfirmationDate: undefined | string

Optional EndMaxExpectedAvailabilityDate

EndMaxExpectedAvailabilityDate: undefined | string

Optional EndMinExpectedAvailabilityDate

EndMinExpectedAvailabilityDate: undefined | string

Optional EndOfferExpirationDate

EndOfferExpirationDate: undefined | string

Optional EndRequestedDate

EndRequestedDate: undefined | string

Optional EndShipmentDate

EndShipmentDate: undefined | string

Optional EndTime

EndTime: undefined | string

Optional FulfillmentStatus

Optional HasCancelledExportedQuantities

HasCancelledExportedQuantities: undefined | false | true

Optional HasCustomer

HasCustomer: undefined | false | true

Optional HasDeliveryLines

HasDeliveryLines: undefined | false | true

Optional HasDisputedPayments

HasDisputedPayments: undefined | false | true

Optional HasOrderLines

HasOrderLines: undefined | false | true

Optional HasReserveLines

HasReserveLines: undefined | false | true

Optional HasShipLines

HasShipLines: undefined | false | true

Optional HasUnresolvedDisputedPayments

HasUnresolvedDisputedPayments: undefined | false | true

Optional IncludeChildOrganizationUnits

IncludeChildOrganizationUnits: undefined | false | true

Optional InvoiceNumber

InvoiceNumber: undefined | string

Optional IsCaptured

IsCaptured: undefined | false | true

Optional IsClickAndCollect

IsClickAndCollect: undefined | false | true

Optional IsCompleted

IsCompleted: undefined | false | true

Optional IsConfirmed

IsConfirmed: undefined | false | true

Optional IsCrossChannelReturn

IsCrossChannelReturn: undefined | false | true

Optional IsEmpty

IsEmpty: undefined | false | true

Optional IsEndlessAisle

IsEndlessAisle: undefined | false | true

Optional IsExported

IsExported: undefined | false | true

Optional IsInvoiced

IsInvoiced: undefined | false | true

Optional IsOffer

IsOffer: undefined | false | true

Optional IsOrder

IsOrder: undefined | false | true

Optional IsPlaced

IsPlaced: undefined | false | true

Optional IsReserved

IsReserved: undefined | false | true

Optional IsShipped

IsShipped: undefined | false | true

Optional IsSuspended

IsSuspended: undefined | false | true

Optional LastModifiedByID

LastModifiedByID: undefined | number

Entity type: User

Optional MaxOpenAmountInTax

MaxOpenAmountInTax: undefined | number

Optional MaxTotalAmountInTax

MaxTotalAmountInTax: undefined | number

Optional MinOpenAmountInTax

MinOpenAmountInTax: undefined | number

Optional MinTotalAmountInTax

MinTotalAmountInTax: undefined | number

Optional NotProperties

NotProperties: number[]

Properties that should not be present on the order

Optional OrderBackendID

OrderBackendID: undefined | string

Optional OrderFulfillmentReferenceNumbers

OrderFulfillmentReferenceNumbers: string[]

Optional OrderIDs

OrderIDs: number[]

Entity type: Order

Optional OrderLineID

OrderLineID: undefined | number

Entity type: OrderLine

Optional OrderStatus

OrderStatus: OrderStatus

Optional OrderType

OrderType: OrderTypes

Optional OrganizationUnitID

OrganizationUnitID: undefined | number

Entity type: OrganizationUnit

Optional OriginatingOrganizationUnitID

OriginatingOrganizationUnitID: undefined | number

Entity type: OrganizationUnit

Optional PageConfig

PageConfig: PageConfig<{}>

Optional PaymentStatus

PaymentStatus: PaymentStatus

Optional PaymentTypeID

PaymentTypeID: undefined | number

Entity type: PaymentType

Optional PaymentTypeName

PaymentTypeName: undefined | string

Optional PickupOrganizationUnitID

PickupOrganizationUnitID: undefined | number

Entity type: OrganizationUnit

Optional ProductID

ProductID: undefined | number

Entity type: Product

Optional ProductVariation

ProductVariation: undefined | {}

Optional Properties

Properties: number[]

Properties that should be present on the order

Optional Query

Query: undefined | string

Optional ReturnToSupplierRequestID

ReturnToSupplierRequestID: undefined | number

Entity type: ReturnToSupplierRequest

Optional SerialNumber

SerialNumber: undefined | string

Optional ShipFromOrganizationUnitID

ShipFromOrganizationUnitID: undefined | number

Entity type: OrganizationUnit

Optional ShipToCountryID

ShipToCountryID: undefined | string

Entity type: Country

Optional ShipToOrganizationUnitID

ShipToOrganizationUnitID: undefined | number

Entity type: OrganizationUnit

Optional ShippingMethodID

ShippingMethodID: undefined | number

Entity type: ShippingMethod

Optional ShippingOrganizationUnitID

ShippingOrganizationUnitID: undefined | number

Entity type: OrganizationUnit

Optional SoldFromOrganizationUnitID

SoldFromOrganizationUnitID: undefined | number

Entity type: OrganizationUnit

Optional SoldToOrganizationUnitID

SoldToOrganizationUnitID: undefined | number

Entity type: OrganizationUnit

Optional StartConfirmationDate

StartConfirmationDate: undefined | string

Optional StartMaxExpectedAvailabilityDate

StartMaxExpectedAvailabilityDate: undefined | string

Optional StartMinExpectedAvailabilityDate

StartMinExpectedAvailabilityDate: undefined | string

Optional StartOfferExpirationDate

StartOfferExpirationDate: undefined | string

Optional StartRequestedDate

StartRequestedDate: undefined | string

Optional StartShipmentDate

StartShipmentDate: undefined | string

Optional StartTime

StartTime: undefined | string

Optional UserAgentApplication

UserAgentApplication: string[]