Skip to main content

Search Orders

POST 
/orders/search

Retrieve a list of orders by using the search fields below

NameTypeRequired
statusstringno
exportedbooleanno
externalOrderNumberstringno
dateCreatedDateFilterno
dateStatusModifiedDateFilterno

status: the value of the status in Propeller. By default the available statuses are:

  • NEW
  • VALIDATED
  • CONFIRMED
  • ARCHIVED

It is possible to create custom statuses in Propeller, please consult the Propeller backoffice for custom status values.

exported: Propeller has functionality to export orders to e.g. other ERP and/or financial systems. Once an order has been exported it is good practice to mark the order as exported using the order update api. Searching for orders using the exported field will return a list of orders which are (or not) exported to an external system.

externalOrderNumber: Propeller has functionality to export orders to e.g. other ERP and/or financial systems. Depending on the type of system / techniques used for exporting, Propeller gets back an identifier from these systems (e.g an order id / invoice id). This id is stored in Propellor and can be used for searching using the order search api.

Date filter​

A date filter is a special date search object that can search through a range:

{
    "from": "2020-12-12T00:00:00",
    "to": "2022-12-12T00:00:00"
}

Request​

Query Parameters

    expands string

Body

    extraStatus string

Responses​

Search Orders - 200 (with results) / Search Orders - 200 (no results)

Response Headers

  • Alt-Svc

    string

  • Via

    string

  • alt-svc

    string

  • content-length

    string

  • date

    string

  • return-format

    string

  • server

    string

  • x-request-id

    string

Schema

    data

    object[]

  • Array [

    • channelId number

    clientData

    object

    abbreviation string
    company string
    dateOfBirth string
    debtorId string
    email string
    firstName string
    fullName string
    gender string
    id number
    lastName string
    login string
    middleName string
    mobile string
    phone string
    ssn string
    title string
    vatNumber string
    date string
    debtorId string
    email string
    externalId string
    extraInfo string
    firstName string
    id number

    invoiceData

    object

    address

    object

    active string
    city string
    code string
    company string
    country string
    email string
    fax string
    firstName string
    gender string
    icp string
    id number
    isDefault string
    lastName string
    middleName string
    mobile string
    name string
    notes string
    number string
    numberExtension string
    phone string
    postalCode string
    region string
    street string
    type string
    url string
    itemCount number
    language string
    lastName string
    middleName string

    paymentData

    object

    grossAmount number
    netAmount number
    payMethod string
    payStatus string
    paystatusdate string
    tax number
    taxPercentage number
    transactionId string

    postageData

    object

    carrier string
    partialDeliveryAllowed string
    postage number
    postageNet number
    postageTaxPercentage number
    requestDate string
    shippingMethod string
    reference string
    remarks string

    shippingData

    object

    address

    object

    active string
    city string
    code string
    company string
    country string
    email string
    fax string
    firstName string
    gender string
    icp string
    id number
    isDefault string
    lastName string
    middleName string
    mobile string
    name string
    notes string
    number string
    numberExtension string
    phone string
    postalCode string
    region string
    street string
    type string
    url string
    shopId number
    source string
    status string

    total

    object

    discountPercentage number
    discountValue number

    tax

    object

    21 number
    totalGross number
    totalNet number
    type string
    userId number

  • ]

    • messages undefined[]
    total number
Loading...