コンテンツにスキップ
スマレジ・プラットフォームAPI リファレンス

荷主一覧取得

GET
/shippers
curl --request GET \
  --url 'https://api.smaregi.dev/TARGET-CONTRACT-ID/ec-oms/shippers?limit=100&page=1&fields=shipperId%2CcompanyName&shipper_id=1%2C2&company_name=%E3%83%86%E3%82%B9%E3%83%88%E8%8D%B7%E4%B8%BB1%2C%E3%83%86%E3%82%B9%E3%83%88%E8%8D%B7%E4%B8%BB2&company_kana=%E3%83%86%E3%82%B9%E3%83%88%E3%83%8B%E3%83%8C%E3%82%B71%2C%E3%83%86%E3%82%B9%E3%83%88%E3%83%8B%E3%83%8C%E3%82%B72&sort=rank%3Adesc' \
  --header 'Authorization: Bearer <token>'

荷主の一覧を取得します。

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
limit
integer
default: 100 >= 1 <= 1000

取得件数

page
integer
default: 1 >= 1

ページ

fields
Array<string>
>= 1 items unique items
Allowed values: shipperId companyName companyKana

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

Example
?fields=shipperId,companyName
shipper_id
Array<string>
>= 1 items unique items

荷主IDで絞り込みを行います。

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

荷主名で絞り込みを行います。

  • 完全一致で判定します（部分一致は不可）。
  • カンマ区切りで複数指定した場合はOR条件として扱います（例: A,B はAまたはBに一致するレコードを返却します）。
  • 空文字を指定した場合や、カンマ区切り内に空要素を含む場合（例: A,,B）は400エラーを返却します。
  • パラメータを省略した場合は絞り込みを行いません。
Example
?company_name=%E3%83%86%E3%82%B9%E3%83%88%E8%8D%B7%E4%B8%BB1,%E3%83%86%E3%82%B9%E3%83%88%E8%8D%B7%E4%B8%BB2
company_kana
Array<string>
>= 1 items unique items

荷主名カナで絞り込みを行います。

  • 完全一致で判定します（部分一致は不可）。
  • カンマ区切りで複数指定した場合はOR条件として扱います（例: A,B はAまたはBに一致するレコードを返却します）。
  • 空文字を指定した場合や、カンマ区切り内に空要素を含む場合（例: A,,B）は400エラーを返却します。
  • パラメータを省略した場合は絞り込みを行いません。
Example
?company_kana=%E3%83%86%E3%82%B9%E3%83%88%E3%83%8B%E3%83%8C%E3%82%B71,%E3%83%86%E3%82%B9%E3%83%88%E3%83%8B%E3%83%8C%E3%82%B72
sort
string
default: rank:desc
Allowed values: rank rank:desc

ソート

  • rank: ソート順
Example
rank:desc

Responses

Section titled “Responses”

200

Section titled “200”

取得成功

Media typeapplication/json
Array<object>
Shipper
object
shipperId

荷主ID

string
>= 1 characters <= 9 characters
companyName

荷主名

string
nullable >= 1 characters <= 50 characters
companyKana

荷主名カナ

string
nullable >= 1 characters <= 50 characters
Examples
Exampledefault
[
  {
    "shipperId": "1",
    "companyName": "テスト荷主",
    "companyKana": "テストニヌシ"
  }
]

Headers

Section titled “Headers”
Link
string

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

400

Section titled “400”
  • limitが範囲外の場合
  • pageが範囲外の場合
Media typeapplication/json
object
type
required
string
title
required
string
detail
One of:
string
status
integer
Examples
{
  "type": "about:blank",
  "title": "BadRequest",
  "detail": "limitは1〜1000の範囲で入力してください",
  "status": 400
}

500

Section titled “500”

サーバー内部エラー

Media typeapplication/json
object
type
required
string
title
required
string
detail
One of:
string
status
integer
Examples
Exampledefault
{
  "type": "about:blank",
  "title": "InternalServerError",
  "status": 500
}