List Sold Products
const options = {
method: 'GET',
headers: {'x-api-key': '<x-api-key>', 'x-organization-id': '<x-organization-id>'}
};
fetch('https://api.dcycle.io/v1/sold-products/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.dcycle.io/v1/sold-products/"
headers = {
"x-api-key": "<x-api-key>",
"x-organization-id": "<x-organization-id>"
}
response = requests.get(url, headers=headers)
print(response.text)curl --request GET \
--url https://api.dcycle.io/v1/sold-products/ \
--header 'x-api-key: <x-api-key>' \
--header 'x-organization-id: <x-organization-id>'{
"items": {
"product_id": "<string>",
"product_name": "<string>",
"organization_id": "<string>",
"organization_name": "<string>"
}
}List Sold Products
Retrieve all sold products for your organization with optional filtering
GET
/
v1
/
sold-products
/
List Sold Products
const options = {
method: 'GET',
headers: {'x-api-key': '<x-api-key>', 'x-organization-id': '<x-organization-id>'}
};
fetch('https://api.dcycle.io/v1/sold-products/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.dcycle.io/v1/sold-products/"
headers = {
"x-api-key": "<x-api-key>",
"x-organization-id": "<x-organization-id>"
}
response = requests.get(url, headers=headers)
print(response.text)curl --request GET \
--url https://api.dcycle.io/v1/sold-products/ \
--header 'x-api-key: <x-api-key>' \
--header 'x-organization-id: <x-organization-id>'{
"items": {
"product_id": "<string>",
"product_name": "<string>",
"organization_id": "<string>",
"organization_name": "<string>"
}
}← Sold Products API
Retrieve all sold products for your organization. Optionally filter by product name.
Request
Headers
string
required
Your API key for authenticationExample:
sk_live_1234567890abcdefstring
required
Your organization UUIDExample:
a8315ef3-dd50-43f8-b7ce-d839e68d51faQuery Parameters
string
Filter products by name (case-insensitive contains match)Example:
"Compressor"boolean
default:"false"
Restrict the read to the organization in
x-organization-id (default). Set true to include
its accepted descendant organizations — the whole business group.Example: trueuuid[]
Group view only: restrict the read to these organizations, intersected with the resolved group
scope. Only meaningful together with
consolidate_group=true. Note the [] suffix — without it
the value is not bound and the list comes back unfiltered.Example: organization_id[]=a8315ef3-dd50-43f8-b7ce-d839e68d51fa&organization_id[]=b7c1...uuid
Project to scope the read perimeter to, when project organization scoping is enabled.Example:
550e8400-e29b-41d4-a716-446655440000boolean
default:"false"
When
true, restrict the read perimeter to the organizations linked to project_id.Example: falseResponse
Returns a list of sold products (HTTP 200).array[object]
Example
curl -X GET "https://api.dcycle.io/v1/sold-products/?name=Compressor" \
-H "x-api-key: ${DCYCLE_API_KEY}" \
-H "x-organization-id: ${DCYCLE_ORG_ID}"
import requests
import os
headers = {
"x-api-key": os.getenv("DCYCLE_API_KEY"),
"x-organization-id": os.getenv("DCYCLE_ORG_ID"),
}
response = requests.get(
"https://api.dcycle.io/v1/sold-products/",
headers=headers,
params={"name": "Compressor"},
)
products = response.json()
for product in products["items"]:
print(f"{product['product_name']} ({product['product_id']})")
const axios = require('axios');
const headers = {
'x-api-key': process.env.DCYCLE_API_KEY,
'x-organization-id': process.env.DCYCLE_ORG_ID,
};
axios.get('https://api.dcycle.io/v1/sold-products/', {
headers,
params: { name: 'Compressor' },
})
.then(response => {
response.data.items.forEach(p => console.log(p.product_name));
});
Successful Response
{
"items": [
{
"product_id": "550e8400-e29b-41d4-a716-446655440000",
"product_name": "Industrial Compressor X200",
"organization_id": "a8315ef3-dd50-43f8-b7ce-d839e68d51fa",
"organization_name": "Acme Manufacturing"
},
{
"product_id": "660f9500-f30c-52e5-b827-557766551111",
"product_name": "Mini Compressor M50",
"organization_id": "a8315ef3-dd50-43f8-b7ce-d839e68d51fa",
"organization_name": "Acme Manufacturing"
}
]
}
Common Errors
401 Unauthorized
Cause: Missing or invalid API key{"detail": "Invalid API key for organization", "code": "INVALID_API_KEY"}
403 Forbidden
Cause: The authenticated user is not a member of the organization{"detail": "Logged User is not Member of Organization", "code": "LOGGED_USER_NOT_MEMBER"}
Related Endpoints
Delete Sold Product
Remove a sold product and all related data
List Periods
Get all periods for a sold product
Was this page helpful?