Bloomreach Catalog Management API
Bloomreach Catalog Management API endpoints from Bloomreach
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Bloomreach Catalog Management API endpoints from Bloomreach
Endpoints 19
Catalog configuration
- GETGet current configuration
/accounts/:account_name/catalogs/:catalog_name/environments/:environment_name/configs/LATESTUnderstand the current state of catalog configuration, including custom attributes configuration and all catalog settings present in the dashboard. - POSTModify current configuration
/accounts/:account_name/catalogs/:catalog_name/environments/:environment_name/configs/LATESTProgrammatically modify the current catalog configuration to automate common tasks. - GETGet an older configuration
/accounts/:account_name/catalogs/:catalog_name/environments/:environment_name/configs/:config_idUnderstand what the catalog configuration looked like at the point in time an index was generated. - GETGet reserved attributes
/accounts/:account_name/catalogs/:catalog_name/environments/:environment_name/reserved-attributesGet a list of all reserved attributes for the catalog.
Job processing
- GETGet job details
/accounts/:account_name/catalogs/:catalog_name/environments/:environment_name/jobs/:job_idGet all the details about a particular job including its status. - GETGet all jobs
/accounts/:account_name/catalogs/:catalog_name/environments/:environment_name/jobsGet all the jobs associated with a catalog.
View Catalogs data
- GETGet all catalogs
/accounts/:account_name/catalogsGet all the catalogs present for an account. - GETGet catalog details
/accounts/:account_name/catalogs/:catalog_name/environments/:environment_nameView the current state of a catalog. This returns the entire catalog with product and item feed record data.
Feed indexing
- POSTRun an indexing job
/accounts/:account_name/catalogs/:catalog_name/environments/:environment_name/indexesTrigger an indexing job to update the catalog's index.
Manage feed records
- GETGet current records
/accounts/:account_name/catalogs/:catalog_name/environments/:environment_name/recordsView the current state of product and item feed records in a catalog. - PUTUpload full feed
/accounts/:account_name/catalogs/:catalog_name/environments/:environment_name/recordsUpload the entire feed data at once. - PATCHModify feed records
/accounts/:account_name/catalogs/:catalog_name/environments/:environment_name/recordsEdit/change or add particular product or item records in the feed. - GETGet record details
/accounts/:account_name/catalogs/:catalog_name/environments/:environment_name/records/:record_idView the details of a product or item feed record. - GETGet record variants
/accounts/:account_name/catalogs/:catalog_name/environments/:environment_name/records/:record_id/variantsView the variants associated with a product or item feed record. - GETGet variant details
/accounts/:account_name/catalogs/:catalog_name/environments/:environment_name/records/:record_id/variants/:variant_idView the details of a variant of any product or item in the feed data. - GETGet views
/accounts/:account_name/catalogs/:catalog_name/environments/:environment_name/records/:record_id/viewsGet all the views associated with a product or item feed record. - GETGet view details
/accounts/:account_name/catalogs/:catalog_name/environments/:environment_name/records/:record_id/views/:view_idGet the details of a view of any product or item feed record. - GETGet view variants
/accounts/:account_name/catalogs/:catalog_name/environments/:environment_name/records/:record_id/views/:view_id/variantsGet all the variants associated with a different view of any product feed record. - GETGet view variant details
/accounts/:account_name/catalogs/:catalog_name/environments/:environment_name/records/:record_id/views/:view_id/variants/:variant_idGet the details of a variant for a different view of a product feed record.
API details
- Base URL
https://discovery.bloomreach.com/dataconnect/api/v3- Authentication
- A bearer token in the Authorization header
- Operations
- 19 operations on 16 pathsGET 15POST 2PUT 1PATCH 1
- Main resources
- Manage feed records 10Catalog configuration 4Job processing 2View Catalogs data 2Feed indexing 1
- Response formats
application/json- Description format
- OpenAPI 3.0.3, API version
3.0.0 - Links
- OpenAPI document
- Listed from
- Bloomreach's published OpenAPI description (bloomreach/api-specs) (Apache-2.0)
How to test the Bloomreach Catalog Management API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Bloomreach Catalog Management API collection, without the publisher's secrets.
- Add your credentialsThis API uses A bearer token in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Get current configuration” (GET /accounts/:account_name/catalogs/:catalog_name/environments/:environment_name/configs/LATEST), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Bloomreach Catalog Management API?
Bloomreach Catalog Management API endpoints from Bloomreach It is listed under E-commerce and has 19 endpoints.
Who publishes the Bloomreach Catalog Management API?
It is listed from Bloomreach's public API description (an OpenAPI document), not published by Bloomreach on Swastik Codes. Anyone who controls bloomreach.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Bloomreach Catalog Management API?
Requests go to https://discovery.bloomreach.com/dataconnect/api/v3. Endpoint paths are added to this base URL.
How do I authenticate with the Bloomreach Catalog Management API?
With A bearer token in the Authorization header.
How many endpoints does the Bloomreach Catalog Management API have?
19 operations on 16 paths (15 GET, 2 POST, 1 PUT, 1 PATCH). The largest groups are Manage feed records, Catalog configuration, Job processing, View Catalogs data.
Is forking the Bloomreach Catalog Management API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.