Skip to main content

Function: orderService()

orderService(client): object

Defined in: service/OrderService.ts:163

Service class for Order-related GraphQL operations

Parameters​

client​

GraphQLClient

Returns​

addItemsToOrderlist()​

addItemsToOrderlist(variables): Promise<Orderlist>

Adds items to an orderlist *

Parameters​

variables​

OrderlistAddItemsVariables

Orderlist add items input data *

Returns​

Promise<Orderlist>

Promise<Orderlist> The updated orderlist

addOrderStatusesToOrderStatusSet()​

addOrderStatusesToOrderStatusSet(variables): Promise&lt;OrderStatusSet>

Adds order statuses to an order status set *

Parameters​

variables​

OrderStatusSetAddOrderStatusesVariables

Add order statuses input data *

Returns​

Promise&lt;OrderStatusSet>

Promise<OrderStatusSet> The updated order status set

assignCompaniesToOrderlist()​

assignCompaniesToOrderlist(variables): Promise&lt;Orderlist>

Assigns companies to an orderlist *

Parameters​

variables​

OrderlistAssignCompaniesVariables

Orderlist assign companies input data *

Returns​

Promise&lt;Orderlist>

Promise<Orderlist> The updated orderlist

assignUsersToOrderlist()​

assignUsersToOrderlist(variables): Promise&lt;Orderlist>

Assigns users to an orderlist *

Parameters​

variables​

OrderlistAssignUsersVariables

Orderlist assign users input data *

Returns​

Promise&lt;Orderlist>

Promise<Orderlist> The updated orderlist

createOrder()​

createOrder(variables): Promise&lt;Order>

Creates a new order *

Parameters​

variables​

OrderCreateVariables

Order creation input data *

Returns​

Promise&lt;Order>

Promise<Order> The created order

createOrderItem()​

createOrderItem(variables): Promise&lt;OrderItem>

Creates a new order item *

Parameters​

variables​

OrderItemCreateVariables

Variables for the order item creation mutation

    • orderId: number - Order ID to create order item for
    • orderItem: OrderItemCreateInput - Order item creation input data
    • language: string - Language for localized content
    • imageSearchFilters: MediaImageProductSearchInput - Image search filters
    • imageVariantFilters: TransformationsInput - Image transformation filters

Returns​

Promise&lt;OrderItem>

Promise<OrderItem> The created order item

createOrderlist()​

createOrderlist(input): Promise&lt;Orderlist>

Creates a new orderlist *

Parameters​

input​

OrderlistCreateInput

Orderlist creation input data *

Returns​

Promise&lt;Orderlist>

Promise<Orderlist> The created orderlist

createOrderStatus()​

createOrderStatus(input): Promise&lt;OrderStatus>

Creates a new order status *

Parameters​

input​

CreateOrderStatusInput

Order status creation input data *

Returns​

Promise&lt;OrderStatus>

Promise<OrderStatus> The created order status

createOrderStatusSet()​

createOrderStatusSet(input): Promise&lt;OrderStatusSet>

Creates a new order status set *

Parameters​

input​

CreateOrderStatusSetInput

Order status set creation input data *

Returns​

Promise&lt;OrderStatusSet>

Promise<OrderStatusSet> The created order status set

deleteOrderItem()​

deleteOrderItem(variables): Promise&lt;boolean>

Deletes an order item *

Parameters​

variables​

OrderItemDeleteVariables

Variables for the order item deletion mutation

    • orderId: number - Order ID to delete order item for
    • orderItemId: number - Order item ID to delete

Returns​

Promise&lt;boolean>

Promise<boolean> True if order item was deleted successfully

getAddressesByOrderId()​

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

Fetches addresses by order ID *

Parameters​

orderId​

number

Order ID *

Returns​

Promise&lt;Address[]>

Promise<Address[]> The addresses array

Deprecated​

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

getOrder()​

getOrder(variables): Promise&lt;Order>

Fetches a single order by ID or UUID *

Parameters​

variables​

OrderQueryVariables

Variables for the order query

    • orderId: number - Order ID to fetch
    • orderUUID: String - Order UUID unique identifier
    • language: string - Language for localized content
    • imageSearchFilters: MediaImageProductSearchInput - Image search filters
    • imageVariantFilters: TransformationsInput - Image transformation filters

Returns​

Promise&lt;Order>

Promise<Order> The order data

getOrderAddress()​

getOrderAddress(variables): Promise&lt;OrderAddress>

Fetches order address *

Parameters​

variables​

OrderAddressVariables

Order ID *

Returns​

Promise&lt;OrderAddress>

Promise<Address> The address data

getOrderAddresses()​

getOrderAddresses(orderId): Promise&lt;OrderAddress[]>

Fetches all addresses for an order *

Parameters​

orderId​

number

Order ID *

Returns​

Promise&lt;OrderAddress[]>

Promise<Address[]> The addresses array

getOrderlist()​

getOrderlist(id): Promise&lt;Orderlist>

Fetches a single orderlist by ID *

Parameters​

id​

number

Orderlist ID to fetch *

Returns​

Promise&lt;Orderlist>

Promise<Orderlist> The orderlist data

getOrderlists()​

getOrderlists(input?): Promise&lt;OrderlistsResponse>

Fetches a list of orderlists with search criteria *

Parameters​

input?​

OrderlistSearchInput

Orderlist search input parameters *

Returns​

Promise&lt;OrderlistsResponse>

Promise<OrderlistsResponse> The orderlists response data

getOrderPDF()​

getOrderPDF(orderId): Promise&lt;Base64File>

Fetches order PDF *

Parameters​

orderId​

number

Order ID *

Returns​

Promise&lt;Base64File>

Promise<any> The PDF data

getOrders()​

getOrders(input?): Promise&lt;OrderResponse>

Fetches a list of orders with search criteria *

Parameters​

input?​

OrderSearchArguments

Order search input parameters *

Returns​

Promise&lt;OrderResponse>

Promise<OrderResponse> The orders response data

getOrderStatus()​

getOrderStatus(variables): Promise&lt;OrderStatus>

Fetches a single order status by ID *

Parameters​

variables​

OrderStatusVariables

Order status ID to fetch *

Returns​

Promise&lt;OrderStatus>

Promise<OrderStatus> The order status data

getOrderStatuses()​

getOrderStatuses(input?): Promise&lt;OrderStatusesResponse>

Fetches a list of order statuses with search criteria *

Parameters​

input?​

OrderStatusesSearchInput

Order status search input parameters *

Returns​

Promise&lt;OrderStatusesResponse>

Promise<OrderStatusesResponse> The order statuses response data

getOrderStatusSet()​

getOrderStatusSet(variables): Promise&lt;OrderStatusSet>

Fetches a single order status set by ID *

Parameters​

variables​

OrderStatusSetVariables

Order status set ID to fetch *

Returns​

Promise&lt;OrderStatusSet>

Promise<OrderStatusSet> The order status set data

getOrderStatusSets()​

getOrderStatusSets(input?): Promise&lt;OrderStatusSetsResponse>

Fetches a list of order status sets with search criteria *

Parameters​

input?​

OrderStatusSetsSearchInput

Order status set search input parameters *

Returns​

Promise&lt;OrderStatusSetsResponse>

Promise<OrderStatusSetsResponse> The order status sets response data

getQuotePDF()​

getQuotePDF(quoteId): Promise&lt;Base64File>

Fetches quote PDF *

Parameters​

quoteId​

number

Quote ID *

Returns​

Promise&lt;Base64File>

Promise<any> The PDF data

removeItemsFromOrderlist()​

removeItemsFromOrderlist(variables): Promise&lt;Orderlist>

Removes items from an orderlist *

Parameters​

variables​

OrderlistRemoveItemsVariables

Orderlist remove items input data *

Returns​

Promise&lt;Orderlist>

Promise<Orderlist> The updated orderlist

removeOrderStatusesFromOrderStatusSet()​

removeOrderStatusesFromOrderStatusSet(variables): Promise&lt;OrderStatusSet>

Removes order statuses from an order status set *

Parameters​

variables​

OrderStatusSetRemoveOrderStatusesVariables

Remove order statuses input data *

Returns​

Promise&lt;OrderStatusSet>

Promise<OrderStatusSet> The updated order status set

sendOrderConfirmationEmail()​

sendOrderConfirmationEmail(orderId): Promise&lt;SendOrderConfirmResponseType>

Sends order confirmation email *

Parameters​

orderId​

number

Order ID *

Returns​

Promise&lt;SendOrderConfirmResponseType>

Promise<boolean> Success status

setOrderStatus()​

setOrderStatus(input): Promise&lt;Order>

Sets the status of an order *

Parameters​

input​

OrderSetStatusInput

Order status input data *

Returns​

Promise&lt;Order>

Promise<Order> The updated order

triggerQuoteSendRequest()​

triggerQuoteSendRequest(input): Promise&lt;boolean>

Triggers the send request event for a quote *

Parameters​

input​

TriggerQuoteSendRequestEventInput

Quote send request event input data *

Returns​

Promise&lt;boolean>

Promise<boolean> Success status

unassignCompaniesFromOrderlist()​

unassignCompaniesFromOrderlist(variables): Promise&lt;Orderlist>

Unassigns companies from an orderlist *

Parameters​

variables​

OrderlistUnassignCompaniesVariables

Orderlist unassign companies input data *

Returns​

Promise&lt;Orderlist>

Promise<Orderlist> The updated orderlist

unassignUsersFromOrderlist()​

unassignUsersFromOrderlist(variables): Promise&lt;Orderlist>

Unassigns users from an orderlist *

Parameters​

variables​

OrderlistUnassignUsersVariables

Orderlist unassign users input data *

Returns​

Promise&lt;Orderlist>

Promise<Orderlist> The updated orderlist

updateOrder()​

updateOrder(variables): Promise&lt;Order>

Updates an existing order *

Parameters​

variables​

OrderUpdateVariables

Variables for the order update mutation

    • orderId: number - Order ID to update
    • order: OrderUpdateInput - Order update input data
    • language: string - Language for localized content
    • imageSearchFilters: MediaImageProductSearchInput - Image search filters
    • imageVariantFilters: TransformationsInput - Image transformation filters

Returns​

Promise&lt;Order>

Promise<Order> The updated order

updateOrderAddress()​

updateOrderAddress(variables): Promise&lt;OrderAddress>

Updates an order address *

Parameters​

variables​

OrderAddressUpdateVariables

Variables for the order address update mutation

    • id: number - Id to identify address
    • orderId: number - Order ID to update order address for
    • input: OrderAddressUpdateInput - Order address update input data

Returns​

Promise&lt;OrderAddress>

Promise<OrderAddress> The updated order

updateOrderItem()​

updateOrderItem(variables): Promise&lt;OrderItem>

Updates an existing order item *

Parameters​

variables​

OrderItemUpdateVariables

Variables for the order item update mutation

    • orderId: number - Order ID to update order item for
    • orderItem: OrderItemUpdateInput - Order item update input data
    • language: string - Language for localized content
    • imageSearchFilters: MediaImageProductSearchInput - Image search filters
    • imageVariantFilters: TransformationsInput - Image transformation filters

Returns​

Promise&lt;OrderItem>

Promise<OrderItem> The updated order item

updateOrderlist()​

updateOrderlist(variables): Promise&lt;Orderlist>

Updates an existing orderlist *

Parameters​

variables​

OrderlistUpdateVariables

Orderlist update input data *

Returns​

Promise&lt;Orderlist>

Promise<Orderlist> The updated orderlist

updateOrderStatus()​

updateOrderStatus(variables): Promise&lt;OrderStatus>

Updates an existing order status *

Parameters​

variables​

OrderStatusUpdateVariables

Order status update input data *

Returns​

Promise&lt;OrderStatus>

Promise<OrderStatus> The updated order status

updateOrderStatusSet()​

updateOrderStatusSet(variables): Promise&lt;OrderStatusSet>

Updates an existing order status set *

Parameters​

variables​

OrderStatusSetUpdateVariables

Order status set update input data *

Returns​

Promise&lt;OrderStatusSet>

Promise<OrderStatusSet> The updated order status set