Actions120
- company Actions
- address Actions
- user Actions
- project Actions
- statuses Actions
- pipelines Actions
- import Actions
- export Actions
- corrugatedMaterial Actions
- corrugatedMaterialComposition Actions
- corrugatedMaterialCompositionPrice Actions
- corrugatedFormat Actions
- corrugatedSupplier Actions
- corrugatedFlute Actions
- corrugatedLiner Actions
- article Actions
- order Actions
- orderItem Actions
- currency Actions
- job Actions
address → Create
AI-generatedSummary
Create a new address record in the HIPE system with specified details including name, address components, and optional company association.
Inputs
- Company ID — Optional ID of the company associated with the address.
- Address (required) — Primary address line.
- City (required) — City of the address.
- Country (required) — Country of the address.
- First Complementary Address — Optional first complementary address detail.
- Second Complementary Address — Optional second complementary address detail.
- Name (required) — Name to identify the address.
- State — State or region of the address.
- Zip Code (required) — Postal code of the address.
- External ID — Optional external identifier for the address.
- Options — Additional optional parameters for address creation.
- Async Mode — Whether to execute the creation asynchronously, returning a job ID instead of waiting for completion.
Output shape
A single record representing the created address, or a job ID if asynchronous mode is enabled.
The output contains the created address data as returned by the HIPE API or a job ID for asynchronous processing. Optional fields can be omitted if not provided.
Examples
Example 1: Create a basic address synchronously
Provide mandatory fields Name, Address, City, Country, Zip Code; leave Async Mode unchecked.
Example 2: Create an address associated with a company asynchronously
Set Company ID along with mandatory fields and enable Async Mode to receive a job ID immediately.