Skip to main content

Example: Creating a Leasing Offer

Ready to integrate with JobRad®? Here’s a step-by-step example for working with our /offers API endpoint — from initial access to production readiness.

1. Get in Touch​

To get started, please

Contact us

to request access to our API. We'll guide you through the onboarding and provide credentials for the sandbox environment.

2. Explore the API Docs​

Browse the available endpoints in our API documentation and find the one that fits your use case — for example, the Offers API documentation for creating leasing offers.

3. Understand the POST /offers Endpoint​

Check out the POST /offers specification and make sure you understand:

  • Required request headers
  • JSON structure of the request body
  • Expected response format

4. Get Your OAuth Token and Start a Session​

All API requests are authenticated via OAuth 2.0.
Follow the instructions in the Authentication Section to:

  • Obtain your OAuth token
  • Establish a secure session

You’ll need to include your token in the Authorization header for all requests.

5. Send a POST /offers Request​

Here's a sample request to create a leasing offer:

curl -X POST https://connect.jobrad.org/v1/offers \
  -H "Authorization: Bearer YOUR_OAUTH_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "externalOfferId": "external-id-123",
    "customerName": "Max Mustermann",
    "customerEmail": "max.mustermann@example.com",
    "product": {
      "bidexCode": "123040",
      "brandName": "Gudereit",
      "modelName": "Model X",
      "modelYear": "2023",
      "color": "Black",
      "size": "L",
      "driveManufacturer": "Bosch",
      "batteryCapacity": "500",
      "priceGross": 2900.99,
      "listPriceGross": 2999.99
    },
    "accessory": [
      {
        "bidexCode": "301520",
        "brandName": "ABUS",
        "modelName": "Bordo Granit XPlus 6500",
        "priceGross": 99.99,
        "listPriceGross": 119.99
      }
    ],
    "withShipping": true,
    "shippingCostGross": 49.99,
    "installationCostGross": 29.99,
    "deliveryDate": "2030-12-01T00:00:00.000Z",
    "notes": "Please call before delivery"
  }'

6. Retrieve the Offer Status​

After submitting the offer, the response will include a UUID.
Use this UUID to check the current status of the offer via GET /offers/{uuid}:

curl -X GET https://connect.jobrad.org/v1/offers/{uuid} \
  -H "Authorization: Bearer YOUR_OAUTH_TOKEN"

The response will return the current status and all relevant offer details. You can use this to:

  • Track the lifecycle of the offer
  • Display the status in your frontend
  • Debug and validate that everything works as expected

7. Move to Production​

Once your integration works as intended and testing in the sandbox is complete:

  • Let us know you're ready for production
  • We'll evaluate your implementation
  • If everything checks out, we’ll enable access to the production environment and support your launch

Our team will be available to assist you during testing, validation, and go-live — so you can be confident in your integration.

Need help or want to discuss a special use case?
Don’t hesitate to reach out! We're here to support your integration success.