Developers

WareMatch API

A REST API to read your listings, portfolio, RFQs and quotes directly from your own site or systems. Every request is authenticated with an API key and scoped strictly to your own account.

Base URL

https://api.warematch.com/api/v1

The API is versioned under /api/v1/. We won't make breaking changes within a version.

Authentication

Send your key as a bearer token on every request:

Authorization: Bearer wm_live_sk_...

Secret keys (wm_live_sk_…) are for server-to-server calls and can read and write. Keep them on your server — never expose them in a browser.

Publishable keys (wm_live_pk_…) are safe for the browser: they are read-only, rate-limited, and only work from the domains you've verified (enforced via CORS).

Getting a key

API access is a Premium feature. In your WareMatch dashboard, go to Integrations → API Integration, request access, and once approved you can generate keys, bind & verify your domains, and monitor usage.

Scopes

listings:read	Read your warehouse listings
portfolio:read	Read your white-label portfolio
rfqs:read	Read inbound RFQs on your listings
quotes:read	Read the quotes you've submitted

A key only carries the scopes you select. Publishable keys can hold read scopes only.

Rate limits

Each key is limited to 120 requests per minute. Exceeding it returns 429 Too Many Requests. You can watch your usage per key in the dashboard.

Endpoints

GET/listings/listings:read

List all warehouse listings on your account.

Request

curl https://api.warematch.com/api/v1/listings/ \
  -H "Authorization: Bearer wm_live_sk_..."

Response

[
  {
    "id": "7c9e...",
    "name": "Newark Distribution Center",
    "availability": true,
    "location": "Newark, NJ, USA",
    "city": "Newark",
    "province": "New Jersey",
    "country": "United States",
    "lat": 40.7357,
    "lng": -74.1724,
    "total_square_footage": 120000,
    "total_pallets": 8000,
    "available_square_footage": "30000.00",
    "available_pallets": 2000,
    "pallets_available": true,
    "currency": "USD",
    "minimum_month_required": "3",
    "listing_details": "...",
    "start_date": null,
    "end_date": null
  }
]

GET/listings/{id}/listings:read

Retrieve a single listing you own.

Request

curl https://api.warematch.com/api/v1/listings/7c9e.../ \
  -H "Authorization: Bearer wm_live_sk_..."

Response

{
  "id": "7c9e...",
  "name": "Newark Distribution Center",
  "city": "Newark",
  "country": "United States",
  "total_square_footage": 120000,
  "available_pallets": 2000,
  "currency": "USD"
}

GET/portfolio/portfolio:read

List your white-label portfolio profiles.

Request

curl https://api.warematch.com/api/v1/portfolio/ \
  -H "Authorization: Bearer wm_live_sk_..."

Response

[
  {
    "id": "a1b2...",
    "name": "McCollister's",
    "email": "[email protected]",
    "phone": "+1...",
    "slug": "mccollisters",
    "created_at": "2026-09-01T12:00:00Z"
  }
]

GET/rfqs/rfqs:read

List inbound RFQs on your listings.

Request

curl https://api.warematch.com/api/v1/rfqs/ \
  -H "Authorization: Bearer wm_live_sk_..."

Response

[
  {
    "id": "5e23...",
    "status": "sent",
    "deal_name": "Q4 3PL search",
    "listing_id": "7c9e...",
    "listing_name": "Newark Distribution Center",
    "created_at": "2026-09-10T09:00:00Z",
    "sent_at": "2026-09-10T09:00:00Z"
  }
]

GET/quotes/quotes:read

List the quotes you've submitted.

Request

curl https://api.warematch.com/api/v1/quotes/ \
  -H "Authorization: Bearer wm_live_sk_..."

Response

[
  {
    "id": "5ae9...",
    "rfq_id": "5e23...",
    "status": "submitted",
    "total_price": "2500.00",
    "currency": "USD",
    "validity": 30,
    "landlord_comments": "...",
    "created_at": "2026-09-11T10:00:00Z"
  }
]

Errors

401	Missing or invalid API key.
403	Your key is missing a required scope, or your plan doesn't include API access.
404	The resource doesn't exist on your account.
429	Rate limit exceeded (120 requests/minute per key).