fulfillmenttools
API documentationIncident ManagementFeedback
Developer Docs
Developer Docs
  • Developer docs
  • Getting Started
    • Quickstart
    • Integration tutorial
      • Adding facilities
      • Adding listings to facilities
      • Configuring stocks
      • Carrier configuration
      • Placing orders
      • Checkout options
      • Distributed Order Management System (Routing)
      • Local fulfillment configuration
    • Free trial
  • Technical Basics
    • Access to fulfillmenttools
    • Feature status
    • Available regions
    • Backup policies
  • Connecting to fulfillmenttools
    • Client SDKs
    • commercetools connect
    • OpenID connect
      • Configure Microsoft Entra ID / Azure Active Directory
      • Configure Keycloak
  • API
    • Core concepts
      • Authentication & authorization
      • API Versioning & lifecycle
      • Assign user to jobs
      • Localization
      • Resource timestamps
      • Custom attributes
      • Article attributes
      • Recordable attributes
      • Data update guarantees
      • Rate limits & scaling
      • Retries
      • Performance on test vs. production systems
      • Load testing
    • API calls
      • Postman
      • cURL
      • GraphQL Explorer
    • GraphQL API
    • RESTful API
      • Pagination interface
      • RapiDoc
      • OpenAPI 3.0 Spec
    • Eventing
      • Structure of an event
      • Available events
        • Event flows
      • Eventing example
      • Event export
  • Integration Guides
    • Basics
      • Article categories
      • Audits
      • Facilities
      • Facility groups
      • GDPR configuration
      • Listings
      • Remote configuration
      • Receipts
      • Search
      • Subscribe to events
      • Sticker
      • Stocks
      • Storage locations
      • Tags
      • Users
    • Channel inventory
    • Inbound process
    • Outbound stocks
    • Purchase order
    • Receipt
    • Routing strategy (context-based multi-config DOMS)
    • Show sticker to clients
    • Stow jobs
  • More Integration Guides
    • Carrier management
      • Introduction to carrier configuration
      • Required data when operating carriers
      • Adding & connecting carriers to facilities
      • Custom carrier
    • Configurations for order fulfillment
      • Picking configuration
      • Packing configuration
      • Handover configuration
      • Printing and document configuration
      • Packing container types
      • Parcel tag configuration
      • Headless order fulfillment
      • Short-pick reasons
      • External documents in order fulfillment
      • Service jobs
      • Load units
      • Running sequence
    • DOMS - distributed order management system (routing)
    • External actions
    • Interfacility transfer
    • Notifications
    • Orders
      • Place your first order
      • Ship-from-store orders
      • Click-and-collect orders
      • Locked orders
      • Order with custom services
      • Bundled items in an order
      • Order process status
    • Availability & promising
    • Returns
Powered by GitBook
On this page
  • Supported categories
  • Special categories
  • Category salesPrice
  • Special keys
  • Article attribute inheritance
  • Examples
  • Shop price with currency
  • Subtitles and descriptive attributes
  • Sales price with currency
Edit on GitHub
  1. API
  2. Core concepts

Article attributes

Last updated 9 days ago

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.

Do not confuse attributes with .

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. 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.

Special categories

Category salesPrice

  • Attributes with category salesPrice and key valuePerUnit define the fallback salesPrice (if no context is defined) or the salesPrice for the respective facility / facility group (if a context is defined).

  • Attributes with category salesPrice and key currency define the currency the listing is sold in. If there are multiple currencies for different facilities, multiple currency attributes with contexts must be defined.

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 categoryto 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 chars. 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€.

{
  "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

{
  "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
      }
    ]
  }
}

Sales price with currency

In this example, a listing is created in a supplier facility along with sales prices and respective currencies. The listing has sales prices that apply to different facilities or facility groups. Additionally, different currencies are configured for the different facility groups.

Listings model:

{
  "tenantArticleId": "4711",
  "title": "Adidas Superstar",
  ...
  "attributes": [
    {
      "key": "valuePerUnit",
      "category": "salesPrice",
      "type": "NUMBER",
      "value": "400", // No context, fallback price
    }, {
      "key": "valuePerUnit",
      "category": "salesPrice",
      "type": "NUMBER",
      "value": "400", // 4.00 EUR facility group level
      "context": {
        "type": "FACILITY_GROUP",
        "value": "uuid-facility-group" 
      },
      "priority": 100
    }, {
      "key": "valuePerUnit",
      "category": "salesPrice",
      "type": "NUMBER",
      "value": "300", // 3.00 CHF facility group level
      "context": {
        "type": "FACILITY_GROUP",
        "value": "uuid-facility-group-ch"
      },
      "priority": 1000
    }, {
      "key": "valuePerUnit",
      "category": "salesPrice",
      "type": "NUMBER",
      "value": "318", // 3.18 EUR facility group level
      "context": {
        "type": "FACILITY_GROUP",
        "value": "uuid-facility-group-de"
      },
      "priority": 1000
    }, {
      "key": "valuePerUnit",
      "category": "salesPrice",
      "type": "NUMBER",
      "value": "200", // 2.00 EUR facility level
      "context": {
        "type": "FACILITY",
        "value": "uuid-facility-5001"
      },
      "priority": 5000
    }, {
      "key": "currency",
      "category": "salesPrice",
      "type": "CURRENCY",
      "value": "EUR"
    }, {
      "key": "currency",
      "category": "salesPrice",
      "type": "CURRENCY",
      "value": "CH",
      "context": { // Currency for specific facility group
        "type": "FACILITY_GROUP",
        "value": "uuid-facility-group-ch" 
      }
    }, {
      "key": "currency",
      "category": "salesPrice",
      "type": "CURRENCY",
      "value": "EUR",
      "context": { // Currency for specific facility group
        "type": "FACILITY_GROUP",
        "value": "uuid-facility-group-de"
      }
    }
  ]
}

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

Listings can have a shop price and a sales price. The sales price is particularly relevant for . These facilities sell/deliver articles to other facilities. Therefore, it might be necessary to define the price for which these supplier facilities sell their listings to other facilities / facility groups.

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

customAttributes
ISO-4217
facilities with type supplier
Operations App
client displays subtitle and other attributes including their keys
Example of Attributes