Skip to main content

Function: addressService()

addressService(client): object

Defined in: service/AddressService.ts:22

Service class for Address-related GraphQL operations

Parameters​

client​

GraphQLClient

Returns​

createCompanyAddress()​

createCompanyAddress(input): Promise<Address>

Creates a new address for a company *

Parameters​

input​

CompanyAddressCreateInput

Company address creation input data *

Returns​

Promise<Address>

Promise<Address> The created address

createCustomerAddress()​

createCustomerAddress(input): Promise&lt;Address>

Creates a new address for a customer *

Parameters​

input​

CustomerAddressCreateInput

Customer address creation input data *

Returns​

Promise&lt;Address>

Promise<Address> The created address

deleteCompanyAddress()​

deleteCompanyAddress(input): Promise&lt;boolean>

Deletes a company address *

Parameters​

input​

CompanyAddressDeleteInput

Company address deletion input data *

Returns​

Promise&lt;boolean>

Promise<boolean> Success status of the deletion

deleteCustomerAddress()​

deleteCustomerAddress(input): Promise&lt;boolean>

Deletes a customer address *

Parameters​

input​

CustomerAddressDeleteInput

Customer address deletion input data *

Returns​

Promise&lt;boolean>

Promise<boolean> Success status of the deletion

getAddressesByCompanyId()​

getAddressesByCompanyId(companyId): Promise&lt;Address[]>

Fetches addresses for a company *

Parameters​

companyId​

number

Company ID *

Returns​

Promise&lt;Address[]>

Promise<Address[]> The addresses array

getAddressesByCustomerId()​

getAddressesByCustomerId(customerId): Promise&lt;Address[]>

Fetches addresses for a customer *

Parameters​

customerId​

number

Customer ID *

Returns​

Promise&lt;Address[]>

Promise<Address[]> The addresses array

getAddressesByOrderId()​

getAddressesByOrderId(orderId): Promise&lt;Address[]>

Fetches addresses for an order *

Parameters​

orderId​

number

Order ID *

Returns​

Promise&lt;Address[]>

Promise<Address[]> The addresses array

Deprecated​

The upstream addressesByOrderId query is deprecated. Use OrderService.getOrderAddresses instead. *

updateCompanyAddress()​

updateCompanyAddress(input): Promise&lt;Address>

Updates an existing company address *

Parameters​

input​

CompanyAddressUpdateInput

Company address update input data *

Returns​

Promise&lt;Address>

Promise<Address> The updated address

updateCustomerAddress()​

updateCustomerAddress(input): Promise&lt;Address>

Updates an existing customer address *

Parameters​

input​

CustomerAddressUpdateInput

Customer address update input data *

Returns​

Promise&lt;Address>

Promise<Address> The updated address