---
title: "Get purchase orders"
method: GET
path: "/pos/purchase_orders"
tags: ["Purchase Orders"]
---

# Get purchase orders

`GET /pos/purchase_orders`

Get purchase orders<br>取得進貨單

## Query parameters

- `query` string
- `type` string
- `statuses[]` string[]
- `arrival_statuses` string[]
- `channel_id` string
- `warehouse_id` string
- `start_date` string
- `end_date` string
- `supplier_id` string
- `item_detail` boolean

## Response `200`

OK

- PurchaseOrders
  - `pagination` Paginatable
    - `current_page` integer — The current page number<br>當前分頁
    - `per_page` integer — Number of result per page<br>每頁顯示 n 筆資料<br>(Default: 24)
    - `total_count` integer — Number of result in total<br>資料總量
    - `total_pages` integer — Number of pages in total<br>總頁數量
  - `items` PurchaseOrder[]
    - `id` string — Purchase Order ID<br>進貨單 ID
    - `type` 'purchase' | 'return' — Type<br> 類型
    - `number` string — PurchaseOrder Number<br>單號
    - `custom_number` string — Custom Number<br>自訂單號
    - `status` 'pending' | 'received' | 'completed' | 'cancelled' | 'removed' — Status<br>貨單狀態
    - `arrival_status` 'pending_to_receive' | 'partial' | 'all_received' | 'all_returned' — Arrival Status<br>到貨狀態
    - `scheduled_time` string — Time scheduled to arrive at<br預定到貨日期
    - `actual_time` string — Actual Time to arrive at<br>完成進貨日期
    - `other_fee` object — Other Fee<br>其他費用
      - `cents` integer
      - `currency_symbol` string
      - `currency_iso` string
      - `label` string
      - `dollars` number
    - `total_amount` object — Total Amount<br>預期成本
      - `cents` integer
      - `currency_symbol` string
      - `currency_iso` string
      - `label` string
      - `dollars` number
    - `current_amount` object — Current Amount<br>實際成本
      - `cents` integer
      - `currency_symbol` string
      - `currency_iso` string
      - `label` string
      - `dollars` number
    - `total_quantity` integer — Total Quantity<br>進貨數量
    - `current_quantity` integer — Current Quantity<br>點收數量
    - `note` string — Note<br>備註
    - `child_id` string — Child ID<br>子進貨單 ID
    - `group_id` string — Group ID<br>進貨單群組 ID
    - `items` object[]
      - `id` string — Purchase Order Item ID<br>進貨單項目 ID
      - `product_id` string — Product ID<br> 產品 ID
      - `variation_id` string — Variation ID<br>規格 ID
      - `product_name` object — Product Name<br>產品名稱
        - `zh-hant` string
        - `en` string
      - `variation_titles` object[]
        - `zh-hant` string
        - `en` string
      - `variation_name` object — Variation Name<br>規格內容
        - `zh-hant` string
        - `en` string
      - `image_url` string — Image URL<br圖片網址
      - `sku` string — Stock Keeping Unit<br>商品貨號
      - `gtin` string — Global Trade Item Numbers<br>商品條碼編號
      - `total_quantity` integer — Total Quantity<br>進貨數量
      - `current_quantity` integer — Current Quantity<br>點收數量
      - `purchase_price` object — Purchase Price<br>成本
        - `cents` integer
        - `currency_symbol` string
        - `currency_iso` string
        - `label` string
        - `dollars` number
      - `supplier_id` string — supplier_id<br>供應商 ID
      - `supplier_name` string — supplier_name<br>供應商名稱
      - `subtotal` object — Subtotal<br>小計
        - `cents` integer
        - `currency_symbol` string
        - `currency_iso` string
        - `label` string
        - `dollars` number
      - `price` object — Price<br>價格
        - `cents` integer
        - `currency_symbol` string
        - `currency_iso` string
        - `label` string
        - `dollars` number
      - `product_removed` boolean — Is Product Removed<br>商品是否已移除
      - `unlimited_quantity` boolean — Is Unlimited Quantity<br>是否為無限量庫存
      - `same_price` boolean — Same Price<br>價格是否相同
      - `total_stocks_cost` object — Total Stocks Cost<br>所有庫存成本
        - `cents` integer
        - `currency_symbol` string
        - `currency_iso` string
        - `label` string
        - `dollars` number
      - `stocks` object — Stock<br>庫存
    - `issuer` object — Issuer<br>進貨人員
      - `id` string — Id of the agent<br>員工ID
      - `email` string — Email of the agent<br>員工電郵
      - `name` string — Name of the agent<br>員工名稱
      - `phone` string — Phone of the agent<br>員工電話號碼
      - `is_working` boolean — Working status of the agent<br>員工工作狀態（上班/下班）
      - `channel_ids` unknown[] — Staff's store IDs<br>員工所有的門市
        - unknown
    - `executor` object — executor<br>入庫人員
      - `id` string — Id of the agent<br>員工ID
      - `email` string — Email of the agent<br>員工電郵
      - `name` string — Name of the agent<br>員工名稱
      - `phone` string — Phone of the agent<br>員工電話號碼
      - `is_working` boolean — Working status of the agent<br>員工工作狀態（上班/下班）
      - `channel_ids` unknown[] — Staff's store IDs<br>員工所有的門市
        - unknown
    - `channel` PosChannel
      - `id` string
      - `name` object
      - `warehouse_id` string
    - `warehouse` PosWarehouse
      - `id` string — Warehouse’s id<br>倉庫 id
      - `name` string — Warehouse’s name<br>倉庫名稱
    - `supplier` object — Supplier<br>供應商
      - `id` string — Id of the supplier<br>供應商ID
      - `name_translations` Translatable
        - `en` string — Merchant defined English name<br>店家定義英文名稱
        - `zh-hant` string — Merchant defined Traditional Chinese name<br>店家定義繁體中文名稱
        - `zh-cn` string — Merchant defined Simplified Chinese name<br>店家定義簡體中文名稱
        - `vi` string — Merchant defined Vietnamese name<br>店家定義越南文名稱
        - `ms` string — Merchant defined Malaysian name<br>店家定義馬來西亞文名稱
        - `ja` string — Merchant defined Japanese name<br>店家定義日文名稱
        - `th` string — Merchant defined Thai name<br>店家定義泰文名稱
        - `id` string — Merchant defined Indian name<br>店家定義印度文名稱
        - `de` string — Merchant defined Deutsch name<br>店家定義德文名稱
        - `fr` string — Merchant defined France name<br>店家定義法文名稱
      - `name` string — Name of the supplier<br>供應商名稱
      - `address` string — Address of the supplier<br>供應商地址
      - `phone` string — Phone of the supplier<br>供應商電話號碼
      - `note` string — Note of the supplier<br>供應商備注
      - `status` string — Working status of the supplier<br>供應商狀態 (active/removed)
    - `has_removed_items` boolean — Has Removed Items<br>有商品被移除的進貨單項目
    - `group_purchase_orders` object[]
      - `id` Id — unresolved $ref
      - `purchase_number` Number — unresolved $ref
      - `status` Status — unresolved $ref
    - `created_at` string — Created at<br>建立時間
    - `updated_at` string — Updated at<br>更新時間

## Other responses

- `403` — Forbidden
- `500` — Server error

---

[API](https://skmtc.net/shoplineapp/apis/shopline-open-api.md) · [All operations](https://skmtc.net/shoplineapp/apis/shopline-open-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/shoplineapp/shopline-open-api/revisions/1675ac12cde7/schema)