Skip to main content
POST
Apply template group
Apply a template group to a shipment and its linked declarations, or to specific declarations by ID. This overlays the template’s default field values on the target declarations.

Path parameters

number
required
The unique template group ID.

Request payload

integer
The ID of the shipment to apply templates to. Use this when applying to all declarations under a shipment.
array
Array of specific declaration IDs to apply the template group to. Use this when applying to specific declarations instead of a full shipment.
boolean
default:"true"
If true, only overrides fields that are currently empty/null. If false, overwrites all matching fields.
string
default:"ifEmpty"
Controls how array fields (e.g. documents) are applied. Allowed values: ifEmpty, overwrite, replace.
JSON Payload