DHL

DHL Workorder API

Work Order facilitates the assembly of a finished good from stock components, or the disassembly of an item into component parts.

GitHub OpenAPI

Operations 1

POST /workOrder Create work order #

Documentation

📖
Documentation
https://developer.dhl.com/tracking
📖
Documentation
https://developer.dhl.com/api-reference/shipment-tracking-unified-push
📖
Documentation
https://developer.dhl.com/api-reference/additional-services-dhl-freight
📖
Documentation
https://developer.dhl.com/api-reference/authentication-dhl-ecommerce-americas
📖
Documentation
https://developer.dhl.com/api-reference/authentication-api-dhl-freight
📖
Documentation
https://developer.dhl.com/api-reference/authentication-api-post-parcel-germany
📖
Documentation
https://developer.dhl.com/api-reference/datafactory-autocomplete-20-post-parcel-germany
📖
Documentation
https://developer.dhl.com/api-reference/deutsche-post-hybrid-mail-shipments-e-post-post-parcel-germany
📖
Documentation
https://developer.dhl.com/api-reference/deutsche-post-international-post-parcel-germany
📖
Documentation
https://developer.dhl.com/api-reference/deutsche-post-internetmarke-post-parcel-germany
📖
Documentation
https://developer.dhl.com/api-reference/deutsche-post-print-mailing-dispatch-preparation-post-parcel-germany
📖
Documentation
https://developer.dhl.com/api-reference/deutsche-post-print-mailing-targeting-post-parcel-germany
📖
Documentation
https://developer.dhl.com/parcel-connect
📖
Documentation
https://developer.dhl.com/api-reference/econnect-beta-dhl-ecommerce-europe
📖
Documentation
https://developer.dhl.com/api-reference/dhl-parcel-de-pickup-post-parcel-germany
📖
Documentation
https://developer.dhl.com/api-reference/dhl-parcel-de-postnumber-post-parcel-germany
📖
Documentation
https://developer.dhl.com/api-reference/dhl-parcel-de-private-shipping-post-parcel-germany
📖
Documentation
https://developer.dhl.com/api-reference/dhl-parcel-de-returns-post-parcel-germany
📖
Documentation
https://developer.dhl.com/api-reference/parcel-de-shipping-post-parcel-germany-v2
📖
Documentation
https://developer.dhl.com/api-reference/dhl-parcel-de-shipment-tracking-post-parcel-germany
📖
Documentation
https://developer.dhl.com/api-reference/dgf-document
📖
Documentation
https://developer.dhl.com/api-reference/duty-tax-dhl-ecommerce-americas
📖
Documentation
https://developer.dhl.com/api-reference/ecommerce-uk
📖
Documentation
https://developer.dhl.com/api-reference/parcel-eu
📖
Documentation
https://developer.dhl.com/api-reference/pickup-cancellation-dhl-ecommerce-india-blue-dart
📖
Documentation
https://developer.dhl.com/api-reference/price-quote-dhl-freight
📖
Documentation
https://developer.dhl.com/api-reference/print-dhl-freight
📖
Documentation
https://developer.dhl.com/api-reference/product-dhl-freight
📖
Documentation
https://developer.dhl.com/api-reference/product-and-sub-product-pickup-detail-dhl-ecommerce-india-blue-dart
📖
Documentation
https://developer.dhl.com/api-reference/product-finder-dhl-ecommerce-americas
📖
Documentation
https://developer.dhl.com/api-reference/products-api-post-parcel-germany
📖
Documentation
https://developer.dhl.com/api-reference/dgf-push-api
📖
Documentation
https://developer.dhl.com/api-reference/registration-pickup-dhl-ecommerce-india-blue-dart
📖
Documentation
https://developer.dhl.com/api-reference/return-label-dhl-ecommerce-americas
📖
Documentation
https://developer.dhl.com/api-reference/shipment-booking-dhl-freight
📖
Documentation
https://developer.dhl.com/api-reference/dgf-shipment-booking
📖
Documentation
https://developer.dhl.com/api-reference/shipment-label-dhl-global-forwarding
📖
Documentation
https://developer.dhl.com/api-reference/dgf-shipment-status
📖
Documentation
https://developer.dhl.com/api-reference/shipment-tracking-dhl-ecommerce-india-blue-dart
📖
Documentation
https://developer.dhl.com/api-reference/shipment-tracking-v2-dhl-global-forwarding
📖
Documentation
https://developer.dhl.com/api-reference/time-table-dhl-freight
📖
Documentation
https://developer.dhl.com/api-reference/tracking-dhl-ecommerce-americas

Specifications

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/dhl:dhl-workorder-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

dhl-workorder-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Dhl Work Order API
  version: 3.2.13
  description: 'Operations tagged Work Order across 2 of this provider''s published API definitions: dhl-warehouse-management-openapi.yml, dhl-warehouse-management-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://dsc.api-sandbox.dhl.com/wms/ (TEST)
- url: https://dsc.api.dhl.com/wms/ (PROD)
security:
- basicAuth: []
tags:
- name: workorder
  description: Work Order facilitates the assembly of a finished good from stock components, or the disassembly of an item into component parts.
paths:
  /workOrder:
    post:
      tags:
      - workorder
      summary: Create work order
      description: The API operation for creating a work order in the backend WMS application.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/workOrder_create'
        description: Work order definition
        required: true
      responses:
        '200':
          description: The order was created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workOrder_response'
            application/problem+json:
              schema:
                $ref: '#/components/schemas/workOrder_response'
        '400':
          description: Invalid input
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workOrder_input_invalid'
            application/problem+json:
              schema:
                $ref: '#/components/schemas/workOrder_input_invalid'
        '403':
          description: Invalid combination of user, customer_id, facility and message type
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workOrder_permission_refused'
            application/problem+json:
              schema:
                $ref: '#/components/schemas/workOrder_permission_refused'
        '409':
          description: Work order already exists
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workOrder_conflict'
            application/problem+json:
              schema:
                $ref: '#/components/schemas/workOrder_conflict'
        '503':
          description: Service Unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workOrder_service_unavailable'
            application/problem+json:
              schema:
                $ref: '#/components/schemas/workOrder_service_unavailable'
      operationId: postWorkOrder
      x-operation-id-source: derived
    servers:
    - url: https://dsc.api-sandbox.dhl.com/wms/ (TEST)
    - url: https://dsc.api.dhl.com/wms/ (PROD)
components:
  schemas:
    workOrder:
      type: object
      properties:
        facilityId:
          type: string
          description: DSC facility id.
        customerId:
          type: string
          description: DSC customer id.
        division:
          type: string
          description: Business unit of customer. Only applicable to certain WMS, please refer to the specific WMS implementation guide.
        workOrderNumber:
          type: string
          description: Work order number.
        workType:
          type: string
          description: Type of work order defined in aligment with Customer and DHL operation. Used to determine if assembly or disassembly, order type and requested services.
        workOrderRevision:
          type: string
          description: Work order revision number. Used if a work order is split into multiple orders. This information is mandatory and only applicable for certain WMS. Please refer to the specific WMS implementation guide.
        workOrderDate:
          type: string
          description: Work order date. Date Format - YYYYMMDDHHmmss.
        projectNumber:
          type: string
          description: Project number that the work order is part of. Only applicable to certain WMS, please refer to the specific WMS implementation guide.
        itemNumber:
          type: string
          description: Finished good item number.
        lotNumber:
          type: string
          description: Finished good lot/batch number.
        supplierLotNumber:
          type: string
          description: Lot/batch number assigned to the finished good by the supplier (for assembly, this would be assigned by DHL). Only applicable to certain WMS, please refer to the specific WMS implementation guide.
        revisionLevel:
          type: string
          description: Indicates the revision or version of the finished good item.
        originCode:
          type: string
          description: Indicates the country of origin to be associated with the finished good item.
        orderedQuantity:
          type: number
          description: Finished good quantity ordered.
        inventoryStatus:
          type: string
          description: Inventory status of finished good when assembled or component parts when disassembled.
          enum:
          - Available
          - CriticalHold
          - Damaged
          - Expired
          - Hold
          - Inspection
          - Release
          - Returned
          - Salvaged
          - TimeHold
        dateDue:
          type: string
          description: Work order completion due date. Date format - YYYYMMDDHHmmss. Only applicable to certain WMS, please refer to the specific WMS implementation guide.
        minimumShelfLife:
          type: number
          description: Finished good minimum shelf life (days).
        priority:
          type: integer
          description: Priority of the work order. This information is mandatory and only applicable for certain WMS. Please refer to the specific WMS implementation guide.
        workOrderNotes:
          type: array
          items:
            type: object
            allOf:
            - $ref: '#/components/schemas/workOrderNote'
        inventoryAttributeFields:
          type: array
          items:
            type: object
            properties:
              inventoryAttributeField:
                type: string
                description: Identifier tagged to the inventory and used in agreement with customer. Only applicable to certain WMS, please refer to the specific WMS implementation guide.
              inventoryAttributeType:
                type: string
                description: Indicates the type of data that is contained in inventoryAttributeField. Only applicable to certain WMS, please refer to the specific WMS implementation guide.
        workOrderLines:
          type: array
          items:
            type: object
            allOf:
            - $ref: '#/components/schemas/workOrderLine'
      example:
        facilityId: GB_0044
        customerId: CID005233
        division: DIV02
        workOrderNumber: WO0001
        workType: ASSEMBLY
        workOrderRevision: '03'
        projectNumber: Halloween
        itemNumber: COSTUME01
        lotNumber: LOT01
        supplierLotNumber: SUPNUM01
        revisionLevel: '02'
        originCode: GB
        orderedQuantity: 7
        inventoryStatus: Available
        dateDue: '20240808161301'
        minimumShelfLife: 90
        priority: 10
        workOrderNotes:
        - noteLineNumber: '0001'
          noteType: GiftCard
          noteTypeDescription: Gift card
        - noteLineNumber: '0002'
          noteType: GiftWrap
          noteTypeDescription: Gift wrap
        workOrderLines:
        - lineNumber: '0020'
          itemNumber: HAT001
          lotNumber: LOT01
          supplierLotNumber: SUPNUM01
          bomQuantity: 7
          inventoryStatus: Available
          supplierNumber: HATSUP01
          revisionLevel: '02'
          originCode: BR
          expectedScrap: '0'
          completedQuantity: 7
          minimumShelfLife: 90
          workOrderNotes:
          - noteLineNumber: '0001'
            noteType: GiftCard
            noteTypeDescription: Gift card
          - noteLineNumber: '0002'
            noteType: GiftWrap
            noteTypeDescription: Gift wrap
        - lineNumber: '0030'
          itemNumber: BROOMSTICK001
          lotNumber: BLOT01
          supplierLotNumber: BSUPNUM01
          bomQuantity: 7
          inventoryStatus: Available
          supplierNumber: BROOMSUP01
          revisionLevel: '02'
          originCode: BR
          expectedScrap: '0'
          minimumShelfLife: 90
          workOrderNotes:
          - noteLineNumber: '0001'
            noteType: GiftCard
            noteTypeDescription: Gift card
          - noteLineNumber: '0002'
            noteType: GiftWrap
            noteTypeDescription: Gift wrap
    workOrderNote:
      type: object
      description: Only applicable to certain WMS, please refer to the specific WMS implementation guide.
      required:
      - noteLineNumber
      - noteText
      properties:
        noteLineNumber:
          type: string
          description: Unique note line number.
        noteType:
          type: string
          description: Note type.
          enum:
          - EPI
          - GiftCard
          - GiftWrap
          - GiftMessage
        noteText:
          type: string
          description: Note description.
    workOrder_conflict:
      type: object
      allOf:
      - $ref: '#/components/schemas/problem_detail'
      example:
        title: Request could not be processed
        detail: Object already exists
        status: 409
        instance: workOrder/WO0001
    workOrderLine:
      required:
      - lineNumber
      - itemNumber
      - bomQuantity
      type: object
      description: Work order lines define the component items required to build the finished good in the assembly process.
      properties:
        lineNumber:
          type: string
          description: Unique work order line number.
        itemNumber:
          type: string
          description: Component item number required to build the finished good.
        lotNumber:
          type: string
          description: Component lot/batch number.
        supplierLotNumber:
          type: string
          description: Lot/batch number assigned to the component item by the supplier (for assembly, this would be assigned by DHL). Only applicable to certain WMS, please refer to the specific WMS implementation guide.
        bomQuantity:
          type: number
          description: Quantity of component item required to build one finished goods item.
        inventoryStatus:
          type: string
          description: Inventory status of component item when assembled or disassembled. This information is mandatory for certain WMS only, please refer to specific WMS implementation guide.
          enum:
          - Available
          - CriticalHold
          - Damaged
          - Expired
          - Hold
          - Inspection
          - Release
          - Returned
          - Salvaged
          - TimeHold
        supplierNumber:
          type: string
          description: Vendor identifier for the component item. Only applicable to certain WMS, please refer to the specific WMS implementation guide.
        revisionLevel:
          type: string
          description: Indicates the revision or version of the component item. Only applicable to certain WMS, please refer to the specific WMS implementation guide.
        originCode:
          type: string
          description: Indicates the country of origin of the component item.
        minimumShelfLife:
          type: number
          description: Component item minimum shelf life (days).
        inventoryAttributeFields:
          type: array
          items:
            type: object
            properties:
              inventoryAttributeField:
                type: string
                description: Identifier tagged to the inventory and used in agreement with customer. Only applicable to certain WMS, please refer to the specific WMS implementation guide.
              inventoryAttributeType:
                type: string
                description: Indicates the type of data that is contained in inventoryAttributeField. Only applicable to certain WMS, please refer to the specific WMS implementation guide.
        workOrderLineNotes:
          type: array
          items:
            type: object
            allOf:
            - $ref: '#/components/schemas/workOrderLineNote'
    workOrder_permission_refused:
      type: object
      allOf:
      - $ref: '#/components/schemas/problem_detail'
      example:
        title: Forbidden Error
        detail: API permission refused
        status: 403
        instance: workOrder/WO0001
    workOrder_response:
      type: object
      allOf:
      - $ref: '#/components/schemas/workOrder'
    problem_detail:
      type: object
      description: Definition of [RFC7807](https://tools.ietf.org/html/rfc7807) Problem Detail for HTTP APIs
      properties:
        type:
          type: string
        title:
          type: string
        status:
          type: number
        detail:
          type: string
        instance:
          type: string
      required:
      - title
      - detail
    workOrder_create:
      type: object
      allOf:
      - $ref: '#/components/schemas/workOrder'
      required:
      - facilityId
      - customerId
      - workOrderNumber
      - workType
      - itemNumber
      - orderedQuantity
      - inventoryStatus
      - workOrderLines
    workOrder_input_invalid:
      type: object
      allOf:
      - $ref: '#/components/schemas/problem_detail'
      example:
        title: Bad Request
        detail: Invalid request
        status: 400
        instance: workOrder/WO0001
    workOrderLineNote:
      type: object
      description: Only applicable to certain WMS, please refer to the specific WMS implementation guide.
      required:
      - noteLineNumber
      - noteText
      properties:
        noteLineNumber:
          type: string
          description: Unique note line number.
        noteType:
          type: string
          description: Note type.
          enum:
          - EPI
          - GiftCard
          - GiftWrap
          - GiftMessage
        noteText:
          type: string
          description: Note description.
    workOrder_service_unavailable:
      type: object
      allOf:
      - $ref: '#/components/schemas/problem_detail'
      example:
        title: Request could not be processed
        detail: Service Unavailable
        status: 503
        instance: workOrder/WO0001
  securitySchemes:
    basicAuth:
      type: http
      description: HTTP Basic Authentication. Works over `HTTP` and `HTTPS`
      scheme: basic
x-refined-from:
- dhl-warehouse-management-openapi.yml
- dhl-warehouse-management-openapi.yml