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
    • Address formats for specific carriers
    • Basics
      • Article categories
      • Audits
      • Custom services & bundled line items
      • Facilities
      • Facility groups
      • GDPR configuration
      • Listings
      • Orders
        • Order types
        • Order status
      • Remote configuration
      • Receipts
      • Search
      • Subscribe to events
      • Sticker
      • Stocks
      • Storage locations
      • Tags
      • Users
    • Channel inventory
    • Facility discounts
    • Inbound process
    • Outbound stocks
    • Purchase order
    • Receipt
    • Routing strategy
    • 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
    • Availability & promising
    • Returns
Powered by GitBook
On this page
Edit on GitHub
  1. API
  2. Core concepts

Recordable attributes

Last updated 2 months ago

Recordable attributes can be used to add certain information to line items during the operative process. They are inherited during the creation of entities within the fulfillmenttools platform.

If a line item of a pick job has a recordable attribute, it will be inherited to the following entities (specifically, pack job and, under certain circumstances, handover job line items). Handover job line items can also inherit their recordable attributes from parcel line items.

Recordable attributes can be added at order creation to inherit it to all following line items, or they can be defined on listings for inheritance.

Remember that are meant to be non-editable after creation; recordable attributes add a value (or even the whole object) to the line item during the corresponding operative process.

Example

To find more information about the attributes in our REST documentation, see, for example, the documentation on the that shows the recordable attribute embedded in the line items.

For example, an entry of the recordableAttribute model looks like the following:

{
  "id": "8a8df5c8-c376-4197-8870-ccc33d22449e",
  "key": "Herkunftsland", // read only
  "keyLocalized": {
    "de_DE": "Herkunftsland",
    "en_US": "Country of Origin"
  },
  "value": "Korea, Republic of",
  "group": "general",
  "recordingRule": "MANDATORY"
}

The value is the value that can be added or changed during the different processes.

article attributes
GET endpoint for pack jobs