BeyondERP.Newsletter
Menu

Setup page · Warehouse management

External service definitions

A setup page where you define how the system calls an external service, using one or more operations that describe the HTTP requests it sends.

Used by
Field Service Integration User, Production supervisor, Process engineering manager and 2 more roles
Business process
Manage warehouse operations
Menu item
WhsExternalServiceDefinitions
Main table
WHSExternalServiceDefinition
Data entity
WHSWarehouseExternalServiceDefinitionEntity
Setup steps
1 on this page
Show what matters for
PAGE GUIDEWhat the page does and how to use it8 sections. Choose a role to highlight what matters to you.
Everyone

1What it is and why

What it isA setup page where you define how the system calls an external service, using one or more operations that describe the HTTP requests it sends.
What you do hereUse this page to set up the operations that let Dynamics 365 Supply Chain Management communicate with a third-party service, for example to print labels.
ExampleFor example, you can print labels through third-party labeling products such as Seagull Scientific BarTender and the Loftware label service solution.
External service definitions page in Dynamics 365
The page in Dynamics 365. page title tab to open what to set or check
Functional consultant · Solution architect

2Where it fits

Business processManage warehouse operations
Menu pathWarehouse management › Setup › External Services › External service definitions
Used next byExternal service instances Microsoft Learn
Related pagesLabel printers Microsoft Learn
End user · Functional consultant

3How to do it

About the examples: Examples and screenshots in this guide use BEAT, a demo company in a Dynamics 365 test environment. Use your own company's codes and values instead of copying them.

Setup steps on this page

Set up External service definitions

Use this page to set up the operations that let Dynamics 365 Supply Chain Management communicate with a third-party service, for example to print labels.

Steps from Microsoft

  1. Go to Warehouse management > Setup > External Services > External service definitions.
  2. On the Action Pane, select New to create an external service definition.
  3. Enter an External service definition name and a Description, then select Save.
  4. On the External service operations FastTab, select Edit operations and add at least one operation.
  5. On the Label print service FastTab, select the Print operation or the Variables print operation, then select Save.

Source: Microsoft Learn

Fields on the page

FieldWhat it meansTable column
External service definitionThe name of the definition.Microsoft Learn ExternalServiceDefinitionId
HTTP methodThe HTTP method that an operation uses: GET, POST or PUT.Microsoft Learn
Relative URLThe relative part of the URL for calling the service, which the external service provider supplies.Microsoft Learn RelativeURL
Print operationThe operation used to print ZPL-based label layouts.Microsoft Learn ExternalServiceOperationId
Variables print operationThe operation used to print variable-based label layouts.Microsoft Learn ExternalServiceOperationId
Variable label layout templateThe content of the variable-based layout template.Microsoft Learn VariableLabelTemplate

Test checklist

  1. Create a definition with a print operation and select it in Print operation on the Label print service tab.
  2. Create an instance and a label printer with Connection type External label service.
  3. Print a license plate or container label.
  4. Check the External service request log shows the request with HTTP success code 200.

Source: Microsoft Learn

Functional consultant

4Setup decisions

Setup stepRecommended value and whyDecision, common mistake and test
Set up External service definitionsOne definition per labeling service, with operations built from the provider's API, using $auth.secret, $label.printer and $label.body substitutions, and label layouts (not document routing layouts)The definition depends on the API that the provider supplies. Learn says to use the newer label layouts because document routing label layouts apply string escaping that can produce malformed JSON or XML.Printing through the external service with classic document routing label layouts, which can produce malformed JSON or XML payloads.
Solution architect

5Design impact

Can it be undoneReversible: Operations, the print operation selection and the variable template can be changed at any time; they affect labels printed afterwards. Microsoft Learn
Technical architect

6Technical

Menu itemWhsExternalServiceDefinitions Checked in Dynamics 365
FormWhsExternalServiceDefinitions Checked in Dynamics 365
TableWHSExternalServiceDefinitionShown as “EXTERNAL SERVICE DEFINITIONS” in Record infoKey field: ExternalServiceDefinitionIdChecked in Dynamics 365
Data entitiesWHSWarehouseExternalServiceDefinitionEntityExternal service definitions Checked in Dynamics 365
Who can open itPrivilegesMaintain warehouse external service definitions WhsExternalServiceDefinitionMaintainView warehouse external service definitions WhsExternalServiceDefinitionViewDuties WhsExternalServiceEnableInquire into warehouse operation master WMSWarehouseOperationMasterInquire
5 security rolesField Service Integration User FieldServiceIntegrationUserProduction supervisor ProdProductionSupervisorProcess engineering manager RouteProcessEngineeringManagerWarehouse planner WHSWarehousePlannerWarehouse manager WMSWarehouseManager
Checked in Dynamics 365
Roles to set it up and use itTo set it up or change itWarehouse manager WMSWarehouseManagerTo use itWarehouse planner WHSWarehousePlannerProduction supervisor ProdProductionSupervisorProcess engineering manager RouteProcessEngineeringManagerField Service Integration User FieldServiceIntegrationUserGive people one of these roles. On this system, 5 roles can open this page.Checked in Dynamics 365
Developer

7Developer

Open it by URLhttps://<your-environment>/?mi=WhsExternalServiceDefinitions
Integrate withWHSWarehouseExternalServiceDefinitionEntity data entity Checked in Dynamics 365
Everyone

8Sources