注文の一覧

GET /orders

注文の一覧を取得するには、/api/ordersに対してGETを送信します。

リクエスト：ヘッダー

Name	Value
Content-Type	application/json
Authorization	Basic <認証情報>

認証情報について

認証情報は、ユーザーのEメールアドレスとAPIキーをコロンで連結したものをBase64エンコードしたものです。

PATH パラメータ

page int32 Defaults to 1 ページ番号

1 items_per_page int32 Defaults to 10 1ページあたりの表示数

10 sort_by string Defaults to date ソートキー

date sort_order string Defaults to desc desc status string user_id int32 company_id int32 email string invoice_id int32 credit_memo_id int32

Name	Type	説明	デフォルト値
page	integer	ページ番号	1
items_per_page	integer	1ページあたりの表示数	10
sort_by	string	ソートキー	date
sort_order	string	ソート順序	desc
status	string	ステータス
user_id	integer	ユーザーID
company_id	integer	ベンダーID
email	string	ユーザーのメールアドレス
invoice_id	integer	請求書ID
credit_memo_id	integer	クレジットメモID

レスポンス

200

{
  "orders": [
    {
      "order_id": "98",
      "issuer_id": null,
      "user_id": "1",
      "is_parent_order": "N",
      "parent_order_id": "0",
      "company_id": "1",
      "company": "",
      "timestamp": "1577320136",
      "firstname": "日本",
      "lastname": "太郎",
      "email": "[email protected]",
      "phone": "01-2345-6789",
      "status": "O",
      "total": "29880.00",
      "invoice_id": null,
      "credit_memo_id": null,
      "issuer_name": null
    },
    {
      "order_id": "97",
      "issuer_id": null,
      "user_id": "3",
      "is_parent_order": "N",
      "parent_order_id": "0",
      "company_id": "1",
      "company": "",
      "timestamp": "1572431735",
      "firstname": "George",
      "lastname": "Nills",
      "email": "[email protected]",
      "phone": "[phone]",
      "status": "O",
      "total": "677.95",
      "invoice_id": null,
      "credit_memo_id": null,
      "issuer_name": null
    },
    {
      "order_id": "96",
      "issuer_id": null,
      "user_id": "3",
      "is_parent_order": "N",
      "parent_order_id": "0",
      "company_id": "1",
      "company": "",
      "timestamp": "1572431735",
      "firstname": "Customer",
      "lastname": "Customer",
      "email": "[email protected]",
      "phone": "",
      "status": "P",
      "total": "972.00",
      "invoice_id": null,
      "credit_memo_id": null,
      "issuer_name": null
    }
  ],
  "params": {
    "page": 1,
    "items_per_page": 10,
    "include_incompleted": false,
    "sort_order": "desc",
    "sort_by": "date",
    "sort_order_rev": "asc",
    "total_items": "65"
  }
}

400