πProduct
Build templates for automating emission estimations
[Secure] - API Key is required to call all Product endpoints.
Create a new product.
POST
https://api.carbonlink.io/v1/products
Request Body
Name | Type | Description |
---|---|---|
name* | string | Name of product to be created |
shippable | boolean | Whether this product can be shipped or not. Defaults to false. |
skus | string[] | List of IDs to represent this product |
factors | object | This attribute computes the unit emission rate for this Product. Key-value pairs where the key of each pair represents the ID of the Factor to add to this product with a value corresponding to the quantity of the Factor to apply. Example:
|
Update an existing product.
PATCH
https://api.carbonlink.io/v1/products
Path Parameters
Name | Type | Description |
---|---|---|
id* | string | ID of Product to update |
Request Body
Name | Type | Description |
---|---|---|
name | string | Name of product to be updated |
shippable | boolean | Whether this product can be shipped or not. Defaults to false. |
skus | string[] | List of IDs to represent this product. Overwrites previous list of IDs. |
factors | object | This attribute computes the unit emission rate for this Product. Key-value pairs where the key of each pair represents the ID of the Factor to add to this product with a value corresponding to the quantity of the Factor to apply. If a new emission |
Retrieve a product.
GET
https://api.carbonlink.io/v1/products
Path Parameters
Name | Type | Description |
---|---|---|
id* | string | ID of Product to retrieve |
Retrieve all products.
GET
https://api.carbonlink.io/v1/products
Delete a product.
DELETE
https://api.carbonlink.io/v1/products
Path Parameters
Name | Type | Description |
---|---|---|
id* | string | ID of Product to delete |
Last updated