GET

Get catalog

Retrieve brands and products assigned to your account, with optional filtering, pagination, and target-currency pricing.

GET/api/integration/v2.0/catalog

Get catalog

Discover available products

Get accounts

Retrieve your accounts

Place order

Create an order for your customer

Get order

Check order status

Notification

Receive webhook updates

The GET /api/integration/v2.0/catalog endpoint returns the brands and products available for your Bamboo account.

Use this endpoint before placing an order to discover product IDs, supported countries, currencies, denomination ranges, current availability, price ranges, redemption information, and brand terms.

This endpoint requires Basic Auth using your API credentials.

Query parameters

All query parameters are optional. Use them to filter the catalog, paginate large result sets, or return prices in a target currency.

Parameter	Type	Required	Description	Example
`CurrencyCode`	string	No	Filter by 3-letter ISO currency code.	USD
`CountryCode`	string	No	Filter by 2-letter ISO country code.	US
`Name`	string	No	Filter results by brand name.	playstation germany
`ModifiedDate`	date	No	Return products modified after the specified date.	2022-08-21
`ProductId`	number	No	Return the matching product if it exists.	114111
`PageSize`	number	No	Number of records per page. Default is 100.	100
`PageIndex`	number	No	Zero-based page index used for pagination.	0
`BrandId`	number	No	Filter products by brand ID.	1020
`TargetCurrency`	string	No	Display all prices in a single target currency.	USD

Response specifications

The catalog response is paginated. Each item includes brand metadata and the products that can be ordered for that brand.

Field	Type	Description
`pageIndex`	number	Current zero-based response page index.
`pageSize`	number	Number of records requested per page.
`count`	number	Total number of matching catalog items.
`items`	array	List of matching brands and their products.
`internalId`	string	Bamboo internal brand identifier.
`name`	string	Brand name.
`countryCode`	string	Brand country code.
`currencyCode`	string	Brand currency code.
`description`	string \| null	Brand description. This value can be empty.
`disclaimer`	string \| null	Brand disclaimer. This value can be empty.
`redemptionInstructions`	string \| null	Redemption instructions. This value can be empty.
`terms`	string \| null	Brand terms. This value can be empty.
`logoUrl`	string	Brand logo URL.
`modifiedDate`	string	Last catalog update timestamp for the brand.
`products`	array	Products available under the brand.
`id`	number	Unique product identifier used when placing orders.
`name`	string	Product name returned for the brand.
`minFaceValue`	number	Minimum face value available for the product.
`maxFaceValue`	number	Maximum face value available for the product.
`count`	number \| null	Available quantity. Null means unrestricted; 0 means out of stock.
`price.min`	number	Minimum client price mapped to the face value range.
`price.max`	number	Maximum client price mapped to the face value range.
`price.currencyCode`	string	Currency code used for the product price.
`modifiedDate`	string	Last catalog update timestamp for the product.
`categories`	array	Categories assigned to the brand.
`id`	number	Category identifier.
`name`	string	Category name.
`description`	string \| null	Optional category description.

Response notes

Use these rules when interpreting product denomination, availability, and price information.

Denomination range

For products with a range of denominations, minFaceValue and maxFaceValue represent the allowed card value range.

Fixed-value products

For fixed-value products, minFaceValue and maxFaceValue are the same.

Unlimited stock

If count is null, the product quantity is unrestricted.

Out of stock

If count is 0, the product is currently out of stock.

Price refresh

Catalog prices, when applicable, are updated on an hourly basis.

Target currency

TargetCurrency lets you display pricing in one settlement currency while preserving the underlying product denomination data.

Examples

Full request and response examples for this endpoint.

Example request

Use this full request as the primary reference for client-side implementation.

# Generate token: echo -n 'YOUR_CLIENT_ID:YOUR_CLIENT_SECRET' | base64

curl --location 'https://api.bamboocardportal.com/api/integration/v2.0/catalog?CurrencyCode=USD&CountryCode=US&Name=playstation+germany&ModifiedDate=2022-08-21&ProductId=114111&PageSize=100&PageIndex=0&BrandId=1020&TargetCurrency=USD' \
  --header 'Authorization: Basic YOUR_BASE64_TOKEN' \
  --header 'Accept: application/json'

Example response

Use this sample payload to validate parsing, field mapping, and downstream handling.

200 OK

{
  "pageIndex": 0,
  "pageSize": 100,
  "count": 1,
  "items": [
    {
      "internalId": "2921",
      "name": "Airbnb USA",
      "countryCode": "US",
      "currencyCode": "USD",
      "description": "Amazing places to stay and things to do, all around the world.",
      "disclaimer": null,
      "redemptionInstructions": "Sign up or log in at airbnb.com/gift...",
      "terms": "Card balance does not expire...",
      "logoUrl": "https://bamboo-assets.s3.amazonaws.com/app-images/brand-images/2921/logo",
      "modifiedDate": "2024-05-16T04:18:26.8697061",
      "products": [
        {
          "id": 483243,
          "name": "Airbnb USA",
          "minFaceValue": 25,
          "maxFaceValue": 500,
          "count": null,
          "price": {
            "min": 25,
            "max": 500,
            "currencyCode": "USD"
          },
          "modifiedDate": "2024-05-16T04:18:26.8697061"
        }
      ],
      "categories": [
        {
          "id": 6,
          "name": "Airlines & Hotels",
          "description": null
        }
      ]
    }
  ]
}

Sandbox usage

Sandbox is designed to help you test catalog discovery and order planning without affecting production accounts.

Separate credentials

Sandbox uses credentials that are separate from production credentials.

Realistic structure

Sandbox mirrors the live catalog structure for realistic testing.

Separate balances

Sandbox accounts and balances are separate from live current accounts.

Sandbox channel

Orders created in sandbox are associated with the sandbox channel.

Reports and transactions

Sandbox reports and transactions return sandbox activity only.

Version comparison

Bamboo provides two catalog versions. Both are supported and actively used.

v1.0

Version v1.0

Returns a flat brands array. No filtering or pagination parameters.

v2.0

Version v2.0

Supports filtering by currency, country, name, product ID, and brand ID. Also supports pagination and target-currency display.

PreviousAuthentication NextGet Accounts

On this page

Try it out

Open the interactive API panel to test this endpoint with your own credentials.

Client ID

Client Secret

Save for this browser

Requests are sent directly from your device. Your IP address must be whitelisted in the client portal API Access page for requests to succeed.

Credentials are stored only in this browser tab session and are removed when the tab is closed. They are never saved to BambooDocs servers.

GET

KeyValueDescription

CurrencyCodeReturn products priced in USD.

CountryCodeFilter the catalog to United States brands.

NameSearch by brand name.

ModifiedDateFilter products updated after this date.

ProductIdReturn a specific product if it exists.

PageSizeLimit the response page size.

PageIndexRequest the first result page.

BrandIdReturn products under a specific brand.

TargetCurrencyConvert display pricing to one settlement currency.

Sample — send a request to see live data

{
  "pageIndex": 0,
  "pageSize": 100,
  "count": 1,
  "items": [
    {
      "internalId": "2921",
      "name": "Airbnb USA",
      "countryCode": "US",
      "currencyCode": "USD",
      "description": "Amazing places to stay and things to do, all around the world.",
      "disclaimer": null,
      "redemptionInstructions": "Sign up or log in at airbnb.com/gift...",
      "terms": "Card balance does not expire...",
      "logoUrl": "https://bamboo-assets.s3.amazonaws.com/app-images/brand-images/2921/logo",
      "modifiedDate": "2024-05-16T04:18:26.8697061",
      "products": [
        {
          "id": 483243,
          "name": "Airbnb USA",
          "minFaceValue": 25,
          "maxFaceValue": 500,
          "count": null,
          "price": {
            "min": 25,
            "max": 500,
            "currencyCode": "USD"
          },
          "modifiedDate": "2024-05-16T04:18:26.8697061"
        }
      ],
      "categories": [
        {
          "id": 6,
          "name": "Airlines & Hotels",
          "description": null
        }
      ]
    }
  ]
}

Time: Not sentSize: —

Get catalog

Follow this flow to place your first order

Get catalog

Get accounts

Place order

Get order

Notification

Query parameters

Response specifications

Response notes

Denomination range

Fixed-value products

Unlimited stock

Out of stock

Price refresh

Target currency

Examples

Example request

Example response

Sandbox usage

Separate credentials

Realistic structure

Separate balances

Sandbox channel

Reports and transactions

Version comparison

Version v1.0

Version v2.0