How Skrym represents key objects and processes

This section outlines the most important data structures within the Skrym
toolbox and describes how you can manage them.
It is a good place to get started in order to understand the terminology and
concepts used by Skrym in other sections of the documentation, such as  or in .

Data

Orders are the key data objects to understand when working with Skrym. The following points are important to keep in mind
regarding our definition of an order:

You should always have a unique identifier for your order
An order should contain at least one item
An order constitutes a promise of a delivery of goods
An order can be split into multiple order parts (e.g. for partial delivery)
An order is delivered through one or more , which in turn can have multiple tracked parcels

Order parts
An order part is a partition of an order, and must have at least one item.
If an order part is split, it removes the previous part and creates two new parts.

Orders

This section details the endpoints you can use to modify your package data within Skrym

Package data is one of the most important parts of logistics, it ties into costs, emissions and overall customer satisfaction.
What kinds of packaging is there? 📦
At Skrym we deal with different kinds of packaging be it regular boxes, plastic bags or height adjustable packaging with machine cutting/folding.

Fixed: Rigid packages that might have a fold/cut-down-point which we refer to as a variation
Height Adjustable: A pre-set base area with walls that are either cut or folded down to a specified height
Fully adjustable: Fully customizable per-order packaging that can create a package (within a span)
Plastic bags: Popular in fashion and pharmacies and is deformable to a certain extent
Envelopes: A little less rigid than a fixed package but slightly less deformable compared to a plastic bag

What is a package made of? 📦
The material of a package is important for both the environment and the cost of the package. Skrym works with packaging manufacturers to get the most accurate data possible.
We have broken down the material of a package into the following categories enabling you to select the correct material for your package.

Name: The name of the package material
Material type: The material type of the package, currently Skrym allows it to be one of the following materials

Cardboard This is the most common material type and is used for most packages.
Plastic Commonly used for bags
Paper Mainly used for envelopes and other paper-based packaging
Unknown: This is a default value and is selected when the material type is unknown


Recycled Percentage: This constitutes the percentage of the package that is made from recycled materials. As default we set this to 0%
CO2e: This is the amount of CO2 equivalent that is emitted when producing the package, measured in grams
Density: The density of the material, measured in kilograms per cubic meter

What fold is used for a package? 📦
The fold of a package is important for both the environment and the structural integrity of the package.
At Skrym we follow FEFCO standards for the folds of a package.

Packages

A product is an item sold by your organization and thus being the building block of an order. Product data is important for ensuring the accuracy of various Skrym
functionality such as optimization and shipping cost calculations.

It is important to ensure that the data provided is accurate and up-to-date.
Warnings will be displayed in  for products that have suspected data quality issues, such as:

One or more dimensions are 0
The weight is 0
The product has an abnormal density or suspicious dimensions (e.g. 1x1x1 mm)

We recommend continously monitoring and adjusting such cases since they may cause issues otherwise.

Below follows a more detailed description of the product object and the available endpoints.
Fetch products
The GetProductByExternalId function retrieves a product using its external ID, e.g. a SKU.

Insert / update products
The UpsertProducts function is designed to insert new products or update existing ones, based on the provided product details.
It accepts a list of products, each with unique identifiers and various attributes, returning a count of successfully updated or inserted products.
It requires each product to have a mandatory externalId and non-negative dimensions for successful processing.

It is also possible to insert products in bulk by uploading a CSV file on .
This is still an experimental feature and comes with some requirements:

File format must be CSV
Units must be millimeters (mm) and grams (g)
The first row must contain the column names

Note that doing this will overwrite any existing data in the system, so make sure to only upload correct data, or to properly test in a sandbox environment first.

Products

Understand the Skrym Definition of a Transporter

A transporter is a company that provides transportation services. This can be a shipping company, a courier service, or any other entity that moves goods from one location to another.
In many systems, transporters are referred to as carriers. Skrym uses the term transporter as we believe it is more descriptive of the services provided.
Examples of transporters include PostNord and DHL.

| Name                                                              | Skrym ID                                     |
| ----------------------------------------------------------------- | ------------------------------------------- |
|     | fc1432c9-b3f8-41ea-826c-e3afd829c4a4        |
|     | b015de0f-b2d4-43c1-bb4b-77e12e127e8f        |
|                       | 09c96082-2eb5-412b-9f4a-71d236c7be93        |
|                     | 6ca892f6-d047-4665-8409-2ce980214242        |
|                        | a4dfe31b-eda4-4598-8fa5-f562d16be08f        |
|               | f2d83dd5-374a-4ef1-8946-af7800d798ea        |
|               | 716ed06c-ece5-46da-8de9-bf2ff9f48622        |
|                        | 2b6444cc-80d3-4fed-a3a0-2783af58277a        |
|         | 0e8b1365-3a5e-4e01-8f7a-7790a68a4deb        |
|                       | f89a49e3-6718-489a-8311-a0431be663bd        |
| | 6a92c0e6-dca9-4170-a518-7bea880400b6        |
|  | d4368205-22ae-46f7-9f1f-e3827c7ea570        |
|         | 6ddbb930-144b-45f9-aeb6-4efa5b68334d        |
|                         | af89dc0c-6a87-4a4e-ae91-9de89685c799        |
|               | 0ec9d8cd-c9f2-4312-8ca5-37af3c402830        |
|         | f86e65d2-a938-4617-b92e-284197d43a27        |
|     | 1386831a-b644-4ddd-aa02-609a34a1dff9        |
|               | 4aa8c0dd-7cb0-4d40-8354-1845b3794830        |
|               | 0a9a06b4-3661-48ff-9dfa-c3d42917d081        |
|               | e0bacffc-79fa-4d59-9c91-cbecab4701b1        |
|  | af5d0a8a-17c2-4e5d-abbb-550c4a1c056a |
|       | 5f5bcb85-d342-44b8-b117-3cd2052fb450        |

Each transporter offers a range of services, such as express delivery, standard delivery, and pick-up points. We call those
services transport methods, which you can read more about below.

Transporters

Understanding our data model for physical places

A Location defines a physical location in a generic way. The best way to think of it is just as
point on a map, without any additional meaning such as what type of location it is or which organization operates it.

Because of the generic way we represent locations, the same location can be shared by multiple organizations, and can be used for multiple purposes. This meaning is instead represented
as a Organization Location.