Retrieve a Bundle by reference

1min
GET
This endpoint allows the ability to retrieve a bundle by reference
Authentication
Authorization
Bearer
Path Parameters
bundleReference
string
*
Header Parameters
X-TokenId
string
X-SessionId
string
X-Version
string
*
Origin
string
Responses
200
Ok
FictiveGlobal.Api.Rest.Dtos.v1.Bundle.Bundle
Description
The Dto of a bundle
name
string
description
string
tag
string
status
string<Active | Inactive | Archived>
404
Not Found
            <br />• Bundle reference does not correspond to a bundle Id
            <br />• Bundle does not exist for the affiliate
500
Internal Server Error
Curl
JS
Ruby
Python
curl --location --globoff 'https://api.fictive.com/REST/api/bundles/{bundleReference}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
curl --location --globoff 'https://api.fictive.com/REST/api/bundles/{bundleReference}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
Responses
200
404
500
{
  "bundleReference": "001PB4PI6KTXCYR8R4",
  "carts": [
    {
      "cartReference": "0010K4PI6KTXCYFT82",
      "active": 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)",
  "description": "The third bundle, featuring a tag & single cart",
  "tag": "A002",
  "status": "Active"
}
{
  "bundleReference": "001PB4PI6KTXCYR8R4",
  "carts": [
    {
      "cartReference": "0010K4PI6KTXCYFT82",
      "active": 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)",
  "description": "The third bundle, featuring a tag & single cart",
  "tag": "A002",
  "status": "Active"
}
﻿
﻿
Updated 22 Sep 2023
Did this page help you?
Creates a Bundle for the affiliate
Allows a bundle to be deleted for an affiliate