Get Purchase Orders

Function

To get purchase orders
取得進貨單

URL

GET <<api_domain>>/v1/pos/purchase_orders

Request Parameters

Parameter

Type

Description

Example

query

String

Purchase order number or Custom ID

20230321085431306

type

String

Purchase order Type
(purchase or return)

purchase

start_date

String

Date Range Start At

2018-01-10T06:33:45.231+00:00

end_date

String

Date Range End At

2018-01-10T06:33:45.231+00:00

statuses

Array<String>

Purchase order status
pending
received
completed
cancelled

['completed']

arrival_statuses

Array<String>

Purchase order arrival status
pending_to_receive
partial
all_received
all_returned

['all_received']

channel_id

String

Purchase order channel ID

6049d431709478001d7c496b

item_detail

Boolean

Is Show Item Detail Required
default: false

true

page

Integer

Page Number
頁數
(Default: 1)

1

per_page

Integer

Numbers of Orders per Page
每頁顯示 n 筆資料
(Default: 24)

20

Request Example

Response Body