Orders | @tillhub/javascript-sdk

Hierarchy

ThBaseHandler
- Orders

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Orders(options: OrdersOptions, http: Client): Orders

Overrides ThBaseHandler.constructor
- Defined in src/v0/orders.ts:93
Parameters
- options: OrdersOptions
- http: Client
Returns Orders

Properties

endpoint

endpoint: string

http

http: Client

options

options: OrdersOptions

uriHelper

uriHelper: UriHelper

Static baseEndpoint

baseEndpoint: string = '/api/v0/orders'

Methods

bookStock

bookStock(query: BookStockRequest): Promise<OrdersResponse>

- Defined in src/v0/orders.ts:314
Parameters
- query: BookStockRequest
Returns Promise<OrdersResponse>

create

create(options: OrdersRequest): Promise<OrdersResponse>

- Defined in src/v0/orders.ts:122
Parameters
- options: OrdersRequest
Returns Promise<OrdersResponse>

createOrderItems

createOrderItems(body: OrderItemsCreateRequest): Promise<OrdersResponse>

- Defined in src/v0/orders.ts:191
Parameters
- body: OrderItemsCreateRequest
Returns Promise<OrdersResponse>

deleteOrderItems

deleteOrderItems(query: OrdersQuery): Promise<OrdersResponse>

- Defined in src/v0/orders.ts:170
Parameters
- query: OrdersQuery
Returns Promise<OrdersResponse>

getAll

getAll(query?: OrdersQuery): Promise<OrdersResponse>

- Defined in src/v0/orders.ts:105
Parameters
- Optional query: OrdersQuery
Returns Promise<OrdersResponse>

getHistoricOrderItems

getHistoricOrderItems(orderId: string): Promise<OrdersResponse>

- Defined in src/v0/orders.ts:298
Parameters
- orderId: string
Returns Promise<OrdersResponse>

getIncomingOrders

getIncomingOrders(query?: OrdersQuery): Promise<OrdersResponse>

- Defined in src/v0/orders.ts:237
Parameters
- Optional query: OrdersQuery
Returns Promise<OrdersResponse>

getOpenOrder

getOpenOrder(query?: OrdersQuery): Promise<OrdersResponse>

- Defined in src/v0/orders.ts:332
Parameters
- Optional query: OrdersQuery
Returns Promise<OrdersResponse>

getOrderItems

getOrderItems(orderId: string): Promise<OrdersResponse>

- Defined in src/v0/orders.ts:154
Parameters
- orderId: string
Returns Promise<OrdersResponse>

getOrderSuggestions

getOrderSuggestions(query?: OrdersQuery): Promise<OrdersResponse>

- Defined in src/v0/orders.ts:281
Parameters
- Optional query: OrdersQuery
Returns Promise<OrdersResponse>

getOutgoingOrders

getOutgoingOrders(query?: OrdersQuery): Promise<OrdersResponse>

- Defined in src/v0/orders.ts:259
Parameters
- Optional query: OrdersQuery
Returns Promise<OrdersResponse>

update

update(options: OrdersRequest): Promise<OrdersResponse>

- Defined in src/v0/orders.ts:138
Parameters
- options: OrdersRequest
Returns Promise<OrdersResponse>

updateOrderItem

updateOrderItem(query: OrderItemUpdateRequest): Promise<OrdersResponse>

- Defined in src/v0/orders.ts:221
Parameters
- query: OrderItemUpdateRequest
Returns Promise<OrdersResponse>

updateOrderItems

updateOrderItems(body: OrderItemsUpdateRequest): Promise<OrdersResponse>

- Defined in src/v0/orders.ts:206
Parameters
- body: OrderItemsUpdateRequest
Returns Promise<OrdersResponse>

Generated using TypeDoc