API documentation

The Bidali commerce API is available at the following URLs:

Both environments provide the following endpoints:

Making requests

Except for /authentication and some requests for /charges all requests need to be authenticated.

Querying data

A list of data can for all endpoints (except /authentication) can be requested via https://api.bidali.com/<endpoint>. The $limit (default value: 10, maximum value: 100) and $skip query parameters can be used to navigate multiple entries:

# List all charges (that the user has access to)
GET https://api.bidali.com/charges 
# List charges page 3 (with page size of 20)
GET https://api.bidali.com/charges?$skip=40&$limit=20

Getting individual entries

Individual entries can be retrieved using https://api.bidali.com/<enpoint>/<id>:

# Get a specific organization
GET https://api.bidali.com/organization/<organization id>
# Get a specific charge
GET https://api.bidali.com/charges/<charge id>

Creating data

Important: For POST and PATCH requests the Content-Type HTTP header must be set to the body content type. Currently application/json and application/x-www-form-urlencoded are supported. We recommend application/json.

New data can be created using the POST https://api.bidali.com/<endpoint> HTTP method.

Updating data

The top level properties of existing /organizations and /webhooks can be modified using the PATCH HTTP method and submitting the data to update:

PATCH https://api.bidali.com/organizations

Content-Type: application/json
Authorization: Bearer <valid JWT>

{
  "legalName": "Updated company name"
}

results matching ""

    No results matching ""