Class: OrderService
Defined in: service/OrderService.ts:516
Backwards-compatible class form. New code should call orderService(client).
Constructors
Constructor
new OrderService(
client):OrderService
Defined in: service/OrderService.ts:518
Parameters
client
Returns
OrderService
Methods
addItemsToOrderlist()
addItemsToOrderlist(
variables):Promise<Orderlist>
Defined in: service/OrderService.ts:613
Adds items to an orderlist
Parameters
variables
Orderlist add items input data
Returns
Promise<Orderlist>
addOrderStatusesToOrderStatusSet()
addOrderStatusesToOrderStatusSet(
variables):Promise<OrderStatusSet>
Defined in: service/OrderService.ts:683
Adds order statuses to an order status set
Parameters
variables
OrderStatusSetAddOrderStatusesVariables
Add order statuses input data
Returns
Promise<OrderStatusSet>
assignCompaniesToOrderlist()
assignCompaniesToOrderlist(
variables):Promise<Orderlist>
Defined in: service/OrderService.ts:623
Assigns companies to an orderlist
Parameters
variables
OrderlistAssignCompaniesVariables
Orderlist assign companies input data
Returns
Promise<Orderlist>
assignUsersToOrderlist()
assignUsersToOrderlist(
variables):Promise<Orderlist>
Defined in: service/OrderService.ts:633
Assigns users to an orderlist
Parameters
variables
Orderlist assign users input data
Returns
Promise<Orderlist>
createOrder()
createOrder(
variables):Promise<Order>
Defined in: service/OrderService.ts:533
Creates a new order
Parameters
variables
Order creation input data
Returns
Promise<Order>
createOrderItem()
createOrderItem(
variables):Promise<OrderItem>
Defined in: service/OrderService.ts:578
Creates a new order item
Parameters
variables
Variables for the order item creation mutation
Returns
Promise<OrderItem>
createOrderlist()
createOrderlist(
input):Promise<Orderlist>
Defined in: service/OrderService.ts:603
Creates a new orderlist
Parameters
input
Orderlist creation input data
Returns
Promise<Orderlist>
createOrderStatus()
createOrderStatus(
input):Promise<OrderStatus>
Defined in: service/OrderService.ts:653
Creates a new order status
Parameters
input
Order status creation input data
Returns
Promise<OrderStatus>
createOrderStatusSet()
createOrderStatusSet(
input):Promise<OrderStatusSet>
Defined in: service/OrderService.ts:673
Creates a new order status set
Parameters
input
Order status set creation input data
Returns
Promise<OrderStatusSet>
deleteOrderItem()
deleteOrderItem(
variables):Promise<boolean>
Defined in: service/OrderService.ts:588
Deletes an order item
Parameters
variables
Variables for the order item deletion mutation
Returns
Promise<boolean>
getOrder()
getOrder(
variables):Promise<Order>
Defined in: service/OrderService.ts:528
Fetches a single order by ID or UUID
Parameters
variables
Variables for the order query
Returns
Promise<Order>
getOrderAddress()
getOrderAddress(
variables):Promise<OrderAddress>
Defined in: service/OrderService.ts:568
Fetches order address
Parameters
variables
Order ID
Returns
Promise<OrderAddress>
getOrderAddresses()
getOrderAddresses(
orderId):Promise<OrderAddress[]>
Defined in: service/OrderService.ts:573
Fetches all addresses for an order
Parameters
orderId
number
Order ID
Returns
Promise<OrderAddress[]>
getOrderlist()
getOrderlist(
id):Promise<Orderlist>
Defined in: service/OrderService.ts:593
Fetches a single orderlist by ID
Parameters
id
number
Orderlist ID to fetch
Returns
Promise<Orderlist>
getOrderlists()
getOrderlists(
input?):Promise<OrderlistsResponse>
Defined in: service/OrderService.ts:598
Fetches a list of orderlists with search criteria
Parameters
input?
Orderlist search input parameters
Returns
Promise<OrderlistsResponse>
getOrderPDF()
getOrderPDF(
orderId):Promise<Base64File>
Defined in: service/OrderService.ts:558
Fetches order PDF
Parameters
orderId
number
Order ID
Returns
Promise<Base64File>
getOrders()
getOrders(
input?):Promise<OrderResponse>
Defined in: service/OrderService.ts:523
Fetches a list of orders with search criteria
Parameters
input?
Order search input parameters
Returns
Promise<OrderResponse>
getOrderStatus()
getOrderStatus(
variables):Promise<OrderStatus>
Defined in: service/OrderService.ts:643
Fetches a single order status by ID
Parameters
variables
Order status ID to fetch
Returns
Promise<OrderStatus>
getOrderStatuses()
getOrderStatuses(
input?):Promise<OrderStatusesResponse>
Defined in: service/OrderService.ts:648
Fetches a list of order statuses with search criteria
Parameters
input?
Order status search input parameters
Returns
Promise<OrderStatusesResponse>
getOrderStatusSet()
getOrderStatusSet(
variables):Promise<OrderStatusSet>
Defined in: service/OrderService.ts:663
Fetches a single order status set by ID
Parameters
variables
Order status set ID to fetch
Returns
Promise<OrderStatusSet>
getOrderStatusSets()
getOrderStatusSets(
input?):Promise<OrderStatusSetsResponse>
Defined in: service/OrderService.ts:668
Fetches a list of order status sets with search criteria
Parameters
input?
Order status set search input parameters
Returns
Promise<OrderStatusSetsResponse>
getQuotePDF()
getQuotePDF(
quoteId):Promise<Base64File>
Defined in: service/OrderService.ts:563
Fetches quote PDF
Parameters
quoteId
number
Quote ID
Returns
Promise<Base64File>
removeItemsFromOrderlist()
removeItemsFromOrderlist(
variables):Promise<Orderlist>
Defined in: service/OrderService.ts:618
Removes items from an orderlist
Parameters
variables
Orderlist remove items input data
Returns
Promise<Orderlist>
removeOrderStatusesFromOrderStatusSet()
removeOrderStatusesFromOrderStatusSet(
variables):Promise<OrderStatusSet>
Defined in: service/OrderService.ts:688
Removes order statuses from an order status set
Parameters
variables
OrderStatusSetRemoveOrderStatusesVariables
Remove order statuses input data
Returns
Promise<OrderStatusSet>
sendOrderConfirmationEmail()
sendOrderConfirmationEmail(
orderId):Promise<SendOrderConfirmResponseType>
Defined in: service/OrderService.ts:553
Sends order confirmation email
Parameters
orderId
number
Order ID
Returns
Promise<SendOrderConfirmResponseType>
setOrderStatus()
setOrderStatus(
input):Promise<Order>
Defined in: service/OrderService.ts:543
Sets the status of an order
Parameters
input
Order status input data
Returns
Promise<Order>
triggerQuoteSendRequest()
triggerQuoteSendRequest(
input):Promise<boolean>
Defined in: service/OrderService.ts:693
Triggers the send request event for a quote
Parameters
input
TriggerQuoteSendRequestEventInput
Quote send request event input data
Returns
Promise<boolean>
unassignCompaniesFromOrderlist()
unassignCompaniesFromOrderlist(
variables):Promise<Orderlist>
Defined in: service/OrderService.ts:628
Unassigns companies from an orderlist
Parameters
variables
OrderlistUnassignCompaniesVariables
Orderlist unassign companies input data
Returns
Promise<Orderlist>
unassignUsersFromOrderlist()
unassignUsersFromOrderlist(
variables):Promise<Orderlist>
Defined in: service/OrderService.ts:638
Unassigns users from an orderlist
Parameters
variables
OrderlistUnassignUsersVariables
Orderlist unassign users input data
Returns
Promise<Orderlist>
updateOrder()
updateOrder(
variables):Promise<Order>
Defined in: service/OrderService.ts:538
Updates an existing order
Parameters
variables
Variables for the order update mutation
Returns
Promise<Order>
updateOrderAddress()
updateOrderAddress(
variables):Promise<OrderAddress>
Defined in: service/OrderService.ts:548
Updates an order address
Parameters
variables
Variables for the order address update mutation
Returns
Promise<OrderAddress>
updateOrderItem()
updateOrderItem(
variables):Promise<OrderItem>
Defined in: service/OrderService.ts:583
Updates an existing order item
Parameters
variables
Variables for the order item update mutation
Returns
Promise<OrderItem>
updateOrderlist()
updateOrderlist(
variables):Promise<Orderlist>
Defined in: service/OrderService.ts:608
Updates an existing orderlist
Parameters
variables
Orderlist update input data
Returns
Promise<Orderlist>
updateOrderStatus()
updateOrderStatus(
variables):Promise<OrderStatus>
Defined in: service/OrderService.ts:658
Updates an existing order status
Parameters
variables
Order status update input data
Returns
Promise<OrderStatus>
updateOrderStatusSet()
updateOrderStatusSet(
variables):Promise<OrderStatusSet>
Defined in: service/OrderService.ts:678
Updates an existing order status set
Parameters
variables
Order status set update input data
Returns
Promise<OrderStatusSet>