@tillhub/javascript-sdk
Options
All
Public
Public/Protected
All
Inherited
Externals
Only exported
Menu
Purchase
Orders
constructor
endpoint
http
options
uri
Helper
base
Endpoint
bulk
Add
Products
bulk
Delete
Products
create
export
get
get
All
meta
pdf
Uri
preview
put
send
Purchase
Orders
Bulk
Add
Products
Failed
Purchase
Orders
Bulk
Delete
Products
Failed
Purchase
Orders
Creation
Failed
Purchase
Orders
Export
Failed
Purchase
Orders
Get
Failed
Purchase
Orders
Meta
Failed
Purchase
Orders
Update
Failed
Purchase
Order
Purchase
Order
Export
Purchase
Order
Meta
Query
Purchase
Order
Product
Purchase
Orders
Bulk
Add
Products
Query
Purchase
Orders
Bulk
Delete
Products
Query
Purchase
Orders
Create
Query
Purchase
Orders
Export
Response
Purchase
Orders
Multiple
Response
Purchase
Orders
Options
Purchase
Orders
Pdf
Response
Purchase
Orders
Preview
Response
Purchase
Orders
Send
Query
Purchase
Orders
Single
Response
Purchase
Orders
Update
Query
Purchase
Order
Status
Hierarchy
ThBaseHandler
PurchaseOrders
Index
Constructors
constructor
Properties
endpoint
http
options
uri
Helper
base
Endpoint
Methods
bulk
Add
Products
bulk
Delete
Products
create
export
get
get
All
meta
pdf
Uri
preview
put
send
Constructors
constructor
new
Purchase
Orders
(
options
:
PurchaseOrdersOptions
, http
:
Client
)
:
PurchaseOrders
Parameters
options:
PurchaseOrdersOptions
http:
Client
Returns
PurchaseOrders
Properties
endpoint
endpoint
:
string
http
http
:
Client
options
options
:
PurchaseOrdersOptions
uri
Helper
uri
Helper
:
UriHelper
Static
base
Endpoint
base
Endpoint
:
string
= '/api/v0/purchase-orders'
Methods
bulk
Add
Products
bulk
Add
Products
(
purchaseOrderId
:
string
, purchaseOrder
:
PurchaseOrdersBulkAddProductsQuery
)
:
Promise
<
PurchaseOrdersSingleResponse
>
Parameters
purchaseOrderId:
string
purchaseOrder:
PurchaseOrdersBulkAddProductsQuery
Returns
Promise
<
PurchaseOrdersSingleResponse
>
bulk
Delete
Products
bulk
Delete
Products
(
purchaseOrderId
:
string
, purchaseOrder
:
PurchaseOrdersBulkDeleteProductsQuery
)
:
Promise
<
PurchaseOrdersSingleResponse
>
Parameters
purchaseOrderId:
string
purchaseOrder:
PurchaseOrdersBulkDeleteProductsQuery
Returns
Promise
<
PurchaseOrdersSingleResponse
>
create
create
(
purchaseOrder
:
PurchaseOrdersCreateQuery
)
:
Promise
<
PurchaseOrdersSingleResponse
>
Parameters
purchaseOrder:
PurchaseOrdersCreateQuery
Returns
Promise
<
PurchaseOrdersSingleResponse
>
export
export
(
q
?:
PurchaseOrderMetaQuery
)
:
Promise
<
PurchaseOrdersExportResponse
>
Parameters
Optional
q:
PurchaseOrderMetaQuery
Returns
Promise
<
PurchaseOrdersExportResponse
>
get
get
(
purchaseOrderId
:
string
)
:
Promise
<
PurchaseOrdersSingleResponse
>
Parameters
purchaseOrderId:
string
Returns
Promise
<
PurchaseOrdersSingleResponse
>
get
All
get
All
(
query
?:
Record
<
string
,
unknown
>
)
:
Promise
<
PurchaseOrdersMultipleResponse
>
Parameters
Optional
query:
Record
<
string
,
unknown
>
Returns
Promise
<
PurchaseOrdersMultipleResponse
>
meta
meta
(
q
?:
PurchaseOrderMetaQuery
)
:
Promise
<
PurchaseOrdersMultipleResponse
>
Parameters
Optional
q:
PurchaseOrderMetaQuery
Returns
Promise
<
PurchaseOrdersMultipleResponse
>
pdf
Uri
pdf
Uri
(
purchaseOrderId
:
string
)
:
Promise
<
PurchaseOrdersPdfResponse
>
Parameters
purchaseOrderId:
string
Returns
Promise
<
PurchaseOrdersPdfResponse
>
preview
preview
(
purchaseOrderId
:
string
)
:
Promise
<
PurchaseOrdersPreviewResponse
>
Parameters
purchaseOrderId:
string
Returns
Promise
<
PurchaseOrdersPreviewResponse
>
put
put
(
purchaseOrderId
:
string
, purchaseOrder
:
PurchaseOrdersUpdateQuery
)
:
Promise
<
PurchaseOrdersSingleResponse
>
Parameters
purchaseOrderId:
string
purchaseOrder:
PurchaseOrdersUpdateQuery
Returns
Promise
<
PurchaseOrdersSingleResponse
>
send
send
(
purchaseOrderId
:
string
, sendQuery
:
PurchaseOrdersSendQuery
)
:
Promise
<
PurchaseOrdersSingleResponse
>
Parameters
purchaseOrderId:
string
sendQuery:
PurchaseOrdersSendQuery
Returns
Promise
<
PurchaseOrdersSingleResponse
>
Generated using
TypeDoc