Skip to main content

List bundles

GET 
/v1/bundles

List bundles

Request​

Query Parameters

    taxZone any

    Tax zone

    Example: NL
    page any

    Pagination page number

    Example: 1
    offset any

    Pagination offset number

    Example: 12
    expands any

    Expansion flag. Expand the response with [items]. (comma separated list of values)

    Example: [items]

Responses​

List bundles

Schema

    items

    object[]

    required

    List of items of type Bundle

  • Array [

    • id integerrequired

    The bundles primary identifier

    comboId integerdeprecated

    [DEPRECATED] The bundles identifier for Propeller internal use

    name stringrequired

    The name for this bundle.

    description stringnullable

    The description for this bundle.

    discount numbernullable

    The discount percentage this bundle.

    condition stringnullable

    Possible values: [ALL, EP]

    The discount condition for this bundle. Discount can be applied for Extra Products (EP) or All Products (ALL).

    price

    object

    nullable

    net number

    Net price of the bundle after discounts applied

    gross number

    Gross price of the bundle after discounts applied

    originalNet number

    Original net price of the bundle before discounts applied

    originalGross number

    Original gross price of the bundle before discounts applied

    items

    object[]

    nullable

    Items for this bundle.

  • Array [

    • productId numberrequired

    The bundles primary product identifier

    price

    object

    nullable

    net number

    Net price of the bundle after discounts applied

    gross number

    Gross price of the bundle after discounts applied

    originalNet number

    Original net price of the bundle before discounts applied

    originalGross number

    Original gross price of the bundle before discounts applied

    isLeader stringrequired

    Possible values: [Y, N]

    Indicates whether the product is leader for this bundle.

  • ]

  • ]

    • itemsFound integerrequired

    Total number of items found

    offset integernullablerequired

    Possible values: >= 1

    Default value: 12

    The amount of items to show per page

    page integernullablerequired

    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...