DELTA H7 API 0.3.0

H7/Operators API

Servers

https://edi.douane.gouv.fr/dh7 http

Operations

Pub demandes/invalider

Operators/H7 interface for a Request_Invalidation_H7 message

Accepts the following message:

Request_Invalidation_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

UUID + timestamp in seconds

operatorRequestReference
required
string
length <= 35
invalidationMotivation
required
string
requestComment
string
length <= 350

Additional properties are NOT allowed.

clearanceAgreement
required
object
clearanceAgreementNumber
required
string
length <= 8

Additional properties are NOT allowed.

declarations
required
array<object>
<= 99 items

Items:

0
object
lrn
required
string
length <= 22
customsDeclarationReference
required
string
length <= 22
mrn
required
string
must match .{18}
supportingDocuments
required
array<object>
<= 99 items

Items:

0
object
supportingDocumentReference
required
string
length <= 70
supportingDocumentType
required
string
must match .{4}

Additional properties are NOT allowed.

Additional items are allowed.

Additional properties are NOT allowed.

Additional items are allowed.

Additional properties are NOT allowed.

Examples

Request_Invalidation_H7
Payload
{
  "header": {
    "messageDateTime": "2014-04-12T03:30:30-05:00[US/Central]",
    "messageId": "FR42198531800045",
    "operatorRequestReference": "OP1234",
    "invalidationMotivation": "",
    "requestComment": ""
  },
  "clearanceAgreement": {
    "clearanceAgreementNumber": "A234567"
  },
  "declarations": [
    {
      "lrn": "123456",
      "customsDeclarationReference": "2282319",
      "mrn": "15FR9876AB889012B5",
      "supportingDocuments": [
        {
          "supportingDocumentReference": "",
          "supportingDocumentType": ""
        }
      ]
    }
  ]
}
This example has been generated automatically.

Messages

#1 Request_Invalidation_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

UUID + timestamp in seconds

operatorRequestReference
required
string
length <= 35
invalidationMotivation
required
string
requestComment
string
length <= 350

Additional properties are NOT allowed.

clearanceAgreement
required
object
clearanceAgreementNumber
required
string
length <= 8

Additional properties are NOT allowed.

declarations
required
array<object>
<= 99 items

Items:

0
object
lrn
required
string
length <= 22
customsDeclarationReference
required
string
length <= 22
mrn
required
string
must match .{18}
supportingDocuments
required
array<object>
<= 99 items

Items:

0
object
supportingDocumentReference
required
string
length <= 70
supportingDocumentType
required
string
must match .{4}

Additional properties are NOT allowed.

Additional items are allowed.

Additional properties are NOT allowed.

Additional items are allowed.

Additional properties are NOT allowed.