Get a bundle by id

GET 
/v1/bundles/:id

Get a bundle by id

Request

Path Parameters

id integerrequired
Bundle identifier
Example: 1234

Query Parameters

taxZone any

Tax zone

expands any
Expansion flag. Expand the response with oneOf: [items]. (comma separated list of values)
Example: [items]

Responses

200

Get a bundle by id

application/json

Schema

Schema

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.

]

Example (from schema)

{
  "id": 0,
  "name": "string",
  "description": "string",
  "discount": 0,
  "condition": "ALL",
  "price": {
    "net": 0,
    "gross": 0,
    "originalNet": 0,
    "originalGross": 0
  },
  "items": [
    {
      "productId": 0,
      "price": {
        "net": 0,
        "gross": 0,
        "originalNet": 0,
        "originalGross": 0
      },
      "isLeader": "Y"
    }
  ]
}

400

Bad request

application/json

Schema

Schema

any

validationError

{
  "message": "Please provide valid integer(string encoded) value for id",
  "status": 400,
  "code": 20003,
  "type": "BundleBadRequestError",
  "info": "https://www.propel.us/docs/errors/20003"
}

403

Forbidden.

404

Bundle not found

application/json

Schema

Schema

any

byId

{
  "message": "Bundle with id '666' not found!",
  "status": 404,
  "code": 20002,
  "type": "BundleNotFoundError",
  "info": "https://www.propel.us/docs/errors/20002"
}

500

Get bundle error

Loading...