This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

O63 carrier shipment response

Status

Draft

Data flow

Data flow diagram

Business Object Model

1 - O63 carrier shipment response

Back to O63 carrier shipment response

Description

Carrier shipment response to an O62 shipment registration request. The response contains the shipment state and, in case of success, the shipment document data. Otherwise the carrier specific error message.

Status

Draft

Business Object

Following the description of the schema specific (data property) contents. See here for the FINE service header. The table below indicates mandatory fields with a ✅.

Name Type Content Example Mandatory
externalReferenceId String request reference id 2989cffe-dc66-4aa5-b922-e87ac6310463 ✅
state Enum State of the request SUCCESS, ERROR ✅
direction Integer Carrier specific delivery direction 1, 2 when state = SUCCESS
shippingLabel Object Shipping label data when state = SUCCESS
returnsLabel Object Returns label data
errormessage String Error message when state = ERROR

Embedded objects

shippingLabel

Name Type Content Example Mandatory
id String unique document identifier H1234567890123456789 ✅
data String depends on dataType SGVsbG8gV29ybGQ= ✅
dataType Enum document content type PDF, PNG, ZPL, DATA_DHL, DATA_HG, DATA_CHP ✅

data schema dataType=DATA_DHL

{
  "properties": {
    "identcode": { 
      "type": "string"
    },
    "postleitcode": {
      "type": "string"
    },
    "labelUrl": {
      "type": "string"
    },
    "labelFormat": {
      "enum": ["PDF", "ZPL2"]
    }
  },
  "required": [
    "identcode", 
    "postleitcode",
    "labelUrl",
    "labelFormat"
  ]
}

data schema dataType=DATA_HG

{
  "properties": {
    "sendungsidentnummer": {
      "type": "string"
    },
    "tour": {
      "type": "number",
      "minimum": 0,
      "maximum": 99
    },
    "zelle": {
      "type": "number",
      "minimum": 0,
      "maximum": 99
    },
    "depotbezeichnung": {
      "type": "string"
    },
    "sperrgut": {
      "type": "boolean"
    },
    "gewichtsklasse": {
      "enum": ["UP_TO_10KG", "MORE_THAN_10KG", "MORE_THAN_20KG"]
    }
  },
  "required": [
    "sendungsidentnummer",
    "tour",
    "zelle",
    "depotbezeichnung",
    "sperrgut",
    "gewichtsklasse"
  ]
}

data schema dataType=DATA_CHP

{
  "properties": {
    "sendungsidentnummer": {
      "type": "string"
    }
  },
  "required": ["sendungsidentnummer"]
}

returnsLabel

Name Type Content Example Mandatory
id String unique document identifier H1234567890123456789 ✅
data String depends on dataType SGVsbG8gV29ybGQ= ✅
dataType Enum document content type PDF, PNG, ZPL, DATA_DHL, DATA_HG, DATA_CHP ✅

data schema dataType=DATA_DHL

{

}

data schema dataType=DATA_HG

{

}

data schema dataType=DATA_CHP

{

}