Python SDK Resources
Resource clients and endpoint mapping for the planned Python SDK.
Resource methods are domain-oriented wrappers over the REST API. They should not duplicate the API reference; use the linked pages for request and response schemas.
SuppliersClient
| Python method | HTTP endpoint | API reference |
|---|
suppliers.list(...) | GET /api/v1/suppliers | Suppliers |
suppliers.get(id) | GET /api/v1/suppliers/{id} | Suppliers |
suppliers.create(payload) | POST /api/v1/suppliers | Suppliers |
suppliers.update(id, payload) | PATCH /api/v1/suppliers/{id} | Suppliers |
suppliers.delete(id) | DELETE /api/v1/suppliers/{id} | Suppliers |
suppliers.certifications.list(supplier_id=...) | GET /api/v1/supplier-certifications | Supplier Certifications |
suppliers.certifications.create(payload) | POST /api/v1/supplier-certifications | Supplier Certifications |
suppliers.certifications.get(id) | GET /api/v1/supplier-certifications/{id} | Supplier Certifications |
suppliers.certifications.update(id, payload) | PATCH /api/v1/supplier-certifications/{id} | Supplier Certifications |
suppliers.certifications.delete(id) | DELETE /api/v1/supplier-certifications/{id} | Supplier Certifications |
suppliers.upload_document(supplier_id, file, ...) | POST /api/v1/suppliers/{supplierId}/documents | Supplier Documents |
suppliers.upload_policy_document(...) | POST /api/v1/suppliers/{supplierId}/policies/{policyType}/document | Supplier Documents |
suppliers.upload_questionnaire_attachment(...) | POST /api/v1/suppliers/{supplierId}/questionnaire/attachments/{field} | Supplier Documents |
suppliers.upload_compliance_specifications(...) | POST /api/v1/suppliers/{supplierId}/compliance-checklist/specifications-document | Supplier Documents |
suppliers.certifications.attach_document(id, file) | POST /api/v1/supplier-certifications/{id}/document | Supplier Documents |
suppliers.certifications.replace_document(id, file) | PUT /api/v1/supplier-certifications/{id}/document | Supplier Documents |
suppliers.submit_external_wizard(payload, files) | POST /api/v1/external-supplier-wizard/final-submit | External Supplier Wizard |
ProductMaterialsClient
ProductMaterialsClient is a facade for product catalog and textile material APIs.
| Python method | HTTP endpoint | API reference |
|---|
product_materials.supplier_products.list(...) | GET /api/v1/supplier/products | Supplier Products |
product_materials.supplier_products.create(payload) | POST /api/v1/supplier/products | Supplier Products |
product_materials.supplier_products.get(id) | GET /api/v1/supplier/products/{id} | Supplier Products |
product_materials.supplier_products.update(id, payload) | PATCH /api/v1/supplier/products/{id} | Supplier Products |
product_materials.supplier_products.delete(id) | DELETE /api/v1/supplier/products/{id} | Supplier Products |
product_materials.company_products.list(...) | GET /api/v1/company/products | Company Products |
product_materials.company_products.create(payload) | POST /api/v1/company/products | Company Products |
product_materials.company_products.get(id) | GET /api/v1/company/products/{id} | Company Products |
product_materials.company_products.update(id, payload) | PATCH /api/v1/company/products/{id} | Company Products |
product_materials.company_products.delete(id) | DELETE /api/v1/company/products/{id} | Company Products |
product_materials.fabrics.* | /api/v1/textile/fabrics | Textile Fabrics |
product_materials.yarns.* | /api/v1/textile/yarns | Textile Yarns |
product_materials.fibers.* | /api/v1/textile/fibers | Textile Fibers |
ChemicalsClient
| Python method | HTTP endpoint | API reference |
|---|
chemicals.list(zdhc_level=...) | GET /api/v1/chemicals | Chemicals |
chemicals.get(id) | GET /api/v1/chemicals/{id} | Chemicals |
chemicals.create(payload) | POST /api/v1/chemicals | Chemicals |
chemicals.update(id, payload) | PATCH /api/v1/chemicals/{id} | Chemicals |
chemicals.delete(id) | DELETE /api/v1/chemicals/{id} | Chemicals |
PurchasesClient
| Python method | HTTP endpoint | API reference |
|---|
purchases.list(status=..., supplier_id=...) | GET /api/v1/purchases | Purchases |
purchases.get(id) | GET /api/v1/purchases/{id} | Purchases |
purchases.create(payload) | POST /api/v1/purchases | Purchases |
purchases.update(id, payload) | PATCH /api/v1/purchases/{id} | Purchases |
purchases.delete(id) | DELETE /api/v1/purchases/{id} | Purchases |
purchases.transition(id, payload) | POST /api/v1/purchases/{id}/transition | Purchases |
purchases.logs(id) | GET /api/v1/purchases/{id}/logs | Purchases |
purchases.documents.list(purchase_id) | GET /api/v1/purchases/{purchaseId}/documents | Purchase Documents |
purchases.documents.upload(purchase_id, category, file) | POST /api/v1/purchases/{purchaseId}/documents | Purchase Documents |
purchases.documents.presign(purchase_id, payload) | POST /api/v1/purchases/{purchaseId}/documents/presign | Purchase Documents |
purchases.documents.complete(purchase_id, document_id, payload) | POST /api/v1/purchases/{purchaseId}/documents/{documentId}/complete | Purchase Documents |
purchases.documents.delete(purchase_id, document_id) | DELETE /api/v1/purchases/{purchaseId}/documents/{documentId} | Purchase Documents |
DocumentsClient
| Python method | HTTP endpoint | API reference |
|---|
documents.list(...) | GET /api/v1/documents | Documents |
documents.upload(file, metadata) | POST /api/v1/documents | Documents |
documents.presign(payload) | POST /api/v1/documents/presign | Documents |
documents.get(id) | GET /api/v1/documents/{id} | Documents |
documents.download(id, destination=None) | GET /api/v1/documents/{id}/download | Documents |
documents.complete(id, payload) | POST /api/v1/documents/{id}/complete | Documents |
documents.delete(id) | DELETE /api/v1/documents/{id} | Documents |
TraceabilityClient
| Python method | HTTP endpoint | API reference |
|---|
traceability.product_journeys.stage_types() | GET /api/v1/product/traceability/stage-types | Product Traceability |
traceability.product_journeys.list(...) | GET /api/v1/product/traceability | Product Traceability |
traceability.product_journeys.create(payload) | POST /api/v1/product/traceability | Product Traceability |
traceability.product_journeys.get(id) | GET /api/v1/product/traceability/{id} | Product Traceability |
traceability.product_journeys.update(id, payload) | PATCH /api/v1/product/traceability/{id} | Product Traceability |
traceability.product_journeys.delete(id) | DELETE /api/v1/product/traceability/{id} | Product Traceability |
traceability.product_journeys.add_stage(id, payload) | POST /api/v1/product/traceability/{id}/stages | Product Traceability |
traceability.product_journeys.update_stage(stage_id, payload) | PATCH /api/v1/product/traceability/stages/{stageId} | Product Traceability |
traceability.product_journeys.delete_stage(stage_id) | DELETE /api/v1/product/traceability/stages/{stageId} | Product Traceability |
traceability.batch_records.list(...) | GET /api/v1/traceability | Traceability Records |
traceability.batch_records.create(payload) | POST /api/v1/traceability | Traceability Records |
traceability.batch_records.get(id) | GET /api/v1/traceability/{id} | Traceability Records |
traceability.batch_records.update(id, payload) | PATCH /api/v1/traceability/{id} | Traceability Records |
traceability.batch_records.delete(id) | DELETE /api/v1/traceability/{id} | Traceability Records |