Through this API you can Manage products and suppliers. Access to this API is restricted to authenticated users. Before accessing this API, first authenticate via the "Account" API. (https://uat-account.authenticateis.com/)
This Python package is automatically generated by the Swagger Codegen project:
- API version: 1.0
- Package version: 1.0.0
- Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegen For more information, please visit https://www.authenticateis.com
Python 2.7 and 3.4+
If the python package is hosted on Github, you can install directly from Github
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)
Then import the package:
import authenticate_supply_chain Install via Setuptools.
python setup.py install --user(or sudo python setup.py install to install the package for all users)
Then import the package:
import authenticate_supply_chainPlease follow the installation procedure and then run the following:
from __future__ import print_function
import time
import authenticate_supply_chain
from authenticate_supply_chain.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = authenticate_supply_chain.AttachmentsApi(authenticate_supply_chain.ApiClient(configuration))
attachment_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str |
try:
# Returns a specified attachment
api_instance.get_attachment(attachment_id)
except ApiException as e:
print("Exception when calling AttachmentsApi->get_attachment: %s\n" % e)All URIs are relative to /
| Class | Method | HTTP request | Description |
|---|---|---|---|
| AttachmentsApi | get_attachment | GET /api/v1/GetAttachment/{attachmentId} | Returns a specified attachment |
| BlobApi | api_v1_blob_post | POST /api/v1/Blob | Posts a file to the given folder path in the Documents storage account |
| BlobApi | get_blob | GET /api/v1/Blob | Get a File identified by its external provider reference |
| CategoriesApi | api_v1_categories_post | POST /api/v1/Categories | Create a new Categories |
| CategoriesApi | delete_category | DELETE /api/v1/Categories/{categoryId} | Delete a Categories. Only empty categories can be deleted. If the Categories contains products or other categories the delete will fail |
| CategoriesApi | get_categories | GET /api/v1/Categories | Returns a list of all categories meeting the request criteria |
| CategoriesApi | get_category | GET /api/v1/Categories/{categoryId} | Returns a specified Categories |
| CategoriesApi | patch_category | PATCH /api/v1/Categories/{categoryId} | Partially update a Categories. Only provided fields will be updated |
| CategoriesApi | update_category | PUT /api/v1/Categories/{categoryId} | Fully update a Categories. All elements must be supplied or fields will be updated to default values |
| CertificatesApi | get_site_certificate | GET /api/v1/Suppliers/{supplierId}/Sites/{siteId}/Certificates/{certificateId} | Returns a specified certificate |
| CertificatesApi | get_site_certificates | GET /api/v1/Suppliers/{supplierId}/Sites/{siteId}/Certificates | Returns a list of all certificates for a site where the certificates meet the request criteria |
| CertificatesApi | get_site_certification_statuses | GET /api/v1/Suppliers/{supplierId}/Sites/{siteId}/CertificateStatus | |
| CompaniesApi | api_v1_companies_post | POST /api/v1/Companies | Create a new Companies |
| CompaniesApi | get_companies | GET /api/v1/Companies | Returns a list of all Companies meeting the request criteria |
| CompaniesApi | get_company | GET /api/v1/Companies/{companyId} | Returns a specified Companies |
| CompaniesApi | search_companies_from_supply_chain | POST /api/v1/Companies/Suppliers/Search | |
| CompanyLicenceRequestsApi | api_v1_companies_company_id_licence_requests_licence_request_id_complete_post | POST /api/v1/Companies/{companyId}/LicenceRequests/{licenceRequestId}/Complete | Sets a company licence request as completed |
| CompanyLicenceRequestsApi | api_v1_companies_company_id_licence_requests_licence_request_id_reject_post | POST /api/v1/Companies/{companyId}/LicenceRequests/{licenceRequestId}/Reject | Sets a company licence request as rejected and sets a reason |
| CompanyLicenceRequestsApi | api_v1_companies_licence_requests_get | GET /api/v1/Companies/LicenceRequests | Returns a list of licence requests for your company |
| CompanyLicenceRequestsApi | api_v1_companies_licence_requests_licence_request_id_get | GET /api/v1/Companies/LicenceRequests/{licenceRequestId} | Returns a licence request assigned to your company |
| CompanyLicenceRequestsApi | create_company_licence_request | POST /api/v1/Companies/{companyId}/LicenceRequests | Create a company licence request |
| CompanyLicenceTypesApi | api_v1_company_licence_types_get | GET /api/v1/CompanyLicenceTypes | Returns a list of company licence types |
| CompanyLicencesApi | api_v1_companies_company_id_licences_get | GET /api/v1/Companies/{companyId}/Licences | Returns a list of licences for a company |
| CompanyLicencesApi | api_v1_companies_company_id_licences_licence_id_put | PUT /api/v1/Companies/{companyId}/Licences/{licenceId} | Fully update a company licence |
| CompanyLicencesApi | create_company_licence | POST /api/v1/Companies/{companyId}/Licences | Create a company licence |
| CompanyLicencesApi | delete_company_licence | DELETE /api/v1/Companies/{companyId}/Licences/{licenceId} | Delete a company licence |
| CompanyLicencesApi | patch_company_licence | PATCH /api/v1/Companies/{companyId}/Licences/{licenceId} | Partially update a company licence. Only provided fields will be updated |
| CompanyRelationshipsApi | get_company_company_relationship | GET /api/v1/CompanyRelationships/{companyId} | Returns a specified company relationship based on viewing company |
| ContactsApi | create_contact | POST /api/v1/Suppliers/{supplierId}/Sites/{siteId}/Contacts | Create a new contact |
| ContactsApi | create_contact_v2 | POST /api/v1/Suppliers/{supplierId}/Contacts | Create a new contact |
| ContactsApi | get_company_contact | GET /api/v1/Suppliers/{supplierId}/Contacts/{contactId} | Returns a specified contact |
| ContactsApi | get_company_contacts | GET /api/v1/Suppliers/{supplierId}/Contacts | Returns a list of all contacts meeting the request criteria |
| ContactsApi | get_contacts | GET /api/v1/Contacts | Returns a list of contacts meeting the request criteria |
| CountriesApi | get_countries | GET /api/v1/Countries | Returns a list of all categories meeting the request criteria |
| CountriesApi | get_country | GET /api/v1/Countries/{countryId} | Returns a specified country |
| CountryEsgScoreDetailsApi | get_country_esg_score_details | GET /api/v1/Countries/{countryId}/CountryEsgSummaries/{summaryId}/CountryEsgScores/{scoreId}/CountryEsgScoreDetails | Returns a list of the esg score details associated with the country esg score |
| CountryEsgScoresApi | get_country_esg_scores | GET /api/v1/Countries/{countryId}/CountryEsgSummaries/{summaryId}/CountryEsgScores | Returns a list of the esg scores associated with the country esg summary |
| CountryEsgSummariesApi | get_country_esg_summaries | GET /api/v1/CountryEsgSummaries | Returns the latest country esg summaries for all countries |
| CountryEsgSummariesApi | get_country_esg_summary | GET /api/v1/Countries/{countryId}/CountryEsgSummaries | Returns a the latest esg summary associated with the country |
| CustomerLinksApi | api_v1_customer_links_product_link_id_accept_post | POST /api/v1/CustomerLinks/{productLinkId}/Accept | Accept an active product link request to your product (also accepts requests for the same product from the same customer) |
| CustomerLinksApi | get_customer_product_link | GET /api/v1/CustomerLinks/{productLinkId} | Returns a specified customer product link |
| CustomerLinksApi | get_customer_product_link_for_product | GET /api/v1/Products/{productId}/CustomerLinks/{productLinkId} | For the product with Id {productId}, return a specified customer product link |
| CustomerLinksApi | get_customer_product_links | GET /api/v1/CustomerLinks | Returns a list of all customer product links meeting the request criteria |
| CustomerLinksApi | get_customer_product_links_for_product | GET /api/v1/Products/{productId}/CustomerLinks | For the product with Id {productId}, return a list of all customer product links meeting the request criteria |
| CustomerLinksApi | remove_customer_product_link_for_product | POST /api/v1/Products/{productId}/CustomerLinks/{productLinkId}/Remove | Remove an active product link request to your product |
| DeclaredSupplyChainApi | create_declared_supply_chain | POST /api/v1/DeclaredSupplyChain/{topLevelProductId} | Create a new Declared Supply Chain |
| DeclaredSupplyChainApi | get_declared_supply_chain | GET /api/v1/DeclaredSupplyChain/{topLevelProductId} | Returns the declared supply chain for a given top level product id |
| DeclaredSupplyChainApi | update_declared_supply_chain | PUT /api/v1/DeclaredSupplyChain/{declaredSupplyChainId} | Update a Declared Supply Chain |
| DeclaredSupplyChainStatusApi | api_v1_declared_supply_chain_declared_supply_chain_id_declared_supply_chain_status_get | GET /api/v1/DeclaredSupplyChain/{declaredSupplyChainId}/DeclaredSupplyChainStatus | Returns a list of all declared supply chains statuses by declared supply chain id. |
| DeclaredSupplyChainStatusApi | api_v1_declared_supply_chain_declared_supply_chain_id_declared_supply_chain_status_post | POST /api/v1/DeclaredSupplyChain/{declaredSupplyChainId}/DeclaredSupplyChainStatus | Create a new Declared Supply Chain Status |
| DocumentsApi | api_v1_document_id_put | PUT /api/v1/{documentId} | Fully update a document. All elements must be supplied or fields will be updated to default values |
| DocumentsApi | api_v1_notes_note_id_documents_post | POST /api/v1/Notes/{noteId}/Documents | Associate a document with a given note |
| NotesApi | get_site_note | GET /api/v1/Suppliers/{supplierId}/Sites/{siteId}/Notes/{noteId} | Returns a specified note |
| NotesApi | get_site_note_count | GET /api/v1/Suppliers/{supplierId}/Sites/{siteId}/Notes/Count | Returns a list of all notes for the given supplier and site |
| NotesApi | get_site_notes | GET /api/v1/Suppliers/{supplierId}/Sites/{siteId}/Notes | Returns a list of all notes meeting the request criteria |
| NotesApi | get_supplier_note | GET /api/v1/Suppliers/{supplierId}/Notes/{noteId} | Returns a specified note |
| NotesApi | get_supplier_notes | GET /api/v1/Suppliers/{supplierId}/Notes | Returns a list of all notes meeting the request criteria |
| OnsCompanyTypesApi | get_company_type | GET /api/v1/OnsCompanyTypes/{onsCompanyTypeId} | Returns a specified ONS company type |
| OnsCompanyTypesApi | get_company_types | GET /api/v1/OnsCompanyTypes | Returns a list of all ONS company types meeting the request criteria |
| OnsCompanyTypesApi | get_company_types_for_sector | GET /api/v1/OnsSectors/{onsSectorId}/OnsCompanyTypes | Returns a list of all ONS company types meeting the request criteria for a give ONS sector |
| OnsCompanyTypesApi | get_ons_sectors | GET /api/v1/OnsSectors | Returns a list of all ONS business sectors meeting the request criteria |
| ProductLineApprovalApi | api_v1_product_line_approval_post | POST /api/v1/ProductLineApproval | Save a new approval record for a product line |
| ProductLineApprovalApi | api_v1_product_line_approval_product_line_approval_id_put | PUT /api/v1/ProductLineApproval/{productLineApprovalId} | Updates a product line approval record. |
| ProductLineApprovalApi | api_v1_product_line_approval_product_line_id_get | GET /api/v1/ProductLineApproval/{productLineId} | Returns a list of all approval records for a product, meeting the request criteria |
| ProductLineApprovalRequestApi | api_v1_product_line_approval_request_post | POST /api/v1/ProductLineApprovalRequest | Save a new approval request for a product line approval |
| ProductLineApprovalRequestApi | api_v1_product_line_approval_request_product_line_approval_id_get | GET /api/v1/ProductLineApprovalRequest/{productLineApprovalId} | Returns a list of all approval requests for a product line approval, meeting the request criteria |
| ProductLineDocumentAssociationApi | api_v1_product_line_document_association_get | GET /api/v1/ProductLineDocumentAssociation | Returns a list of product line document associations. |
| ProductLineDocumentAssociationApi | api_v1_product_line_document_association_product_line_document_association_id_delete | DELETE /api/v1/ProductLineDocumentAssociation/{productLineDocumentAssociationId} | Deletes a product line document association. |
| ProductLineDocumentAssociationApi | api_v1_product_line_product_line_id_product_line_document_association_post | POST /api/v1/ProductLine/{productLineId}/ProductLineDocumentAssociation | Saves a new product line document association. |
| ProductLineOwnersApi | add_owner | POST /api/v1/ProductLine/{productLineId}/ProductLineOwners/{userId} | Associates an Owner with an Inventory Item. |
| ProductLineOwnersApi | delete_owner | DELETE /api/v1/ProductLine/{productLineId}/ProductLineOwners/{userId} | Deletes an Inventory Item Owner |
| ProductLineStatusApi | api_v1_product_line_product_line_id_product_line_status_get | GET /api/v1/ProductLine/{productLineId}/ProductLineStatus | Returns a list of all statuses for a product, meeting the request criteria |
| ProductLineStatusApi | api_v1_product_line_product_line_id_product_line_status_post | POST /api/v1/ProductLine/{productLineId}/ProductLineStatus | Create a new Product Line Status |
| ProductLineVariationsApi | api_v1_product_line_variations_product_line_variation_id_delete | DELETE /api/v1/ProductLineVariations/{productLineVariationId} | Delete a product line variation |
| ProductLineVariationsApi | api_v1_product_line_variations_product_line_variation_id_put | PUT /api/v1/ProductLineVariations/{productLineVariationId} | Fully update a product line variation. All elements must be supplied or fields will be updated to default values |
| ProductLineVariationsApi | api_v1_product_lines_product_line_id_product_line_variations_post | POST /api/v1/ProductLines/{productLineId}/ProductLineVariations | Create a new product line variation. |
| ProductLineVariationsApi | list | GET /api/v1/ProductLineVariations | Returns a list of all variations associated with your company's product lines. |
| ProductLineVariationsApi | list_by_product_line | GET /api/v1/ProductLines/{productLineId}/ProductLineVariations | Returns a list of all variations associated with a product line. |
| ProductLineVersionApi | api_v1_product_line_product_line_id_product_line_version_post | POST /api/v1/ProductLine/{productLineId}/ProductLineVersion | Set a product line as versioned |
| ProductTagsApi | api_v1_product_tags_get | GET /api/v1/ProductTags | Returns a list of all product tags meeting the request criteria |
| ProductTagsApi | api_v1_product_tags_post | POST /api/v1/ProductTags | |
| ProductTagsApi | api_v1_product_tags_product_line_id_get | GET /api/v1/ProductTags/{productLineId} | Returns a list of all product tags for a product, meeting the request criteria |
| ProductTagsApi | api_v1_product_tags_product_line_id_post | POST /api/v1/ProductTags/{productLineId} | |
| ProductTagsApi | delete_tag | DELETE /api/v1/ProductLine/{productLineId}/ProductTags/{tagId} | Deletes a tag associated with a product line. |
| ProductsApi | api_v1_products_post | POST /api/v1/Products | Create a new product. Product Name and product reference together must be unique |
| ProductsApi | api_v1_products_product_id_image_get | GET /api/v1/Products/{productId}/Image | Returns the image for the product |
| ProductsApi | delete_product | DELETE /api/v1/Products/{productId} | Delete a product. Only products with no accepted or pending product links can be deleted. |
| ProductsApi | get_product | GET /api/v1/Products/{productId} | Returns a specified product |
| ProductsApi | get_product_for_category | GET /api/v1/Categories/{categoryId}/Products/{productId} | Returns a specified product in a given category |
| ProductsApi | get_product_status | GET /api/v1/Products/{productId}/Status | Returns the latest status for the product |
| ProductsApi | get_products | GET /api/v1/Products | Returns a list of all products meeting the request criteria |
| ProductsApi | get_products_for_category | GET /api/v1/Categories/{categoryId}/Products | Returns a list of all products meeting the request criteria in this category |
| ProductsApi | patch_product | PATCH /api/v1/Products/{productId} | Partially update a product. Only provided fields will be updated |
| ProductsApi | update_product | PUT /api/v1/Products/{productId} | Fully update a product. All elements must be supplied or fields will be updated to default values |
| RawMaterialAdditionalInformationsApi | api_v1_raw_materials_raw_material_id_raw_material_additional_informations_patch | PATCH /api/v1/RawMaterials/{rawMaterialId}/RawMaterialAdditionalInformations | Partially update an existing raw material additional information. Only provided fields will be updated |
| RawMaterialAdditionalInformationsApi | api_v1_raw_materials_raw_material_id_raw_material_additional_informations_put | PUT /api/v1/RawMaterials/{rawMaterialId}/RawMaterialAdditionalInformations | Update an existing raw material additional information |
| RawMaterialAdditionalInformationsApi | get_raw_material_additional_information | GET /api/v1/RawMaterials/{rawMaterialId}/RawMaterialAdditionalInformations | Returns the rawMaterial additional information for the given raw material |
| RawMaterialAdditionalInformationsApi | save_raw_material_additional_information | POST /api/v1/RawMaterials/{rawMaterialId}/RawMaterialAdditionalInformations | Creates raw material additional information for the given raw material id |
| RawMaterialApprovalApi | delete_approval | DELETE /api/v1/RawMaterials/{rawMaterialId}/Approval | Deletes the approval for the given raw material |
| RawMaterialApprovalApi | get_approval | GET /api/v1/RawMaterials/{rawMaterialId}/Approval | Returns the approval for the given raw material |
| RawMaterialApprovalApi | get_approvals | POST /api/v1/RawMaterials/Approvals | Returns a list of raw material approvals for a list of given raw material ids |
| RawMaterialApprovalApi | save_approval | POST /api/v1/RawMaterials/{rawMaterialId}/Approval | Creates an approval for the given raw material |
| RawMaterialFunctionsApi | api_v1_raw_materials_raw_material_id_raw_material_functions_get | GET /api/v1/RawMaterials/{rawMaterialId}/RawMaterialFunctions | Returns a material function for a given raw material |
| RawMaterialFunctionsApi | list_functions | GET /api/v1/RawMaterialFunctions | Returns a list of raw material functions |
| RawMaterialLogisticsApi | api_v1_raw_materials_raw_material_id_logistics_logistic_id_delete | DELETE /api/v1/RawMaterials/{rawMaterialId}/Logistics/{logisticId} | Delete a raw material logistic |
| RawMaterialLogisticsApi | api_v1_raw_materials_raw_material_id_logistics_post | POST /api/v1/RawMaterials/{rawMaterialId}/Logistics | Create a new logistic for a raw material |
| RawMaterialLogisticsApi | list_logistics | POST /api/v1/RawMaterials/Logistics | Returns a list of all logistics for the given raw material |
| RawMaterialRecordsApi | api_v1_raw_material_records_status_count_get | GET /api/v1/RawMaterialRecords/StatusCount | Returns counts of Raw material records based on the resource parameters |
| RawMaterialRecordsApi | api_v1_raw_materials_raw_material_id_records_post | POST /api/v1/RawMaterials/{rawMaterialId}/Records | Create a raw material record for a raw material |
| RawMaterialRecordsApi | api_v1_raw_materials_raw_material_id_records_raw_material_record_id_delete | DELETE /api/v1/RawMaterials/{rawMaterialId}/Records/{rawMaterialRecordId} | Delete a raw material record. |
| RawMaterialRecordsApi | api_v1_raw_materials_raw_material_id_records_raw_material_record_id_get | GET /api/v1/RawMaterials/{rawMaterialId}/Records/{rawMaterialRecordId} | Returns a specified raw material record |
| RawMaterialRecordsApi | api_v1_raw_materials_raw_material_id_records_raw_material_record_id_put | PUT /api/v1/RawMaterials/{rawMaterialId}/Records/{rawMaterialRecordId} | Fully update a raw material record. All elements must be supplied or fields will be updated to default values |
| RawMaterialRecordsApi | list_all_raw_material_records | GET /api/v1/RawMaterialRecords | Returns a list of Raw material records for the requesting company |
| RawMaterialRecordsApi | list_raw_material_records | GET /api/v1/RawMaterials/{rawMaterialId}/Records | Returns a list of Raw material records for a raw material |
| RawMaterialRelationshipsApi | api_v1_raw_materials_raw_material_id_raw_material_relationships_get | GET /api/v1/RawMaterials/{rawMaterialId}/RawMaterialRelationships | Returns the raw material relationship for the given raw material |
| RawMaterialRelationshipsApi | save_raw_material_relationship | POST /api/v1/RawMaterials/{rawMaterialId}/RawMaterialRelationships | Creates a raw material relationship for the given raw material id |
| RawMaterialsApi | api_v1_raw_materials_raw_material_id_get | GET /api/v1/RawMaterials/{rawMaterialId} | Returns a specified raw material |
| RawMaterialsApi | api_v1_raw_materials_raw_material_id_patch | PATCH /api/v1/RawMaterials/{rawMaterialId} | Partially update a raw material. Only provided fields will be updated |
| RawMaterialsApi | list_raw_materials | GET /api/v1/RawMaterials | Returns a list of Raw materials |
| SearchLookupApi | get_sites_relationships_values | GET /api/v1/SearchLookup/GetSitesRelationshipsValues | Returns a list of all site to company relationships |
| SiteLicenceRequestsApi | api_v1_sites_licence_requests_licence_request_id_get | GET /api/v1/Sites/LicenceRequests/{licenceRequestId} | Returns a licence request assigned to a site on your company |
| SiteLicenceRequestsApi | api_v1_sites_site_id_licence_requests_get | GET /api/v1/Sites/{siteId}/LicenceRequests | Returns a list of licence requests for a site on your company |
| SiteLicenceRequestsApi | api_v1_sites_site_id_licence_requests_licence_request_id_complete_post | POST /api/v1/Sites/{siteId}/LicenceRequests/{licenceRequestId}/Complete | Sets a site licence request as completed |
| SiteLicenceRequestsApi | api_v1_sites_site_id_licence_requests_licence_request_id_reject_post | POST /api/v1/Sites/{siteId}/LicenceRequests/{licenceRequestId}/Reject | Sets a company licence request as rejected and sets a reason |
| SiteLicenceRequestsApi | create_site_licence_request | POST /api/v1/Sites/{siteId}/LicenceRequests | Create a site licence request |
| SiteLicenceTypesApi | api_v1_site_licence_types_get | GET /api/v1/SiteLicenceTypes | Returns a list of site licence types |
| SiteLicencesApi | api_v1_sites_site_id_licences_get | GET /api/v1/Sites/{siteId}/Licences | Returns a list of licences for a site |
| SiteLicencesApi | api_v1_sites_site_id_licences_licence_id_put | PUT /api/v1/Sites/{siteId}/Licences/{licenceId} | Fully update a site licence |
| SiteLicencesApi | create_site_licence | POST /api/v1/Sites/{siteId}/Licences | Create a site licence |
| SiteLicencesApi | delete_site_licence | DELETE /api/v1/Sites/{siteId}/Licences/{licenceId} | Delete a site licence |
| SiteLicencesApi | patch_site_licence | PATCH /api/v1/Sites/{siteId}/Licences/{licenceId} | Partially update a site licence. Only provided fields will be updated |
| SiteRelationshipApi | api_v1_site_relationship_site_id_patch | PATCH /api/v1/SiteRelationship/{siteId} | Partially update a site relationship. Only provided fields will be updated |
| SiteRelationshipApi | api_v1_site_relationship_site_id_post | POST /api/v1/SiteRelationship/{siteId} | Create a new site relationship |
| SiteRelationshipApi | api_v1_site_relationship_site_id_put | PUT /api/v1/SiteRelationship/{siteId} | Update an existing site relationship |
| SiteRelationshipApi | get_all_site_relationship_values | GET /api/v1/SiteRelationship/{siteId}/History | Returns a specified site relationship's values based on viewing company |
| SiteRelationshipApi | get_site_relationship | GET /api/v1/SiteRelationship/{siteId} | Returns a specified site relationship based on viewing company |
| SiteRelationshipCategoriesApi | api_v1_site_relationship_categories_get | GET /api/v1/SiteRelationshipCategories | Returns a list of site relationship categories based on viewing company |
| SiteRelationshipCategoriesApi | api_v1_site_relationship_categories_post | POST /api/v1/SiteRelationshipCategories | Create a new site relationship category |
| SiteRelationshipFunctionsApi | api_v1_site_relationship_functions_get | GET /api/v1/SiteRelationshipFunctions | Returns a list of site relationship functions based on viewing company |
| SiteRelationshipFunctionsApi | api_v1_site_relationship_functions_post | POST /api/v1/SiteRelationshipFunctions | Create a new site relationship function |
| SitesApi | api_v1_company_company_id_sites_post | POST /api/v1/Company/{companyId}/Sites | Add a new site to a company. |
| SitesApi | get_company_sites | GET /api/v1/Company/{companyId}/Sites | Returns a list of all sites for a company - not using supply chain |
| SitesApi | get_site | GET /api/v1/Suppliers/{supplierId}/Sites/{siteId} | Returns a specified site |
| SitesApi | get_sites | GET /api/v1/Sites | Returns a list of all sites meeting the request criteria - not using the supply chain |
| SitesApi | get_sites_from_supply_chain | GET /api/v1/Suppliers/Sites | Returns a list of all sites meeting the request criteria |
| SitesApi | get_supplier_sites | GET /api/v1/Suppliers/{supplierId}/Sites | Returns a list of all sites meeting the request criteria |
| SitesApi | search_sites | POST /api/v1/Sites/Search | Returns a list of all sites meeting the request criteria - not using the supply chain |
| SitesApi | search_sites_from_supply_chain | POST /api/v1/Suppliers/Sites/Search | Returns a list of all sites meeting the request criteria |
| SupplierCodesApi | companies_create_company_supplier_code | POST /api/v1/Companies/{companyId}/SupplierCodes | Create a new supplier code |
| SupplierCodesApi | companies_create_site_supplier_code | POST /api/v1/Companies/{companyId}/Sites/{siteId}/SupplierCodes | Create a new site supplier code |
| SupplierCodesApi | companies_delete_company_supplier_code | DELETE /api/v1/Companies/{companyId}/SupplierCodes/{supplierCodeId} | Delete a supplier code. |
| SupplierCodesApi | companies_delete_site_supplier_code | DELETE /api/v1/Companies/{companyId}/Sites/{siteId}/SupplierCodes/{supplierCodeId} | Delete a site supplier code. |
| SupplierCodesApi | companies_get_company_supplier_code | GET /api/v1/Companies/{companyId}/SupplierCodes/{supplierCodeId} | Returns a specified supplier code |
| SupplierCodesApi | companies_get_company_supplier_codes | GET /api/v1/Companies/{companyId}/SupplierCodes | Returns a list of all Supplier Codes meeting the request criteria |
| SupplierCodesApi | companies_get_site_supplier_code | GET /api/v1/Companies/{companyId}/Sites/{siteId}/SupplierCodes/{supplierCodeId} | Returns a specified site supplier code |
| SupplierCodesApi | companies_get_site_supplier_codes | GET /api/v1/Companies/{companyId}/Sites/{siteId}/SupplierCodes | Returns a list of all site Supplier Codes meeting the request criteria |
| SupplierCodesApi | suppliers_create_company_supplier_code | POST /api/v1/Suppliers/{supplierId}/SupplierCodes | Create a new supplier code |
| SupplierCodesApi | suppliers_create_site_supplier_code | POST /api/v1/Suppliers/{supplierId}/Sites/{siteId}/SupplierCodes | Create a new site supplier code |
| SupplierCodesApi | suppliers_delete_company_supplier_code | DELETE /api/v1/Suppliers/{supplierId}/SupplierCodes/{supplierCodeId} | Delete a supplier code. |
| SupplierCodesApi | suppliers_delete_site_supplier_code | DELETE /api/v1/Suppliers/{supplierId}/Sites/{siteId}/SupplierCodes/{supplierCodeId} | Delete a site supplier code. |
| SupplierCodesApi | suppliers_get_company_supplier_code | GET /api/v1/Suppliers/{supplierId}/SupplierCodes/{supplierCodeId} | Returns a specified supplier code |
| SupplierCodesApi | suppliers_get_company_supplier_codes | GET /api/v1/Suppliers/{supplierId}/SupplierCodes | Returns a list of all Supplier Codes meeting the request criteria |
| SupplierCodesApi | suppliers_get_site_supplier_code | GET /api/v1/Suppliers/{supplierId}/Sites/{siteId}/SupplierCodes/{supplierCodeId} | Returns a specified site supplier code |
| SupplierCodesApi | suppliers_get_site_supplier_codes | GET /api/v1/Suppliers/{supplierId}/Sites/{siteId}/SupplierCodes | Returns a list of all site Supplier Codes meeting the request criteria |
| SupplierLinksApi | create_supplier_product_link | POST /api/v1/SupplierLinks | Create a new product link request |
| SupplierLinksApi | create_supplier_product_link_for_product | POST /api/v1/Products/{productId}/SupplierLinks | Create a new product link request |
| SupplierLinksApi | delete_supplier_product_link | DELETE /api/v1/SupplierLinks/{productLinkId} | Delete a product link. Active product links (Pending, Accepted) cannot be deleted |
| SupplierLinksApi | delete_supplier_product_link_for_product | DELETE /api/v1/Products/{productId}/SupplierLinks/{productLinkId} | Delete a product link. Active product links (Pending, Accepted) cannot be deleted |
| SupplierLinksApi | get_supplier_product_link | GET /api/v1/SupplierLinks/{productLinkId} | Returns a specified supplier product link |
| SupplierLinksApi | get_supplier_product_link_for_product | GET /api/v1/Products/{productId}/SupplierLinks/{productLinkId} | For the product with Id {productId}, return a specified supplier product link |
| SupplierLinksApi | get_supplier_product_links | GET /api/v1/SupplierLinks | Returns a list of all supplier product links meeting the request criteria |
| SupplierLinksApi | get_supplier_product_links_for_product | GET /api/v1/Products/{productId}/SupplierLinks | For the product with Id {productId}, return a list of all supplier product links for meeting the request criteria |
| SupplierLinksApi | remove_supplier_product_link | POST /api/v1/SupplierLinks/{productLinkId}/Remove | Remove an active product link request |
| SupplierLinksApi | remove_supplier_product_link_for_product | POST /api/v1/Products/{productId}/SupplierLinks/{productLinkId}/Remove | Remove an active product link request |
| SupplierLinksApi | rescind_supplier_product_link | POST /api/v1/SupplierLinks/{productLinkId}/Rescind | Rescind an active product link request |
| SupplierLinksApi | rescind_supplier_product_link_for_product | POST /api/v1/Products/{productId}/SupplierLinks/{productLinkId}/Rescind | Rescind an active product link request |
| SupplierLinksApi | update_supplier_product_link | PUT /api/v1/SupplierLinks/{productLinkId} | Update a product link |
| SupplierProductCountryDeclarationsApi | api_v1_supplier_product_country_declarations_product_id_post | POST /api/v1/SupplierProductCountryDeclarations/{productId} | Create country declaration for a specified product line |
| SupplierProductCountryDeclarationsApi | get_supplier_product_country_declarations | GET /api/v1/SupplierProductCountryDeclarations/{productId} | Returns declared countries for a specific product line |
| SupplierProductsApi | get_supplier_product | GET /api/v1/Suppliers/{supplierId}/Products/{productId} | Returns a specified supplier product |
| SupplierProductsApi | get_supplier_products | GET /api/v1/Suppliers/{supplierId}/Products | Returns a list of all products meeting the request criteria |
| SuppliersApi | get_supplier | GET /api/v1/Suppliers/{supplierId} | Returns a specified supplier |
| SuppliersApi | get_suppliers | GET /api/v1/Suppliers | Returns a list of all Suppliers meeting the request criteria |
| SuppliersApi | search_suppliers | POST /api/v1/Suppliers/Search | Returns a list of all Suppliers meeting the request criteria |
| SupplyChainApi | get_supply_chain | GET /api/v1/SupplyChain/{entityId} | Returns the supply chain for a given entity id e.g. product line id |
| SupplyChainApi | get_supply_chain_site_locations | GET /api/v1/SupplyChain/{entityId}/SiteLocations | Returns the supply chain site locations for a given entity id e.g. product line id |
| SupplyChainSnapshotApi | synchronise_supply_chain_snapshots_for_product | GET /api/v1/SupplyChainSnapshot/Synchronise/Product/{productId} | Update the supply chain using a specific product id |
| SupplyChainSnapshotApi | synchronise_supply_chain_snapshots_for_product_link | GET /api/v1/SupplyChainSnapshot/Synchronise/ProductLink/{productLinkId} | Update the supply chain using a specific product link id |
| UsersApi | get_company_user | GET /api/v1/Suppliers/{supplierId}/Users/{userId} | Returns a specified user |
| UsersApi | get_company_users | GET /api/v1/Suppliers/{supplierId}/Users | Returns a list of all users meeting the request criteria |
| UsersApi | get_users | GET /api/v1/Users | Returns a list of users meeting the request criteria |
- AddressDto
- CategoryDto
- CategoryForCreationDto
- CategoryForUpdateDto
- CertificateDto
- CompanyDto
- CompanyForCreationDto
- CompanyFunctionDto
- CompanyRelationshipDto
- CompanyResourceParameters
- CompanySiteRelationshipCurrencyEnum
- ContactDto
- ContactForCreationDto
- CountryDto
- CountryEsgScoreDetailDto
- CountryEsgScoreDto
- CountryEsgScoreThresholdDto
- CountryEsgSummaryDto
- CustomerProductLinkDto
- DeclaredSupplyChainDto
- DeclaredSupplyChainForCreationDto
- DeclaredSupplyChainForUpdateDto
- DeclaredSupplyChainStatusDto
- DeclaredSupplyChainStatusEnum
- DocumentDto
- DocumentForCreationDto
- DocumentForUpdateDto
- EntitySupplyChainDto
- EntitySupplyChainSiteDto
- EntitySupplyChainSiteLocationDto
- EsgOutcomeEnum
- EsgStatusEnum
- JobTitleEnum
- LicenceDto
- LicenceRequestDto
- LicenceRequestDtoForCreation
- LicenceRequestEnum
- LicenceRequestReasonDto
- LicenceRequestReasonEnum
- LicenceTypeDto
- NotMappingProductLineReasonEnum
- NoteDto
- OnsCompanyTypeDto
- OnsSectorDto
- OnsSiteOperationDto
- Operation
- OperationType
- ParentTypeEnum
- ProblemDetails
- ProductDto
- ProductForCreationDto
- ProductForUpdateDto
- ProductLineApprovalDto
- ProductLineApprovalRequestDto
- ProductLineApprovalRequestResponseEnum
- ProductLineCountryDeclarationDto
- ProductLineCountryDeclarationForCreationDto
- ProductLineDocumentAssociationDto
- ProductLineOwnerDto
- ProductLineStatusDto
- ProductLineStatusEnum
- ProductLineStatusForCreationDto
- ProductLineVariationDto
- ProductLineVariationForManipulationDto
- ProductLinkAcceptDto
- ProductLinkRemovalDto
- ProductSiteDto
- ProductSiteForManipulationDto
- ProductTagDto
- RawMaterialAdditionalInformationDto
- RawMaterialApprovalDto
- RawMaterialDto
- RawMaterialFunctionDto
- RawMaterialLogisticDto
- RawMaterialLogisticForCreationDto
- RawMaterialLogisticsTypeEnum
- RawMaterialRecordDocumentDto
- RawMaterialRecordDto
- RawMaterialRecordForCreationDto
- RawMaterialRecordForUpdateDto
- RawMaterialRecordStatusEnum
- RawMaterialRecordSugarDataDto
- RawMaterialRelationshipDto
- RawMaterialResourceParameters
- RegionDto
- RelationshipRiskEnum
- RelationshipStatusEnum
- SearchLookupDto
- SiteCertificationStatusDto
- SiteDto
- SiteRelationshipCategoryDto
- SiteRelationshipDto
- SiteRelationshipForManipulationDto
- SiteRelationshipFunctionDto
- SiteRelationshipValuesDto
- SiteResourceParametersExtended
- SiteSearchTypeEnum
- SiteSupplyChainResourceParameters
- StorageAccountEnum
- Stream
- SupplierCodeDto
- SupplierCodeForCreationDto
- SupplierDto
- SupplierLinkSiteDto
- SupplierProductDto
- SupplierProductLinkDto
- SupplierProductLinkForCreationDto
- SupplierProductLinkForUpdateDto
- SupplierResourceParameters
- TagDto
- UserDto
- V1BlobBody
- V1BlobBody1
All endpoints do not require authorization.