API docs by Redocly

ロジクラ API (1.0)

Download OpenAPI specification:Download

ロジクラで管理しているデータを外部から利用するためのAPIです。

概要

リクエスト制限

ロジクラAPIでは1分あたり100回のリクエスト制限を設けています。 リクエスト制限に関する情報はヘッダに含まれています。

ヘッダ名 説明
X-RateLimit-Limit 1分あたりのリクエスト数
X-RateLimit-Remaining リクエスト可能数
X-Rate-Limit-Reset リクエスト数がリセットされるまでの秒数

エラーレスポンス

HTTPステータスコード 種類 原因
401 Unauthorized アクセストークンが不正
404 Not Found リソースが存在しません
422 Unprocessable Entity 不正なパラメーター
499 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"

拠点

拠点一覧

拠点一覧

Authorizations:
OAuth2

Responses

Response samples

Content type
application/json
{
  • "warehouses": [
    ]
}

商品マスター

商品マスター一覧

Authorizations:
OAuth2

Responses

Response samples

Content type
application/json
{
  • "products": [
    ]
}

商品マスター作成

Authorizations:
OAuth2
Request Body schema: application/json
required
object (商品)

Responses

Request samples

Content type
application/json
{
  • "product": {
    }
}

Response samples

Content type
application/json
{
  • "product": {
    }
}

商品マスター詳細

Authorizations:
OAuth2
path Parameters
id
required
integer <integer> (Id) >= 1
Example: 1

商品マスターID

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "name": "Tシャツ",
  • "master_code": "LOGIKURA",
  • "description": "青色",
  • "tax_type_id": 1,
  • "countryCode": "JP",
  • "suppliers": [
    ],
  • "variants": [
    ]
}

商品マスター更新

Authorizations:
OAuth2
path Parameters
id
required
integer <integer> (Id) >= 1
Example: 1

商品マスターID

Request Body schema: application/json
required
object (商品)

Responses

Request samples

Content type
application/json
{
  • "product": {
    }
}

Response samples

Content type
application/json
{
  • "product": {
    }
}

種類

種類一覧

Authorizations:
OAuth2

Responses

Response samples

Content type
application/json
{
  • "product_variants": [
    ]
}

種類作成

Authorizations:
OAuth2
Request Body schema: application/json
required
object (種類)

Responses

Request samples

Content type
application/json
{
  • "product_variant": {
    }
}

Response samples

Content type
application/json
{
  • "product_varian": {
    }
}

種類詳細

Authorizations:
OAuth2
path Parameters
id
required
integer <integer> (Id) >= 1
Example: 1

種類ID

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "product_id": 1,
  • "name": "Tシャツ",
  • "product_code": "LOGIKURA-123",
  • "barcode": 2200020050008,
  • "sales_price": 200,
  • "purchase_price": 100,
  • "weight": 100,
  • "weight_unit": "g",
  • "image": "https://logikura.com/images/searching.png",
  • "option1": "赤",
  • "option2": "Sサイズ",
  • "option3": "綿",
  • "order_point": 100,
  • "sales_start_date": "2019-01-01"
}

種類更新

Authorizations:
OAuth2
Request Body schema: application/json
required
object (種類)

Responses

Request samples

Content type
application/json
{
  • "product_variant": {
    }
}

Response samples

Content type
application/json
{
  • "product_variant": {
    }
}

入荷

入荷予定一覧

入荷予定一覧

Authorizations:
OAuth2

Responses

Response samples

Content type
application/json
{
  • "receiving_schedules": [
    ]
}

入荷予定作成

Authorizations:
OAuth2
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{
  • "receiving_schedule": {
    }
}

Response samples

Content type
application/json
{
  • "receiving_schedule": {
    }
}

入荷予定更新

Authorizations:
OAuth2
path Parameters
id
required
integer <integer> (Id) >= 1
Example: 1

入荷予定ID

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{
  • "receiving_schedule": {
    }
}

Response samples

Content type
application/json
{
  • "receiving_schedule": {
    }
}

入荷予定削除

Authorizations:
OAuth2
path Parameters
id
required
integer <integer> (Id) >= 1
Example: 1

入荷予定ID

Responses

Response samples

Content type
application/json
{
  • "error": "string"
}

入荷履歴削除

Authorizations:
OAuth2
path Parameters
id
required
integer <integer> (Id) >= 1
Example: 1

入荷履歴ID

Responses

Response samples

Content type
application/json
{
  • "error": "string"
}

入荷履歴一覧

入荷履歴一覧

Authorizations:
OAuth2
query Parameters
received_date_from
string <date>
Example: received_date_from=2020-01-01

指定した入荷日以降の履歴が返されます

received_date_to
string <date>
Example: received_date_to=2020-01-31

指定した入荷日以前の履歴が返されます

Responses

Response samples

Content type
application/json
{
  • "receiving_histories": [
    ]
}

出荷

出荷予定一覧

出荷予定一覧

Authorizations:
OAuth2

Responses

Response samples

Content type
application/json
{
  • "shipping_schedules": [
    ]
}

出荷予定作成

Authorizations:
OAuth2
Request Body schema: application/json
required
object or null (受注)
required
object (出荷予定)

Responses

Request samples

Content type
application/json
{
  • "sales_order": {
    },
  • "shipping_schedule": {
    }
}

Response samples

Content type
application/json
{
  • "shipping_schedule": {
    }
}

出荷作業開始

Authorizations:
OAuth2
Request Body schema: application/json
warehouse_id
required
integer >= 1

拠点ID

Responses

Request samples

Content type
application/json
{
  • "warehouse_id": 1
}

Response samples

Content type
application/json
{
  • "shipping_schedule": {
    }
}

出荷確定

Authorizations:
OAuth2
path Parameters
id
required
integer <integer> (Id) >= 1
Example: 1

出荷予定ID

Responses

Response samples

Content type
application/json
{
  • "shipping_schedule": {
    }
}

出荷予定詳細

Authorizations:
OAuth2
path Parameters
id
required
integer <integer> (Id) >= 1
Example: 1

出荷予定ID

Responses

Response samples

Content type
application/json
{
  • "shipping_schedule": {
    }
}

出荷予定更新

Authorizations:
OAuth2
path Parameters
id
required
integer <integer> (Id) >= 1
Example: 1

出荷予定ID

Request Body schema: application/json
required
object or null (受注)
required
object (出荷予定)

Responses

Request samples

Content type
application/json
{
  • "sales_order": {
    },
  • "shipping_schedule": {
    }
}

Response samples

Content type
application/json
{
  • "shipping_schedule": {
    }
}

出荷予定削除

Authorizations:
OAuth2
path Parameters
id
required
integer <integer> (Id) >= 1
Example: 1

出荷予定ID

Responses

Response samples

Content type
application/json
{
  • "error": "string"
}

出荷履歴詳細

Authorizations:
OAuth2
path Parameters
id
required
integer <integer> (Id) >= 1
Example: 1

出荷履歴ID

Responses

Response samples

Content type
application/json
{
  • "shipping_history": {
    }
}

出荷履歴一覧

出荷履歴一覧

Authorizations:
OAuth2
query Parameters
shipped_date_from
string <date>
Example: shipped_date_from=2020-01-01

指定した出荷実績日以降の履歴が返されます

shipped_date_to
string <date>
Example: shipped_date_to=2020-01-31

指定した出荷実績以前の履歴が返されます

Responses

Response samples

Content type
application/json
{
  • "shipping_histories": [
    ]
}

出荷履歴作成

Authorizations:
OAuth2
Request Body schema: application/json
required
object or null (受注)
required
object (出荷履歴)

Responses

Request samples

Content type
application/json
{
  • "sales_order": {
    },
  • "shipping_history": {
    }
}

Response samples

Content type
application/json
{
  • "shipping_history": {
    }
}

在庫

在庫一覧

在庫一覧

Authorizations:
OAuth2

Responses

Response samples

Content type
application/json
{
  • "inventories": [
    ]
}

在庫作成

Authorizations:
OAuth2
Request Body schema: application/json
required
object (在庫)

Responses

Request samples

Content type
application/json
{
  • "inventory": {
    }
}

Response samples

Content type
application/json
{
  • "inventory": {
    }
}

出荷先

出荷先一覧

出荷先一覧

Authorizations:
OAuth2

Responses

Response samples

Content type
application/json
{
  • "consignees": [
    ]
}

出荷先作成

Authorizations:
OAuth2
Request Body schema: application/json
required
object (出荷先)

Responses

Request samples

Content type
application/json
{
  • "consignee": {
    }
}

Response samples

Content type
application/json
{
  • "consignee": {
    }
}

出荷先更新

Authorizations:
OAuth2
path Parameters
id
required
integer <integer> (Id) >= 1
Example: 1

出荷先ID

Request Body schema: application/json
required
object (出荷先)

Responses

Request samples

Content type
application/json
{
  • "consignee": {
    }
}

Response samples

Content type
application/json
{
  • "consignee": {
    }
}

仕入先

仕入先一覧

仕入先一覧

Authorizations:
OAuth2

Responses

Response samples

Content type
application/json
{
  • "suppliers": [
    ]
}

仕入先作成

Authorizations:
OAuth2
Request Body schema: application/json
required
object (出荷先)

Responses

Request samples

Content type
application/json
{
  • "supplier": {
    }
}

Response samples

Content type
application/json
{
  • "consignee": {
    }
}

仕入先更新

Authorizations:
OAuth2
path Parameters
id
required
integer <integer> (Id) >= 1
Example: 1

仕入先ID

Request Body schema: application/json
required
object (仕入先)

Responses

Request samples

Content type
application/json
{
  • "supplier": {
    }
}

Response samples

Content type
application/json
{
  • "consignee": {
    }
}

ショップ

ショップ一覧

入荷履歴一覧

Authorizations:
OAuth2

Responses

Response samples

Content type
application/json
{
  • "shops": [
    ]
}

ショップ作成

Authorizations:
OAuth2
Request Body schema: application/json
required
object (ショップ)

Responses

Request samples

Content type
application/json
{
  • "shop": {
    }
}

Response samples

Content type
application/json
{
  • "shop": {
    }
}

外部連携

外部連携アカウント一覧

外部連携アカウント一覧

Authorizations:
OAuth2

Responses

Response samples

Content type
application/json
{
  • "external_service_accounts": [
    ]
}

商品の外部サービス連携紐付け作成

Authorizations:
OAuth2
Request Body schema: application/json
external_service_account_id
required
integer <integer> >= 1

外部連携アカウントID

product_variant_id
required
integer <integer> >= 1

種類ID

external_service_product_code
required
string

連携先コード

Responses

Request samples

Content type
application/json
{
  • "external_service_account_id": 1,
  • "product_variant_id": 1,
  • "external_service_product_code": "SHOPIFY-PRODUCT-CODE"
}

Response samples

Content type
application/json
{
  • "external_service_product_variant": {
    }
}

商品の外部サービス連携紐付け更新

Authorizations:
OAuth2
path Parameters
id
required
integer <integer> (Id) >= 1
Example: 1

外部連携紐付けID

Request Body schema: application/json
external_service_product_code
required
string

連携先コード

Responses

Request samples

Content type
application/json
{
  • "external_service_product_code": "SHOPIFY-PRODUCT-CODE"
}

Response samples

Content type
application/json
{
  • "external_service_product_variant": {
    }
}

商品の外部サービス連携紐付け削除

Authorizations:
OAuth2
path Parameters
id
required
integer <integer> (Id) >= 1
Example: 1

外部連携紐付けID

Responses

Response samples

Content type
application/json
{
  • "external_service_product_variant": {
    }
}