Download OpenAPI specification:Download
物流アウトソーシングサービスの オープンロジ が提供する Web API です。
オープンロジAPIを活用することで物流業務の自動化を行うことができるようになります。
こちらを参照してください。
オープンロジAPIを利用してユーザリソースにアクセスするにはアクセストークンが必要となります。
アクセストークンは以下URLのAPI設定画面より発行することができます。
https://app.openlogi.com/portal/tokens (本番環境)
https://app-demo.openlogi.com/portal/tokens (デモ環境)
※ユーザー管理
より追加したサブアカウントでのアクセストークンの発行はできません
複数クライアントから利用する場合はそれぞれ別のアクセストークンを発行し利用してください。
ここで発行されるアクセストークンは有効期限が無い状態で発行されますので取り扱いにはくれぐれもご注意ください。 不要になったアクセストークンは必ず削除してください。 (アクセストークン漏洩による被害に関しては一切の責任を負いません)
オープンロジAPIを提供するホストは以下のURLになります。
https://api.openlogi.com (本番環境)
https://api-demo.openlogi.com (デモ環境)
アクセスする際には指定のリクエストヘッダーを付与する必要があります。
Key | Description |
---|---|
X-Api-Version | 利用するAPIのバージョン (1.3 / 1.4 / 1.5) |
Authorization | API設定画面にて取得したBearer Token |
例)
X-Api-Version: 1.5
Authorization: Bearer wz2FvCW3NRm4GZgLC7GMlW3XbM2qIIbuCDv8RZ8F
APIリクエストは1分間に約60回を上限とします。
それ以上の頻度で送信する必要がある場合は、弊社までお問い合わせください。
※仕様は変更となる場合があります。
商品の一覧を在庫情報と合わせて取得できます。
商品情報と同じフォーマットのJSONが配列で取得できます。
id required | string Example: id=TS001-I000001,AB001-I000003 商品ID指定 カンマ( |
stock | integer Example: stock=1 在庫情報を含むかどうか |
成功
本番環境
デモ環境
{- "items": [
- {
- "id": "TS001-I000001",
- "code": "item-002",
- "name": "勇者の盾",
- "price": "1000",
- "is_reduced_tax": true,
- "hs_code": "000000.000",
- "barcode": "1234567890128",
- "item_barcodes": [
- "TEST1"
], - "description": "玩具",
- "international_info": {
- "invoice_summary": "Toy",
- "origin": "JP"
}, - "child_items": [
- {
- "id": "TS001-I000003",
- "code": "item-001",
- "quantity": 1
}
], - "tags": [
- "water gun"
], - "stock": {
- "available": 1,
- "shipping": 1,
- "reserved": 1,
- "backordered": 1,
- "quantity": 1,
- "size": "S",
- "weight": 200
}, - "stocks": [
- {
- "warehouse": "NBZ",
- "available": 1,
- "shipping": 1,
- "reserved": 1,
- "backordered": 1,
- "quantity": 1,
- "dispose": "waiting"
}
], - "bundled_item": true,
- "externalCode": "TEST1",
- "hidden": true,
- "temperature_zone": "frozen",
- "fifo": true,
- "lot_limit_type": "expiry",
- "expiry_at_allocatable_days": 20,
- "manufacture_date_allocatable_days": 20,
- "expiry_at": "2021-04-05",
- "manufacture_date": "2021-04-01",
- "lot_allocatable_at": "2021-04-05",
- "lot_allocatable_priority": 1
}
]
}
商品を登録します。
code required | string 商品コード |
name | string 商品名 |
price | any 価格 |
is_reduced_tax | boolean 軽減税率適用商品 |
hs_code | string ^\d{4}\.?\d{2}((\.|-)?\d{3,4})?$ HSコード |
barcode | string バーコード |
international_info | object 海外発送情報 |
child_items | Array of objects セット商品の子商品リスト |
tags | Array of strings 商品タグ |
temperature_zone | string Nullable Enum: "dry" "constant" "chilled" "frozen" 保管温度帯 ※温度帯管理を利用するお客様のみ使用可能 |
fifo | boolean Nullable 先入れ先出し ※先入れ先出し管理を利用するお客様のみ使用可能 |
lot_limit_type | string Nullable Enum: "expiry" "manufacture" 期限商品タイプ ※商品マスタ情報。期限管理を利用するお客様のみ使用可能 |
expiry_at_allocatable_days | integer Nullable 引当可能残期間(賞味期限) ※商品マスタ情報。期限管理を利用するお客様のみ使用可能 |
manufacture_date_allocatable_days | integer Nullable 引当可能残期間(製造年月日) ※商品マスタ情報。期限管理を利用するお客様のみ使用可能 |
成功(セット商品含む)
本番環境
デモ環境
{- "code": "item-002",
- "name": "勇者の盾",
- "price": "1000",
- "is_reduced_tax": true,
- "hs_code": "000000.000",
- "barcode": "1234567890128",
- "international_info": {
- "invoice_summary": "Toy",
- "origin": "JP"
}, - "child_items": [
- {
- "id": "TS001-I000003",
- "code": "item-001",
- "quantity": 1
}
], - "tags": [
- "water gun"
], - "temperature_zone": "frozen",
- "fifo": true,
- "lot_limit_type": "expiry",
- "expiry_at_allocatable_days": 20,
- "manufacture_date_allocatable_days": 20
}
{- "id": "TS001-I000001",
- "code": "item-002",
- "name": "勇者の盾",
- "price": "1000",
- "is_reduced_tax": true,
- "hs_code": "000000.000",
- "barcode": "1234567890128",
- "item_barcodes": [
- "TEST1"
], - "description": "玩具",
- "international_info": {
- "invoice_summary": "Toy",
- "origin": "JP"
}, - "child_items": [
- {
- "id": "TS001-I000003",
- "code": "item-001",
- "quantity": 1
}
], - "tags": [
- "water gun"
], - "stock": {
- "available": 1,
- "shipping": 1,
- "reserved": 1,
- "backordered": 1,
- "quantity": 1,
- "size": "S",
- "weight": 200
}, - "stocks": [
- {
- "warehouse": "NBZ",
- "available": 1,
- "shipping": 1,
- "reserved": 1,
- "backordered": 1,
- "quantity": 1,
- "dispose": "waiting"
}
], - "bundled_item": true,
- "externalCode": "TEST1",
- "hidden": true,
- "temperature_zone": "frozen",
- "fifo": true,
- "lot_limit_type": "expiry",
- "expiry_at_allocatable_days": 20,
- "manufacture_date_allocatable_days": 20,
- "expiry_at": "2021-04-05",
- "manufacture_date": "2021-04-01",
- "lot_allocatable_at": "2021-04-05",
- "lot_allocatable_priority": 1
}
商品を一括登録します。
商品登録と同じフォーマットのJSONを配列で送信することで一括登録できます。
items | Array of objects 商品リスト |
成功(セット商品含む)
本番環境
デモ環境
{- "items": [
- {
- "code": "item-002",
- "name": "勇者の盾",
- "price": "1000",
- "is_reduced_tax": true,
- "hs_code": "000000.000",
- "barcode": "1234567890128",
- "international_info": {
- "invoice_summary": "Toy",
- "origin": "JP"
}, - "child_items": [
- {
- "id": "TS001-I000003",
- "code": "item-001",
- "quantity": 1
}
], - "tags": [
- "water gun"
], - "temperature_zone": "frozen",
- "fifo": true,
- "lot_limit_type": "expiry",
- "expiry_at_allocatable_days": 20,
- "manufacture_date_allocatable_days": 20
}
]
}
{- "items": [
- {
- "id": "TS001-I000001",
- "code": "item-002",
- "name": "勇者の盾",
- "price": "1000",
- "is_reduced_tax": true,
- "hs_code": "000000.000",
- "barcode": "1234567890128",
- "item_barcodes": [
- "TEST1"
], - "description": "玩具",
- "international_info": {
- "invoice_summary": "Toy",
- "origin": "JP"
}, - "child_items": [
- {
- "id": "TS001-I000003",
- "code": "item-001",
- "quantity": 1
}
], - "tags": [
- "water gun"
], - "stock": {
- "available": 1,
- "shipping": 1,
- "reserved": 1,
- "backordered": 1,
- "quantity": 1,
- "size": "S",
- "weight": 200
}, - "stocks": [
- {
- "warehouse": "NBZ",
- "available": 1,
- "shipping": 1,
- "reserved": 1,
- "backordered": 1,
- "quantity": 1,
- "dispose": "waiting"
}
], - "bundled_item": true,
- "externalCode": "TEST1",
- "hidden": true,
- "temperature_zone": "frozen",
- "fifo": true,
- "lot_limit_type": "expiry",
- "expiry_at_allocatable_days": 20,
- "manufacture_date_allocatable_days": 20,
- "expiry_at": "2021-04-05",
- "manufacture_date": "2021-04-01",
- "lot_allocatable_at": "2021-04-05",
- "lot_allocatable_priority": 1
}
]
}
在庫情報を含んだ商品情報を取得できます。
id required | string Example: TS001-I000001 商品ID |
stock | integer Example: stock=1 在庫情報を含むかどうか |
成功
本番環境
デモ環境
{- "id": "TS001-I000001",
- "code": "item-002",
- "name": "勇者の盾",
- "price": "1000",
- "is_reduced_tax": true,
- "hs_code": "000000.000",
- "barcode": "1234567890128",
- "item_barcodes": [
- "TEST1"
], - "description": "玩具",
- "international_info": {
- "invoice_summary": "Toy",
- "origin": "JP"
}, - "child_items": [
- {
- "id": "TS001-I000003",
- "code": "item-001",
- "quantity": 1
}
], - "tags": [
- "water gun"
], - "stock": {
- "available": 1,
- "shipping": 1,
- "reserved": 1,
- "backordered": 1,
- "quantity": 1,
- "size": "S",
- "weight": 200
}, - "stocks": [
- {
- "warehouse": "NBZ",
- "available": 1,
- "shipping": 1,
- "reserved": 1,
- "backordered": 1,
- "quantity": 1,
- "dispose": "waiting"
}
], - "bundled_item": true,
- "externalCode": "TEST1",
- "hidden": true,
- "temperature_zone": "frozen",
- "fifo": true,
- "lot_limit_type": "expiry",
- "expiry_at_allocatable_days": 20,
- "manufacture_date_allocatable_days": 20,
- "expiry_at": "2021-04-05",
- "manufacture_date": "2021-04-01",
- "lot_allocatable_at": "2021-04-05",
- "lot_allocatable_priority": 1
}
商品情報を更新します。
id required | string Example: TS001-I000001 商品ID |
code required | string 商品コード |
name | string 商品名 |
price | any 価格 |
is_reduced_tax | boolean 軽減税率適用商品 |
hs_code | string ^\d{4}\.?\d{2}((\.|-)?\d{3,4})?$ HSコード |
barcode | string バーコード |
international_info | object 海外発送情報 |
child_items | Array of objects セット商品の子商品リスト |
tags | Array of strings 商品タグ |
temperature_zone | string Nullable Enum: "dry" "constant" "chilled" "frozen" 保管温度帯 ※温度帯管理を利用するお客様のみ使用可能 |
fifo | boolean Nullable 先入れ先出し ※先入れ先出し管理を利用するお客様のみ使用可能 |
lot_limit_type | string Nullable Enum: "expiry" "manufacture" 期限商品タイプ ※商品マスタ情報。期限管理を利用するお客様のみ使用可能 |
expiry_at_allocatable_days | integer Nullable 引当可能残期間(賞味期限) ※商品マスタ情報。期限管理を利用するお客様のみ使用可能 |
manufacture_date_allocatable_days | integer Nullable 引当可能残期間(製造年月日) ※商品マスタ情報。期限管理を利用するお客様のみ使用可能 |
bundled_item | boolean Nullable 同梱物 |
成功(セット商品含む)
本番環境
デモ環境