DELTA H7 API 0.3.0

H7/Operators API

Servers

https://{URL_OPERATEUR_EDI}/dh7 http
URL_OPERATEUR_EDI: This value is the url of the operator.

Operations

Pub declarations/{customsDeclarationReference}/etats

H7/operators interface for a State_H7 message

Parameters
customsDeclarationReference
required
string

Accepts the following message:

State_H7

Payload
object
header
required
object
messageDateTime
required
string
date-time must match [0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}[+,-][0-9]{2}:[0-9]{2}.+

AAAA-MM-DDThh:mm:ss[offset][ZoneID]

messageId
required
string
length <= 291
lrn
required
string
length <= 22
customsDeclarationReference
required
string
length <= 22
mrn
required
string
must match [0-9a-zA-Z]{18}

Additional properties are NOT allowed.

declarationState
required
object
state
required
string
length <= 35
stateDateTime
required
string
date-time must match [0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}[+,-][0-9]{2}:[0-9]{2}.+

AAAA-MM-DDThh:mm:ss[offset][ZoneID]

previousState
required
string
length <= 35
event
required
string
length <= 260

Additional properties are NOT allowed.

Additional properties are NOT allowed.

Examples

State_H7
Payload
{
  "header": {
    "messageDateTime": "2020-06-12T05:36:30-05:00[US/Central]",
    "messageId": "b6c9f124-4a83-4003-bcc9-1bce1798c2ab1591712615",
    "lrn": "TEST123456",
    "customsDeclarationReference": "228231995374",
    "mrn": "15FR9876AB889012B5"
  },
  "declarationState": {
    "state": "VLD",
    "stateDateTime": "2020-06-12T05:36:20-05:00[US/Central]",
    "previousState": "ANT",
    "event": "Validation"
  }
}
This example has been generated automatically.

Messages

#1 State_H7

Payload
object
header
required
object
messageDateTime
required
string
date-time must match [0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}[+,-][0-9]{2}:[0-9]{2}.+

AAAA-MM-DDThh:mm:ss[offset][ZoneID]

messageId
required
string
length <= 291
lrn
required
string
length <= 22
customsDeclarationReference
required
string
length <= 22
mrn
required
string
must match [0-9a-zA-Z]{18}

Additional properties are NOT allowed.

declarationState
required
object
state
required
string
length <= 35
stateDateTime
required
string
date-time must match [0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}[+,-][0-9]{2}:[0-9]{2}.+

AAAA-MM-DDThh:mm:ss[offset][ZoneID]

previousState
required
string
length <= 35
event
required
string
length <= 260

Additional properties are NOT allowed.

Additional properties are NOT allowed.