Retrieve Bundles for the affiliate

1min
GET
This endpoint allows the ability to retrieve a list of bundles attached to the affiliate.
The following custom headers must be provided in the request
• X-PageNumber
• X-ResultsPerPage
The following custom headers will be provided in the response
• X-TotalNumberOfRecords
• X-PageNumber
• X-ResultsPerPage
Authentication
Authorization
Bearer
Query Parameters
name
string
tag
string
status
string[]
exactMatch
boolean
Header Parameters
X-TokenId
string
X-SessionId
string
X-Version
string
*
Origin
string
Responses
200
Ok
FictiveGlobal.Api.Rest.Dtos.v1.Bundle.BundleContents[]
Description
The Dto of a bundle contents
bundleReference
string
carts
FictiveGlobal.Api.Rest.Dtos.v1.Bundle.BundleCart[]
name
string
description
string
tag
string
status
string<Active | Inactive | Archived>
204
There are no bundles configured for the affiliate
FictiveGlobal.Api.Rest.Dtos.v1.Bundle.BundleContents[]
Description
The Dto of a bundle contents
bundleReference
string
carts
FictiveGlobal.Api.Rest.Dtos.v1.Bundle.BundleCart[]
name
string
description
string
tag
string
status
string<Active | Inactive | Archived>
404
The is no bundle matching the provided search parameters
412
Precondition Failed
            <br />• The X-PageNumber header has not been supplied
            <br />• The page number must be greater than zero.
            <br />• The X-ResultsPerPage header has not been supplied
            <br />• The number of items in the page must be greater than zero.
500
Internal Server Error
Curl
JS
Ruby
Python
curl --location 'https://api.fictive.com/REST/api/bundles' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
curl --location 'https://api.fictive.com/REST/api/bundles' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
Responses
200
204
404
412
500
[
  {
    "bundleReference": "001PB4PI6KTEVRY8R2",
    "name": "First Bundle (With Tag)",
    "description": "The first bundle, featuring a tag",
    "tag": "A001",
    "status": "Active"
  },
  {
    "bundleReference": "001PBUA2JKV9N8QIA3",
    "name": "Second Bundle (Without Tag)",
    "description": "The second bundle, without a tag",
    "status": "Inactive"
  },
  {
    "bundleReference": "001PB4PI6KTXCYR8R4",
    "carts": [
      {
        "cartReference": "0010K4PI6KTXCYFT82",
        "active": true,
        "trialInfo": {
          "trialEnabled": true,
          "trialUnit": "Day",
          "trialPeriod": 7,
          "discountPercentage": 100,
          "nonPaymentTrial": false,
          "trialChargedAsSinglePeriod": true
        },
        "contractReference": "0010C4PI6KTXCYB8R9",
        "lineItems": [
          {
            "lineItemReference": "0010I4PI6KTEVRY8R2",
            "description": "The first line item in the cart",
            "pricing": {
              "grossAmount": 2.5,
              "netAmount": 2.08,
              "taxAmount": 0.42,
              "currency": "GBP"
            },
            "quantity": 1,
            "productInfo": {
              "title": "Example Product",
              "productReference": "0010B4PI6KTXCYR8R4"
            },
            "customLineItemParameters": {}
          }
        ]
      }
    ],
    "name": "Third Bundle (With Tag & Cart & Active Trial)",
    "description": "The third bundle, featuring a tag & single cart & trial",
    "tag": "A002",
    "status": "Active"
  }
]
[
  {
    "bundleReference": "001PB4PI6KTEVRY8R2",
    "name": "First Bundle (With Tag)",
    "description": "The first bundle, featuring a tag",
    "tag": "A001",
    "status": "Active"
  },
  {
    "bundleReference": "001PBUA2JKV9N8QIA3",
    "name": "Second Bundle (Without Tag)",
    "description": "The second bundle, without a tag",
    "status": "Inactive"
  },
  {
    "bundleReference": "001PB4PI6KTXCYR8R4",
    "carts": [
      {
        "cartReference": "0010K4PI6KTXCYFT82",
        "active": true,
        "trialInfo": {
          "trialEnabled": true,
          "trialUnit": "Day",
          "trialPeriod": 7,
          "discountPercentage": 100,
          "nonPaymentTrial": false,
          "trialChargedAsSinglePeriod": true
        },
        "contractReference": "0010C4PI6KTXCYB8R9",
        "lineItems": [
          {
            "lineItemReference": "0010I4PI6KTEVRY8R2",
            "description": "The first line item in the cart",
            "pricing": {
              "grossAmount": 2.5,
              "netAmount": 2.08,
              "taxAmount": 0.42,
              "currency": "GBP"
            },
            "quantity": 1,
            "productInfo": {
              "title": "Example Product",
              "productReference": "0010B4PI6KTXCYR8R4"
            },
            "customLineItemParameters": {}
          }
        ]
      }
    ],
    "name": "Third Bundle (With Tag & Cart & Active Trial)",
    "description": "The third bundle, featuring a tag & single cart & trial",
    "tag": "A002",
    "status": "Active"
  }
]
﻿
﻿
Updated 22 Sep 2023
Did this page help you?
Bulk add entitlements
Creates a Bundle for the affiliate