Trading API (1.0.0)

Download OpenAPI specification:Download

contracts

Create a contract

Authorizations:

jwt

Request Body schema: application/json

buyerOrganisationId required	string
buyerOrganisationName	string
businessUnitIds	Array of strings
required	object
required	object

Responses

Request samples

Payload

Content type

application/json

{"buyerOrganisationId": "string",
"buyerOrganisationName": "string",
"businessUnitIds": ["string"
],
"details": {"bidId": "string",
"listingId": "string",
"reference": "string",
"totalWeight": 0,
"priceType": "base",
"totalPrice": {"amount": 0,
"currency": "string"
},
"pricePerUnit": {"amount": 0,
"currency": "string"
},
"contractDateISO": "string",
"movementMonth": {"month": 0,
"year": 0
},
"files": [{"name": "string",
"id": "string",
"url": "string"
}
]
},
"inventory": {"type": "crop",
"harvestYear": "string",
"commodity": {"id": 0,
"type": 0,
"grade": 0,
"variety": "string",
"tags": [0
]
},
"measures": [{"specificationId": 0,
"min": 0,
"max": 0
}
]
}
}

Response samples

Content type

application/json

{"id": "string",
"status": "active",
"businessUnits": [{"id": "string",
"name": "string",
"type": "string"
}
],
"details": {"bidId": "string",
"listingId": "string",
"reference": "string",
"totalWeight": {"name": "string",
"conversion": 0,
"weight": 0
},
"priceType": "base",
"totalPrice": {"amount": 0,
"currency": "string"
},
"pricePerUnit": {"amount": 0,
"currency": "string"
},
"contractDateISO": "string",
"movementMonth": {"month": 0,
"year": 0
},
"files": [{"name": "string",
"id": "string",
"url": "string"
}
]
},
"inventory": {"type": "crop",
"harvestYear": "string",
"commodity": {"commodity": {"id": 0,
"name": "string"
},
"type": {"id": 0,
"name": "string"
},
"grade": {"id": 0,
"name": "string"
},
"variety": "string",
"tags": [0
]
},
"measures": [{"specification": {"id": 0,
"name": "string",
"unit": "string"
},
"min": 0,
"max": 0
}
]
},
"buyer": {"id": "string",
"location": {"what3words": "string",
"address": {"name": "string",
"line1": "string",
"region": "string",
"postcode": "string"
},
"coordinates": {"lat": 0,
"lon": 0
}
},
"countryISO": "GB",
"name": "string",
"status": "active",
"ownerContact": {"id": "string",
"email": "string",
"familyName": "string",
"givenName": "string",
"phone": {"callingCode": "string",
"number": "string"
}
}
}
}

Search contracts

Authorizations:

jwt

query Parameters

limit	integer Limit page size of results
offset	integer Number of results to skip for the current page
sortBy	string Sort results by this field
sortDesc	boolean Sort results descending if true, otherwise ascending
docs	boolean Defaults to true, but if included and set to false, only fitlers will be returned for the search, no documents
format	string Format for the endpoint response, supports JSON (default) or CSV
status	string Filter by status
query	string Free text search field for querying
f:commodity	string Filter by commodity
f:commodityGrade	string Filter records by commodity grade
f:commodityType	string Filter by commodity type
f:commodityVariety	string Filter records by commodity variety
f:harvestYear	string Filter by harvest year
f:businessUnitIds	string Filter by business units
f:tags	string Filter by tags

Responses

Response samples

Content type

application/json

{"docs": {"id": "string",
"status": "active",
"businessUnits": [{"id": "string",
"name": "string",
"type": "string"
}
],
"details": {"bidId": "string",
"listingId": "string",
"reference": "string",
"totalWeight": {"name": "string",
"conversion": 0,
"weight": 0
},
"priceType": "base",
"totalPrice": {"amount": 0,
"currency": "string"
},
"pricePerUnit": {"amount": 0,
"currency": "string"
},
"contractDateISO": "string",
"movementMonth": {"month": 0,
"year": 0
},
"files": [{"name": "string",
"id": "string",
"url": "string"
}
]
},
"inventory": {"type": "crop",
"harvestYear": "string",
"commodity": {"commodity": {"id": 0,
"name": "string"
},
"type": {"id": 0,
"name": "string"
},
"grade": {"id": 0,
"name": "string"
},
"variety": "string",
"tags": [0
]
},
"measures": [{"specification": {"id": 0,
"name": "string",
"unit": "string"
},
"min": 0,
"max": 0
}
]
},
"buyer": {"id": "string",
"location": {"what3words": "string",
"address": {"name": "string",
"line1": "string",
"region": "string",
"postcode": "string"
},
"coordinates": {"lat": 0,
"lon": 0
}
},
"countryISO": "GB",
"name": "string",
"status": "active",
"ownerContact": {"id": "string",
"email": "string",
"familyName": "string",
"givenName": "string",
"phone": {"callingCode": "string",
"number": "string"
}
}
}
},
"custom": {"ranges": [{"type": "month",
"name": "string",
"sold": {"name": "string",
"conversion": 0,
"weight": 0
},
"percentSold": 0,
"averagePrice": {"amount": 0,
"currency": "string"
},
"totalValue": {"amount": 0,
"currency": "string"
}
}
]
},
"totalDocs": 0,
"limit": 0,
"offset": 0,
"clearUrl": "string",
"activeFilters": [{"name": "string",
"clearUrl": "string",
"terms": [{"name": "string",
"clearUrl": "string"
}
]
}
],
"facets": [{"displayName": "string",
"clearUrl": "string",
"disabled": true,
"name": "string",
"selected": true,
"active": true,
"terms": [{"name": "string",
"url": "string",
"hits": "string",
"selected": "string",
"id": "string",
"state": "checked disabled",
"aggregations": {"property1": {"sum": 0,
"min": 0,
"max": 0,
"average": 0
},
"property2": {"sum": 0,
"min": 0,
"max": 0,
"average": 0
}
}
}
]
}
],
"aggregations": [{"name": "string",
"sum": 0,
"min": 0,
"max": 0,
"average": 0,
"count": 0,
"range": "string",
"hits": 0
}
]
}

Update a contract

Authorizations:

jwt

path Parameters

id

required

string

Id of the resource

Request Body schema: application/json

businessUnitIds	Array of strings
required	object

Responses

Request samples

Payload

Content type

application/json

{"businessUnitIds": ["string"
],
"details": {"bidId": "string",
"listingId": "string",
"reference": "string",
"totalWeight": 0,
"priceType": "base",
"totalPrice": {"amount": 0,
"currency": "string"
},
"pricePerUnit": {"amount": 0,
"currency": "string"
},
"contractDateISO": "string",
"movementMonth": {"month": 0,
"year": 0
},
"files": [{"name": "string",
"id": "string",
"url": "string"
}
]
}
}

Response samples

Content type

application/json

{"id": "string",
"status": "active",
"businessUnits": [{"id": "string",
"name": "string",
"type": "string"
}
],
"details": {"bidId": "string",
"listingId": "string",
"reference": "string",
"totalWeight": {"name": "string",
"conversion": 0,
"weight": 0
},
"priceType": "base",
"totalPrice": {"amount": 0,
"currency": "string"
},
"pricePerUnit": {"amount": 0,
"currency": "string"
},
"contractDateISO": "string",
"movementMonth": {"month": 0,
"year": 0
},
"files": [{"name": "string",
"id": "string",
"url": "string"
}
]
},
"inventory": {"type": "crop",
"harvestYear": "string",
"commodity": {"commodity": {"id": 0,
"name": "string"
},
"type": {"id": 0,
"name": "string"
},
"grade": {"id": 0,
"name": "string"
},
"variety": "string",
"tags": [0
]
},
"measures": [{"specification": {"id": 0,
"name": "string",
"unit": "string"
},
"min": 0,
"max": 0
}
]
},
"buyer": {"id": "string",
"location": {"what3words": "string",
"address": {"name": "string",
"line1": "string",
"region": "string",
"postcode": "string"
},
"coordinates": {"lat": 0,
"lon": 0
}
},
"countryISO": "GB",
"name": "string",
"status": "active",
"ownerContact": {"id": "string",
"email": "string",
"familyName": "string",
"givenName": "string",
"phone": {"callingCode": "string",
"number": "string"
}
}
}
}

Delete a contract

Authorizations:

jwt

path Parameters

id

required

string

Id of the resource

Responses

Response samples

Content type

application/json

{"message": "string",
"status": "string"
}

Create or update a contract file

Authorizations:

jwt

path Parameters

id

required

string

Id of the resource

Request Body schema: application/json

required

object or null

name	string
id required	string
url	string or null

Responses

Request samples

Payload

Content type

application/json

{"file": {"name": "string",
"id": "string",
"url": "string"
}
}

Response samples

Content type

application/json

{"id": "string",
"status": "active",
"businessUnits": [{"id": "string",
"name": "string",
"type": "string"
}
],
"details": {"bidId": "string",
"listingId": "string",
"reference": "string",
"totalWeight": {"name": "string",
"conversion": 0,
"weight": 0
},
"priceType": "base",
"totalPrice": {"amount": 0,
"currency": "string"
},
"pricePerUnit": {"amount": 0,
"currency": "string"
},
"contractDateISO": "string",
"movementMonth": {"month": 0,
"year": 0
},
"files": [{"name": "string",
"id": "string",
"url": "string"
}
]
},
"inventory": {"type": "crop",
"harvestYear": "string",
"commodity": {"commodity": {"id": 0,
"name": "string"
},
"type": {"id": 0,
"name": "string"
},
"grade": {"id": 0,
"name": "string"
},
"variety": "string",
"tags": [0
]
},
"measures": [{"specification": {"id": 0,
"name": "string",
"unit": "string"
},
"min": 0,
"max": 0
}
]
},
"buyer": {"id": "string",
"location": {"what3words": "string",
"address": {"name": "string",
"line1": "string",
"region": "string",
"postcode": "string"
},
"coordinates": {"lat": 0,
"lon": 0
}
},
"countryISO": "GB",
"name": "string",
"status": "active",
"ownerContact": {"id": "string",
"email": "string",
"familyName": "string",
"givenName": "string",
"phone": {"callingCode": "string",
"number": "string"
}
}
}
}

Delete a contract file

Authorizations:

jwt

path Parameters

id required	string Id of the resource
fileId required	string File ID

Responses

Response samples

Content type

application/json

{"message": "string",
"status": "string"
}

contract

Get Contract Details

Authorizations:

jwt

path Parameters

id

required

string

Id of the resource

Responses

Response samples

Content type

application/json

{"id": "string",
"status": "active",
"businessUnits": [{"id": "string",
"name": "string",
"type": "string"
}
],
"details": {"bidId": "string",
"listingId": "string",
"reference": "string",
"totalWeight": {"name": "string",
"conversion": 0,
"weight": 0
},
"priceType": "base",
"totalPrice": {"amount": 0,
"currency": "string"
},
"pricePerUnit": {"amount": 0,
"currency": "string"
},
"contractDateISO": "string",
"movementMonth": {"month": 0,
"year": 0
},
"files": [{"name": "string",
"id": "string",
"url": "string"
}
]
},
"inventory": {"type": "crop",
"harvestYear": "string",
"commodity": {"commodity": {"id": 0,
"name": "string"
},
"type": {"id": 0,
"name": "string"
},
"grade": {"id": 0,
"name": "string"
},
"variety": "string",
"tags": [0
]
},
"measures": [{"specification": {"id": 0,
"name": "string",
"unit": "string"
},
"min": 0,
"max": 0
}
]
},
"buyer": {"id": "string",
"location": {"what3words": "string",
"address": {"name": "string",
"line1": "string",
"region": "string",
"postcode": "string"
},
"coordinates": {"lat": 0,
"lon": 0
}
},
"countryISO": "GB",
"name": "string",
"status": "active",
"ownerContact": {"id": "string",
"email": "string",
"familyName": "string",
"givenName": "string",
"phone": {"callingCode": "string",
"number": "string"
}
}
}
}

listings

Create a listing

Authorizations:

jwt

Request Body schema: application/json

businessUnitId required	string or null
required	object
required	object
	Array of objects or null
	Array of objects or null
tags	Array of strings or null

Responses

Request samples

Payload

Content type

application/json

{"businessUnitId": "string",
"details": {"price": {"amount": 0,
"currency": "string"
},
"movementDate": {"start": {"month": 0,
"year": 0
},
"end": {"month": 0,
"year": 0
}
},
"buyerNotes": "string",
"files": [{"name": "string",
"id": "string",
"url": "string"
}
]
},
"inventory": {"type": "crop",
"harvestYear": "string",
"commodity": {"id": 0,
"type": 0,
"grade": 0,
"variety": "string",
"tags": [0
]
},
"weight": {"min": 0,
"max": 0
},
"farmAssured": {"assured": true,
"membershipNumber": "string"
},
"measures": [{"specificationId": 0,
"min": 0,
"max": 0
}
]
},
"marketBuyers": [{"userId": "string",
"organisationId": "string",
"fullName": "string",
"emailAddress": "string",
"authPlatformId": "string",
"mobileNumber": "string"
}
],
"bidAlerts": [{"userId": "string",
"organisationId": "string",
"fullName": "string",
"emailAddress": "string",
"authPlatformId": "string",
"mobileNumber": "string"
}
],
"tags": ["string"
]
}

Response samples

Content type

application/json

{"id": "string",
"status": "active",
"substatus": "unsold",
"business": {"name": "string",
"email": "string",
"phone": "string",
"location": {"what3words": "string",
"address": {"name": "string",
"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"region": "string",
"postcode": "string",
"countryName": "string",
"countryISO": "string"
},
"coordinates": {"lat": 0,
"lon": 0
}
}
},
"details": {"startDateUTC": "string",
"endDateUTC": "string",
"price": {"amount": 0,
"currency": "string"
},
"movementDate": {"start": {"month": 0,
"year": 0
},
"end": {"month": 0,
"year": 0
}
},
"buyerNotes": "string",
"files": [{"name": "string",
"id": "string",
"url": "string"
}
]
},
"inventory": {"type": "crop",
"harvestYear": "string",
"commodity": {"commodity": {"id": 0,
"name": "string"
},
"type": {"id": 0,
"name": "string"
},
"grade": {"id": 0,
"name": "string"
},
"variety": "string",
"tags": [0
]
},
"weight": {"min": {"name": "string",
"conversion": 0,
"weight": 0
},
"max": {"name": "string",
"conversion": 0,
"weight": 0
}
},
"farmAssured": {"assured": true,
"membershipNumber": "string"
}
},
"activeBids": 0
}

Search listings

Authorizations:

jwt

query Parameters

limit	integer Limit page size of results
offset	integer Number of results to skip for the current page
sortBy	string Sort results by this field
sortDesc	boolean Sort results descending if true, otherwise ascending
docs	boolean Defaults to true, but if included and set to false, only fitlers will be returned for the search, no documents
format	string Format for the endpoint response, supports JSON (default) or CSV
status	string Filter by status
f:commodity	string Filter by commodity
f:commodityGrade	string Filter records by commodity grade
f:commodityType	string Filter by commodity type
f:commodityVariety	string Filter records by commodity variety
f:harvestYear	string Filter by harvest year
f:businessUnitIds	string Filter by business units
f:tags	string Filter by tags

Responses

Response samples

Content type

application/json

{"docs": {"id": "string",
"status": "active",
"substatus": "unsold",
"business": {"name": "string",
"email": "string",
"phone": "string",
"location": {"what3words": "string",
"address": {"name": "string",
"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"region": "string",
"postcode": "string",
"countryName": "string",
"countryISO": "string"
},
"coordinates": {"lat": 0,
"lon": 0
}
}
},
"details": {"startDateUTC": "string",
"endDateUTC": "string",
"price": {"amount": 0,
"currency": "string"
},
"movementDate": {"start": {"month": 0,
"year": 0
},
"end": {"month": 0,
"year": 0
}
},
"buyerNotes": "string",
"files": [{"name": "string",
"id": "string",
"url": "string"
}
]
},
"inventory": {"type": "crop",
"harvestYear": "string",
"commodity": {"commodity": {"id": 0,
"name": "string"
},
"type": {"id": 0,
"name": "string"
},
"grade": {"id": 0,
"name": "string"
},
"variety": "string",
"tags": [0
]
},
"weight": {"min": {"name": "string",
"conversion": 0,
"weight": 0
},
"max": {"name": "string",
"conversion": 0,
"weight": 0
}
},
"farmAssured": {"assured": true,
"membershipNumber": "string"
}
},
"activeBids": 0
},
"custom": { },
"totalDocs": 0,
"limit": 0,
"offset": 0,
"clearUrl": "string",
"activeFilters": [{"name": "string",
"clearUrl": "string",
"terms": [{"name": "string",
"clearUrl": "string"
}
]
}
],
"facets": [{"displayName": "string",
"clearUrl": "string",
"disabled": true,
"name": "string",
"selected": true,
"active": true,
"terms": [{"name": "string",
"url": "string",
"hits": "string",
"selected": "string",
"id": "string",
"state": "checked disabled",
"aggregations": {"property1": {"sum": 0,
"min": 0,
"max": 0,
"average": 0
},
"property2": {"sum": 0,
"min": 0,
"max": 0,
"average": 0
}
}
}
]
}
],
"aggregations": [{"name": "string",
"sum": 0,
"min": 0,
"max": 0,
"average": 0,
"count": 0,
"range": "string",
"hits": 0
}
]
}

Close a listing

Authorizations:

jwt

path Parameters

id

required

string

Id of the resource

Responses

Response samples

Content type

application/json

{"id": "string",
"status": "active",
"substatus": "unsold",
"business": {"name": "string",
"email": "string",
"phone": "string",
"location": {"what3words": "string",
"address": {"name": "string",
"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"region": "string",
"postcode": "string",
"countryName": "string",
"countryISO": "string"
},
"coordinates": {"lat": 0,
"lon": 0
}
}
},
"details": {"startDateUTC": "string",
"endDateUTC": "string",
"price": {"amount": 0,
"currency": "string"
},
"movementDate": {"start": {"month": 0,
"year": 0
},
"end": {"month": 0,
"year": 0
}
},
"buyerNotes": "string",
"files": [{"name": "string",
"id": "string",
"url": "string"
}
]
},
"inventory": {"type": "crop",
"harvestYear": "string",
"commodity": {"commodity": {"id": 0,
"name": "string"
},
"type": {"id": 0,
"name": "string"
},
"grade": {"id": 0,
"name": "string"
},
"variety": "string",
"tags": [0
]
},
"weight": {"min": {"name": "string",
"conversion": 0,
"weight": 0
},
"max": {"name": "string",
"conversion": 0,
"weight": 0
}
},
"farmAssured": {"assured": true,
"membershipNumber": "string"
}
},
"activeBids": 0
}

listing

Get Listing Details

Authorizations:

jwt

path Parameters

id

required

string

Id of the resource

Responses

Response samples

Content type

application/json

{"id": "string",
"status": "active",
"substatus": "unsold",
"business": {"name": "string",
"email": "string",
"phone": "string",
"location": {"what3words": "string",
"address": {"name": "string",
"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"region": "string",
"postcode": "string",
"countryName": "string",
"countryISO": "string"
},
"coordinates": {"lat": 0,
"lon": 0
}
}
},
"details": {"startDateUTC": "string",
"endDateUTC": "string",
"price": {"amount": 0,
"currency": "string"
},
"movementDate": {"start": {"month": 0,
"year": 0
},
"end": {"month": 0,
"year": 0
}
},
"buyerNotes": "string",
"files": [{"name": "string",
"id": "string",
"url": "string"
}
]
},
"inventory": {"type": "crop",
"harvestYear": "string",
"commodity": {"commodity": {"id": 0,
"name": "string"
},
"type": {"id": 0,
"name": "string"
},
"grade": {"id": 0,
"name": "string"
},
"variety": "string",
"tags": [0
]
},
"weight": {"min": {"name": "string",
"conversion": 0,
"weight": 0
},
"max": {"name": "string",
"conversion": 0,
"weight": 0
}
},
"farmAssured": {"assured": true,
"membershipNumber": "string"
}
},
"activeBids": 0
}

bids

Create a bid

Authorizations:

jwt

Request Body schema: application/json

listingId required	string
expiresAtUTC required	string
required	Array of objects
required	object
reference	string or null
	Array of objects or null

Responses

Request samples

Payload

Content type

application/json

{"listingId": "string",
"expiresAtUTC": "string",
"options": [{"movementDate": {"month": 0,
"year": 0
},
"pricePerUnit": {"amount": 0,
"currency": "string"
}
}
],
"terms": {"weight": {"min": 0,
"max": 0
},
"paymentDays": 0,
"paymentType": "base",
"haulageType": "ex-farm",
"sellerNotes": "string"
},
"reference": "string",
"files": [{"name": "string",
"id": "string",
"url": "string"
}
]
}

Response samples

Content type

application/json

{"id": "string",
"listingId": "string",
"userId": "string",
"organisationId": "string",
"organisationName": "string",
"createdAtUTC": "string",
"status": "active",
"expiresAtUTC": "string",
"options": [{"id": 0,
"status": "active",
"movementDate": {"month": 0,
"year": 0
},
"pricePerUnit": {"amount": 0,
"currency": "string"
}
}
],
"terms": {"weight": {"min": {"name": "string",
"conversion": 0,
"weight": 0
},
"max": {"name": "string",
"conversion": 0,
"weight": 0
}
},
"paymentDays": 0,
"paymentType": "base",
"haulageType": "ex-farm",
"sellerNotes": "string"
},
"contract": {"files": [{"name": "string",
"id": "string",
"url": "string"
}
],
"reference": "string"
}
}

Search bids

Authorizations:

jwt

query Parameters

limit	integer Limit page size of results
offset	integer Number of results to skip for the current page
sortBy	string Sort results by this field
sortDesc	boolean Sort results descending if true, otherwise ascending
docs	boolean Defaults to true, but if included and set to false, only fitlers will be returned for the search, no documents
format	string Format for the endpoint response, supports JSON (default) or CSV
status	string Filter by status
listingId	string Filter by listing

Responses

Response samples

Content type

application/json

{"docs": {"id": "string",
"listingId": "string",
"userId": "string",
"organisationId": "string",
"organisationName": "string",
"createdAtUTC": "string",
"status": "active",
"expiresAtUTC": "string",
"options": [{"id": 0,
"status": "active",
"movementDate": {"month": 0,
"year": 0
},
"pricePerUnit": {"amount": 0,
"currency": "string"
}
}
],
"terms": {"weight": {"min": {"name": "string",
"conversion": 0,
"weight": 0
},
"max": {"name": "string",
"conversion": 0,
"weight": 0
}
},
"paymentDays": 0,
"paymentType": "base",
"haulageType": "ex-farm",
"sellerNotes": "string"
},
"contract": {"files": [{"name": "string",
"id": "string",
"url": "string"
}
],
"reference": "string"
}
},
"custom": { },
"totalDocs": 0,
"limit": 0,
"offset": 0,
"clearUrl": "string",
"activeFilters": [{"name": "string",
"clearUrl": "string",
"terms": [{"name": "string",
"clearUrl": "string"
}
]
}
],
"facets": [{"displayName": "string",
"clearUrl": "string",
"disabled": true,
"name": "string",
"selected": true,
"active": true,
"terms": [{"name": "string",
"url": "string",
"hits": "string",
"selected": "string",
"id": "string",
"state": "checked disabled",
"aggregations": {"property1": {"sum": 0,
"min": 0,
"max": 0,
"average": 0
},
"property2": {"sum": 0,
"min": 0,
"max": 0,
"average": 0
}
}
}
]
}
],
"aggregations": [{"name": "string",
"sum": 0,
"min": 0,
"max": 0,
"average": 0,
"count": 0,
"range": "string",
"hits": 0
}
]
}

Get Bid Details

Authorizations:

jwt

path Parameters

id

required

string

Id of the resource

Responses

Response samples

Content type

application/json

{"id": "string",
"listingId": "string",
"userId": "string",
"organisationId": "string",
"organisationName": "string",
"createdAtUTC": "string",
"status": "active",
"expiresAtUTC": "string",
"options": [{"id": 0,
"status": "active",
"movementDate": {"month": 0,
"year": 0
},
"pricePerUnit": {"amount": 0,
"currency": "string"
}
}
],
"terms": {"weight": {"min": {"name": "string",
"conversion": 0,
"weight": 0
},
"max": {"name": "string",
"conversion": 0,
"weight": 0
}
},
"paymentDays": 0,
"paymentType": "base",
"haulageType": "ex-farm",
"sellerNotes": "string"
},
"contract": {"files": [{"name": "string",
"id": "string",
"url": "string"
}
],
"reference": "string"
}
}

Update a bid

Withdraws a bid, updates and returns a new bid

Authorizations:

jwt

path Parameters

id

required

string

Id of the resource

Request Body schema: application/json

expiresAtUTC required	string
required	Array of objects
required	object

Responses

Request samples

Payload

Content type

application/json

{"expiresAtUTC": "string",
"options": [{"id": 0,
"movementDate": {"month": 0,
"year": 0
},
"pricePerUnit": {"amount": 0,
"currency": "string"
}
}
],
"terms": {"weight": {"min": 0,
"max": 0
},
"paymentDays": 0,
"paymentType": "base",
"haulageType": "ex-farm",
"sellerNotes": "string"
}
}

Response samples

Content type

application/json

{"id": "string",
"listingId": "string",
"userId": "string",
"organisationId": "string",
"organisationName": "string",
"createdAtUTC": "string",
"status": "active",
"expiresAtUTC": "string",
"options": [{"id": 0,
"status": "active",
"movementDate": {"month": 0,
"year": 0
},
"pricePerUnit": {"amount": 0,
"currency": "string"
}
}
],
"terms": {"weight": {"min": {"name": "string",
"conversion": 0,
"weight": 0
},
"max": {"name": "string",
"conversion": 0,
"weight": 0
}
},
"paymentDays": 0,
"paymentType": "base",
"haulageType": "ex-farm",
"sellerNotes": "string"
},
"contract": {"files": [{"name": "string",
"id": "string",
"url": "string"
}
],
"reference": "string"
}
}

Accepts a bid

Authorizations:

jwt

path Parameters

id

required

string

Id of the resource

Request Body schema: application/json

optionId required	number
weight required	number

Responses

Request samples

Payload

Content type

application/json

{"optionId": 0,
"weight": 0
}

Response samples

Content type

application/json

{"id": "string",
"listingId": "string",
"userId": "string",
"organisationId": "string",
"organisationName": "string",
"createdAtUTC": "string",
"status": "active",
"expiresAtUTC": "string",
"options": [{"id": 0,
"status": "active",
"movementDate": {"month": 0,
"year": 0
},
"pricePerUnit": {"amount": 0,
"currency": "string"
}
}
],
"terms": {"weight": {"min": {"name": "string",
"conversion": 0,
"weight": 0
},
"max": {"name": "string",
"conversion": 0,
"weight": 0
}
},
"paymentDays": 0,
"paymentType": "base",
"haulageType": "ex-farm",
"sellerNotes": "string"
},
"contract": {"files": [{"name": "string",
"id": "string",
"url": "string"
}
],
"reference": "string"
}
}

Withdraws a bid

Authorizations:

jwt

path Parameters

id

required

string

Id of the resource

Responses

Response samples

Content type

application/json

{"id": "string",
"listingId": "string",
"userId": "string",
"organisationId": "string",
"organisationName": "string",
"createdAtUTC": "string",
"status": "active",
"expiresAtUTC": "string",
"options": [{"id": 0,
"status": "active",
"movementDate": {"month": 0,
"year": 0
},
"pricePerUnit": {"amount": 0,
"currency": "string"
}
}
],
"terms": {"weight": {"min": {"name": "string",
"conversion": 0,
"weight": 0
},
"max": {"name": "string",
"conversion": 0,
"weight": 0
}
},
"paymentDays": 0,
"paymentType": "base",
"haulageType": "ex-farm",
"sellerNotes": "string"
},
"contract": {"files": [{"name": "string",
"id": "string",
"url": "string"
}
],
"reference": "string"
}
}

Adds a contract to the bid

Authorizations:

jwt

path Parameters

id

required

string

Id of the resource

Request Body schema: application/json

reference required	string
required	Array of objects or null

Responses

Request samples

Payload

Content type

application/json

{"reference": "string",
"files": [{"name": "string",
"id": "string",
"url": "string"
}
]
}

Response samples

Content type

application/json

{"id": "string",
"listingId": "string",
"userId": "string",
"organisationId": "string",
"organisationName": "string",
"createdAtUTC": "string",
"status": "active",
"expiresAtUTC": "string",
"options": [{"id": 0,
"status": "active",
"movementDate": {"month": 0,
"year": 0
},
"pricePerUnit": {"amount": 0,
"currency": "string"
}
}
],
"terms": {"weight": {"min": {"name": "string",
"conversion": 0,
"weight": 0
},
"max": {"name": "string",
"conversion": 0,
"weight": 0
}
},
"paymentDays": 0,
"paymentType": "base",
"haulageType": "ex-farm",
"sellerNotes": "string"
},
"contract": {"files": [{"name": "string",
"id": "string",
"url": "string"
}
],
"reference": "string"
}
}

Trading service

Ping api

Ping trading api

Responses

Response samples

Content type

application/json

{"message": "string",
"status": "string"
}

Execute event

Execute event in trading module

Authorizations:

jwt

path Parameters

action

required

string

Action to perform

Responses

Response samples

Content type

application/json

{"message": "string",
"status": "string"
}

Update system settings

Change the system settings document in the trading module

Authorizations:

jwt

Request Body schema: application/json

required

object

level required	string
filter required	string or null

Responses

Request samples

Payload

Content type

application/json

{"logging": {"level": "string",
"filter": "string"
}
}

Response samples

Content type

application/json

{"message": "string",
"status": "string"
}