API documentationIncident ManagementFeedback

Article attributes

Article attributes can be used in the fulfillmenttools platform to impose a certain degree of customization to a process, such as improving the appearance of the platform and clients.

Attention: Do not confuse attributes with customAttributes.

Example entry of the attributes model:

{
    "category": "descriptive",
    "type": "STRING",
    "priority": 100,
    "key": "Farbe", // read only
    "keyLocalized": {
        "de_DE": "Farbe",
        "en_US": "Color"
    },
    "value": "Blau",
    "valueLocalized": {
        "de_DE": "Blau",
        "en_US": "Blue"
    }
}

The priority property sorts the attributes in a client. The smallest allowed value is 1, the maximum allowed value is 1000, and the default value is 1001.

Supported categories

Category
Comment

descriptive

key and value are shown in the fft clients, like the Backoffice. It can be used to enhance the displayed data to ease processing.

pickingSequence

Defines the sequence of how line items are ordered during picking.

miscellaneous (default)

Currently not used by the fulfillmenttools clients. Exception with key BRANDS, see the info box below.

customs

Has keys like valuePerUnit, hsCode and currency. Other keys are possible for this attribute.

insurance

Defines insurance-related data and can have keys like valuePerUnit and currency.

shop

Defines the customer shop price and can have keys like valuePerUnit and currency.

dimensions

Defines dimensions and has keys weightPerUnit, height, width, length.

salesPrice

Defines the price at which (supplier) facilities sell the listing to other facilities in the network.

For categories customs, insurance, shop, salesPrice, and dimensions, It is mandatory to fill the field type. The type can be CURRENCY (ISO-4217), NUMBER or STRING. For other categories, the field type is optional.

Special categories

Category salesPrice

Sales prices can only be supplied on the platform via listing attributes. The sales price is particularly relevant for facilities with a type supplier. These facilities sell/deliver articles to other facilities. Therefore, it might be necessary to define the price at which these supplier facilities sell their listings to other facilities/facility groups.

An example of creating a listing with a sales price can be found below.

Attributes with category salesPrice:

  • Can only contain the following keys: valuePerUnit, currency and numberOfDecimalPlaces.

  • Key valuePerUnit:

    • Mandatory

    • value defines the fallback salesPrice (If no context is defined) or the salesPrice for the respective facility/facility group (if a context is defined). Commas or dots are not allowed. If no key numberOfDecimalPlaces is defined, the default value stored for the respective currency is used. This means the value "400" would be displayed as "4 €".

    • priority describes the hierarchy in which the configured prices are to be applied (from low to high). Must be unique.

  • Key currency:

    • Mandatory

    • Defines the currency the listing is sold in. If there are multiple currencies for different facilities or facility groups, multiple currency attributes with contexts must be defined.

    • Must have unique key and context.value pairs.

  • Key numberOfDecimalPlaces:

    • numberOfDecimalPlaces is optional. If no key numberOfDecimalPlaces is defined, the default value stored for the respective currency is used.

    • If a different numberOfDecimalPlaces should be applied per currency or facility (group), a context must be defined.

It is not possible to configure multiple sales prices for the same facility (group).

Special keys

Special keys are predefined keys that have a special function in the platform.

Key
Comment

%%subtitle%%

Can be used in the context of the descriptive category to show the attribute directly below the line item in our clients.

BRAND

Can be used to add information about the brand of the article. This allows to filter and search by brand in the Backoffice. Used in the context of the miscellaneous category.

Article attribute inheritance

Article attributes are inherited during the creation of entities within the fulfillmenttools platform. When supplying article attributes to order line items, all subsequent entities will inherit these attributes. When additionally supplying article attributes to listings, these will be taken as a fallback.

Limitations

Each attributes object has a limit of 15360 chars (the whole object is serialized as a string). This approximately corresponds to 15 objects with around 1024 characters. The API responds with an HTTP error code 400 when trying to create or update an entity that exceeds this limit.

Examples

Shop price with currency

In this example, the article attributes for the shop price are depicted with a currency. The other categories for prices (insurance, customs) work similarly. In this example, the article would cost 13.37 EUR.

{
  "quantity": 2,
  "article": {
    "tenantArticleId": "111222333",
    "title": "T-Shirt",
    "imageUrl": "https://loremflickr.com/320/240/shirt",
    "attributes": [
        {
          "key": "valuePerUnit",
          "category": "shop",
          "type": "NUMBER",
          "value": "1337"
        }, {
          "key": "currency",
          "category": "shop",
          "type": "CURRENCY",
          "value": "EUR"
        }
    ]
  }
}

Subtitles and descriptive attributes

When creating an order, users can add attributes as ArticleAttributeItems on the article within the line items. The following examples show a line item with brands and further product information. In this case, the brands would be shown in the subtitle when using the Operations App.

{
  "quantity": 2,
  "article": {
    "tenantArticleId": "111222333",
    "title": "T-Shirt",
    "imageUrl": "https://loremflickr.com/320/240/shirt",
    "attributes": [
      {
        "key": "%%subtitle%%",
        "value": "Super Brand",
        "category": "descriptive",
        "priority": 100
      }, {
        "key": "Color",
        "value": "white",
        "category": "descriptive",
        "priority": 101
      }, {
        "key": "Size",
        "value": "M",
        "category": "descriptive",
        "priority": 102
      }
    ]
  }
}
Example of Attributes
Client displays subtitle and other attributes including their keys.

Sales price with currency

In this example, a listing is created in a supplier facility along with sales prices and respective currencies. The code sample reflects the values described in the table below:

Facility (group)

Sales price

Priority

fallback

4 €

-

Facility GB

2 GBP

700

Facility group CH

3 CHF

500

PUT https://{YOUR_TENANT_NAME}.api.fulfillmenttools.com/api/facilities/{facilityId}/listings
{
  "listings": [
    {
      "tenantArticleId": "4711",
      "title": "Adidas Superstar",
      "attributes": [
        {
          "key": "valuePerUnit",
          "category": "salesPrice",
          "type": "NUMBER",
          "value": "400" 
        }, {
          "key": "currency",
          "category": "salesPrice",
          "type": "CURRENCY",
          "value": "EUR" 
        }, {
          "key": "numberOfDecimalPlaces", 
          "category": "salesPrice",
          "type": "NUMBER",
          "value": "2" 
        }, {
          "key": "valuePerUnit",
          "category": "salesPrice",
          "type": "NUMBER",
          "value": "300",
          "priority": 500,
          "context": {
            "type": "FACILITY_GROUP",
            "value": "uuid-facility-group-ch"
          }
        }, {
          "key": "currency",
          "category": "salesPrice",
          "type": "CURRENCY",
          "value": "CHF", 
          "context": {
            "type": "FACILITY_GROUP",
            "value": "uuid-facility-group-ch"
          }
        }, {
          "key": "numberOfDecimalPlaces",
          "category": "salesPrice",
          "type": "NUMBER",
          "value": "2", 
          "context": {
            "type": "FACILITY_GROUP",
            "value": "uuid-facility-group-ch"
          }
        }, {
          "key": "valuePerUnit",
          "category": "salesPrice",
          "type": "NUMBER",
          "value": "200", 
          "priority": 700,
          "context": {
            "type": "FACILITY",
            "value": "uuid-facility-gb"
          }
        }, {
          "key": "currency",
          "category": "salesPrice",
          "type": "CURRENCY",
          "value": "GBP", 
          "context": {
            "type": "FACILITY",
            "value": "uuid-facility-gb" 
          }
        }, {
          "key": "numberOfDecimalPlaces",
          "category": "salesPrice",
          "type": "NUMBER",
          "value": "2", 
          "context": {
            "type": "FACILITY",
            "value": "uuid-facility-gb"
          }
        }
      ]
    }
  ]
}

Last updated