Skip to main content

Search orders

POST 

/v2/orders/search

Search orders

Request

Body

Search orders

    userId integer[]nullable

    List of user IDs

    status string[]nullable

    List of order statuses

    type string[]nullable

    Possible values: [dropshipment, purchase, quotation, stock]

    List of order types

    page integernullable

    Possible values: >= 1

    Default value: 1

    Pagination page number

    offset integernullable

    Possible values: >= 1

    Default value: 12

    Pagination offset number

    term string

    Search term

    termFields string[]nullable

    Possible values: [id, accountingId, debtorId, externalId, extra3, extra4, debtorCompany, debtorFirstName, debtorLastName, recipientCompany, email, recipientFirstName, recipientLastName, reference, remarks, eanCode, manufacturer, manufacturerCode, name, notes, sku, supplier, supplierCode]

    List of fields to search in

    createdAt

    object

    greaterThan date-time

    Date greater than provided date

    lessThan date-time

    Date less than provided date

    lastModifiedAt

    object

    greaterThan date-time

    Date greater than provided date

    lessThan date-time

    Date less than provided date

    price

    object

    greaterThan floatnullable

    greater than or equal

    lessThan floatnullable

    less than or equal

    companyIds integer[]nullable

    List of company primary identifiers

    companySources string[]nullable

    List of company sources

    originalOrderIds integer[]nullable

    List of original order ids

    exportStatuses string[]nullable

    Possible values: [``, exported, finished, failed]

    List of export statuses

    exportedAt

    object

    greaterThan date-time

    Date greater than provided date

    lessThan date-time

    Date less than provided date

Responses

Search orders

Schema

    items

    object[]

    required

    List of items of type Order

  • Array [

  • id integerrequired

    The auto-incremental id for this order

    userId integerrequired

    The userId of the user that placed this order

    accountManagerId integernullable

    The id of the Owner/Account Manager that will handle this order

    accountingId stringnullabledeprecated

    The accounting id [Deprecated in favour of paymentData.accountingId]

    pickupStoreId integernullabledeprecated

    The userId of the store that this order can be picked up in case of the pickup shippingMethod is chosen

    cartId uuidnullable

    The cartId of the cart that this order is created from.

    siteId integernullabledeprecated

    The siteId of the webshop this order originated from

    channelId integernullable

    The channel identifier of the webshop this order originated from

    shopId integerrequired

    The ID of the shop the Order belongs to

    uuid uuidrequired

    Unique identifier for this order

    externalId stringnullable

    External identifier for this order from an external source like an ERP system

    debtorId stringnullable

    The debtorId of the Customer or Company that placed this Order

    status stringrequired

    The processing status for this order

    type stringrequired

    Possible values: [dropshipment, purchase, quotation, stock]

    The type of this order, one of 'dropshipment', 'purchase' or 'quotation'

    source stringrequired

    The source this order originates from, like 'webshop' or 'internal'

    email emailrequired

    The email address the transactional emails should be sent to

    emailDate date-timenullable

    The date the last transactional email was sent for this order

    remarks stringnullable

    Possible values: <= 65535 characters

    Remarks added by the customer about this order

    reference stringnullable

    Possible values: <= 65535 characters

    Reference added by the customer about this order

    extra3 stringnullable

    Possible values: <= 65535 characters

    extra3: Open text field to add meta data on an Order. The field will not be visible to Propeller admins, but can be used to be displayed on front-ends or be used in integrations.

    extra4 stringnullable

    Possible values: <= 65535 characters

    extra4: Open text field to add meta data on an Order. The field will not be visible to Propeller admins, but can be used to be displayed on front-ends or be used in integrations.

    currency currency-coderequired

    The currency used to place this order

    currencyRatio floatrequired

    The currency's exchange rate at the time the order was placed

    language language-coderequired

    The selected language on the webshop at the time the order was placed

    date date-timerequired

    The date and time the order was placed

    statusDate date-timenullable

    The date and time the status of the order was last changed

    postageData

    object

    required

    method stringrequired

    The chosen shipping method

    taxPercentage floatrequired

    The shipping costs tax percentage

    requestDate datenullable

    The preferred delivery date for the Order

    gross floatrequired

    The shipping costs excluding tax

    net floatrequired

    The shipping costs including tax

    tax floatrequired

    The tax on the shipping costs

    partialDeliveryAllowed stringnullable

    Possible values: [Y, N]

    Is partial delivery allowed for this Order

    pickUpLocationId integernullable

    ID of the pick up location when the Order's shipping method is PICKUP

    carrier stringnullable

    The selected carrier for this Order

    overruled stringnullable

    Possible values: [Y, N]

    Whether the shipping costs for this order are overruled, if N, the shipping costs will be recalculated on every mutation

    paymentData

    object

    required

    net floatrequired

    The transaction cost including tax

    gross floatrequired

    The transaction cost excluding tax

    tax floatrequired

    The tax on the transaction costs

    taxPercentage floatnullable

    The transaction costs tax percentage

    method stringrequired

    The paymethod for this Order

    status stringnullable

    The transaction status

    statusDate datenullable

    Last time the transaction status was changed

    accountingId stringnullable

    The accountingId that belongs to this order

    overruled stringnullable

    Possible values: [Y, N]

    Whether the transaction costs for this order are overruled, if N, the shipping costs will be recalculated on every mutation

    total

    object

    required

    orderId integerrequired

    The orderId of this Order

    gross floatrequired

    The total of this Order excluding tax

    net floatrequired

    The total of this Order including tax

    tax floatrequired

    The total amount of tax for this Order

    discountType stringrequired

    Possible values: [N, P, A]

    The type of global discount

    discountValue floatrequired

    The discount value, can be absolute or a percentage depending on the discountType

    taxPercentages

    object[]

    required

    The totals per tax percentage

  • Array [

  • percentage integerrequired

    The tax percentage

    total floatrequired

    The total for the tax percentage

  • ]

  • items

    object[]

    required

    The items included in the order

  • Array [

  • id integerrequired

    The autoincerment ID for the OrderItem

    orderId integerrequired

    The ID of the Order the OrderItem belongs to

    uuid uuidrequired

    The UUID for the OrderItem

    class stringrequired

    Possible values: [product, incentive, surcharge, postage, payment]

    The class of the orderItem. Either product, incentive, surcharge, postage, payment

    productId integernullable

    The productId of the OrderItem

    parentOrderItemId integernullable

    The ID of the parent OrderItem

    quantity integerrequired

    The quantity of the OrderItem

    sku stringrequired

    Possible values: <= 30 characters

    The SKU of the product of the OrderItem

    notes stringnullable

    Possible values: <= 65536 characters

    Remarks by the customer for the OrderItem

    name stringnullable

    Possible values: <= 150 characters

    The name of the product of the OrderItem

    supplier stringnullable

    Possible values: <= 35 characters

    The supplier of the product of the OrderItem

    supplierCode stringnullable

    Possible values: <= 35 characters

    The supplierCode of the product of the OrderItem

    manufacturer stringnullable

    Possible values: <= 50 characters

    The manufacturer of the product of the OrderItem

    manufacturerCode stringnullable

    Possible values: <= 30 characters

    The manufacturerCode of the product of the OrderItem

    eanCode stringnullable

    Possible values: <= 15 characters

    The eanCode of the product of the OrderItem

    originalPrice floatnullable

    The original price of the OrderItem, before applying any discounts

    price floatrequired

    The calculated price per unit excluding tax

    priceTotal floatrequired

    The total price of the OrderItem excluding tax

    priceNet floatnullable

    The calculated price per unit including tax

    priceTotalNet floatnullable

    The total price of the OrderItem including tax

    customerPrice floatnullable

    The calculated customerPrice of the OrderItem at the time the order was placed

    costPrice floatnullable

    The cost price of the OrderItem at the time the order was placed

    discount floatnullablerequired

    The discount of the OrderItem

    tax floatnullablerequired

    The total tax of the OrderItem

    taxPercentage integerrequired

    The tax percentage of the OrderItem

    taxCode stringrequired

    Possible values: [H, L, N]

    The tax code of the OrderItem

    isBonus stringrequired

    Possible values: [Y, N]

    Is the OrderItem a bonusItem?

    minumumQuantity integernullabledeprecated

    The minimum quantity of the product of the OrderItem

    minimumQuantity integernullable

    The minimum quantity of the product of the OrderItem

    unit integernullable

    The unit of the product of the OrderItem

    package stringnullable

    Possible values: <= 20 characters

    The package of the product of the OrderItem

    packageUnit stringnullable

    Possible values: <= 20 characters

    The package unit of the product of the OrderItem

    packageUnitQuantity stringnullable

    Possible values: <= 20 characters

    The package unit quantity of the product of the OrderItem

    purchaseUnit integernullable

    The purchase unit of the product of the OrderItem

    purchaseMinimumQuantity integernullable

    The purchase minimum quantity of the product of the OrderItem

    requestDate date-timenullable

    The requested delivery date for this orderline

  • ]

  • shipments

    object[]

    nullable

    Shipments for this Order

  • Array [

  • id integerrequired

    Shipment unique identifier

    orderId integerrequired

    Order unique identifier

    status stringrequired

    Shipment status

    date daterequired

    Shipment creation date

    totalGross floatrequired

    Total gross amount of the shipment

    totalNet floatrequired

    Total net amount of the shipment

    totalTax floatrequired

    Total tax amount of the shipment

    totalDiscountValue floatrequired

    Total discount value of the shipment

    printDate datenullable

    Preferred delivery date for the shipment

    items

    object[]

    nullable

    Items in the shipment

  • Array [

  • id integerrequired

    Shipment item unique identifier

    shipmentId integerrequired

    Shipment unique identifier

    orderItemId integerrequired

    Order item unique identifier

    uuid stringrequired

    Shipment item UUID

    productId integernullable

    Product unique identifier

    sku stringrequired

    Product SKU

    quantity integerrequired

    Shipment item quantity

    name stringrequired

    Shipment item name

    supplier stringrequired

    Shipment item description

    supplierCode stringrequired

    Shipment item supplier code

    price floatrequired

    Shipment item price

    priceTotal floatrequired

    Shipment item total price

    discount floatrequired

    Shipment item discount

    tax floatrequired

    Shipment item tax

    taxPercentage floatrequired

    Shipment item tax percentage

  • ]

  • trackAndTrace

    object[]

    nullable

    Track and trace information

  • Array [

  • id integerrequired

    Track and trace unique identifier

    orderId integerrequired

    Order unique identifier

    shipmentId integerrequired

    Shipment unique identifier

    carrierId integerrequired

    Carrier unique identifier

    code stringrequired

    Track and trace code

  • ]

  • ]

  • invoiceUserId integernullable

    The id of the User, contact or Customer that should receive the invoice for this Order

    validUntil date-timenullable

    The date and time until the order is valid

    companyId integernullable

    The companyId of the company that placed this order

    lastModifiedAt date-timenullable

    The date and time the order was last modified

    originalOrderId integer

    Default value: 0

    Original order id

    exportedAt date-timenullable

    The date and time the order was exported

    exportStatus stringnullable

    Possible values: [``, exported, finished, failed]

    The export status of this order. One of: [, exported, finished, failed]

    exportMessage stringnullable

    Possible values: <= 255 characters

    Order export message

  • ]

  • itemsFound integerrequired

    Total number of items found

    offset integernullable

    Possible values: >= 1

    Default value: 12

    The amount of items to show per page

    page integernullable

    Possible values: >= 1

    Default value: 1

    The current page

    pages integernullablerequired

    Possible values: >= 1

    Total amount of pages

    start integernullablerequired

    Possible values: >= 1

    Start position of the current page

    end integernullablerequired

    Possible values: >= 1

    End position of the current page

Loading...