> ## Documentation Index
> Fetch the complete documentation index at: https://developer.worldly.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Scope 3 Data Dictionary

> The Scope 3 Data Dictionary includes definitions of commonly used metadata, impacts, purchase orders and facility linking

## Product/Material Metadata

General information returned with all products, materials, components and packaging. Also included are product-level logistics tied to a percentage of unowned transportation, distribution and retail energy.

| Field                            | Description                                                                                                                                           | Type                          |
| -------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------- |
| id/ids                           | Product ID. This is a unique Scope 3 system identifier. Results return 'id', search parameters use 'ids' to support multiple search ids.              | STRING                        |
| name                             | Product name                                                                                                                                          | STRING                        |
| productType                      | Product type (Apparel, Footwear, Home Textiles, Other)                                                                                                | STRING                        |
| productCategory                  | Product type category (Socks, BaseballCaps, ApparelAccessory, etc.)                                                                                   | STRING                        |
| weightInformation                | Total weight in kilograms                                                                                                                             | DOUBLE                        |
| dataSource                       | Indicates creation through Product Module, MSI or Scope 3                                                                                             | STRING                        |
| type                             | Indicates product, material, component or packaging                                                                                                   | STRING                        |
| imported                         | Product, material, component or packaging that was imported from Product Module or MSI                                                                | BOOLEAN                       |
| modelNumber                      | Product model number. This field can be used to store PLM or other external ID, but note that the user can manually edit field in the tool interface. | STRING                        |
| barcodes                         | Barcodes (UPC/EAN) / Retail Code                                                                                                                      | STRING                        |
| user:id                          | User who created product account id                                                                                                                   | STRING                        |
| user:email                       | User who created product email address                                                                                                                | STRING                        |
| account: id                      | Worldly system account id                                                                                                                             | STRING                        |
| account: name                    | Name of the account                                                                                                                                   | STRING                        |
| account: country                 | Company account country                                                                                                                               | STRING                        |
| account: sacId                   | This is the account ID. To search use higgId, results return sacId.                                                                                   | STRING                        |
| createdOn                        | Result for date product was created                                                                                                                   | unix timestamp, 1629492077829 |
| modifiedOn                       | Result for date product was last edited                                                                                                               | unix timestamp, 1629492077829 |
| deleted                          | Product status (true/false)                                                                                                                           | BOOLEAN                       |
| defaultProduct                   | Representative product available in the Scope 3 inventory (jacket, gloves, button-down shirts, belts, swimwear, etc.)                                 | STRING                        |
| netUse                           | Percentage of the material being used in the final product (default is 75%)                                                                           | DOUBLE                        |
| upstreamTransportation           | Percentage of upstream transportation unowned                                                                                                         | DOUBLE                        |
| downstreamTransportationRetail   | Percentage of distribution to retail unowned                                                                                                          | DOUBLE                        |
| downstreamTransportationConsumer | Percentage of distribution to consumer unowned                                                                                                        | DOUBLE                        |
| distributionCenterUnOwned        | Percentage of distribution center unowned                                                                                                             | DOUBLE                        |
| retailEnergyUnOwned              | Percentage of retail energy unowned                                                                                                                   | DOUBLE                        |

## Purchase Orders

Elements of a purchase order attached to a product.

| Field                  | Description                                                                                                                             | Type                          |
| :--------------------- | :-------------------------------------------------------------------------------------------------------------------------------------- | :---------------------------- |
| purchaseOrderId        | ID of the purchase order. Note that a user can edit this field in the tool interface.                                                   | STRING                        |
| purchaseDate           | Date the purchase order was attached                                                                                                    | unix timestamp, 1629492077829 |
| amountPurchase         | Number of units purchased in the order                                                                                                  | DOUBLE                        |
| notes                  | Text description of the purchase order                                                                                                  | STRING                        |
| assembly:isDefault     | Indicates if default final assembly (facility) emissions are being used or if a facility's FEM results are linked to the purchase order | BOOLEAN                       |
| assembly:femId         | ID of the specific FEM module linked to the purchase order                                                                              | STRING                        |
| assembly:femDescriptor | Text description of the linked FEM                                                                                                      | STRING                        |

## Impacts

Scope 3 carbon emissions impacts from products, materials and purchase orders. Impacts are represented as both a total tied to a purchase order and as per-product values.

| Field                        | Description                                     | Category | Type   |
| :--------------------------- | :---------------------------------------------- | :------- | :----- |
| tier1impact                  | Finished goods manufacturing (Final Assembly)   | 1        | DOUBLE |
| logisticsImpactsUpstreamTD   | Upstream transportation and distribution        | 4        | DOUBLE |
| logisticsImpactsDTImpact     | Downstream transportation                       | 9        | DOUBLE |
| logisticsImpactsDCImpact     | Downstream transportation - distribution center | 9        | DOUBLE |
| logisticsImpactsRetailImpact | Downstream transportation - retail              | 9        | DOUBLE |
| productCareImpacts           | Use of sold products                            | 11       | DOUBLE |
| endOfUseImpact               | End-of-life treatment of sold products          | 12       | DOUBLE |
| purchaseOrderImpactsTotal    | Impacts multiplied by the purchase order amount | n/a      | DOUBLE |
| materialImpact               | Material impact (either total or per product)   | 1        | DOUBLE |
| componentImpact              | Component impact (either total or per product)  | 1        | DOUBLE |
| packagingImpact              | Packaging impact (either total or per product)  | 1        | DOUBLE |