logo
API docs by Redocly

Donation as a Service API (1.0.0)

Download OpenAPI specification:Download

E-mail: developer@liquidonate.com License: Apache 2.0 Terms of Service

Introduction

Donation as a Service API allows access to LiquiDonate's network of nonprofits.

Using these APIs, donate items, match them to nonprofits and more.

Donate

Donate an item

Provide details of an item that needs to be donated.
Note: The item will be listed on LiquiDonate's free marketplace.

Authorizations:
(LiquiDonate KeyLiquiDonate Secret)
Request Body schema: application/json
required

Request payload to donate an item

required
object (item)

The item being donated

Responses

Request samples

Content type
application/json
{
  • "item": {
    }
}

Response samples

Content type
application/json
{
  • "item": {
    }
}

Match

Match items

Provide details of an array of items that needs to be matched with a recipient
Note: All items need to have the same location.

Authorizations:
(LiquiDonate KeyLiquiDonate Secret)
Request Body schema: application/json
required

Request payload to match an item

Array
required
object (match_item)

The item being matched

Responses

Request samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Response samples

Content type
application/json
{
  • "nonprofit": {
    }
}

Match and Ship an Item

Provide details of an item that needs to be matched with a recipient and shipped to them. Compared with v1/match, this API returns a shipping label.
Note: The item will not be listed on LiquiDonate's free marketplace.

Authorizations:
(LiquiDonate KeyLiquiDonate Secret)
Request Body schema: application/json
required

Request payload to donate an item

required
object (item)

The item being donated

externalRetailerID
string

An ID that will be associated with this donated item to identify the retailer

preferredCarrier
string (carriers)
Enum: "usps" "fedex" "ups"

If this isn't provided, the carrier that offers the best rate will be chosen by default

Responses

Request samples

Content type
application/json
{
  • "item": {
    },
  • "externalRetailerID": "retailer-id-1"
}

Response samples

Content type
application/json
{
  • "item": {
    },
  • "match": {
    },
  • "label": {}
}

Retailer

Get Retailer

Provide details of a retailer when provided with an api key and secret

Authorizations:
(LiquiDonate KeyLiquiDonate Secret)

Responses

Response samples

Content type
application/json
{
  • "retailer": {
    }
}

Setup Retailer

Sets up a retailer, associated user and generate an API key

Authorizations:
(LiquiDonate KeyLiquiDonate Secret)
Request Body schema: application/json
required

Request payload to setup retailer

required
object

Retailer information (to create)

required
object

User information

Responses

Request samples

Content type
application/json
{
  • "item": {
    },
  • "externalRetailerID": "retailer-id-1"
}

Response samples

Content type
application/json
{
  • "retailer": {
    },
  • "user": {
    },
  • "apiKey": {
    }
}

Receipts

Retreive donation receipts

Retrieve donation receipts for by match or item.

Authorizations:
(LiquiDonate KeyLiquiDonate Secret)
query Parameters
matchUUID
string <uuid>

The UUID of the match

itemUUID
string <uuid>

The UUID of the item

Responses

Response samples

Content type
application/json
[]