支払方法一覧取得

GET

/payments

const url = 'https://api.smaregi.dev/TARGET-CONTRACT-ID/ec-oms/payments?limit=100&page=1&fields=paymentId%2CpaymentMethod&payment_id=1%2C2&payment_method=%E3%83%86%E3%82%B9%E3%83%88%E6%94%AF%E6%89%95%E6%96%B9%E6%B3%951%2C%E3%83%86%E3%82%B9%E3%83%88%E6%94%AF%E6%89%95%E6%96%B9%E6%B3%952&sort=rank%3Adesc';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.smaregi.dev/TARGET-CONTRACT-ID/ec-oms/payments?limit=100&page=1&fields=paymentId%2CpaymentMethod&payment_id=1%2C2&payment_method=%E3%83%86%E3%82%B9%E3%83%88%E6%94%AF%E6%89%95%E6%96%B9%E6%B3%951%2C%E3%83%86%E3%82%B9%E3%83%88%E6%94%AF%E6%89%95%E6%96%B9%E6%B3%952&sort=rank%3Adesc' \
  --header 'Authorization: Bearer <token>'

支払方法の一覧を取得します。

Authorizations

AppAccessToken
ec-oms.payments:read

Parameters

Query Parameters

limit

integer

default: 100 >= 1 <= 1000

取得件数

page

integer

default: 1 >= 1

ページ

fields

Array<string>

>= 1 items unique items

Allowed values: paymentId paymentMethod

取得するフィールドをカンマ区切りで指定します。指定がない場合すべてのフィールドを取得します。

Example

?fields=paymentId,paymentMethod

payment_id

Array<string>

>= 1 items unique items

支払方法IDで絞り込みを行います。

完全一致で判定します。
カンマ区切りで複数指定した場合はOR条件として扱います（例: 1,2 は支払方法IDが1または2に一致するレコードを返却します）。
空文字を指定した場合や、カンマ区切り内に空要素を含む場合（例: 1,,2）は400エラーを返却します。
パラメータを省略した場合は絞り込みを行いません。

Example

?payment_id=1,2

payment_method

Array<string>

>= 1 items unique items

支払方法名で絞り込みを行います。

完全一致で判定します（部分一致は不可）。
カンマ区切りで複数指定した場合はOR条件として扱います（例: A,B はAまたはBに一致するレコードを返却します）。
空文字を指定した場合や、カンマ区切り内に空要素を含む場合（例: A,,B）は400エラーを返却します。
パラメータを省略した場合は絞り込みを行いません。

Example

?payment_method=%E3%83%86%E3%82%B9%E3%83%88%E6%94%AF%E6%89%95%E6%96%B9%E6%B3%951,%E3%83%86%E3%82%B9%E3%83%88%E6%94%AF%E6%89%95%E6%96%B9%E6%B3%952

sort

string

default: rank:desc

Allowed values: rank rank:desc

ソート

rank: ソート順

Example

rank:desc

Responses

200

取得成功

application/json

Array<object>

Payment

object

paymentId

支払方法ID

string

>= 1 characters <= 9 characters

paymentMethod

支払方法名

string

>= 1 characters <= 50 characters

Examples

default

[
  {
    "paymentId": "1",
    "paymentMethod": "テスト支払方法"
  }
]

Headers

Link

string

<前ページURI>; rel="prev", <次ページURI>; rel="next", <最初ページURI>; rel="start", <最終ページURI>; rel="last"

400

limitが範囲外の場合
pageが範囲外の場合

application/json

object

type

required

string

title

required

string

detail

One of:

string
Array<string>

string

status

integer

Examples

{
  "type": "about:blank",
  "title": "BadRequest",
  "detail": "limitは1〜1000の範囲で入力してください",
  "status": 400
}

{
  "type": "about:blank",
  "title": "BadRequest",
  "detail": "pageは1以上で入力してください",
  "status": 400
}

500

サーバー内部エラー

application/json

object

type

required

string

title

required

string

detail

One of:

string
Array<string>

string

status

integer

Examples

default

{
  "type": "about:blank",
  "title": "InternalServerError",
  "status": 500
}