
English
Connect your hire business to ezHire.
Publish selected hire stock on ezHire alongside your own website, using a connection from your business software.
Private pilot — access by approval. Public API access is not open yet. An application does not create a key or enable publishing.
Request API access
We review the business and the proposed integration before approving access. Tell us who you are, which hire business you represent and what you want to connect.
- Business name, website and ABN or local registration, where applicable.
- Your name, role and business contact email.
- Your stock software or website platform, estimated listing count and intended use.
- The access required: read, draft import or reviewed publishing.
Email an API access application
Or email admin@ezbusiness.com.au.
This opens your email app with a template. Nothing is submitted until you send the email.
Do not send passwords, API keys, card information or identity documents. We may ask you to verify control of the business website or use an independently published business contact.
After approval
A verified business owner signs in to the shared ezGarageSale account used for ezHire. Once pilot access is enabled, the owner creates a scoped, expiring key in Store API connections after confirming their password. Developers receive only the access the owner authorises.
Owner API connection settings — Requires an eligible business-owner account and enabled pilot access; unavailable while the API is off.
Keys are displayed once in the secure account page, stored as hashes, and expire after 1–90 days. Up to ten active keys per business. Review does not guarantee approval or an activation date.
Quick start
Use HTTPS server-to-server requests to https://ezhire.net.au/api.php. Keep the credential in your server's secret settings. Never put it in public JavaScript, a URL, a spreadsheet or a public repository. Browser cookies and CORS access are not supported.
- Apply for access and verify the business. The current business-store owner controls key creation and revocation.
- Choose minimum access:
readreads API-imported items;writealso imports drafts and withdraws offers;publishalso requests reviewed publication. - Use a stable, case-sensitive external ID for each item. Import a draft; imports never automatically publish.
- Add photos in My hire items, wait for screening and accept the current marketplace terms.
- GET the current item and its three revisions before updating, publishing or withdrawing. Publishing requires separate explicit consent and all existing listing checks.
Read your imported items
Illustrative command for an approved connection. Set EZHIRE_API_KEY securely on your own server; do not paste real credentials into chat or support tickets.
curl --request GET 'https://ezhire.net.au/api.php' \
--header "Authorization: Bearer ${EZHIRE_API_KEY}"
Create a draft
Send PUT /api.php?external_id=SKU-001 with Authorization: Bearer <credential>, Content-Type: application/json and a unique Idempotency-Key header. This example is for a new external ID only:
{
"expected_revision": 0,
"expected_item_revision": 0,
"expected_profile_revision": 0,
"item": {
"title": "Cordless drill",
"description": "Business-owned hire equipment",
"defects": "Minor marks on casing",
"pickup_suburb": "Pakenham VIC 3810",
"item_condition": "used_good"
},
"hire": {
"category": "tools",
"daily": "25.50",
"weekly": "100.00",
"collection_notes": "Arrange collection with our store",
"details": {},
"deposit_amount": "",
"deposit_terms": ""
}
}
Rates are AUD decimal strings, not JSON floating-point numbers. Conditions: new, like_new, used_good or used_fair. The example uses the tools category. Category-specific vehicle, space and property integrations need their corresponding listing fields and approval checks.
No photo upload or remote photo URL is accepted by this API. Deposits describe proposed terms only; the API does not reserve or charge money.
Endpoint reference
GET /api.php- List up to 100 mapped items for the authenticated business. Follow
data.next_afterusing?after=; null means the last page. GET /api.php?external_id=SKU-001- Read the item and current API, item and profile revisions.
PUT /api.php?external_id=SKU-001- Create or replace an unpublished item and hire settings. This is replacement, not a partial PATCH.
POST /api.php?action=publish&external_id=SKU-001- Request reviewed publication with publish scope, current revisions and
publication_consent: true. Vehicles, spaces and property also requireauthority_confirmed: true. POST /api.php?action=withdraw&external_id=SKU-001- Withdraw the mapped hire offer with current revisions. Stock, photos and sale publication are retained.
Every write requires expected_revision, expected_item_revision and expected_profile_revision from the latest response, plus an Idempotency-Key. Publish/withdraw bodies contain these revision fields; publish also contains the consent fields. Do not reuse example revisions for existing items.
Success is HTTP 200 with a data object. Item data includes external_id, revision, item_revision, profile_revision, publication_enabled, screening, photo_count, listing_url, item and hire. A saved publication flag is not a guarantee of current public visibility; moderation and other public listing checks still apply.
Limits, retries and errors
- 120 requests per minute per key, plus a 240-request/minute direct-network limit; up to 1,000 API-mapped items per business. Public listing allowances are separate.
- JSON write bodies: at most 64 KiB and depth 12. No bulk endpoint.
- External IDs: 1–100 ASCII letters, numbers, dots, underscores, colons or hyphens; start with a letter or number.
- Idempotency-Key: 16–100 ASCII letters, numbers, underscores or hyphens. Retain the same key and identical ordered JSON on an uncertain retry. Retry acceptance lasts 24 hours; use a fresh key after correcting a rejected payload.
- 409 means reconcile the current revisions or request content before trying again. Do not blindly overwrite a conflict. GET the current item after a replay to see its latest state.
Errors contain error and message: 400 malformed request; 401 unavailable credential; 403 denied scope; 404 missing item/action; 409 conflict; 413 body too large; 415 unsupported media; 422 invalid or not-ready listing; 429 rate limit (Retry-After: 60); 503 unavailable or disabled.
Only GET, PUT and POST are supported. Tenant IDs, internal item/photo IDs, private customer fields and arbitrary URLs are not accepted. Ownership, enabled marketplace access, expiry, revocation and password versions are rechecked. Revoking a key stops future calls but does not withdraw existing public offers.
Help with integrations
Start with a read-only connection, then draft import. If you get 409, read the item again and reconcile all three revisions. For 429, wait for Retry-After. For 503, access may be disabled; repeated applications do not enable it.
For support, share the HTTP status, error code, request time and a redacted example. Never share the Authorization header or your key. Use the application email above when available.
What is not included yet?
Ready-made Shopify/WooCommerce connectors, webhooks, automated photo ingestion, live availability or booking synchronisation, API enquiry retrieval, payments, card holds and insurance are not available through this API. Hire enquiries continue through the listing's existing owner contact flow.
Marketplace guide, privacy and safety · Request API access · Return to ezHire