fulfillmenttools
  • Welcome to the fulfillmenttools Platform Documentation
  • Getting Started
    • Setup your access to fulfillmenttools
    • Make your first API Calls
      • Add your first facility
      • Add your first listing
      • Place your first order
    • Core concepts & terminology
      • Order Flow
    • Postman Collection
    • Client SDKs
    • FAQ
  • Clients
    • Backoffice
      • First steps - Registration
      • Network view
        • Home
        • Orders
          • Unroutable orders
          • Pre-orders & Backorders
          • Order History
        • Inventory Management
          • Stock Overview
          • Channel Inventory
        • Facilities
        • Users
        • Returns
        • DOMS configuration
        • Settings
        • Analytics
          • DOMS Pages
          • Fulfillment Operations Pages
          • Inventory Pages
          • Downloads Page
      • Facility view
        • Home
        • Inbound
        • Tasks
        • Listings
        • Storage Locations
        • Facility
        • Users
    • Inventory app
      • Registration Inventory App
      • App sections
        • Inbound
        • Storage and relocation
    • Operations app
      • Android
        • Manual Registration
        • Android Enterprise Registration
        • Sections
          • Picking
            • Load Units (legacy)
            • Substitute items
            • Weighed or measured products
            • Scanning configuration
            • Picking Methods
              • Batch Picking
              • Multi Order Picking
          • Packing
          • Handover
          • Returns (legacy)
        • Printing
        • Notifications
      • Webapp
        • Packing
      • Overview features Android & Webapp
    • Technical requirements
      • Zebra Hardware Scanner Configuration
      • Honeywell Hardware Scanner Configuration
      • Supported barcodes for camera scanning
      • Requirements for fft applications
      • Zebra printer
    • Returns app
      • Handle unannounced returns
      • Handle announced returns
  • Products
    • Core Functionality
      • Process
        • External actions
      • Add and manage facilities
      • Notification Center
      • Checking on features
      • Tags and Stickers Concept
      • GDPR
      • Remote Configuration
      • Expiry
      • Target time
      • Time calculation for queries of future availabilities (LPS-calculation)
      • Interfacility Transfer
    • Carrier Management
      • Overview
        • Available Carriers
      • Concepts
        • Carrier Country Service Mapping (CCSM)
        • Non-delivery-days
        • Custom Carrier & Headless operation of Carriers
      • Providing needed data
    • Fulfillment Options
      • Fulfillability Check
      • Checkout Options
        • Available fulfillment options based on basket
        • Earliest possible delivery date
        • Available delivery dates within time-period
        • Availability for delivery date
      • Delivery Promise
    • Inventory Management
      • Configurations
      • Entities
        • Listing
        • Stock
          • Stock Properties
        • Storage Location
        • Zone
      • Global Inventory
        • Stock availability
        • Channel Inventory
        • Expected stock
        • Inbound Process
        • Reservations
        • Safety Stock
      • Inventory Control
        • Inventory Traits
        • Measurement Units
        • Outbound Inventory Tracking
        • Storage Location Recommendations
    • Order Fulfillment
      • Headless Order Fulfillment
      • Pick Jobs
      • Zone picking
      • Load Units
      • Custom Service
      • Handover Jobs
      • Add External Documents
      • Configurations
        • Picking Configuration
          • Picking methods
          • Short Pick Reasons
        • Packing Configuration
          • Packing Container Types
        • Print / Document Configuration
        • Tag Configurations
          • Parcel Tag Configuration
        • Handover Configuration
        • Operative Container Types
    • Order Routing
      • Entities
        • Ship-from-Store Orders
        • Click-and-Collect Orders
        • Locked Orders
        • Custom Services Orders
          • Simple Custom Service Order
          • Complex Custom Service Order
      • Fences
      • Ratings
      • Order Split
        • Order split - initial routing
        • Order split after shortpick
        • Item bundles
      • Reroute
      • Shape the routing with the DOMS Toolkit
      • Decision logs
    • Returns Management
      • Returns legacy
        • Available status
      • Returns 2.0
        • Return Reasons
        • Item Conditions
        • Integrating Returns with Events
    • Use Cases
      • Demand-Driven Replenishment
      • Expected stock in availability
      • Multi Order Picking
      • Interfacility transfer
      • Assigned Users
  • Connecting to fulfillmenttools
    • General Topics
      • Use external identity providers to authenticate to fulfillmenttools
        • Microsoft Entra ID / Azure Active Directory (AD)
      • Public Event Export
      • Available Regions
      • Backup Policies
    • GraphQL API
    • RESTful API
      • General Topics
        • API Release Life Cycle
        • Versioning
        • Authorization
        • Customization via Attributes
        • Update Guarantees
        • Rate Limits
        • Resource Timestamps
        • Pagination Interface
        • Localization
        • Custom Attributes
      • OpenAPI Specification
        • Swagger UI
        • OpenAPI 3.0 Spec
    • Eventing
      • Structure of an Event
      • Available Events
      • Tutorial
    • commercetools Connect
    • Integration Tutorial
      • Adding facilities
      • Adding listings to facilities
      • Configuring stocks
      • Carrier configuration
      • Placing orders
      • Checkout Options
      • Distributed Order Management System (Routing)
      • Local fulfillment configuration
  • Incident Reporting
    • How to report incidents in fulfillmenttools
    • How to define incident priorities
  • Release Notes
    • Release Summary – May 2024
    • Release Summary – June 2024
    • Release Summary – July 2024
    • Release Summary – August 2024
    • Release Summary – September 2024
    • Release Summary – October 2024
Powered by GitBook
On this page
  • Specific Return Address per Tag
  • Create the needed tag and value
  • Create a Parcel Tag Configuration
  • Create an order with the tag
  • Create a shipping label

Was this helpful?

  1. Products
  2. Order Fulfillment
  3. Configurations
  4. Tag Configurations

Parcel Tag Configuration

PreviousTag ConfigurationsNextHandover Configuration

Last updated 5 months ago

Was this helpful?

This page is outdated. Please go to our new documentation under .

Specific Return Address per Tag

Sometimes certain good need to be sent to a special location if returned. This could for example be the case if an item has reached its end of life, and it needs to be handled in a specific facility (outlet). This can be handled by configuring tags that contain the information about a specific return address. An order can be created with that tag which will then make sure that the return label will carry that new return address instead of the standard return address of the facility.

This will not affect the return notes generated via the fulfillmenttools platform.

There could be the case, that multiple alternative return addresses are chosen via tags. In this case, the alternative return addresses is chosen upon sorting the results by tagRef.

Create the needed tag and value

Create a new tag or use an existing tag. More about tags and how to set them up can be found .

Create a Parcel Tag Configuration

When the tag is available, the tag configuration can be created which will carry information about the new return address.

The configuration can be set with a PUT request send to the with a payload looking like this:

curl --location --request PUT 'https://your.api.fulfillmenttools.com/api/configurations/tags/parcel' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <TOKEN>' \
--data '{
    "version": 4,
    "alternativeReturnAddressConfiguration": {
        "alternativeReturnAddressPerTag": [
            {
                "tagRef": "ALTERNATIVE_RETURN_ADDRESS",
                "matchingValues": [
                    "END_OF_LIFE"
                ],
                "alternativeReturnAddress": {
                    "city": "Hamburg",
                    "houseNumber": "1",
                    "postalCode": "12345",
                    "street": "Hamburger Str.",
                    "country": "DE",
                    "companyName": "SenderInc",
                    "phoneNumbers": [
                        {
                            "value": "040-558558",
                            "label": "private",
                            "type": "LANDLINE"
                        },
                        {
                            "value": "0171-55555555",
                            "label": "private",
                            "type": "MOBILE"
                        }
                    ]
                }
            }
        ]
    }
}'

The platform then should respond with a 200 OK response containing the information provided with the creation and last modified timestamp added.

Create an order with the tag

With the order, the now configured tag can be set. The tag works only when the tag is set on the order itself, not when it's on order line items.

curl --location 'https://your.api.fulfillmenttools.com/api/orders' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <TOKEN>' \
--data-raw '{
    "orderDate": "2021-03-11T08:16:07.000Z",
    "tags": [
        {
            "id": "ALTERNATIVE_RETURN_ADDRESS",
            "value": "END_OF_LIFE"
        }
    ],
    "consumer": {
        "email": "ulf.steinke@ocff.de",
        "addresses": [
            {
                "street": "Schanzenstr.",
                "houseNumber": "30",
                "postalCode": "51063",
                "city": "Köln",
                "country": "DE",
                "phoneNumbers": [
                    {
                        "value": "0177-555-6273",
                        "label": "private",
                        "type": "MOBILE"
                    }
                ],
                "additionalAddressInfo": "3. Etage",
                "salutation": "Herr",
                "firstName": "Ulf",
                "lastName": "Steinke"
            }
        ]
    },
    "tenantOrderId": "FC-4711-2361",
    "status": "OPEN",
    "orderLineItems": [
        {
            "article": {
                "tenantArticleId": "2020249",
                "title": "T-Shirt \"Am Sonnenhut\"",
                "imageUrl": "https://d358g9injarr4u.cloudfront.net/res/product_1000/240eadd8-8f50-479d-b0d8-74412bd4a9f9.jpg",
                "attributes": [
                    {
                        "category": "descriptive",
                        "priority": 100,
                        "key": "%%subtitle%%",
                        "value": "Neu!"
                    },
                    {
                        "category": "descriptive",
                        "priority": 200,
                        "key": "Mitgliederpreis",
                        "value": "17,96 EUR"
                    },
                    {
                        "category": "descriptive",
                        "priority": 300,
                        "key": "Schnitt",
                        "value": "Frauen"
                    },
                    {
                        "category": "descriptive",
                        "priority": 400,
                        "key": "Material",
                        "value": "100% Baumwolle"
                    },
                    {
                        "category": "descriptive",
                        "priority": 500,
                        "key": "Artikelnummer",
                        "value": "2020249"
                    },
                    {
                        "category": "descriptive",
                        "priority": 600,
                        "key": "Größe",
                        "value": "S"
                    },
                    {
                        "category": "descriptive",
                        "priority": 700,
                        "key": "Beschreibung",
                        "value": "Rotes T-Shirt mit weißen Streifen an den Ärmeln, Blockdruck mit Schriftzug auf der Brust"
                    }
                ]
            },
            "quantity": 2,
            "scannableCodes": [
                "2020249"
            ]
        },
        {
            "article": {
                "tenantArticleId": "2010681",
                "title": "Steppjacke \"Mühlenbach\"",
                "imageUrl": "https://d358g9injarr4u.cloudfront.net/res/product_1000/9fcb7e42-7c84-4ab0-999a-869efe077e0a.jpg",
                "attributes": [
                    {
                        "category": "descriptive",
                        "priority": 100,
                        "key": "%%subtitle%%",
                        "value": "Neu!"
                    },
                    {
                        "category": "descriptive",
                        "priority": 200,
                        "key": "Größe",
                        "value": "L"
                    },
                    {
                        "category": "descriptive",
                        "priority": 300,
                        "key": "Oberstoff",
                        "value": "100% Polyester"
                    },
                    {
                        "category": "descriptive",
                        "priority": 400,
                        "key": "Futter",
                        "value": "100% Polyester"
                    },
                    {
                        "category": "descriptive",
                        "priority": 500,
                        "key": "Füllung",
                        "value": "100% Polyester"
                    },
                    {
                        "category": "descriptive",
                        "priority": 600,
                        "key": "Beschreibung",
                        "value": "Dreifarbige Steppjacke mit verstaubarer Kapuze, Zwei Eingriffstaschen, Gesticktes Logo auf der Brust"
                    },
                    {
                        "category": "descriptive",
                        "priority": 700,
                        "key": "Artikelnummer",
                        "value": "2010681"
                    }
                ]
            },
            "quantity": 4,
            "scannableCodes": [
                "2010681"
            ]
        },
        {
            "article": {
                "tenantArticleId": "5020064",
                "title": "Wandtattoo Stadion",
                "imageUrl": "https://d358g9injarr4u.cloudfront.net/res/product_1000/343f4569-66bb-4b0c-aa2b-20011a51b620.jpg",
                "attributes": [
                    {
                        "category": "descriptive",
                        "priority": 100,
                        "key": "Maße",
                        "value": "70 x 50 cm"
                    },
                    {
                        "category": "descriptive",
                        "priority": 200,
                        "key": "Beschreibung",
                        "value": "Wandtattoo in Ziegelwand-Optik, Mit tollem Blick aufs Stadion"
                    },
                    {
                        "category": "descriptive",
                        "priority": 300,
                        "key": "Anwendung",
                        "value": "Für die Beklebung sollte die Fläche staub- und fetfrei sein. Bringen Sie den Aufkleber in Position und reiben Sie diese gleichmäßig mit der flachen Hand an den Untergrund, um sie zu fixieren. Jede Stelle nochmals gest andrücken. Fertig! Für auftretende Schäden nach der Verklebung auf dem Untergrund etc. ist eine Haftung ausgeschlossen."
                    },
                    {
                        "category": "descriptive",
                        "priority": 400,
                        "key": "Artikelnummer",
                        "value": "5020064"
                    }
                ]
            },
            "quantity": 2,
            "scannableCodes": [
                "5020064"
            ]
        }
    ]
}'

Create a shipping label

When a shipping label is created a corresponding return label is created at the same time (if activated at all). The return label then carries the new return address which is given with the tag.

https://docs.fulfillmenttools.com/documentation
here
parcel tags configurations endpoint