api-docs/models/ContractDeliverGood.json
2022-12-07 22:42:01 -08:00

30 lines
819 B
JSON

{
"description": "The details of a delivery contract. Includes the type of good, units needed, and the destination.",
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "The symbol of the trade good to deliver.",
"minLength": 1
},
"destinationSymbol": {
"type": "string",
"description": "The destination where goods need to be delivered.",
"minLength": 1
},
"unitsRequired": {
"type": "integer",
"description": "The number of units that need to be delivered on this contract."
},
"unitsFulfilled": {
"type": "integer",
"description": "The number of units fulfilled on this contract."
}
},
"required": [
"symbol",
"destinationSymbol",
"unitsRequired",
"unitsFulfilled"
]
}