Introduction

Tulip Bulk API Service

The Tulip Platform Bulk API service is a web-based service that provides capabilities to load client-side business data into the backend database of our cloud platform. The service is designed on RESTful architectural principles and style, and provides secure and efficient API endpoints.

The service is related to the bulk insert and update feature in database systems — a means and a specification for loading large volumes of structured data. For more information, see https://en.wikipedia.org/wiki/Bulk_insert

Using the Bulk API service, you can:

  • Create, retrieve, and update business data records in bulk.
  • Incorporate Bulk API routes into regular data maintenance procedures specific to Tulip client enterprises.
  • Develop systems/software for integrating Tulip products and services into existing enterprise software infrastructures.

To properly collect, organize, format, prepare, and submit API calls with bulk payloads of client-side business data (and capture and reuse information in server responses), you should familiarize with a few basic concepts and know-how.

The following subject areas are covered for technical staff at Tulip’s client enterprises to develop initial POCs, plan properly structured API call payloads for mass data loading, and architect and design API requests and practices that are secure, reliable and reusable:

  • Dependencies among interrelated resources, such as representations of products and customers.
  • Supported HTTP methods and ways to ensure their usage is in line with best practices in bulk API operations, including those that cover performance, safeguarding against data duplication, security, and maintainability.
  • Data entity identification and using record IDs to create, map, interconnect, trace, retrieve, and reuse business data records on demand, and to use them in common maintenance and update activities.
  • Field values of Bulk API resources that you may need to specify or include in your API request payloads, such as dates, time and geographical information, and text in other languages — things that require special handling, assembly, and formatting.

Tulip Bulk API Releases

Tulip releases schema changes as part of its feature pipeline in its CI-CD methodology and informs Clients of the latest features and configurations to enable them. At the same time API changes may be necessary to support those new features.

Feature that require data to be synchronized to Tulip via Bulk API, such as Customer preference data values that could be sent into Tulip from an external system, or Customer loyalty display attributes, will be release via an update to the Bulk API specifications.

Tulip releases these updates as frequently as every 2 weeks into its production cloud multi-tenant platform. But if there are no features that require API updates then subsequently no updates will be made to the specifications.

Latest Version of Bulk API

As of March 2020, version 7.0 is the latest Bulk API version. See the 7.0 Bulk API specifications for details.