Bulk

Run several read requests in one call

Executes up to 20 GET requests against the public read endpoints in a single round trip and returns each sub-response with its own status and body. The batch always answers 200 once the envelope is valid, even if individual items fail, so check each item's status. Only the read endpoints listed in the allowed_paths of an error item can be batched; a batch counts as one request against the rate limit.

post/api/v1/batch

Request

  • Base URL: https://www.adadiamonds.com
  • URL: https://www.adadiamonds.com/api/v1/batch
  • Auth: one of:
    • none
    • API key in header X-Ada-Api-Key
    • OAuth 2 (authorization code, authorization URL https://www.adadiamonds.com/oauth/authorize, token URL https://www.adadiamonds.com/api/oauth/token; client credentials, token URL https://www.adadiamonds.com/api/oauth/token, scopes: catalog:read)

Request body

Example request

{
  "requests": [
    {
      "id": "stones",
      "path": "/api/v1/diamonds",
      "query": {
        "shape": "Oval",
        "limit": "3"
      }
    }
  ]
}

Response

Every sub-response, in request order.

object'batch' required
countinteger required

Example response

{
  "responses": [
    {
      "body": {
        "data": [
          {
            "name": "1.02ct F VS1 Ideal Round"
          }
        ]
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.