--- updatedAt: 2026-04-23T13:29:19.000Z agentTools: projectIndex: https://developer.xentral.com/llms.txt --- # List parts Returns a list of given Products' Parts # OpenAPI definition ```json { "openapi": "3.0.0", "info": { "title": "Xentral API", "version": "v0.1", "description": "Xentral is an ERP platform.", "contact": { "name": "Xentral", "url": "https://xentral.com", "email": "api@xentral.com" } }, "tags": [ { "name": "Product", "description": "Product represents the services or things given company sells in the business." } ], "components": { "securitySchemes": { "BearerAuth": { "type": "http", "scheme": "bearer", "description": "Bearer token obtained in POST /tokens endpoint or pregenerated in the system." } } }, "security": [ { "BearerAuth": [] } ], "servers": [ { "url": "https://{xentralId}.xentral.biz", "description": "Your Xentral Instance", "variables": { "xentralId": { "default": "xentral" } } }, { "url": "https://{domain}", "description": "Xentral at a custom domain", "variables": { "domain": { "default": "xentral.com" } } } ], "x-readme": { "samples-languages": [] }, "paths": { "/api/v1/products/{id}/parts": { "get": { "tags": [ "Product" ], "operationId": "product.listParts", "summary": "List parts", "description": "Returns a list of given Products' Parts", "parameters": [ { "in": "path", "name": "id", "required": true, "description": "The resource's identifier.", "schema": { "type": "string", "pattern": "\\d+", "example": "17", "description": "Resource identifier." } }, { "in": "query", "name": "page", "required": false, "style": "deepObject", "schema": { "type": "object", "additionalProperties": false, "required": [ "number", "size" ], "properties": { "number": { "type": "string", "pattern": "\\d+", "description": "Page number should be an integer greater than or equal to 1" }, "size": { "type": "string", "pattern": "\\d+", "description": "Page size should usually be an integer between 10 and 50." } } } }, { "name": "order", "in": "query", "style": "deepObject", "schema": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "field": { "type": "string", "enum": [ "product", "productName", "amount" ] }, "dir": { "type": "string", "enum": [ "asc", "desc" ] } } } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string", "pattern": "\\d+", "example": "17", "description": "Resource identifier." }, "amount": { "description": "Amount of the part.", "type": "string", "format": "float", "example": "25.00" }, "product": { "description": "Product details for the part.", "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string", "pattern": "\\d+", "example": "17", "description": "Resource identifier." }, "name": { "type": "string" }, "number": { "type": "string" } }, "example": { "id": "1", "name": "Product Name", "number": "SKU123456" } }, "reference": { "description": "Reference for the part.", "type": "string", "example": "REF-12345" }, "type": { "description": "Type of the part.", "type": "string", "nullable": true, "enum": [ "shopping part", "information part / service", "provision" ], "example": "provision" }, "createdAt": { "description": "Timestamp of when the part was created.", "type": "string", "format": "date-time", "example": "2021-12-15T11:31:44+01:00" }, "updatedAt": { "description": "Timestamp of when the part was last updated.", "type": "string", "format": "date-time", "example": "2022-12-15T11:31:44+01:00" } } } }, "extra": { "type": "object", "required": [ "page" ], "additionalProperties": false, "description": "Pagination data from the current request.", "properties": { "page": { "description": "The pagination object containing the current page number and size", "type": "object", "required": [ "number", "size" ], "additionalProperties": false, "properties": { "number": { "type": "integer" }, "size": { "type": "integer" } }, "example": { "number": 1, "size": 10 } } }, "example": { "page": { "number": 1, "size": 10 } } } } }, "examples": { "Lists all parts of a given product": { "value": { "data": [ { "id": "1301", "amount": "2.0000", "product": { "id": "1102", "name": "Fabric", "number": "346532" } } ], "extra": { "page": { "number": 1, "size": 10 } } } } } } } }, "401": { "description": "Unable to authenticate the client", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error message explaining why the request failed.", "example": "Missing required scopes: customer:create." } } }, "example": { "message": "Missing required scopes: customer:create." } }, "text/html": { "schema": { "type": "string", "example": "Unauthorized" } } } }, "403": { "description": "IETF RFC 9457 Problem API compliant response", "content": { "application/problem+json": { "schema": { "oneOf": [ { "type": "object", "additionalProperties": false, "required": [ "type", "title", "violations" ], "properties": { "type": { "type": "string", "enum": [ "https://api.xentral.biz/problems/request-validation" ] }, "title": { "type": "string", "minLength": 1, "example": "Request payload validation failed." }, "violations": { "oneOf": [ { "type": "array", "items": { "type": "object", "example": { "username": [ "This value should not be blank." ], "email": [ "This value is not a valid email address." ] } }, "description": "This field will be a mirrored request payload with only invalid fields and values replaced by error messages." }, { "type": "object", "example": { "_": [ "This value should contain at most `9` elements." ] }, "description": "This field will be a mirrored request payload with only invalid fields and values replaced by error messages." } ] } } }, { "type": "object", "additionalProperties": false, "required": [ "type", "title", "messages" ], "properties": { "type": { "type": "string", "enum": [ "https://api.xentral.biz/problems/generic-validation" ] }, "title": { "type": "string", "minLength": 1 }, "messages": { "type": "array", "items": { "type": "string" } } } }, { "type": "object", "additionalProperties": false, "required": [ "type", "title", "messages" ], "properties": { "type": { "type": "string", "enum": [ "https://api.xentral.biz/problems/conflict" ] }, "title": { "type": "string", "minLength": 1 }, "messages": { "type": "array", "items": { "type": "string" } } } }, { "type": "object", "additionalProperties": false, "required": [ "type", "title", "items" ], "properties": { "type": { "type": "string", "enum": [ "https://api.xentral.biz/problems/conflictItems" ] }, "title": { "type": "string", "minLength": 1 }, "items": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "id", "title", "messages" ], "properties": { "id": { "type": "integer" }, "title": { "type": "string", "minLength": 1 }, "messages": { "type": "array", "items": { "type": "string" } } } } } } }, { "type": "object", "additionalProperties": false, "required": [ "type", "title", "scopes" ], "properties": { "type": { "type": "string", "enum": [ "https://developer.xentral.com/reference/problems#token-scopes" ] }, "title": { "type": "string", "minLength": 1 }, "scopes": { "type": "array", "items": { "type": "string" } } } }, { "type": "object", "additionalProperties": false, "required": [ "type", "title", "messages" ], "properties": { "type": { "type": "string", "enum": [ "https://api.xentral.biz/problems/generic-validation" ] }, "title": { "type": "string", "minLength": 1 }, "messages": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } ] } } } }, "429": { "description": "Too many API calls made." } } } } } } ```