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 demandes/{customsRequestReference}/reponses

Operators/H7 interface for a Response_invalidation_H7 message

Parameters
customsRequestReference
required
string

Accepts the following message:

Response_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
operatorRequestReference
required
string
length <= 35

Additional properties are NOT allowed.

request
required
object
customsRequestReference
required

The Customs Request Reference.

requestStatus
required
string
customsInvalidationMotivation
string
customsInvalidationLegalMotivation
string

Used in case of request acceptance

decisionComment
string
length <= 350

Used in case of request rejection

decisionDateTime
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]

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 [0-9a-zA-Z]{18}
declarationState
required
object
state
required
string
length <= 35

In case of invalidation request acceptance, the declaration state is filled with 'INV' (invalidated). Otherwise, the declaration state remains unchanged.

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.

Additional items are allowed.

Additional properties are NOT allowed.

Examples

Response_invalidation_H7
Payload
{
  "header": {
    "messageDateTime": "2014-04-12T03:30:30-05:00[US/Central]",
    "messageId": "FR42198531800045",
    "operatorRequestReference": "OP1234"
  },
  "request": {
    "customsRequestReference": null,
    "requestStatus": "accepté",
    "customsInvalidationMotivation": "",
    "customsInvalidationLegalMotivation": "",
    "decisionComment": "",
    "decisionDateTime": "2014-04-12T03:30:30-05:00[US/Central]"
  },
  "declarations": [
    {
      "lrn": "TEST123456",
      "customsDeclarationReference": "228231995374",
      "mrn": "15FR9876AB889012B5",
      "declarationState": {
        "state": "INV",
        "stateDateTime": "2014-04-12T03:30:30-05:00[US/Central]",
        "previousState": "VAL",
        "event": ""
      }
    }
  ]
}
This example has been generated automatically.

Messages

#1 Response_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
operatorRequestReference
required
string
length <= 35

Additional properties are NOT allowed.

request
required
object
customsRequestReference
required

The Customs Request Reference.

requestStatus
required
string
customsInvalidationMotivation
string
customsInvalidationLegalMotivation
string

Used in case of request acceptance

decisionComment
string
length <= 350

Used in case of request rejection

decisionDateTime
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]

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 [0-9a-zA-Z]{18}
declarationState
required
object
state
required
string
length <= 35

In case of invalidation request acceptance, the declaration state is filled with 'INV' (invalidated). Otherwise, the declaration state remains unchanged.

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.

Additional items are allowed.

Additional properties are NOT allowed.