# List Blended Lots

Retrieves a list of post-roast blended lots from inventory, optionally filterable by
an inclusive blended date.

Endpoint: POST /inventory.blend.listBlendedLots
Security: oauth2

## Request fields (application/json):

  - `params` (object)

  - `params.filter` (object)
    Defines all required and optional filter parameters for the operation.

  - `params.filter.blendedDate` (object)

  - `params.filter.blendedDate.from` (string)
    Filters the results to include only records created on or after this date. The date must be provided in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ). The filter is inclusive.
    Example: "2023-10-05T14:48:00Z"

  - `params.pagination` (object)
    Defines all required and optional pagination parameters for the operation.

  - `params.pagination.limit` (integer)
    The number of elements to be returned
    Example: 20

  - `params.pagination.after` (string)
    The cursor to retrieve the next page. This is an opaque value that should not be interpreted by the client.
    Example: "aBc="

## Response 200 fields (application/json):

  - `ok` (boolean)
    Indicates whether the request was successful.
    Example: true

  - `result` (object)
    Contains the response data of a successful request.

  - `result.blendedLots` (array)

  - `result.blendedLots.id` (string)
    The unique identifier of the blended lot.
    Example: "550e8400-e29b-41d4-a716-446655440000"

  - `result.blendedLots.name` (string)
    The name of the blended lot.
    Example: "House Blend"

  - `result.blendedLots.weight` (object)
    Represents the current weight of the object.

  - `result.blendedLots.weight.amount` (number, required)
    The weight amount represented as floating-point number.
    Example: 12.5

  - `result.blendedLots.weight.unit` (string, required)
    The weight unit of the object.
    Enum: "KG", "LBS"

  - `result.blendedLots.roastedLots` (array)
    The roasted lots that were used to create this blended lot.

  - `result.blendedLots.roastedLots.id` (string)
    The unique identifier of the lot.
    Example: "550e8400-e29b-41d4-a716-446655440000"

  - `result.blendedLots.roastedLots.name` (string)
    The name of the lot.
    Example: "Colombia Washed"

  - `result.blendedLots.roastedLots.externalId` (string)
    Represents the unique identifier of this lot in an external system (e.g. ERP).
    Example: "lot-5382"

  - `result.blendedLots.roastedLots.usedWeight` (object)
    The amount of weight consumed from the source lot for a specified operation. (e.g. roasting, blending). For example, 5 KG of a green lot were consumed for roasting.

  - `result.blendedLots.location` (object)
    Represents the relationship between an internal object and its external identifier.

  - `result.blendedLots.location.id` (string)
    The unique identifier of the object.
    Example: "550e8400-e29b-41d4-a716-446655440000"

  - `result.blendedLots.location.externalId` (string)
    Represents the unique identifier of this object in an external system (e.g. ERP).
    Example: "location-1234"

  - `result.blendedLots.blendedDate` (string)
    The date when the lot was blended in ISO 8601 format
    Example: "2023-10-05T14:48:00Z"

  - `meta` (object)
    Contains the metadata (e.g. pagination information) of the response.

  - `meta.pagination` (object)
    Represents the pagination fields of the response.

  - `meta.pagination.endCursor` (string)
    Cursor value to retrieve the records of the next page. If there no further pages, this value is null.
    Example: "aBc="

## Response 400 fields (application/json):

  - `ok` (boolean)
    Indicates whether the request was successful or not

  - `error` (object)

  - `error.code` (string)
    Specifies error code that can be handled programmatically.
    Example: "invalid_parameter"

  - `error.message` (string)
    A detailed description of the occurred error.
    Example: "Invalid parameter provided"

## Response 401 fields (application/json):

  - `ok` (boolean)
    Indicates whether the request was successful or not

  - `error` (object)

  - `error.code` (string)
    Specifies error code that can be handled programmatically.
    Example: "invalid_parameter"

  - `error.message` (string)
    A detailed description of the occurred error.
    Example: "Invalid parameter provided"

## Response 403 fields (application/json):

  - `ok` (boolean)
    Indicates whether the request was successful or not

  - `error` (object)

  - `error.code` (string)
    Specifies error code that can be handled programmatically.
    Example: "invalid_parameter"

  - `error.message` (string)
    A detailed description of the occurred error.
    Example: "Invalid parameter provided"

## Response 422 fields (application/json):

  - `ok` (boolean)
    Indicates whether the request was successful or not

  - `error` (object)

  - `error.code` (string)
    Specifies error code that can be handled programmatically.
    Example: "invalid_parameter"

  - `error.message` (string)
    A detailed description of the occurred error.
    Example: "Invalid parameter provided"

## Response 500 fields (application/json):

  - `ok` (boolean)
    Indicates whether the request was successful or not

  - `error` (object)

  - `error.code` (string)
    Specifies error code that can be handled programmatically.
    Example: "invalid_parameter"

  - `error.message` (string)
    A detailed description of the occurred error.
    Example: "Invalid parameter provided"