Get purchase orders for the given organization.
GET/partner/v1.0/organizations/:organizationId/purchase-orders
Get purchase orders for the given organization.
Request
Path Parameters
organizationId stringrequired
The ID of the organization in the Carbon Trail platform
Query Parameters
page int32
Default value: 1
The page number to retrieve. Defaults to 1.
pageSize int32
Default value: 10
The number of purchase orders to retrieve per page. Defaults to 10.
$filter string
An OData $filter expression. Results can be filtered by sku,
articleNumber, purchasedOrderNumber, amount, status,
location/countryName, or an external ID using externalId/{Name}.
Example: $filter=sku eq 'SKU-123' and amount gt 0 and externalId/SAP eq 'PO-123'
Responses
- 200
- 400
OK
- text/plain
- application/json
- text/json
- Schema
- Example (from schema)
Schema
data object[]nullable
The list of items for the current page.
page int32
The current page number (1-indexed).
pageSize int32
The number of items per page.
totalCount int64
The total number of items across all pages.
{
"data": [
{
"category": "Energy",
"id": "string",
"inventoryId": "string",
"subsidiaryId": "string",
"location": {
"id": "loc-12345",
"city": "Paris",
"country": "FR",
"countryName": "France",
"continent": "Europe",
"latitude": 48.8566,
"longitude": 2.3522
},
"useStartTimestamp": "2024-07-29T15:51:28.071Z",
"useEndTimestamp": "2024-07-29T15:51:28.071Z",
"source": "Real Data",
"supplierId": "string",
"supplierName": "string",
"supplierLocation": {
"id": "loc-12345",
"city": "Paris",
"country": "FR",
"countryName": "France",
"continent": "Europe",
"latitude": 48.8566,
"longitude": 2.3522
},
"facilityId": "string",
"supplierFacilityId": "string",
"notes": "string",
"customFieldValues": [
{
"type": "Text",
"customFieldId": "string"
},
{
"type": "Text",
"customFieldId": "string",
"value": "string"
},
{
"type": "Text",
"customFieldId": "string",
"value": "string"
},
{
"type": "Text",
"customFieldId": "string",
"values": [
"string"
]
}
],
"amount": 0,
"unit": "string",
"invoiceNumber": "string",
"preCalculatedEmissions": 0,
"externalIds": [
{
"name": "string",
"value": "string"
}
],
"ownership": "Owned",
"emissions": [
{
"id": "string",
"created": "2024-07-29T15:51:28.071Z",
"emissions": 0,
"activityId": "string",
"inventoryId": "string",
"activityCategory": "Energy",
"useStartTimestamp": "2024-07-29T15:51:28.071Z",
"useEndTimestamp": "2024-07-29T15:51:28.071Z",
"source": "Real Data",
"facilityId": "string",
"supplierId": "string",
"supplierFacilityId": "string",
"subsidiaryId": "string",
"emissionFactorId": "string",
"emissionFactorSource": "string",
"emissionFactorType": "Default",
"emissionScope": "Scope 1",
"scope3Category": "3.1 Purchased Goods and services",
"accountingMethod": "Location Based",
"primaryDataShare": 0,
"emissionFactorName": "string",
"emissionFactorValue": {
"value": 0,
"unit": "string"
},
"location": {
"id": "loc-12345",
"city": "Paris",
"country": "FR",
"countryName": "France",
"continent": "Europe",
"latitude": 48.8566,
"longitude": 2.3522
}
}
],
"created": "2024-07-29T15:51:28.071Z",
"updated": "2024-07-29T15:51:28.071Z",
"type": "string",
"dataProvider": "string",
"purchasedGoodCategory": "string",
"sku": "string",
"articleNumber": "string",
"purchasedOrderNumber": "string",
"emissionFactors": [
{
"scope3Category": "3.1 Purchased Goods and services",
"value": 0
}
],
"similarProductId": "string",
"documents": [
"string"
]
}
],
"page": 1,
"pageSize": 100,
"totalCount": 250
}
- Schema
- Example (from schema)
Schema
data object[]nullable
The list of items for the current page.
page int32
The current page number (1-indexed).
pageSize int32
The number of items per page.
totalCount int64
The total number of items across all pages.
{
"data": [
{
"category": "Energy",
"id": "string",
"inventoryId": "string",
"subsidiaryId": "string",
"location": {
"id": "loc-12345",
"city": "Paris",
"country": "FR",
"countryName": "France",
"continent": "Europe",
"latitude": 48.8566,
"longitude": 2.3522
},
"useStartTimestamp": "2024-07-29T15:51:28.071Z",
"useEndTimestamp": "2024-07-29T15:51:28.071Z",
"source": "Real Data",
"supplierId": "string",
"supplierName": "string",
"supplierLocation": {
"id": "loc-12345",
"city": "Paris",
"country": "FR",
"countryName": "France",
"continent": "Europe",
"latitude": 48.8566,
"longitude": 2.3522
},
"facilityId": "string",
"supplierFacilityId": "string",
"notes": "string",
"customFieldValues": [
{
"type": "Text",
"customFieldId": "string"
},
{
"type": "Text",
"customFieldId": "string",
"value": "string"
},
{
"type": "Text",
"customFieldId": "string",
"value": "string"
},
{
"type": "Text",
"customFieldId": "string",
"values": [
"string"
]
}
],
"amount": 0,
"unit": "string",
"invoiceNumber": "string",
"preCalculatedEmissions": 0,
"externalIds": [
{
"name": "string",
"value": "string"
}
],
"ownership": "Owned",
"emissions": [
{
"id": "string",
"created": "2024-07-29T15:51:28.071Z",
"emissions": 0,
"activityId": "string",
"inventoryId": "string",
"activityCategory": "Energy",
"useStartTimestamp": "2024-07-29T15:51:28.071Z",
"useEndTimestamp": "2024-07-29T15:51:28.071Z",
"source": "Real Data",
"facilityId": "string",
"supplierId": "string",
"supplierFacilityId": "string",
"subsidiaryId": "string",
"emissionFactorId": "string",
"emissionFactorSource": "string",
"emissionFactorType": "Default",
"emissionScope": "Scope 1",
"scope3Category": "3.1 Purchased Goods and services",
"accountingMethod": "Location Based",
"primaryDataShare": 0,
"emissionFactorName": "string",
"emissionFactorValue": {
"value": 0,
"unit": "string"
},
"location": {
"id": "loc-12345",
"city": "Paris",
"country": "FR",
"countryName": "France",
"continent": "Europe",
"latitude": 48.8566,
"longitude": 2.3522
}
}
],
"created": "2024-07-29T15:51:28.071Z",
"updated": "2024-07-29T15:51:28.071Z",
"type": "string",
"dataProvider": "string",
"purchasedGoodCategory": "string",
"sku": "string",
"articleNumber": "string",
"purchasedOrderNumber": "string",
"emissionFactors": [
{
"scope3Category": "3.1 Purchased Goods and services",
"value": 0
}
],
"similarProductId": "string",
"documents": [
"string"
]
}
],
"page": 1,
"pageSize": 100,
"totalCount": 250
}
- Schema
- Example (from schema)
Schema
data object[]nullable
The list of items for the current page.
page int32
The current page number (1-indexed).
pageSize int32
The number of items per page.
totalCount int64
The total number of items across all pages.
{
"data": [
{
"category": "Energy",
"id": "string",
"inventoryId": "string",
"subsidiaryId": "string",
"location": {
"id": "loc-12345",
"city": "Paris",
"country": "FR",
"countryName": "France",
"continent": "Europe",
"latitude": 48.8566,
"longitude": 2.3522
},
"useStartTimestamp": "2024-07-29T15:51:28.071Z",
"useEndTimestamp": "2024-07-29T15:51:28.071Z",
"source": "Real Data",
"supplierId": "string",
"supplierName": "string",
"supplierLocation": {
"id": "loc-12345",
"city": "Paris",
"country": "FR",
"countryName": "France",
"continent": "Europe",
"latitude": 48.8566,
"longitude": 2.3522
},
"facilityId": "string",
"supplierFacilityId": "string",
"notes": "string",
"customFieldValues": [
{
"type": "Text",
"customFieldId": "string"
},
{
"type": "Text",
"customFieldId": "string",
"value": "string"
},
{
"type": "Text",
"customFieldId": "string",
"value": "string"
},
{
"type": "Text",
"customFieldId": "string",
"values": [
"string"
]
}
],
"amount": 0,
"unit": "string",
"invoiceNumber": "string",
"preCalculatedEmissions": 0,
"externalIds": [
{
"name": "string",
"value": "string"
}
],
"ownership": "Owned",
"emissions": [
{
"id": "string",
"created": "2024-07-29T15:51:28.071Z",
"emissions": 0,
"activityId": "string",
"inventoryId": "string",
"activityCategory": "Energy",
"useStartTimestamp": "2024-07-29T15:51:28.071Z",
"useEndTimestamp": "2024-07-29T15:51:28.071Z",
"source": "Real Data",
"facilityId": "string",
"supplierId": "string",
"supplierFacilityId": "string",
"subsidiaryId": "string",
"emissionFactorId": "string",
"emissionFactorSource": "string",
"emissionFactorType": "Default",
"emissionScope": "Scope 1",
"scope3Category": "3.1 Purchased Goods and services",
"accountingMethod": "Location Based",
"primaryDataShare": 0,
"emissionFactorName": "string",
"emissionFactorValue": {
"value": 0,
"unit": "string"
},
"location": {
"id": "loc-12345",
"city": "Paris",
"country": "FR",
"countryName": "France",
"continent": "Europe",
"latitude": 48.8566,
"longitude": 2.3522
}
}
],
"created": "2024-07-29T15:51:28.071Z",
"updated": "2024-07-29T15:51:28.071Z",
"type": "string",
"dataProvider": "string",
"purchasedGoodCategory": "string",
"sku": "string",
"articleNumber": "string",
"purchasedOrderNumber": "string",
"emissionFactors": [
{
"scope3Category": "3.1 Purchased Goods and services",
"value": 0
}
],
"similarProductId": "string",
"documents": [
"string"
]
}
],
"page": 1,
"pageSize": 100,
"totalCount": 250
}
Bad Request
- text/plain
- application/json
- text/json
- Schema
- Example (from schema)
Schema
type stringnullable
title stringnullable
status int32nullable
detail stringnullable
instance stringnullable
property name* any
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string"
}
- Schema
- Example (from schema)
Schema
type stringnullable
title stringnullable
status int32nullable
detail stringnullable
instance stringnullable
property name* any
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string"
}
- Schema
- Example (from schema)
Schema
type stringnullable
title stringnullable
status int32nullable
detail stringnullable
instance stringnullable
property name* any
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string"
}
Loading...