Skip to main content

List OrderItems for order

GET 
/v2/orders/id/:id/items

List OrderItems for order

Request​

Path Parameters

    id integerrequired

    Order id

Responses​

List OrderItems for order

Schema

  • 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

  • ]

Loading...