Get Purchase Orders

Function

To get purchase orders
取得進貨單

URL

GET API_DOMAIN/v1/pos/purchase_orders

Request Parameters

ParameterTypeDescriptionExample
queryStringPurchase order number or Custom ID20230321085431306
typeStringPurchase order Type
(purchase or return)
purchase
start_dateStringDate Range Start At2018-01-10T06:33:45.231+00:00
end_dateStringDate Range End At2018-01-10T06:33:45.231+00:00
statusesArray<String>Purchase order status
pending
received
completed
cancelled
['completed']
arrival_statusesArray<String>Purchase order arrival status
pending_to_receive
partial
all_received
all_returned
['all_received']
channel_idStringPurchase order channel ID6049d431709478001d7c496b
item_detailBooleanIs Show Item Detail Required
default: false
true
pageIntegerPage Number
頁數
(Default: 1)
1
per_pageIntegerNumbers of Orders per Page
每頁顯示 n 筆資料
(Default: 24)
20

Request Example

Response Body


Did this page help you?