Skip to main content
POST
Post Production Batch

Authorizations

Authorization
string
header
required

A JWT Bearer token header for authentication and authorization, in the format Authorization: Bearer <token>

Headers

x-client-secret
string
required

A secret token identifying the client connecting to the API

Example:

"Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"

Body

application/json
ended_at
string<date-time>
required

The date and time at which production of this production batch was completed

facility_id
string
required

The facility where the production batch was created

Required string length: 20 - 37
Examples:

"fcl_1G8QT5ZAB1S0XSDW"

"fcl_1E384BDCGSBXNNZZ"

feedstock_type_ids
string[]
required

The kinds of feedstock used to create this production batch

Required string length: 20 - 37
kind
enum<string>
required

The kind of production batch

Available options:
biochar
mass
ScalarQuantity · object
required
started_at
string<date-time>
required

The date and time at which production of this production batch was started

supplier_reference_id
string
required

A string that must be unique for all resources created by a specific supplier. It can be used by a client to identify the correct objects in their system.

Required string length: 1 - 200
display_name
string | null

The display name for this production batch. If not provided, one will be auto-generated from the facility name

Required string length: 1 - 150

Response

Successful Response

display_name
string
required
ended_at
string<date-time>
required
facility_id
string
required
Required string length: 20 - 37
Examples:

"fcl_1G8QT5ZAB1S0XSDW"

"fcl_1E384BDCGSBXNNZZ"

feedstock_type_ids
string[]
required
Required string length: 20 - 37
id
string
required
Required string length: 20 - 37
Examples:

"ptb_1GAFJ4C051S06E0Z"

"ptb_1FQVMJYTASBXSZT8"

kind
enum<string>
required
Available options:
biochar
mass
ScalarQuantity · object
required
started_at
string<date-time>
required
supplier_reference_id
string | null
required

A string that must be unique for all resources created by a specific supplier. It can be used by a client to identify the correct objects in their system.

Required string length: 1 - 200
uploaded_at
string<date-time>
required