updateCustomsData

post

https://rz3.aeb.de/demo1cai/rest/DLCarrierBFBean/updateCustomsData

Updates customs data for one existing shipment. Updates data on shipment and item level. Updates customs relevant data only.

Body Params

clientSystemId

string

Id of the sending client system.

e.g. Installation ID of the sending host or ERP system.

Maximum length: 20

clientIdentCode

string

Client identification code.

Maximum length: 10

userName

string

User who initiated the request from the client system.

If the user is found either in the system's user management or in a connected LDAP directory, the request runs under this user's roles.

If the user is not found, the request is only granted the basic 'I_EVERYONE' role. The user name may be used for logging purposes in this case.

Actual authentication is handled separately via the request's headers, so no password is required in the request's data.

resultLanguageIsoCodes

array of strings

2-letter ISO codes of the languages in which texts will be returned.

English ('en') and German ('de') are typically supported by default. Other languages may be supported.

Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.

resultLanguageIsoCodes

shipmentReference

object

required

Reference of the shipment to be updated. Mandatory field.

customsShipmentData

object

Shipment data. The field may be empty when there's no need to update shipment data. Only a few customs fields in shipment are supported.

customsItemData

array of objects

Item data. The field may be empty when there's no need to update any existing item. Only customs fields for items are supported.

customsItemData

customsReferencesTexts

array of objects

Updates references and texts data. The field may be empty when there's no need to update any references and texts. This update deletes all existing references with the types included in this request from the shipment and adds the references and texts from the request to the shipment. Remember: All references of every reference type included in this request will be deleted! Only customs relevant references and texts are accepted. Therefore the following reference types are allowed only:

TYPE_CUSTOMS_REGISTRATION_NUMBER

TYPE_IMPORTER_EORI_NUMBER

TYPE_RECEIVER_EORI_NUMBER

TYPE_IMPORTER_VAT_NUMBER

TYPE_RECEIVER_VAT_NUMBER

TYPE_INVOICE_NUMBER

TYPE_SHIPPER_IOSS_NUMBER

TYPE_SHIPPER_PVA_NUMBER

TYPE_SHIPPER_VOEC_NUMBER

TYPE_RECEIVER_UKIMS_NUMBER

TYPE_IMPORTER_UKIMS_NUMBER

TYPE_RECEIVER_DUTY_DEFERMENT_NUMBER

TYPE_IMPORTER_DUTY_DEFERMENT_NUMBER

TYP_CUSTOMS_AGENT_EORI_NUMBER

TYPE_CUSTOMS_AGENT_VAT_NUMBER

TYPE_CUSTOMS_AGENT_UKIMS_NUMBER

TYPE_CUSTOMS_AGENT_DUTY_DEFERMENT_NUMBER

TYPE_SENT_NUMBER

TYPE_EKAER_NUMBER

TYPE_UIT_NUMBER

customsReferencesTexts

additionalValues

object

Additional values for the shipment. The definition of the included fields depends on the carrier. Only field names defined in the carrier customizing are allowed here.
Use the getCarrierProperties business facade call to retrieve all valid field names for a specific carrier.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Response

defaultdefault response