Skip to main content

REST API Reference

Complete reference for the Propeller REST API. Use the interactive explorer to test endpoints, or browse the full endpoint listing.

The REST API is the primary interface for integrating Propeller with business systems: ERP, PIM, CRM, PLM and other operational tools. Use it for bulk data operations, syncing and system-to-system communication.

Connection details​

SettingValue
Base URLhttps://api.helice.cloud/v2
Token endpointPOST https://api.helice.cloud/oauth2/token with grant_type=client_credentials, client_id and client_secret as form fields
AuthorizationAuthorization: Bearer ACCESS_TOKEN header on every request. A token is valid for 30 minutes and there is no refresh token
Content typeapplication/json for request bodies
Paginationpage and offset on list and search endpoints. offset is the page size and defaults to 12 on most endpoints
Rate limit5 requests per second per API key. See Rate limits

See Get Access Token for the token request and its error responses, and Authentication and Security for token renewal in unattended integrations.

In this section​

  • Explorer. Interactive REST API explorer for testing endpoints.
  • Authentication. The access token endpoint.
  • Shared Configuration. Attribute descriptions, attributes, valuesets, taxes and carriers.
  • Product Management. Categories, products, clusters, inventory, bundles, surcharges and media.
  • User Management. Companies, contacts, customers, addresses, favorite lists and order lists.
  • Pricing. Prices, cost prices, bulk prices, pricesheets, discounts and zone tax codes.
  • Orders. Carts, orders, shipments, track and traces and order statuses.

Machine-readable spec​

Download the REST OpenAPI specs, one file per service, for code generation and tooling. Each endpoint page is also available as Markdown, with its request and response schema, at the same URL with .md in place of the trailing slash.