DHL

DHL Containers API

The Containers API from DHL — 4 operation(s) for containers.

GitHub OpenAPI

Operations 4

POST /shipping/v4/containers Create a container #
POST /shipping/v4/containers/{containerId}/packages Manage packages in a container #
POST /shipping/v4/containers/{containerId}/close Close a container #
GET /shipping/v4/containers/{containerId} Get an existing container ID #

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

Schemas & Data

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-containers-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-containers-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Dhl Containers API
  version: 4.0.0
  description: 'Operations tagged Containers across 2 of this provider''s published API definitions: dhl-container-dhl-ecommerce-americas-openapi.yml, dhl-container-dhl-ecommerce-americas-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api-sandbox.dhlecs.com
  description: Sandbox Environment
- url: https://api.dhlecs.com
  description: Production Environment
security:
- OAuth2: []
tags:
- name: Containers
paths:
  /shipping/v4/containers:
    post:
      tags:
      - Containers
      operationId: createContainer
      summary: Create a container
      description: 'Use this request to create a container ID to which packages can be added and optionally, create a container label.

        Below is the minimum information you need to generate a container ID:

        - Your pickup Account number

        - Sort Level

        - Container Type

        - Format (if creating a container label)


        AUTHORIZATION Bearer Token

        - This request is using Bearer Token from collection DHL eCommerce Americas API


        - HEADERS

        - Content-Type: application/json

        - PARAMS

        - format: ZPL'
      parameters:
      - name: User-Agent
        in: header
        description: Information about the client application making the request.
        schema:
          type: string
          default: eCOMv4 DHLeC Developer portal
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/createContainerRequest'
            example:
              CreateContainerExample:
                summary: Sample Create Container Request
                value:
                  pickup: '5300000'
                  containerRef1: ABC12345
                  sortLevel: GND
                  containerType: PALLET
                  label:
                    generate: 'true'
                    format: ZPL
      responses:
        '200':
          description: Successful container response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/createContainerResponse'
              examples:
                CreateContainersResponseExample:
                  summary: Sample Create Container Response
                  value:
                    pickup: '5300000'
                    containerRef1: ABC12345
                    sortLevel: GRD
                    containerType: PALLET
                    containerId: DC1090926000530000000000333
                    status: OPEN
                    packageCount: '0'
                    packageIds: '[]'
                    label:
                      labelData: '^XA^n^CI28

                        ^LL1218

                        ^FO95,270^BY3^BCN,155,N,N,N,A^FDDC1090926000530000000000333^FS

                        ^FO150,...'
                      encodeType: PLAIN
                      format: ZPL
                      link: https://api-sandbox.dhlecs.com/shipping/v4/containers/5300000?containerId=DC1090926000530000000000333
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  type:
                    type: string
                    example: https://api-sandbox.dhlecs.com/docs/errors/400.0204004
                  title:
                    type: string
                    example: Dynamic Validation Failed
                  invalidParams:
                    type: array
                    items:
                      type: object
                      properties:
                        name:
                          type: string
                          example: containerType
                        path:
                          type: string
                          example: /containerType
                        reason:
                          type: string
                          example: containerType attribute value is not valid
    servers:
    - url: https://api-sandbox.dhlecs.com
      description: Sandbox Environment
    - url: https://api.dhlecs.com
      description: Production Environment
  /shipping/v4/containers/{containerId}/packages:
    post:
      tags:
      - Containers
      operationId: managePackages
      summary: Manage packages in a container
      description: 'Use this request to manage the packages in a container (add or delete packages).

        Below is the minimum information you need to manage a container:

        - Action

        - Package IDs

        - Format (if generating a container label)


        AUTHORIZATION Bearer Token

        - This request is using Bearer Token from collection DHL eCommerce Americas API


        - HEADERS

        - Content-Type: application/json

        - PARAMS

        - format: ZPL'
      parameters:
      - name: User-Agent
        in: header
        description: Information about the client application making the request.
        schema:
          type: string
          default: eCOMv4 DHLeC Developer portal
      - name: containerId
        in: path
        description: The container Id.
        required: true
        schema:
          type: string
          minLength: 1
          maxLength: 28
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/managePackagesRequest'
            examples:
              ManageContainerExample:
                summary: Sample Manage Packages Request
                value:
                  action: ADD
                  packages: 'packageId: 12345, packageId: 12346, packageId: 12347'
                  label:
                    generate: 'true'
                    format: ZPL
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/managePackagesResponse'
              examples:
                ManageContainerResponseExample:
                  summary: Sample Manage Packages Response
                  value:
                    pickup: '5300000'
                    containerRef1: ABC12345
                    sortLevel: GRD
                    containerType: PALLET
                    containerId: DC1090926000530000000000333
                    status: OPEN
                    packageCount: '3'
                    packageIds:
                    - '12345'
                    - '12346'
                    - '12347'
                    label:
                      labelData: '^XA^n^CI28

                        ^LL1218

                        ^FO95,270^BY3^BCN,155,N,N,N,A^FDDC1090926000530000000000333^FS

                        ^FO150,...'
                      encodeType: PLAIN
                      format: ZPL
                      link: https://api-sandbox.dhlecs.com/shipping/v4/containers/5300000?containerId=DC1090926000530000000000333
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/DynamicValidationErrorOne'
                - $ref: '#/components/schemas/DynamicValidationErrorTwo'
              examples:
                DynamicValidationErrorOne:
                  summary: Dynamic Validation Failed (400.0204003)
                  value:
                    type: https://api-sandbox.dhlecs.com/docs/errors/400.0204004
                    title: Dynamic Validation Error
                    invalidParams:
                    - name: packages/packageId
                      path: /packages/packageId
                      reason: Package 544ABCD is already associated with another container
                DynamicValidationErrorTwo:
                  summary: Dynamic Validation Failed (400.0204003)
                  value:
                    type: https://api-sandbox.dhlecs.com/docs/errors/400.0204004
                    title: Dynamic Validation Error
                    invalidParams:
                    - name: packages/packageId
                      path: /packages/packageId
                      reason: Package 12338985 cannot be added as product EXP is not valid for this container
    servers:
    - url: https://api-sandbox.dhlecs.com
      description: Sandbox Environment
    - url: https://api.dhlecs.com
      description: Production Environment
  /shipping/v4/containers/{containerId}/close:
    post:
      tags:
      - Containers
      operationId: closeContainer
      summary: Close a container
      description: 'Use this request to transition a container from an OPEN to a CLOSED status. When a container is closed, packages cannot be added or removed. Closing the container makes it visible for DHL eCommerce operations to scan.

        NOTE: The containerId is entered in the path, not the request body.


        AUTHORIZATION Bearer Token

        - This request is using Bearer Token from collection DHL eCommerce Americas API


        - HEADERS

        - Content-Type: application/json

        - PARAMS

        - format: ZPL'
      parameters:
      - name: User-Agent
        in: header
        description: Information about the client application making the request.
        schema:
          type: string
          default: eCOMv4 DHLeC Developer portal
      - name: containerId
        in: path
        description: The container Id.
        required: true
        schema:
          type: string
          minLength: 1
          maxLength: 28
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/closeContainerRequest'
            example:
              CloseContainerExample:
                summary: Sample Close Container Request
                value:
                  label:
                    generate: 'true'
                    format: ZPL
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/closeContainerResponse'
              example:
                CloseContainerResponseExample:
                  summary: Sample Close Container Response
                  value:
                    pickup: '5300000'
                    containerRef1: ABC12345
                    sortLevel: GRD
                    containerType: PALLET
                    containerId: DC1090926000530000000000333
                    status: CLOSED
                    packageCount: '3'
                    packageIds: 'packageId: 123456, packageId: 123457, packageId: 123458'
                    label:
                      labelData: '^XA^n^CI28

                        ^LL1218

                        ^FO95,270^BY3^BCN,155,N,N,N,A^FDDC1090926000530000000000333^FS

                        ^FO150,...'
                      encodeType: PLAIN
                      format: ZPL
                      link: https://api-sandbox.dhlecs.com/shipping/v4/containers/5300000?containerId=DC1090926000530000000000333
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  type:
                    type: string
                    example: https://api-sandbox.dhlecs.com/docs/errors/400.0204004
                  title:
                    type: string
                    example: Dynamic Validation Failed
                  invalidParams:
                    type: array
                    items:
                      type: object
                      properties:
                        name:
                          type: string
                          example: containerId
                        path:
                          type: string
                          example: /containerId
                        reason:
                          type: string
                          example: Container is not created
    servers:
    - url: https://api-sandbox.dhlecs.com
      description: Sandbox Environment
    - url: https://api.dhlecs.com
      description: Production Environment
  /shipping/v4/containers/{containerId}:
    get:
      tags:
      - Containers
      operationId: getContainerId
      summary: Get an existing container ID
      description: 'Use this request to retrieve an existing container. The response returns all stored details for the requested container, including a printable ZPL label.


        Request Description


        AUTHORIZATION Bearer Token


        This request is using Bearer Token from collection DHL eCommerce Americas API.'
      parameters:
      - name: User-Agent
        in: header
        description: Information about the client application making the request.
        schema:
          type: string
          default: eCOMv4 DHLeC Developer portal
      - name: containerId
        in: path
        required: true
        description: The container Id to be retrieved. (M)
        schema:
          type: string
          maxLength: 28
          minLength: 1
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  pickup:
                    type: string
                    maxLength: 10
                    minLength: 4
                    description: DHLeCS pickup account number. You will receive this number from DHL eCommerce after onboarding. (M)
                    example: '5300000'
                  containerRef1:
                    type: string
                    maxLength: 30
                    minLength: 1
                    description: Container reference number. (O)
                    example: ABC12345
                  sortLevel:
                    type: string
                    description: The sort level for the container. (M)
                    example: EXP
                    enum:
                    - GND
                    - EXP
                    - MAX
                  containerType:
                    type: string
                    description: The type of container. Currently, PALLET is the only type. (M)
                    example: PALLET
                    enum:
                    - PALLET
                  containerId:
                    type: string
                    description: The Id of the container. (M)
                    example: DC12909260005300000000000769
                  status:
                    type: string
                    description: The status of the container. (M)
                    example: OPEN
                    enum:
                    - OPEN
                    - CLOSED
                  packageCount:
                    type: number
                    maximum: 20000
                    minimum: 0
                    description: The count of pieces nested in the container at the time of the response. (M)
                    example: 3
                  packageIds:
                    type: array
                    items:
                      properties:
                        packageId:
                          type: string
                          description: The package Ids in the container. (M)
                          example: 'packageId: 123456, packageId: 123457, packageId: 123458'
                  label:
                    type: array
                    items:
                      type: object
                      properties:
                        labelData:
                          type: string
                          description: This will be an encoded string containing the        container label plain text ZPL string. (C)
                          minLength: 0
                          maxLength: 100000
                          example: '^XA^n^CI28

                            ^LL1218

                            ^FO95,270^BY3^BCN,155,N,N,N,A^FDDC1090926000530000000000333^FS

                            ^FO150,...'
                        encodeType:
                          type: string
                          example: PLAIN
                          description: Plain text format.(M)
                          enum:
                          - PLAIN
                        format:
                          type: string
                          description: ZPL format. (M)
                          enum:
                          - ZPL
                          example: ZPL
                        link:
                          type: string
                          minLength: 1
                          maxLength: 150
                          description: Link to the container label. (M)
                          example: https://api.dhlecs.com/shipping/v4/containers/5300000?containerId=DC11009260005300000000000400
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  type:
                    type: string
                    example: https://api-sandbox.dhlecs.com/docs/errors/400.0204004
                  title:
                    type: string
                    example: Dynamic Validation Failed
                  invalidParams:
                    type: array
                    items:
                      type: object
                      properties:
                        name:
                          type: string
                          example: containerId
                        path:
                          type: string
                          example: /containerId
                        reason:
                          type: string
                          example: Container is not created
    servers:
    - url: https://api-sandbox.dhlecs.com
      description: Sandbox Environment
    - url: https://api.dhlecs.com
      description: Production Environment
components:
  schemas:
    closeContainerRequest:
      type: object
      properties:
        label:
          type: object
          properties:
            generate:
              type: boolean
              example: 'true'
              description: Indicates whether to generate a container label. (O)
              enum:
              - true
              - false
            format:
              type: string
              example: ZPL
              description: Format for the container label. Mandatory if generate = true. (C)
              enum:
              - ZPL
    managePackagesResponse:
      type: object
      properties:
        pickup:
          type: string
          maxLength: 10
          minLength: 4
          description: DHLeCS pickup account number. You will receive this number from DHL eCommerce with the Onboarding Form. (M)
          example: '5300000'
        containerRef1:
          type: string
          maxLength: 30
          minLength: 1
          description: Client container reference number. (O)
          example: ABC12345
        sortLevel:
          type: string
          description: The sort level for the container. (M)
          example: EXP
          enum:
          - GND
          - EXP
          - MAX
        containerType:
          type: string
          description: The type of container. (M)
          example: PALLET
          enum:
          - PALLET
        containerId:
          type: string
          maxLength: 28
          minLength: 1
          description: Unique container ID. (M)
          example: DC1090926000530000000000333
        status:
          type: string
          description: The status of the container. Packages can be added when the status is Open.
          example: OPEN
          enum:
          - OPEN
        packageCount:
          type: number
          maximum: 20000
          minimum: 0
          description: The number of packages in the container. (M)
          example: 1000
        packageIds:
          type: array
          items:
            type: object
            properties:
              packageid:
                type: string
                description: The IDs of the packages in the container. (M)
                example: 'packageId: 123456, packageId: 123457, packageId: 123458'
        label:
          type: array
          items:
            type: object
            properties:
              labelData:
                type: string
                description: This will be an encoded string containing the container label plain text ZPL string. (O)
                minLength: 0
                maxLength: 100000
                example: ^XA\n^CI28\n^PW812\n^LL218\n^FO96,270^BY3^BCN,155...
              encodeType:
                type: string
                example: PLAIN
                description: Plain text label format. (M)
                enum:
                - PLAIN
              format:
                type: string
                description: Format supported is ZPL. (M)
                enum:
                - ZPL
                example: ZPL
              link:
                type: string
                minLength: 1
                maxLength: 150
                description: Link to the container label. (M)
                example: https://api-sandbox.dhlecs.com/shipping/v4/containers/5300000?containerId=DC1090926000530000000000333
    closeContainerResponse:
      type: object
      properties:
        pickup:
          type: string
          maxLength: 10
          minLength: 4
          description: DHLeCS pickup account number. You will receive this number from DHL eCommerce with the Onboarding Form. (M)
          example: '5300000'
        containerRef1:
          type: string
          maxLength: 30
          minLength: 1
          description: Client container reference number. (O)
          example: ABC12345
        sortLevel:
          type: string
          description: The sort level for the container. (M)
          example: EXP
          enum:
          - GND
          - EXP
          - MAX
        containerType:
          type: string
          description: The type of container. (M)
          example: PALLET
          enum:
          - PALLET
        containerId:
          type: string
          maxLength: 28
          minLength: 1
          description: Unique container ID. (M)
          example: DC1090926000530000000000333
        status:
          type: string
          description: The status of the container changes to Closed. Packages can no longer be added.
          example: CLOSED
          enum:
          - CLOSED
        packageCount:
          type: number
          maximum: 20000
          minimum: 0
          description: The number of packages in the container. (M)
          example: 1000
        packageIds:
          type: array
          items:
            type: object
            properties:
              packageid:
                type: string
                description: The IDs of the packages in the container. (M)
                example: 'packageId: 123456, packageId: 123457, packageId: 123458'
        label:
          type: array
          items:
            type: object
            properties:
              labelData:
                type: string
                description: This will be an encoded string containing the container label plain text ZPL string. (C)
                minLength: 0
                maxLength: 100000
                example: ^XA\n^CI28\n^PW812\n^LL218\n^FO96,270^BY3^BCN,155...
              encodeType:
                type: string
                example: PLAIN
                description: Plain text label format. (M)
                enum:
                - PLAIN
              format:
                type: string
                description: Format supported is ZPL. (M)
                enum:
                - ZPL
                example: ZPL
              link:
                type: string
                minLength: 1
                maxLength: 150
                description: Link to the container label. (M)
                example: https://api-sandbox.dhlecs.com/shipping/v4/containers/5300000?containerId=DC1090926000530000000000333
    DynamicValidationErrorOne:
      type: object
      properties:
        type:
          type: string
          example: https://api-sandbox.dhlecs.com/docs/errors/400.0204004
        title:
          type: string
          example: Dynamic Validation Failed
        invalidParams:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
                example: packages/packageId
              path:
                type: string
                example: /packages/packageId
              reason:
                type: string
                example: Package 544ABCD is already associated with another container
    createContainerResponse:
      type: object
      properties:
        pickup:
          type: string
          maxLength: 10
          minLength: 4
          description: DHLeCS pickup account number. You will receive this number from DHL eCommerce with the Onboarding Form. (M)
          example: '5300000'
        containerRef1:
          type: string
          maxLength: 30
          minLength: 1
          description: Client container reference number. (O)
          example: ABC12345
        sortLevel:
          type: string
          description: The sort level for the container. (M)
          example: EXP
          enum:
          - GND
          - EXP
          - MAX
        containerType:
          type: string
          description: The type of container. (M)
          example: PALLET
          enum:
          - PALLET
        containerId:
          type: string
          maxLength: 28
          minLength: 1
          description: Unique container ID. (M)
          example: DC1090926000530000000000333
        status:
          type: string
          description: The status of the container. (M)
          example: OPEN
          enum:
          - OPEN
        packageCount:
          type: number
          maximum: 20000
          minimum: 0
          description: The number of packages in the container. (M)
          example: 0
        packageIds:
          type: array
          items:
            type: object
            properties:
              packageid:
                type: string
                description: The IDs of the packages in the container. (M)
                example: '[]'
        label:
          type: array
          items:
            type: object
            properties:
              labelData:
                type: string
                description: This will be an encoded string containing the container label plain text ZPL string. (C)
                minLength: 0
                maxLength: 100000
                example: ^XA\n^CI28\n^PW812\n^LL218\n^FO96,270^BY3^BCN,155...
              encodeType:
                type: string
                example: PLAIN
                description: Plain text label format. (M)
                enum:
                - PLAIN
              format:
                type: string
                description: Format supported is ZPL. (M)
                enum:
                - ZPL
                example: ZPL
              link:
                type: string
                minLength: 1
                maxLength: 150
                description: Link to the container label. (M)
                example: https://api-sandbox.dhlecs.com/shipping/v4/containers/5300000?containerId=DC1090926000530000000000333
    DynamicValidationErrorTwo:
      type: object
      properties:
        type:
          type: string
          example: https://api-sandbox.dhlecs.com/docs/errors/400.0204004
        title:
          type: string
          example: Dynamic Validation Failed
        invalidParams:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
                example: packages/packageId
              path:
                type: string
                example: /packages/packageId
              reason:
                type: string
                example: Package 12338985 cannot be added as product EXP is not valid for this container
    createContainerRequest:
      type: object
      required:
      - pickup
      - sortLevel
      - containerType
      properties:
        pickup:
          type: string
          maxLength: 10
          minLength: 4
          pattern: ^[\S]+$
          description: DHL eCommerce pickup account number. You will receive this after onboarding with DHL eCommerce. This is not the same as the Sold To Account number. (M)
          example: '5300000'
        containerRef1:
          type: string
          maxLength: 30
          minLength: 1
          description: Client Container Reference Number. (O)
          example: ABCD123456
        sortLevel:
          type: string
          description: Sort Level for the container. (M)
          example: GND
          enum:
          - GND
          - EXP
          - MAX
        containerType:
          type: string
          example: PALLET
          enum:
          - PALLET
          description: The type of container. (M)
        label:
          type: object
          properties:
            generate:
              type: boolean
              example: 'true'
              description: Indicates whether to generate a container label. (O)
              enum:
              - true
              - false
            format:
              type: string
              example: ZPL
              description: Format for the container label. Mandatory if generate = true. (C)
              enum:
              - ZPL
    managePackagesRequest:
      type: object
      required:
      - action
      properties:
        action:
          type: string
          example: ADD
          description: Add packages to or remove packages from a container. (M)
          enum:
          - ADD
          - DELETE
        packages:
          type: array
          items:
            properties:
              packageId:
                type: string
                description: The package Ids to be added to or removed from the container Id.
                example: 'packageId: 123456, packageId: 123457, packageId: 123458'
        label:
          type: object
          properties:
            generate:
              type: boolean
              example: 'true'
              description: Indicates whether to generate a container label. (O)
              enum:
              - true
              - false
            format:
              type: string
              example: ZPL
              description: Format for the container label. Mandatory if generate = true. (C)
              enum:
              - ZPL
  securitySchemes:
    OAuth2:
      type: oauth2
      description: This API uses OAuth 2 with the client-credentials grant flow
      flows:
        clientCredentials:
          tokenUrl: https://api-bat.dhlecs.com/auth/v4/accesstoken
          scopes: {}
x-refined-from:
- dhl-container-dhl-ecommerce-americas-openapi.yml
- dhl-container-dhl-ecommerce-americas-openapi.yml