Getting Started

Making Your First Request

View as Markdown

To make your first request to the Rendr API, follow these steps.

1

Authenticate

Before calling any endpoint, obtain an access token using the OAuth2 token endpoint.

  • Use your client_id and client_secret
  • Tokens are valid for 1 hour
  • Include the token in the Authorization: Bearer header on all requests

See Authentication for full details and response formats.

2

Create a Delivery

Once authenticated, create a delivery. A delivery is the primary orchestration object in Rendr. It contains:

FieldDescription
store_id / store_referenceThe store this delivery originates from
Customer detailsRecipient name and contact information
Destination addressWhere the delivery should be sent
Parcel informationDimensions, weight, and item details
Delivery typeStandard, scheduled, regulated, etc.
Booking controlsOptional timing and booking behaviour flags

When you submit the delivery, Rendr will:

  1. Validate the payload
  2. Apply store configuration
  3. Enforce compliance rules
  4. Assign an initial delivery state

If immediate booking is enabled, Rendr automatically begins orchestration. No additional calls are required to trigger carrier selection or dispatch.

For required and optional fields, see the API Reference.

3

Store the Delivery ID

The response will include a unique delivery identifier. You should:

  • Persist this ID in your system
  • Use it for tracking status and events
  • Use it for reconciliation and support queries
4

Track Progression

After creation, Rendr manages the full delivery lifecycle. Poll the delivery object via the API at any time to retrieve the current state.

For full lifecycle details, see Workflow Summary.