Ordoro · Schema

DHL eCommerce Label Request schema

Order ManagementInventory ManagementShippingDropshippingEcommerceMulti-ChannelFulfillmentLogistics

Properties

Name	Type	Description
shipper_id	integer
packages	array
packing_list_id	integer	id for packing list for profile template associated with this label
dangerous_goods	string
delivery_confirmation	string
service_endorsement	string	1 - Address Service Requested; 2 - Forwarding Service Requested; 3 - Change Service Requested; 4 - Return Service Requested
customs_info	array
declared_value	number
insured_value	number
insurance_type	string
shipping_method	string
notify_bill_to	boolean
notify_ship_to	boolean
reference_id	string	Identifier for a Return Order (RMA)
reference_number	string
ship_date	string
receiver_tax_info	object
ship_from	object	The ship_from address is used as the originating address of the rate and label request.
ship_to	object	The to address is used as the destination address of a return order rate and label request.
return	boolean
return_reason	string	reason for return if return is true

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/ordoro/refs/heads/main/json-schema/ordoro-post_dhl_ecommerce_label-schema.json",
  "title": "DHL eCommerce Label Request schema",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "shipper_id": {
      "type": "integer"
    },
    "packages": {
      "maxItems": 1,
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "weight": {
            "description": "Weight in ounces",
            "type": "number"
          },
          "length": {
            "description": "Length in inches",
            "type": "number"
          },
          "width": {
            "description": "Width in inches",
            "type": "number"
          },
          "height": {
            "description": "Height in inches",
            "type": "number"
          },
          "declared_value": {
            "type": "number"
          },
          "description": {
            "type": "string"
          },
          "box_shape": {
            "description": "ignored",
            "type": "string"
          }
        },
        "required": [
          "length",
          "width",
          "height",
          "weight",
          "description"
        ]
      }
    },
    "packing_list_id": {
      "description": "id for packing list for profile template associated with this label",
      "type": "integer"
    },
    "dangerous_goods": {
      "type": "string"
    },
    "delivery_confirmation": {
      "enum": [
        "DELCON",
        "SIGCON"
      ],
      "type": "string"
    },
    "service_endorsement": {
      "description": "1 - Address Service Requested; 2 - Forwarding Service Requested; 3 - Change Service Requested; 4 - Return Service Requested",
      "type": "string",
      "enum": [
        "1",
        "2",
        "3",
        "4"
      ]
    },
    "customs_info": {
      "items": {
        "$ref": "#/components/schemas/customs_line"
      },
      "type": "array"
    },
    "declared_value": {
      "type": "number"
    },
    "insured_value": {
      "type": "number"
    },
    "insurance_type": {
      "type": "string",
      "enum": [
        "dhl_ecommerce"
      ]
    },
    "shipping_method": {
      "type": "string"
    },
    "notify_bill_to": {
      "type": "boolean",
      "default": false
    },
    "notify_ship_to": {
      "type": "boolean",
      "default": false
    },
    "reference_id": {
      "description": "Identifier for a Return Order (RMA)",
      "type": "string"
    },
    "reference_number": {
      "type": "string"
    },
    "ship_date": {
      "type": "string",
      "format": "date-time"
    },
    "receiver_tax_info": {
      "$ref": "#/components/schemas/tax_info"
    },
    "ship_from": {
      "description": "The ship_from address is used as the originating address of the rate and label request.",
      "$ref": "#/components/schemas/v1_address"
    },
    "ship_to": {
      "description": "The to address is used as the destination address of a return order rate and label request.",
      "$ref": "#/components/schemas/v1_address"
    },
    "return": {
      "type": "boolean",
      "default": false
    },
    "return_reason": {
      "description": "reason for return if return is true",
      "type": "string"
    }
  },
  "required": [
    "shipper_id",
    "shipping_method"
  ]
}