products
- products/configuration
- products/configuration/types
- GET products/configuration/types/show — This method returns information related with a product type. A single product type is returned by each call
- POST products/configuration/types/create — This method creates a new product type that will be allowed to be used by products
- GET products/configuration/types/list — This method returns the product types that are allowed to be used by products. Multiple product types are returned by each call
- POST products/configuration/types/update — This method updates an existing product type. A single product type can be updated by each call. Fields which are not specified are not updated at all. Fields which are specified as null will be set as null.
- products/configuration/categories
- POST products/configuration/categories/update — This method updates an existing product category. A single product category can be updated by each call. Fields which are not specified are not updated at all. Fields which are specified as null will be set as null.
- GET products/configuration/categories/list — This method returns the product categories that are allowed to be used by products. Multiple product categories are returned by each call
- GET products/configuration/categories/show — This method returns information related with a product category. A single product category is returned by each call
- POST products/configuration/categories/create — This method creates a new product category that will be allowed to be used by products
- products/configuration/brands
- POST products/configuration/brands/update — This method updates an existing product brand. A single product brand can be updated by each call. Fields which are not specified are not updated at all. Fields which are specified as null will be set as null.
- GET products/configuration/brands/list — This method returns the product brands that are allowed to be used by products. Multiple product brands are returned by each call
- POST products/configuration/brands/create — This method creates a new product brand that will be allowed to be used by products
- GET products/configuration/brands/show — This method returns information related with a product brand. A single product brand is returned by each call
- products/configuration/families
- POST products/configuration/families/create — This method creates a new product family that will be allowed to be used by products
- POST products/configuration/families/update — This method updates an existing product family. A single product family can be updated by each call. Fields which are not specified are not updated at all. Fields which are specified as null will be set as null.
- GET products/configuration/families/show — This method returns information related with a product family. A single product family is returned by each call
- GET products/configuration/families/list — This method returns the product families that are allowed to be used by products. Multiple product families are returned by each call
- products/configuration/meter_reading
- GET products/configuration/meter_reading/types/list — This method returns information related with meter reading types. Multiple meter reading types are returned by each call
- GET products/configuration/meter_reading/units_of_measurement/list — This method returns the units of measurement that are allowed to be used in the system by the Meter Reading Types. Multiple units of measurement are returned by each call
- GET products/configuration/meter_reading/types/show — This method returns information related with a meter reading type. A single meter reading type is returned by each call
- products/configuration/types
- products/images
- GET products/images/list — This method is used to retrieve the images of a product. Multiple product images can be retrieved through each call
- POST products/images/add — This method is used to add a new product image or replace an existing one on an existing product. A single product can be updated through each call. Each product can have up to four product images. This Web API method requires a multipart/form-data post, as defined in RFC 1867. There are many libraries available that can be used in order to submit multipart/form-data posts (for example MultipartEntity http://hc.apache.org/httpcomponents-client-ga/httpmime/apidocs/org/apache/http/entity/mime/Mult
- POST products/images/remove — This method is used to remove an image from a product. A single image can be removed through each call
- GET products/list — This method returns information related with products. Multiple products are returned by each call
- GET products/show — This method returns information related with a product. Single product is returned by each call
- GET products/performance_show — This method returns information related with the performance of a product. The performance of a single product is returned by each call. It is only applicable for products of classification SERVICES with service type TERMED or USAGE, or for products of classification PHYSICALGOODS
- GET products/validate_product_code — This method returns if the product code is in a valid format
- GET products/cross_sells/list — This method returns information related with cross-sell products. Multiple products are returned by each call
- POST products/create — This method creates a product. A single product is created by each call
- POST products/update — This method updates a product. A single product is updated by each call
- POST products/synchronise — This method is used to synchronise products information in CRM.COM with products information that exists in a 3rd party system, within a single Web API method call. Note that the maximum number of products to be synchronised is 1000