Download OpenAPI specification:
ロジクラで管理しているデータを外部から利用するためのAPIです。
ロジクラ API は OAuth 2.0 の認可コードフローを使用します。
API を利用するには、https://logikura.com/oauth/applications にアクセスしてアプリケーションを登録し、クライアント ID とクライアントシークレットを取得してください。
登録時に、アプリケーションが必要とするスコープを選択してください。
| スコープ | 説明 |
|---|---|
read |
データの読み取り |
write |
データの作成・更新 |
以下の URL にリダイレクトすると、ロジクラのアクセス許可画面が表示されます。ユーザーが承認すると、認可コードが発行されます。
https://logikura.com/oauth/authorize?response_type=code&client_id={CLIENT_ID}&redirect_uri={REDIRECT_URI}&scope={SCOPE}
| パラメーター | 説明 |
|---|---|
response_type |
code を指定 |
client_id |
アプリケーション登録時に取得したクライアント ID |
redirect_uri |
アプリケーション登録時に設定したリダイレクト URI |
scope |
アプリケーション登録時に指定したスコープを + 区切りで指定(例: read+write) |
ユーザーが承認すると、指定したリダイレクト URI に認可コードが付与されてリダイレクトされます。認可コードの有効期限は 10 分 です。
{REDIRECT_URI}?code={AUTHORIZATION_CODE}
取得した認可コードを使ってアクセストークンとリフレッシュトークンを発行します。
curl --request POST 'https://logikura.com/oauth/token' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data 'grant_type=authorization_code&code={AUTHORIZATION_CODE}&client_id={CLIENT_ID}&client_secret={CLIENT_SECRET}&redirect_uri={REDIRECT_URI}'
レスポンス例:
{
"access_token": "...",
"token_type": "Bearer",
"expires_in": 86400,
"refresh_token": "...",
"scope": "read write",
"created_at": 1234567890
}
取得したアクセストークンを Authorization ヘッダーに指定してリクエストを送信します。
Authorization: Bearer {ACCESS_TOKEN}
例:
curl --request GET 'https://api.logikura.com/api/v1/warehouses' \
--header 'Authorization: Bearer {ACCESS_TOKEN}'
アクセストークンの有効期限が切れた場合、リフレッシュトークンを使って新しいアクセストークンを取得できます。
curl --request POST 'https://logikura.com/oauth/token' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data 'grant_type=refresh_token&refresh_token={REFRESH_TOKEN}&client_id={CLIENT_ID}&client_secret={CLIENT_SECRET}'
リフレッシュトークンには 90 日間の有効期限 があります。有効期限が切れた場合は、1. 認可コードの取得 から再度実行してアクセストークンを再発行してください。
ロジクラAPIでは1分あたり100回のリクエスト制限を設けています。 リクエスト制限に関する情報はヘッダに含まれています。
| ヘッダ名 | 説明 |
|---|---|
| X-RateLimit-Limit | 1分あたりのリクエスト数 |
| X-RateLimit-Remaining | リクエスト可能数 |
| X-RateLimit-Reset | リクエスト数がリセットされるまでの秒数 |
| HTTPステータスコード | 種類 | 原因 |
|---|---|---|
| 400 | Bad Request | リクエストの形式が不正(必須項目の欠落など) |
| 401 | Unauthorized | アクセストークンが不正 |
| 404 | Not Found | リソースが存在しません |
| 422 | Unprocessable Entity | 不正なパラメーター |
| 429 | Too Many Requests | リクエスト制限の上限を超えました |
リストを返すAPIに関しては応答にLinkヘッダーを追加します。
<https://api.logikura.com/api/v1/path/to?page=1>; rel="prev",
<https://api.logikura.com/api/v1/path/to?page=3>; rel="next"
商品カテゴリ(画面表記「カテゴリ」)の一覧
| page | integer <int64> >= 1 Default: 1 Example: page=1 取得するページ番号(1 始まりの整数。10 進数字のみ)。1 ページあたりの件数は 100 件固定で、クライアントからは変更できません(per_page 等で件数を指定しても無視されます)。 前後のページはレスポンスの Link ヘッダー(rel="next" / rel="prev")で辿れます。 Hash・配列(例 page[size])や 0 以下・非整数、先頭ゼロ・0x・アンダースコア等の表記は 400 を返します。 |
{- "product_types": [
- {
- "id": 1,
- "name": "アパレル",
- "created_at": "2020-12-04T10:09:53.175+09:00",
- "updated_at": "2020-12-04T10:09:53.175+09:00"
}
]
}{- "product_type": {
- "name": "アパレル"
}
}{- "product_type": {
- "id": 1,
- "name": "アパレル",
- "created_at": "2020-12-04T10:09:53.175+09:00",
- "updated_at": "2020-12-04T10:09:53.175+09:00"
}
}| id required | integer <int64> (Id) >= 1 Example: 1 商品カテゴリID |
required | object |
{- "product_type": {
- "name": "アパレル"
}
}{- "product_type": {
- "id": 1,
- "name": "アパレル",
- "created_at": "2020-12-04T10:09:53.175+09:00",
- "updated_at": "2020-12-04T10:09:53.175+09:00"
}
}| page | integer <int64> >= 1 Default: 1 Example: page=1 取得するページ番号(1 始まりの整数。10 進数字のみ)。1 ページあたりの件数は 100 件固定で、クライアントからは変更できません(per_page 等で件数を指定しても無視されます)。 前後のページはレスポンスの Link ヘッダー(rel="next" / rel="prev")で辿れます。 Hash・配列(例 page[size])や 0 以下・非整数、先頭ゼロ・0x・アンダースコア等の表記は 400 を返します。 |
| name | string 商品名で絞り込む(部分一致・大文字小文字を区別しない) |
| master_code | string 商品代表コードで絞り込む(部分一致・大文字小文字を区別しない) |
| country_code | string Example: country_code=JP 原産国で絞り込む(完全一致。ISO 3166-1 alpha-2) |
| ids[] | Array of integers <int64> (Id) <= 100 items [ items <int64 > >= 1 ] Example: ids[]=1 商品 ID で絞り込む(IN 検索。最大 100 件、超過は 400) |
| supplier_id | integer <int64> (Id) >= 1 Example: supplier_id=1 仕入先 ID で絞り込む(完全一致) |
| tax_type_id | integer Enum: 1 2 消費税率で絞り込む(完全一致。1=8.00、2=10.00) |
| product_type_id | integer <int64> (Id) >= 1 Example: product_type_id=1 商品カテゴリで絞り込む(完全一致。カテゴリ一覧は GET /api/v1/product_types で取得できる) |
| updated_from | string Example: updated_from=2026-07-03T10:00:00+09:00 更新日時がこの値以降(以上・inclusive)の商品に絞り込む。ISO 8601 形式で、 タイムゾーン省略時は UTC として解釈する。指定時はページングがカーソル方式になる(cursor 参照)。 |
| updated_to | string Example: updated_to=2026-07-04T10:00:00+09:00 更新日時がこの値より前(未満・exclusive)の商品に絞り込む。ISO 8601 形式で、 タイムゾーン省略時は UTC として解釈する。指定時はページングがカーソル方式になる(cursor 参照)。 |
| created_from | string Example: created_from=2026-07-03T10:00:00+09:00 作成日時がこの値以降(以上・inclusive)の商品に絞り込む。ISO 8601 形式で、 タイムゾーン省略時は UTC として解釈する。指定時はページングがカーソル方式になる(cursor 参照)。 |
| created_to | string Example: created_to=2026-07-04T10:00:00+09:00 作成日時がこの値より前(未満・exclusive)の商品に絞り込む。ISO 8601 形式で、 タイムゾーン省略時は UTC として解釈する。指定時はページングがカーソル方式になる(cursor 参照)。 |
| cursor | string カーソルページネーション用の不透明トークン。updated_from / updated_to / created_from / created_to のいずれかを指定した場合はページ番号(page)の代わりに使用する(page との併用は 400)。 並び順とカーソルの基準は updated 系指定時は updated_at、created 系のみ指定時は created_at (両方指定時は updated_at)の昇順+ id 昇順。 次ページの URL はレスポンスの Link ヘッダー(rel="next")で返る。 |
{- "products": [
- {
- "id": 1,
- "product_type_id": 1,
- "name": "Tシャツ",
- "master_code": "LOGIKURA",
- "description": "青色",
- "tax_type_id": 1,
- "country_code": "JP",
- "suppliers": [
- {
- "id": 1,
- "code": "code",
- "name": "name",
- "email": "text@example.com",
- "phone_number": "0300000000",
- "postal_code": "0000000",
- "address1": "東京都ロジクラ区",
- "address2": "ロジクラ1-1-1",
- "description": "詳細",
- "updated_at": "2020-12-04T10:09:53.175+09:00"
}
], - "variants": [
- {
- "id": 1,
- "product_id": 1,
- "name": "Tシャツ",
- "product_code": "LOGIKURA-123",
- "barcode": 2200020050008,
- "sales_price": "200",
- "purchase_price": "100",
- "weight": 100,
- "weight_unit": "g",
- "option1": "赤",
- "option2": "Sサイズ",
- "option3": "綿",
- "order_point": 100,
- "updated_at": "2020-12-04T10:09:53.175+09:00",
- "sales_start_date": "2019-01-01"
}
]
}
]
}required | object (商品) |
{- "product": {
- "name": "Tシャツ",
- "master_code": "LOGIKURA",
- "description": "シンプルな無地Tシャツです",
- "tax_type_id": 1,
- "country_code": "JP",
- "suppliers": [
- {
- "id": 1
}
]
}
}{- "product": {
- "id": 1,
- "product_type_id": 1,
- "name": "Tシャツ",
- "master_code": "LOGIKURA",
- "description": "青色",
- "tax_type_id": 1,
- "country_code": "JP",
- "suppliers": [
- {
- "id": 1,
- "code": "code",
- "name": "name",
- "email": "text@example.com",
- "phone_number": "0300000000",
- "postal_code": "0000000",
- "address1": "東京都ロジクラ区",
- "address2": "ロジクラ1-1-1",
- "description": "詳細",
- "updated_at": "2020-12-04T10:09:53.175+09:00"
}
], - "variants": [
- {
- "id": 1,
- "product_id": 1,
- "name": "Tシャツ",
- "product_code": "LOGIKURA-123",
- "barcode": 2200020050008,
- "sales_price": "200",
- "purchase_price": "100",
- "weight": 100,
- "weight_unit": "g",
- "option1": "赤",
- "option2": "Sサイズ",
- "option3": "綿",
- "order_point": 100,
- "updated_at": "2020-12-04T10:09:53.175+09:00",
- "sales_start_date": "2019-01-01"
}
]
}
}| id required | integer <int64> (Id) >= 1 Example: 1 商品マスターID |
{- "product": {
- "id": 1,
- "product_type_id": 1,
- "name": "Tシャツ",
- "master_code": "LOGIKURA",
- "description": "青色",
- "tax_type_id": 1,
- "country_code": "JP",
- "suppliers": [
- {
- "id": 1,
- "code": "code",
- "name": "name",
- "email": "text@example.com",
- "phone_number": "0300000000",
- "postal_code": "0000000",
- "address1": "東京都ロジクラ区",
- "address2": "ロジクラ1-1-1",
- "description": "詳細",
- "updated_at": "2020-12-04T10:09:53.175+09:00"
}
], - "variants": [
- {
- "id": 1,
- "product_id": 1,
- "name": "Tシャツ",
- "product_code": "LOGIKURA-123",
- "barcode": 2200020050008,
- "sales_price": "200",
- "purchase_price": "100",
- "weight": 100,
- "weight_unit": "g",
- "option1": "赤",
- "option2": "Sサイズ",
- "option3": "綿",
- "order_point": 100,
- "updated_at": "2020-12-04T10:09:53.175+09:00",
- "sales_start_date": "2019-01-01"
}
]
}
}リクエストに含めた項目のみを更新する部分更新です。送信しなかった項目は既存値を保持します。 値を消したい場合は、空の値を明示的に送信してください (country_code は "" または null、tax_type_id は null、suppliers は [] または null)。
| id required | integer <int64> (Id) >= 1 Example: 1 商品マスターID |
required | object (商品) |
{- "product": {
- "name": "Tシャツ",
- "master_code": "LOGIKURA",
- "description": "シンプルな無地Tシャツです",
- "tax_type_id": 1,
- "country_code": "JP",
- "suppliers": [
- {
- "id": 1
}
]
}
}{- "product": {
- "id": 1,
- "product_type_id": 1,
- "name": "Tシャツ",
- "master_code": "LOGIKURA",
- "description": "青色",
- "tax_type_id": 1,
- "country_code": "JP",
- "suppliers": [
- {
- "id": 1,
- "code": "code",
- "name": "name",
- "email": "text@example.com",
- "phone_number": "0300000000",
- "postal_code": "0000000",
- "address1": "東京都ロジクラ区",
- "address2": "ロジクラ1-1-1",
- "description": "詳細",
- "updated_at": "2020-12-04T10:09:53.175+09:00"
}
], - "variants": [
- {
- "id": 1,
- "product_id": 1,
- "name": "Tシャツ",
- "product_code": "LOGIKURA-123",
- "barcode": 2200020050008,
- "sales_price": "200",
- "purchase_price": "100",
- "weight": 100,
- "weight_unit": "g",
- "option1": "赤",
- "option2": "Sサイズ",
- "option3": "綿",
- "order_point": 100,
- "updated_at": "2020-12-04T10:09:53.175+09:00",
- "sales_start_date": "2019-01-01"
}
]
}
}| page | integer <int64> >= 1 Default: 1 Example: page=1 取得するページ番号(1 始まりの整数。10 進数字のみ)。1 ページあたりの件数は 100 件固定で、クライアントからは変更できません(per_page 等で件数を指定しても無視されます)。 前後のページはレスポンスの Link ヘッダー(rel="next" / rel="prev")で辿れます。 Hash・配列(例 page[size])や 0 以下・非整数、先頭ゼロ・0x・アンダースコア等の表記は 400 を返します。 |
{- "product_variants": [
- {
- "id": 1,
- "product_id": 1,
- "name": "Tシャツ",
- "product_code": "LOGIKURA-123",
- "barcode": 2200020050008,
- "sales_price": "200",
- "purchase_price": "100",
- "weight": 100,
- "weight_unit": "g",
- "option1": "赤",
- "option2": "Sサイズ",
- "option3": "綿",
- "order_point": 100,
- "updated_at": "2020-12-04T10:09:53.175+09:00",
- "sales_start_date": "2019-01-01"
}
]
}required | object (種類) |
{- "product_variant": {
- "product_id": 1,
- "name": "tシャツ ロング",
- "product_code": "LOGIKURA-123",
- "barcode": 2200020050008,
- "sales_price": 200,
- "purchase_price": 100,
- "weight": 100,
- "weight_unit_id": 1,
- "option1": "赤",
- "option2": "Sサイズ",
- "option3": "綿",
- "order_point": 100,
- "sales_start_date": "2019-01-01"
}
}{- "product_variant": {
- "id": 1,
- "product_id": 1,
- "name": "Tシャツ",
- "product_code": "LOGIKURA-123",
- "barcode": 2200020050008,
- "sales_price": "200",
- "purchase_price": "100",
- "weight": 100,
- "weight_unit": "g",
- "option1": "赤",
- "option2": "Sサイズ",
- "option3": "綿",
- "order_point": 100,
- "updated_at": "2020-12-04T10:09:53.175+09:00",
- "sales_start_date": "2019-01-01"
}
}| id required | integer <int64> (Id) >= 1 Example: 1 種類ID |
{- "product_variant": {
- "id": 1,
- "product_id": 1,
- "name": "Tシャツ",
- "product_code": "LOGIKURA-123",
- "barcode": 2200020050008,
- "sales_price": "200",
- "purchase_price": "100",
- "weight": 100,
- "weight_unit": "g",
- "option1": "赤",
- "option2": "Sサイズ",
- "option3": "綿",
- "order_point": 100,
- "updated_at": "2020-12-04T10:09:53.175+09:00",
- "sales_start_date": "2019-01-01"
}
}required | object (種類) |
{- "product_variant": {
- "id": 1,
- "name": "tシャツ ロング",
- "product_code": "LOGIKURA-123",
- "barcode": 2200020050008,
- "sales_price": 200,
- "purchase_price": 100,
- "weight": 100,
- "weight_unit_id": 1,
- "option1": "赤",
- "option2": "Sサイズ",
- "option3": "綿",
- "order_point": 100,
- "sales_start_date": "2019-01-01"
}
}{- "product_variant": {
- "id": 1,
- "product_id": 1,
- "name": "Tシャツ",
- "product_code": "LOGIKURA-123",
- "barcode": 2200020050008,
- "sales_price": "200",
- "purchase_price": "100",
- "weight": 100,
- "weight_unit": "g",
- "option1": "赤",
- "option2": "Sサイズ",
- "option3": "綿",
- "order_point": 100,
- "updated_at": "2020-12-04T10:09:53.175+09:00",
- "sales_start_date": "2019-01-01"
}
}入荷予定一覧
| page | integer <int64> >= 1 Default: 1 Example: page=1 取得するページ番号(1 始まりの整数。10 進数字のみ)。1 ページあたりの件数は 100 件固定で、クライアントからは変更できません(per_page 等で件数を指定しても無視されます)。 前後のページはレスポンスの Link ヘッダー(rel="next" / rel="prev")で辿れます。 Hash・配列(例 page[size])や 0 以下・非整数、先頭ゼロ・0x・アンダースコア等の表記は 400 を返します。 |
{- "receiving_schedules": [
- {
- "receiving_items": [
- {
- "id": 1,
- "receiving_schedule_id": 1,
- "product_variant_id": 1,
- "inventory_id": 1,
- "price": 10,
- "purchase_order_quantity": 1,
- "stocked_quantity": 1,
- "received_date": "2019-01-01",
- "progress_state": "inspecting",
- "lot_code": "string",
- "expiration_date": "2019-08-24"
}
], - "id": 1,
- "warehouse_id": 1,
- "supplier_id": 1,
- "shipping_slip_number": "ABCDEFG012345",
- "tracking_number": "1234-5678-9012",
- "box_quantity": 2,
- "due_date": "2019-01-01",
- "received_date": "2019-01-03",
- "description": "メモです",
- "updated_at": "2020-12-04T10:09:53.175+09:00",
- "progress_state": "inspecting"
}
]
}{- "receiving_schedule": {
- "receiving_items": [
- {
- "product_variant_id": 1,
- "purchase_order_quantity": 1,
- "price": 10,
- "lot_code": "LOT001",
- "expiration_date": "2025-12-31"
}
], - "warehouse_id": 1,
- "supplier_id": 1,
- "shipping_slip_number": "ABCDEFG012345",
- "tracking_number": "1234-5678-9012",
- "box_quantity": 2,
- "due_date": "2019-01-01",
- "description": "メモです"
}
}{- "receiving_schedule": {
- "receiving_items": [
- {
- "id": 1,
- "receiving_schedule_id": 1,
- "product_variant_id": 1,
- "inventory_id": 1,
- "price": 10,
- "purchase_order_quantity": 1,
- "stocked_quantity": 1,
- "received_date": "2019-01-01",
- "progress_state": "inspecting",
- "lot_code": "string",
- "expiration_date": "2019-08-24"
}
], - "id": 1,
- "warehouse_id": 1,
- "supplier_id": 1,
- "shipping_slip_number": "ABCDEFG012345",
- "tracking_number": "1234-5678-9012",
- "box_quantity": 2,
- "due_date": "2019-01-01",
- "received_date": "2019-01-03",
- "description": "メモです",
- "updated_at": "2020-12-04T10:09:53.175+09:00"
}
}| id required | integer <int64> (Id) >= 1 Example: 1 入荷予定ID |
{- "receiving_schedule": {
- "receiving_items": [
- {
- "id": 1,
- "receiving_schedule_id": 1,
- "product_variant_id": 1,
- "inventory_id": 1,
- "price": 10,
- "purchase_order_quantity": 1,
- "stocked_quantity": 1,
- "received_date": "2019-01-01",
- "progress_state": "inspecting",
- "lot_code": "string",
- "expiration_date": "2019-08-24"
}
], - "id": 1,
- "warehouse_id": 1,
- "supplier_id": 1,
- "shipping_slip_number": "ABCDEFG012345",
- "tracking_number": "1234-5678-9012",
- "box_quantity": 2,
- "due_date": "2019-01-01",
- "received_date": "2019-01-03",
- "description": "メモです",
- "updated_at": "2020-12-04T10:09:53.175+09:00"
}
}| id required | integer <int64> (Id) >= 1 Example: 1 入荷予定ID |
required | object |
{- "receiving_schedule": {
- "receiving_items": [
- {
- "id": 1,
- "product_variant_id": 1,
- "purchase_order_quantity": 1,
- "price": 10,
- "lot_code": "LOT001",
- "expiration_date": "2025-12-31"
}
], - "warehouse_id": 1,
- "supplier_id": 1,
- "shipping_slip_number": "ABCDEFG012345",
- "tracking_number": "1234-5678-9012",
- "box_quantity": 2,
- "due_date": "2019-01-01",
- "description": "メモです"
}
}{- "receiving_schedule": {
- "receiving_items": [
- {
- "id": 1,
- "receiving_schedule_id": 1,
- "product_variant_id": 1,
- "inventory_id": 1,
- "price": 10,
- "purchase_order_quantity": 1,
- "stocked_quantity": 1,
- "received_date": "2019-01-01",
- "progress_state": "inspecting",
- "lot_code": "string",
- "expiration_date": "2019-08-24"
}
], - "id": 1,
- "warehouse_id": 1,
- "supplier_id": 1,
- "shipping_slip_number": "ABCDEFG012345",
- "tracking_number": "1234-5678-9012",
- "box_quantity": 2,
- "due_date": "2019-01-01",
- "received_date": "2019-01-03",
- "description": "メモです",
- "updated_at": "2020-12-04T10:09:53.175+09:00"
}
}| id required | integer <int64> (Id) >= 1 Example: 1 入荷予定ID |
{- "receiving_schedule": {
- "receiving_items": [
- {
- "id": 1,
- "receiving_schedule_id": 1,
- "product_variant_id": 1,
- "inventory_id": 1,
- "price": 10,
- "purchase_order_quantity": 1,
- "stocked_quantity": 1,
- "received_date": "2019-01-01",
- "progress_state": "inspecting",
- "lot_code": "string",
- "expiration_date": "2019-08-24"
}
], - "id": 1,
- "warehouse_id": 1,
- "supplier_id": 1,
- "shipping_slip_number": "ABCDEFG012345",
- "tracking_number": "1234-5678-9012",
- "box_quantity": 2,
- "due_date": "2019-01-01",
- "received_date": "2019-01-03",
- "description": "メモです",
- "updated_at": "2020-12-04T10:09:53.175+09:00"
}
}| id required | integer <int64> (Id) >= 1 Example: 1 入荷履歴ID |
{- "receiving_history": {
- "receiving_items": [
- {
- "id": 1,
- "receiving_schedule_id": 1,
- "product_variant_id": 1,
- "inventory_id": 1,
- "price": 10,
- "purchase_order_quantity": 1,
- "stocked_quantity": 1,
- "received_date": "2019-01-01",
- "progress_state": "inspecting",
- "lot_code": "string",
- "expiration_date": "2019-08-24"
}
], - "id": 1,
- "warehouse_id": 1,
- "supplier_id": 1,
- "shipping_slip_number": "ABCDEFG012345",
- "tracking_number": "1234-5678-9012",
- "box_quantity": 2,
- "due_date": "2019-01-01",
- "received_date": "2019-01-03",
- "description": "メモです",
- "updated_at": "2020-12-04T10:09:53.175+09:00",
- "progress_state": "completed"
}
}入荷履歴一覧
| page | integer <int64> >= 1 Default: 1 Example: page=1 取得するページ番号(1 始まりの整数。10 進数字のみ)。1 ページあたりの件数は 100 件固定で、クライアントからは変更できません(per_page 等で件数を指定しても無視されます)。 前後のページはレスポンスの Link ヘッダー(rel="next" / rel="prev")で辿れます。 Hash・配列(例 page[size])や 0 以下・非整数、先頭ゼロ・0x・アンダースコア等の表記は 400 を返します。 |
| received_date_from | string <date> Example: received_date_from=2020-01-01 指定した入荷日以降の履歴が返されます |
| received_date_to | string <date> Example: received_date_to=2020-01-31 指定した入荷日以前の履歴が返されます |
{- "receiving_histories": [
- {
- "receiving_items": [
- {
- "id": 1,
- "receiving_schedule_id": 1,
- "product_variant_id": 1,
- "inventory_id": 1,
- "price": 10,
- "purchase_order_quantity": 1,
- "stocked_quantity": 1,
- "received_date": "2019-01-01",
- "progress_state": "inspecting",
- "lot_code": "string",
- "expiration_date": "2019-08-24"
}
], - "id": 1,
- "warehouse_id": 1,
- "supplier_id": 1,
- "shipping_slip_number": "ABCDEFG012345",
- "tracking_number": "1234-5678-9012",
- "box_quantity": 2,
- "due_date": "2019-01-01",
- "received_date": "2019-01-03",
- "description": "メモです",
- "updated_at": "2020-12-04T10:09:53.175+09:00",
- "progress_state": "completed"
}
]
}{- "receiving_history": {
- "receiving_items": [
- {
- "product_variant_id": 1,
- "stocked_quantity": 10,
- "price": 10,
- "lot_code": "LOT001",
- "expiration_date": "2025-12-31"
}
], - "warehouse_id": 1,
- "supplier_id": 1,
- "shipping_slip_number": "ABCDEFG012345",
- "tracking_number": "1234-5678-9012",
- "box_quantity": 2,
- "received_date": "2019-01-01",
- "description": "メモです"
}
}{- "receiving_history": {
- "receiving_items": [
- {
- "id": 1,
- "receiving_schedule_id": 1,
- "product_variant_id": 1,
- "inventory_id": 1,
- "price": 10,
- "purchase_order_quantity": 1,
- "stocked_quantity": 1,
- "received_date": "2019-01-01",
- "progress_state": "inspecting",
- "lot_code": "string",
- "expiration_date": "2019-08-24"
}
], - "id": 1,
- "warehouse_id": 1,
- "supplier_id": 1,
- "shipping_slip_number": "ABCDEFG012345",
- "tracking_number": "1234-5678-9012",
- "box_quantity": 2,
- "due_date": "2019-01-01",
- "received_date": "2019-01-03",
- "description": "メモです",
- "updated_at": "2020-12-04T10:09:53.175+09:00",
- "progress_state": "completed"
}
}出荷予定一覧
| page | integer <int64> >= 1 Default: 1 Example: page=1 取得するページ番号(1 始まりの整数。10 進数字のみ)。1 ページあたりの件数は 100 件固定で、クライアントからは変更できません(per_page 等で件数を指定しても無視されます)。 前後のページはレスポンスの Link ヘッダー(rel="next" / rel="prev")で辿れます。 Hash・配列(例 page[size])や 0 以下・非整数、先頭ゼロ・0x・アンダースコア等の表記は 400 を返します。 |
{- "shipping_schedules": [
- {
- "shipping_items": [
- {
- "id": 1,
- "product_variant_id": 1,
- "sales_order_quantity": 1,
- "shipping_quantity": 1,
- "price": 10,
- "note": "メモです",
- "progress_state": "idle",
- "lot_code": "string",
- "expiration_date": "2019-08-24",
- "packing_items": [
- {
- "id": 1,
- "packed_quantity": 1,
- "stock_id": 1
}
]
}
], - "shipping_composite_items": [
- {
- "id": 1,
- "composite_item_id": 1,
- "quantity": 1,
- "price": 10,
- "note": "メモです"
}
], - "id": "1",
- "code": "qpV0201911071602",
- "due_date": "2019-01-01",
- "tracking_number": "1234-5678-9012",
- "description": "自社ECからの受注",
- "delivery_slip_note": "割れ物注意",
- "delivery_date": "2019-01-01",
- "picking_note": "同梱物あり",
- "consignee_id": "1",
- "sales_order": {
- "billing_address_id": 1,
- "shop_id": 1,
- "order_number": "A-123456",
- "order_date": "2019-01-01",
- "shipping_cost": 100,
- "sales_commission": 100,
- "other_cost": 100,
- "point": 100,
- "total_price": 100,
- "gift_message": "おめでとうございます",
- "gift_enabled": true,
- "external_service_code": "A-12345",
- "external_service_account": {
- "id": 1,
- "name": "株式会社ロジクラ",
- "uid": "external-uid",
- "shop_id": 1,
- "external_service_name": "スマレジ"
}
}, - "delivery_method": {
- "code": "sagawa_e_hiden_2",
- "name": "佐川e飛伝II"
}, - "progress_state": "idle",
- "shipped_date": "2019-01-01"
}
]
}required | object (受注(作成・更新)) 出荷予定に紐づく受注情報。手動作成では各項目を省略できる(未指定の金額項目はサーバが 0 を補完する)。 |
required | object (出荷予定) |
{- "sales_order": {
- "billing_address_id": 1,
- "shop_id": 1,
- "order_number": "A-123456",
- "order_date": "2019-01-01",
- "shipping_cost": 100,
- "sales_commission": 100,
- "other_cost": 100,
- "point": 100,
- "total_price": 100,
- "gift_enabled": true,
- "gift_message": "おめでとうございます",
- "wrapping_note": "包装紙で包む"
}, - "shipping_schedule": {
- "shipping_items": [
- {
- "product_variant_id": 1,
- "sales_order_quantity": 1,
- "price": 1,
- "note": "メモです",
- "lot_code": "LOT001",
- "expiration_date": "2025-12-31"
}
], - "shipping_composite_items": [
- {
- "composite_item_id": 1,
- "quantity": 1,
- "price": 1,
- "note": "メモです"
}
], - "consignee_id": 1,
- "tracking_number": "1234-5678-9012",
- "due_date": "2019-01-01",
- "description": "メモです",
- "delivery_slip_note": "割れ物注意",
- "delivery_date": "2019-01-01",
- "picking_note": "同梱物あり",
- "delivery_method_code": "sagawa_e_hiden_2",
- "delivery_specification_time": "01"
}
}{- "shipping_schedule": {
- "shipping_items": [
- {
- "id": 1,
- "product_variant_id": 1,
- "sales_order_quantity": 1,
- "shipping_quantity": 1,
- "price": 10,
- "note": "メモです",
- "progress_state": "idle",
- "lot_code": "string",
- "expiration_date": "2019-08-24",
- "packing_items": [
- {
- "id": 1,
- "packed_quantity": 1,
- "stock_id": 1
}
]
}
], - "shipping_composite_items": [
- {
- "id": 1,
- "composite_item_id": 1,
- "quantity": 1,
- "price": 10,
- "note": "メモです"
}
], - "id": "1",
- "code": "qpV0201911071602",
- "due_date": "2019-01-01",
- "tracking_number": "1234-5678-9012",
- "description": "自社ECからの受注",
- "delivery_slip_note": "割れ物注意",
- "delivery_date": "2019-01-01",
- "picking_note": "同梱物あり",
- "consignee_id": "1",
- "sales_order": {
- "billing_address_id": 1,
- "shop_id": 1,
- "order_number": "A-123456",
- "order_date": "2019-01-01",
- "shipping_cost": 100,
- "sales_commission": 100,
- "other_cost": 100,
- "point": 100,
- "total_price": 100,
- "gift_message": "おめでとうございます",
- "gift_enabled": true,
- "external_service_code": "A-12345",
- "external_service_account": {
- "id": 1,
- "name": "株式会社ロジクラ",
- "uid": "external-uid",
- "shop_id": 1,
- "external_service_name": "スマレジ"
}
}, - "delivery_method": {
- "code": "sagawa_e_hiden_2",
- "name": "佐川e飛伝II"
}, - "progress_state": "idle",
- "shipped_date": "2019-01-01"
}
}| warehouse_id required | integer >= 1 拠点ID |
{- "warehouse_id": 1
}{- "shipping_schedule": {
- "shipping_items": [
- {
- "id": 1,
- "product_variant_id": 1,
- "sales_order_quantity": 1,
- "shipping_quantity": 1,
- "price": 10,
- "note": "メモです",
- "progress_state": "idle",
- "lot_code": "string",
- "expiration_date": "2019-08-24",
- "packing_items": [
- {
- "id": 1,
- "packed_quantity": 1,
- "stock_id": 1
}
]
}
], - "shipping_composite_items": [
- {
- "id": 1,
- "composite_item_id": 1,
- "quantity": 1,
- "price": 10,
- "note": "メモです"
}
], - "id": "1",
- "code": "qpV0201911071602",
- "due_date": "2019-01-01",
- "tracking_number": "1234-5678-9012",
- "description": "自社ECからの受注",
- "delivery_slip_note": "割れ物注意",
- "delivery_date": "2019-01-01",
- "picking_note": "同梱物あり",
- "consignee_id": "1",
- "sales_order": {
- "billing_address_id": 1,
- "shop_id": 1,
- "order_number": "A-123456",
- "order_date": "2019-01-01",
- "shipping_cost": 100,
- "sales_commission": 100,
- "other_cost": 100,
- "point": 100,
- "total_price": 100,
- "gift_message": "おめでとうございます",
- "gift_enabled": true,
- "external_service_code": "A-12345",
- "external_service_account": {
- "id": 1,
- "name": "株式会社ロジクラ",
- "uid": "external-uid",
- "shop_id": 1,
- "external_service_name": "スマレジ"
}
}, - "delivery_method": {
- "code": "sagawa_e_hiden_2",
- "name": "佐川e飛伝II"
}, - "progress_state": "inspecting",
- "shipped_date": "2019-01-01"
}
}| id required | integer <int64> (Id) >= 1 Example: 1 出荷予定ID |
{- "shipping_schedule": {
- "shipping_items": [
- {
- "id": 1,
- "product_variant_id": 1,
- "sales_order_quantity": 1,
- "shipping_quantity": 1,
- "price": 10,
- "note": "メモです",
- "progress_state": "idle",
- "lot_code": "string",
- "expiration_date": "2019-08-24",
- "packing_items": [
- {
- "id": 1,
- "packed_quantity": 1,
- "stock_id": 1
}
]
}
], - "shipping_composite_items": [
- {
- "id": 1,
- "composite_item_id": 1,
- "quantity": 1,
- "price": 10,
- "note": "メモです"
}
], - "id": "1",
- "code": "qpV0201911071602",
- "due_date": "2019-01-01",
- "tracking_number": "1234-5678-9012",
- "description": "自社ECからの受注",
- "delivery_slip_note": "割れ物注意",
- "delivery_date": "2019-01-01",
- "picking_note": "同梱物あり",
- "consignee_id": "1",
- "sales_order": {
- "billing_address_id": 1,
- "shop_id": 1,
- "order_number": "A-123456",
- "order_date": "2019-01-01",
- "shipping_cost": 100,
- "sales_commission": 100,
- "other_cost": 100,
- "point": 100,
- "total_price": 100,
- "gift_message": "おめでとうございます",
- "gift_enabled": true,
- "external_service_code": "A-12345",
- "external_service_account": {
- "id": 1,
- "name": "株式会社ロジクラ",
- "uid": "external-uid",
- "shop_id": 1,
- "external_service_name": "スマレジ"
}
}, - "delivery_method": {
- "code": "sagawa_e_hiden_2",
- "name": "佐川e飛伝II"
}, - "progress_state": "completed",
- "shipped_date": "2019-01-01"
}
}| id required | integer <int64> (Id) >= 1 Example: 1 出荷予定ID |
{- "shipping_schedule": {
- "shipping_items": [
- {
- "id": 1,
- "product_variant_id": 1,
- "sales_order_quantity": 1,
- "shipping_quantity": 1,
- "price": 10,
- "note": "メモです",
- "progress_state": "idle",
- "lot_code": "string",
- "expiration_date": "2019-08-24",
- "packing_items": [
- {
- "id": 1,
- "packed_quantity": 1,
- "stock_id": 1
}
]
}
], - "shipping_composite_items": [
- {
- "id": 1,
- "composite_item_id": 1,
- "quantity": 1,
- "price": 10,
- "note": "メモです"
}
], - "id": "1",
- "code": "qpV0201911071602",
- "due_date": "2019-01-01",
- "tracking_number": "1234-5678-9012",
- "description": "自社ECからの受注",
- "delivery_slip_note": "割れ物注意",
- "delivery_date": "2019-01-01",
- "picking_note": "同梱物あり",
- "consignee_id": "1",
- "sales_order": {
- "billing_address_id": 1,
- "shop_id": 1,
- "order_number": "A-123456",
- "order_date": "2019-01-01",
- "shipping_cost": 100,
- "sales_commission": 100,
- "other_cost": 100,
- "point": 100,
- "total_price": 100,
- "gift_message": "おめでとうございます",
- "gift_enabled": true,
- "external_service_code": "A-12345",
- "external_service_account": {
- "id": 1,
- "name": "株式会社ロジクラ",
- "uid": "external-uid",
- "shop_id": 1,
- "external_service_name": "スマレジ"
}
}, - "delivery_method": {
- "code": "sagawa_e_hiden_2",
- "name": "佐川e飛伝II"
}, - "progress_state": "idle",
- "shipped_date": "2019-01-01"
}
}| id required | integer <int64> (Id) >= 1 Example: 1 出荷予定ID |
required | object (受注(作成・更新)) 出荷予定に紐づく受注情報。手動作成では各項目を省略できる(未指定の金額項目はサーバが 0 を補完する)。 |
required | object (出荷予定) |
{- "sales_order": {
- "billing_address_id": 1,
- "shop_id": 1,
- "order_number": "A-123456",
- "order_date": "2019-01-01",
- "shipping_cost": 100,
- "sales_commission": 100,
- "other_cost": 100,
- "point": 100,
- "total_price": 100,
- "gift_enabled": true,
- "gift_message": "おめでとうございます",
- "wrapping_note": "包装紙で包む"
}, - "shipping_schedule": {
- "shipping_items": [
- {
- "id": 1,
- "product_variant_id": 1,
- "sales_order_quantity": 1,
- "price": 1,
- "note": "メモです",
- "lot_code": "LOT001",
- "expiration_date": "2025-12-31"
}
], - "shipping_composite_items": [
- {
- "id": 1,
- "composite_item_id": 1,
- "quantity": 1,
- "price": 1,
- "note": "メモです"
}
], - "consignee_id": 1,
- "tracking_number": "1234-5678-9012",
- "due_date": "2019-01-01",
- "description": "メモです",
- "delivery_slip_note": "割れ物注意",
- "delivery_date": "2019-01-01",
- "picking_note": "同梱物あり",
- "delivery_method_code": "sagawa_e_hiden_2",
- "delivery_specification_time": "01"
}
}{- "shipping_schedule": {
- "shipping_items": [
- {
- "id": 1,
- "product_variant_id": 1,
- "sales_order_quantity": 1,
- "shipping_quantity": 1,
- "price": 10,
- "note": "メモです",
- "progress_state": "idle",
- "lot_code": "string",
- "expiration_date": "2019-08-24",
- "packing_items": [
- {
- "id": 1,
- "packed_quantity": 1,
- "stock_id": 1
}
]
}
], - "shipping_composite_items": [
- {
- "id": 1,
- "composite_item_id": 1,
- "quantity": 1,
- "price": 10,
- "note": "メモです"
}
], - "id": "1",
- "code": "qpV0201911071602",
- "due_date": "2019-01-01",
- "tracking_number": "1234-5678-9012",
- "description": "自社ECからの受注",
- "delivery_slip_note": "割れ物注意",
- "delivery_date": "2019-01-01",
- "picking_note": "同梱物あり",
- "consignee_id": "1",
- "sales_order": {
- "billing_address_id": 1,
- "shop_id": 1,
- "order_number": "A-123456",
- "order_date": "2019-01-01",
- "shipping_cost": 100,
- "sales_commission": 100,
- "other_cost": 100,
- "point": 100,
- "total_price": 100,
- "gift_message": "おめでとうございます",
- "gift_enabled": true,
- "external_service_code": "A-12345",
- "external_service_account": {
- "id": 1,
- "name": "株式会社ロジクラ",
- "uid": "external-uid",
- "shop_id": 1,
- "external_service_name": "スマレジ"
}
}, - "delivery_method": {
- "code": "sagawa_e_hiden_2",
- "name": "佐川e飛伝II"
}, - "progress_state": "idle",
- "shipped_date": "2019-01-01"
}
}| id required | integer <int64> (Id) >= 1 Example: 1 出荷履歴ID |
{- "shipping_history": {
- "shipping_items": [
- {
- "id": 1,
- "product_variant_id": 1,
- "sales_order_quantity": 1,
- "shipping_quantity": 1,
- "price": 10,
- "note": "メモです",
- "progress_state": "idle",
- "lot_code": "string",
- "expiration_date": "2019-08-24",
- "packing_items": [
- {
- "id": 1,
- "packed_quantity": 1,
- "stock_id": 1
}
]
}
], - "shipping_composite_items": [
- {
- "id": 1,
- "composite_item_id": 1,
- "quantity": 1,
- "price": 10,
- "note": "メモです"
}
], - "id": "1",
- "code": "qpV0201911071602",
- "due_date": "2019-01-01",
- "tracking_number": "1234-5678-9012",
- "description": "自社ECからの受注",
- "delivery_slip_note": "割れ物注意",
- "delivery_date": "2019-01-01",
- "picking_note": "同梱物あり",
- "consignee_id": "1",
- "sales_order": {
- "billing_address_id": 1,
- "shop_id": 1,
- "order_number": "A-123456",
- "order_date": "2019-01-01",
- "shipping_cost": 100,
- "sales_commission": 100,
- "other_cost": 100,
- "point": 100,
- "total_price": 100,
- "gift_message": "おめでとうございます",
- "gift_enabled": true,
- "external_service_code": "A-12345",
- "external_service_account": {
- "id": 1,
- "name": "株式会社ロジクラ",
- "uid": "external-uid",
- "shop_id": 1,
- "external_service_name": "スマレジ"
}
}, - "delivery_method": {
- "code": "sagawa_e_hiden_2",
- "name": "佐川e飛伝II"
}, - "progress_state": "completed",
- "shipped_date": "2019-01-01"
}
}出荷履歴一覧
| page | integer <int64> >= 1 Default: 1 Example: page=1 取得するページ番号(1 始まりの整数。10 進数字のみ)。1 ページあたりの件数は 100 件固定で、クライアントからは変更できません(per_page 等で件数を指定しても無視されます)。 前後のページはレスポンスの Link ヘッダー(rel="next" / rel="prev")で辿れます。 Hash・配列(例 page[size])や 0 以下・非整数、先頭ゼロ・0x・アンダースコア等の表記は 400 を返します。 |
| shipped_date_from | string <date> Example: shipped_date_from=2020-01-01 指定した出荷実績日以降の履歴が返されます |
| shipped_date_to | string <date> Example: shipped_date_to=2020-01-31 指定した出荷実績日以前の履歴が返されます |
{- "shipping_histories": [
- {
- "shipping_items": [
- {
- "id": 1,
- "product_variant_id": 1,
- "sales_order_quantity": 1,
- "shipping_quantity": 1,
- "price": 10,
- "note": "メモです",
- "progress_state": "idle",
- "lot_code": "string",
- "expiration_date": "2019-08-24",
- "packing_items": [
- {
- "id": 1,
- "packed_quantity": 1,
- "stock_id": 1
}
]
}
], - "shipping_composite_items": [
- {
- "id": 1,
- "composite_item_id": 1,
- "quantity": 1,
- "price": 10,
- "note": "メモです"
}
], - "id": "1",
- "code": "qpV0201911071602",
- "due_date": "2019-01-01",
- "tracking_number": "1234-5678-9012",
- "description": "自社ECからの受注",
- "delivery_slip_note": "割れ物注意",
- "delivery_date": "2019-01-01",
- "picking_note": "同梱物あり",
- "consignee_id": "1",
- "sales_order": {
- "billing_address_id": 1,
- "shop_id": 1,
- "order_number": "A-123456",
- "order_date": "2019-01-01",
- "shipping_cost": 100,
- "sales_commission": 100,
- "other_cost": 100,
- "point": 100,
- "total_price": 100,
- "gift_message": "おめでとうございます",
- "gift_enabled": true,
- "external_service_code": "A-12345",
- "external_service_account": {
- "id": 1,
- "name": "株式会社ロジクラ",
- "uid": "external-uid",
- "shop_id": 1,
- "external_service_name": "スマレジ"
}
}, - "delivery_method": {
- "code": "sagawa_e_hiden_2",
- "name": "佐川e飛伝II"
}, - "progress_state": "completed",
- "shipped_date": "2019-01-01"
}
]
}object or null (受注(作成・更新)) 出荷予定に紐づく受注情報。手動作成では各項目を省略できる(未指定の金額項目はサーバが 0 を補完する)。 | |
required | object (出荷履歴) sales_order を省略または null にした場合は shipping_history 内の order_number / order_date を受注情報として使う。 |
{- "sales_order": {
- "billing_address_id": 1,
- "shop_id": 1,
- "order_number": "A-123456",
- "order_date": "2019-01-01",
- "shipping_cost": 100,
- "sales_commission": 100,
- "other_cost": 100,
- "point": 100,
- "total_price": 100,
- "gift_enabled": true,
- "gift_message": "おめでとうございます",
- "wrapping_note": "包装紙で包む"
}, - "shipping_history": {
- "shipping_items": [
- {
- "inventory_id": 1,
- "stock_id": 1,
- "shipping_quantity": 1,
- "price": 1,
- "note": "メモです",
- "lot_code": "LOT001",
- "expiration_date": "2025-12-31"
}
], - "warehouse_id": 1,
- "consignee_id": 1,
- "tracking_number": "1234-5678-9012",
- "shipped_date": "2019-01-01",
- "description": "メモです",
- "order_number": "A-123456",
- "order_date": "2019-01-01",
- "delivery_slip_note": "割れ物注意",
- "delivery_date": "2019-01-01",
- "tag": "優先,ギフト"
}
}{- "shipping_history": {
- "shipping_items": [
- {
- "id": 1,
- "product_variant_id": 1,
- "sales_order_quantity": 1,
- "shipping_quantity": 1,
- "price": 10,
- "note": "メモです",
- "progress_state": "idle",
- "lot_code": "string",
- "expiration_date": "2019-08-24",
- "packing_items": [
- {
- "id": 1,
- "packed_quantity": 1,
- "stock_id": 1
}
]
}
], - "shipping_composite_items": [
- {
- "id": 1,
- "composite_item_id": 1,
- "quantity": 1,
- "price": 10,
- "note": "メモです"
}
], - "id": "1",
- "code": "qpV0201911071602",
- "due_date": "2019-01-01",
- "tracking_number": "1234-5678-9012",
- "description": "自社ECからの受注",
- "delivery_slip_note": "割れ物注意",
- "delivery_date": "2019-01-01",
- "picking_note": "同梱物あり",
- "consignee_id": "1",
- "sales_order": {
- "billing_address_id": 1,
- "shop_id": 1,
- "order_number": "A-123456",
- "order_date": "2019-01-01",
- "shipping_cost": 100,
- "sales_commission": 100,
- "other_cost": 100,
- "point": 100,
- "total_price": 100,
- "gift_message": "おめでとうございます",
- "gift_enabled": true,
- "external_service_code": "A-12345",
- "external_service_account": {
- "id": 1,
- "name": "株式会社ロジクラ",
- "uid": "external-uid",
- "shop_id": 1,
- "external_service_name": "スマレジ"
}
}, - "delivery_method": {
- "code": "sagawa_e_hiden_2",
- "name": "佐川e飛伝II"
}, - "progress_state": "completed",
- "shipped_date": "2019-01-01"
}
}在庫一覧
| page | integer <int64> >= 1 Default: 1 Example: page=1 取得するページ番号(1 始まりの整数。10 進数字のみ)。1 ページあたりの件数は 100 件固定で、クライアントからは変更できません(per_page 等で件数を指定しても無視されます)。 前後のページはレスポンスの Link ヘッダー(rel="next" / rel="prev")で辿れます。 Hash・配列(例 page[size])や 0 以下・非整数、先頭ゼロ・0x・アンダースコア等の表記は 400 を返します。 |
| warehouse_id | integer Example: warehouse_id=1 指定した倉庫の在庫のみが返されます |
{- "inventories": [
- {
- "id": 1,
- "warehouse_id": 1,
- "product_variant": {
- "id": 1,
- "product_id": 1,
- "name": "Tシャツ",
- "product_code": "LOGIKURA-123",
- "barcode": 2200020050008,
- "sales_price": "200",
- "purchase_price": "100",
- "weight": 100,
- "weight_unit": "g",
- "option1": "赤",
- "option2": "Sサイズ",
- "option3": "綿",
- "order_point": 100,
- "updated_at": "2020-12-04T10:09:53.175+09:00",
- "sales_start_date": "2019-01-01"
}, - "quantity": 1000,
- "updated_at": "2020-12-04T10:09:53.175+09:00",
- "will_pick_quantity": 2,
- "not_assigned_quantity": 998
}
]
}在庫レコードを直接作成し、初期数量を「在庫調整」として記録します。入荷実績・入荷履歴は作成されません。 入荷として計上する場合は、入荷予定作成 → 入荷確定、または入荷履歴作成を使用してください。 外部サービス連携の在庫連携が有効な場合、この操作による在庫数の変動は「在庫調整」として外部サービスへ通知されます。 lot_code・expiration_date(ロット・消費期限)の指定には対応していません。
required | object (在庫) |
{- "inventory": {
- "warehouse_id": 1,
- "location_id": 1,
- "product_variant_id": 1,
- "quantity": 100
}
}{- "inventory": {
- "id": 1,
- "warehouse_id": 1,
- "product_variant": {
- "id": 1,
- "product_id": 1,
- "name": "Tシャツ",
- "product_code": "LOGIKURA-123",
- "barcode": 2200020050008,
- "sales_price": "200",
- "purchase_price": "100",
- "weight": 100,
- "weight_unit": "g",
- "option1": "赤",
- "option2": "Sサイズ",
- "option3": "綿",
- "order_point": 100,
- "updated_at": "2020-12-04T10:09:53.175+09:00",
- "sales_start_date": "2019-01-01"
}, - "quantity": 1000,
- "updated_at": "2020-12-04T10:09:53.175+09:00",
- "will_pick_quantity": 2,
- "not_assigned_quantity": 998
}
}出荷先一覧
| page | integer <int64> >= 1 Default: 1 Example: page=1 取得するページ番号(1 始まりの整数。10 進数字のみ)。1 ページあたりの件数は 100 件固定で、クライアントからは変更できません(per_page 等で件数を指定しても無視されます)。 前後のページはレスポンスの Link ヘッダー(rel="next" / rel="prev")で辿れます。 Hash・配列(例 page[size])や 0 以下・非整数、先頭ゼロ・0x・アンダースコア等の表記は 400 を返します。 |
{- "consignees": [
- {
- "id": 1,
- "code": "code",
- "name": "name",
- "email": "text@example.com",
- "phone_number": "0300000000",
- "postal_code": "0000000",
- "address1": "東京都ロジクラ区",
- "address2": "ロジクラ1-1-1",
- "description": "詳細",
- "consignee_type": "wholesaler",
- "updated_at": "2020-12-04T10:09:53.175+09:00"
}
]
}required | object (出荷先) |
{- "consignee": {
- "code": "code",
- "name": "name",
- "email": "text@example.com",
- "phone_number": "0300000000",
- "postal_code": "0000000",
- "address1": "東京都ロジクラ区",
- "address2": "ロジクラ1-1-1",
- "description": "詳細",
- "consignee_type": "wholesaler"
}
}{- "consignee": {
- "id": 1,
- "code": "code",
- "name": "name",
- "email": "text@example.com",
- "phone_number": "0300000000",
- "postal_code": "0000000",
- "address1": "東京都ロジクラ区",
- "address2": "ロジクラ1-1-1",
- "description": "詳細",
- "consignee_type": "wholesaler",
- "updated_at": "2020-12-04T10:09:53.175+09:00"
}
}| id required | integer <int64> (Id) >= 1 Example: 1 出荷先ID |
required | object (出荷先) |
{- "consignee": {
- "code": "code",
- "name": "name",
- "email": "text@example.com",
- "phone_number": "0300000000",
- "postal_code": "0000000",
- "address1": "東京都ロジクラ区",
- "address2": "ロジクラ1-1-1",
- "description": "詳細",
- "consignee_type": "wholesaler"
}
}{- "consignee": {
- "id": 1,
- "code": "code",
- "name": "name",
- "email": "text@example.com",
- "phone_number": "0300000000",
- "postal_code": "0000000",
- "address1": "東京都ロジクラ区",
- "address2": "ロジクラ1-1-1",
- "description": "詳細",
- "consignee_type": "wholesaler",
- "updated_at": "2020-12-04T10:09:53.175+09:00"
}
}仕入先一覧
| page | integer <int64> >= 1 Default: 1 Example: page=1 取得するページ番号(1 始まりの整数。10 進数字のみ)。1 ページあたりの件数は 100 件固定で、クライアントからは変更できません(per_page 等で件数を指定しても無視されます)。 前後のページはレスポンスの Link ヘッダー(rel="next" / rel="prev")で辿れます。 Hash・配列(例 page[size])や 0 以下・非整数、先頭ゼロ・0x・アンダースコア等の表記は 400 を返します。 |
{- "suppliers": [
- {
- "id": 1,
- "code": "code",
- "name": "name",
- "email": "text@example.com",
- "phone_number": "0300000000",
- "postal_code": "0000000",
- "address1": "東京都ロジクラ区",
- "address2": "ロジクラ1-1-1",
- "description": "詳細",
- "updated_at": "2020-12-04T10:09:53.175+09:00"
}
]
}required | object (出荷先) |
{- "supplier": {
- "code": "code",
- "name": "name",
- "email": "text@example.com",
- "phone_number": "0300000000",
- "postal_code": "0000000",
- "address1": "東京都ロジクラ区",
- "address2": "ロジクラ1-1-1",
- "description": "詳細"
}
}{- "consignee": {
- "id": 1,
- "code": "code",
- "name": "name",
- "email": "text@example.com",
- "phone_number": "0300000000",
- "postal_code": "0000000",
- "address1": "東京都ロジクラ区",
- "address2": "ロジクラ1-1-1",
- "description": "詳細",
- "updated_at": "2020-12-04T10:09:53.175+09:00"
}
}| id required | integer <int64> (Id) >= 1 Example: 1 仕入先ID |
required | object (仕入先) |
{- "supplier": {
- "code": "code",
- "name": "name",
- "email": "text@example.com",
- "phone_number": "0300000000",
- "postal_code": "0000000",
- "address1": "東京都ロジクラ区",
- "address2": "ロジクラ1-1-1",
- "description": "詳細"
}
}{- "consignee": {
- "id": 1,
- "code": "code",
- "name": "name",
- "email": "text@example.com",
- "phone_number": "0300000000",
- "postal_code": "0000000",
- "address1": "東京都ロジクラ区",
- "address2": "ロジクラ1-1-1",
- "description": "詳細",
- "updated_at": "2020-12-04T10:09:53.175+09:00"
}
}入荷履歴一覧
| page | integer <int64> >= 1 Default: 1 Example: page=1 取得するページ番号(1 始まりの整数。10 進数字のみ)。1 ページあたりの件数は 100 件固定で、クライアントからは変更できません(per_page 等で件数を指定しても無視されます)。 前後のページはレスポンスの Link ヘッダー(rel="next" / rel="prev")で辿れます。 Hash・配列(例 page[size])や 0 以下・非整数、先頭ゼロ・0x・アンダースコア等の表記は 400 を返します。 |
{- "shops": [
- {
- "id": 1,
- "name": "ロジクラショップ",
- "code": "LOGIKURA-SHOP",
- "sales_channel_id": 1,
- "delivery_method_id": 1,
- "email": "test@example.com",
- "phone_number": "03-6362-4084",
- "address1": "東京都港区",
- "address2": "1-1-1 ロジクラビル2F",
- "note": "メモです",
- "tax_included": true,
}
]
}required | object (ショップ) |
{- "shop": {
- "name": "ロジクラショップ",
- "code": "LOGIKURA-SHOP",
- "sales_channel_id": 1,
- "delivery_method_id": 1,
- "email": "test@example.com",
- "phone_number": "03-6362-4084",
- "address1": "東京都港区",
- "address2": "1-1-1 ロジクラビル2F",
- "note": "メモです",
- "tax_included": true
}
}{- "shop": {
- "id": 1,
- "name": "ロジクラショップ",
- "code": "LOGIKURA-SHOP",
- "sales_channel_id": 1,
- "delivery_method_id": 1,
- "email": "test@example.com",
- "phone_number": "03-6362-4084",
- "address1": "東京都港区",
- "address2": "1-1-1 ロジクラビル2F",
- "note": "メモです",
- "tax_included": true,
}
}外部連携アカウント一覧
| page | integer <int64> >= 1 Default: 1 Example: page=1 取得するページ番号(1 始まりの整数。10 進数字のみ)。1 ページあたりの件数は 100 件固定で、クライアントからは変更できません(per_page 等で件数を指定しても無視されます)。 前後のページはレスポンスの Link ヘッダー(rel="next" / rel="prev")で辿れます。 Hash・配列(例 page[size])や 0 以下・非整数、先頭ゼロ・0x・アンダースコア等の表記は 400 を返します。 |
{- "external_service_accounts": [
- {
- "id": 1,
- "name": "株式会社ロジクラ",
- "uid": "external-uid",
- "shop_id": 1,
- "external_service_name": "スマレジ"
}
]
}| external_service_account_id required | integer <int64> >= 1 外部連携アカウントID |
| product_variant_id required | integer <int64> >= 1 種類ID |
| external_service_product_code required | string 連携先コード |
{- "external_service_account_id": 1,
- "product_variant_id": 1,
- "external_service_product_code": "SHOPIFY-PRODUCT-CODE"
}{- "external_service_product_variant": {
- "id": 1,
- "external_service_account_id": 1,
- "product_variant_id": 1,
- "external_service_product_code": "SHOPIFY-PRODUCT-CODE"
}
}| id required | integer <int64> (Id) >= 1 Example: 1 外部連携紐付けID |
| external_service_product_code required | string 連携先コード |
{- "external_service_product_code": "SHOPIFY-PRODUCT-CODE"
}{- "external_service_product_variant": {
- "id": 1,
- "external_service_account_id": 1,
- "product_variant_id": 1,
- "external_service_product_code": "SHOPIFY-PRODUCT-CODE"
}
}| id required | integer <int64> (Id) >= 1 Example: 1 外部連携紐付けID |
{- "external_service_product_variant": {
- "id": 1,
- "external_service_account_id": 1,
- "product_variant_id": 1,
- "external_service_product_code": "SHOPIFY-PRODUCT-CODE"
}
}