Initiate new orders directly through our API.
The POST SalesOrder endpoint allows you to create and submit new sales orders directly within the FincoEnergies platform. This endpoint is a key component of our API, enabling seamless integration of your procurement processes with our system. By using this endpoint, you can automate the creation of sales orders, ensuring that your transactions are processed quickly and efficiently.
When you submit a sales order through this endpoint, you can include all necessary details such as product information and quantities, ensuring that your order is accurately captured and processed. This functionality is essential for businesses looking to streamline their ordering processes and reduce manual effort, ultimately improving operational efficiency and order accuracy.
Default request:
Parameters:
- No parameters required
Request body:
{
"Reference": "string",
"ProductID": "string",
"EmissionLifecycle": "WtW",
"AmountOfCredits": 0
}
- Reference - this concerns your internal reference, e.g. a PO number.
- ProductID - use the FincoEnergies ProductID. Obtain via the GET ProductCategories API.
- EmissionLifecycle - optional field only applicable for scope 3 insetting. Use "WtW" for well-to-wake reduction or "TtW" for tank-to-wake reductions.
- AmountOfCredits - fill in the amount, in tonnes of CO2eq.
Default response:
200: Default response
{
"Message": "Sales order CM000000 has been received correctly",
"SalesOrder": {
"SalesOrderID": "CM000000",
"Reference": "My first Sales Order",
"AmountOfCredits": 10.001,
"ProductID": "GS001",
"ProductCategory": "GoodShipping Ocean"
}
}
422: Validation error response:
{
"error": "Description of validation error."
}
500: Default error response:
{
"error": "Description of the error(s) that occurred."
}
504: Timeout error response:
{
"error": "Timeout waiting for response"
}