Complex Custom Service Order
Last updated
Was this helpful?
Last updated
Was this helpful?
In the we introduced custom services. Custom Services add services to orders or order lines which are executed after picking. This could be shortening of pants, an engraving of a watch or an appointment for an eye test at an optician. In this use-case we show how to combine multiple (dependent) custom services.
In this use-case we want to put an engraving to a watch and furthermore assembly an alternative wristband. Therefore, we need to Introduce two custom services to the fulfillmenttools platform.
Engraving a text to the backside of a watch needs additional information:
the text you want to engrave
the font you want to engrave (font is optional)
The custom service must be created in the fulfillmenttools platform. You can think of the custom service resource as a blue print. In this blue print you can configure the additional information and orders can reference the custom service.
This example creates the custom service described above:
Some details on the example:
each created custom service has a id
which is used in an order to reference the defined custom service.
executionTimeInMin
: how long does the service take (we use the value for calculating target times)
An item processed in a service with itemsReturnable
set to true cannot be retured since it is comumed by the service.
The itemsRequired
attribute sets that this service must be used together with order line items
The additionalInformation
configures the parameters we need to fulfill the service. These parameters can be optional or mandatory furthermore, you can specify the valueType
e.g STRING
, BOOLEAN
or DATE
. Furthermore, each additional information item has an id which is used for referencing the additional information when creating an order.
Let's assume that we want to add the service assembling a wristband to a watch to the fulfillmenttools platform:
Some details on the example:
each created custom service has a id
which is used in an order to reference the defined custom service.
executionTimeInMin
: how long does the service take (we use the value for calculating target times)
An item processed in a service with itemsReturnable
set to true cannot be retured since it is comumed by the service.
The itemsRequired
attribute sets that this service must be used together with order line items
We don't have any additionalInformation
for this custom service
Now that we have configured the two custom services we can create an order which references the two services. So we create an order containing the watch, the wristband and references the custom services in a hierarchical manner. We want to first do the engraving and afterwards assembly the wristband. An request to create such an order with custom services could look like this:
Some details on the example:
in customServices
you can add multiple entries, each entry groups together different services and eaches
the engravement service (customServiceRef
f4eba7c2-21ce-4926-a862-230f57651ec3
) needs additionalInformation
which are referenced by a additionalInformationRef
the wristband assemply service (customServiceRef
f4eba7c2-21ce-4926-a862-230f57651ec3
) takes the result of the engravement service and the wristband article
each article item can only be present once in the customServices
Full specification of the orders endpoint in our