API docs by Redocly

OPENLOGI API v1.5

Download OpenAPI specification:

ご利用方法

物流アウトソーシングサービスの オープンロジ が提供する Web API です。

OPENLOGI APIを活用することで物流業務の自動化を行うことができるようになります。

アクセストークンの取得

OPENLOGI APIを利用してユーザリソースにアクセスするにはアクセストークンが必要となります。

アクセストークンは下記リンクのAPI Token管理画面より発行することができます。 詳細はこちらのページをご確認ください。

※ユーザー管理より追加したサブアカウントでのアクセストークンの発行はできません

複数クライアントから利用する場合はそれぞれ別のアクセストークンを発行し利用してください。

ここで発行されるアクセストークンは有効期限が無い状態で発行されますので取り扱いにはくれぐれもご注意ください。 不要になったアクセストークンは必ず削除してください。 (アクセストークン漏洩による被害に関しては一切の責任を負いません)

認証方法

すべてのAPIエンドポイントへのリクエスト時に、取得したアクセストークンをAuthorizationリクエストヘッダーへセットしてリクエストしてください。

Authorization: Bearer wz2FvCW3NRm4GZgLC7GMlW3XbM2qIIbuCDv8RZ8F...

ベースURL

OPENLOGI APIを提供するベースURLは以下になります。

環境 ベースURL
本番環境 https://api.openlogi.com/api
デモ環境 https://api-demo.openlogi.com/api

バージョン

OPENLOGI APIはバージョン管理を行っています。

サポートするAPIバージョン ステータス
1.6 Preview
1.5 Active（推奨）

すべてのAPIエンドポイントへのリクエスト時に、X-Api-Versionリクエストヘッダーでバージョンを指定してください。

X-Api-Version: 1.5

レートリミット

APIリクエストは1分間に60回を上限とします。

1分間に60回を超えるリクエストを行うと、HTTPステータスコード429（Too Many Requests）が返却されます。 レートリミットに達した場合は、リクエストを中断し、時間を空けてから再度リクエストを行ってください。 それ以上の頻度で送信する必要がある場合は、弊社までお問い合わせください。

現在のレートリミットの状態は、レスポンスヘッダーのX-RateLimit-Limit（上限値）とX-RateLimit-Remaining（残り回数）で確認できます。

X-RateLimit-Limit: 60
X-RateLimit-Remaining: 59

※仕様は変更となる場合があります。

エラーについて

OPENLOGI APIでは、HTTPステータスコードを用いてリクエストの成否を表現しています。 以下の表をご参考にエラーハンドリングをお願いします。

リクエストがタイムアウトした（ステータスコードが5xxとなった）際は、ネットワーク接続が閉じられてもサーバー側で処理を継続し処理が成功している場合があります。 この場合、GETの場合は時間を置いてリトライをお願いします。 また、POSTの場合は管理画面でリソースが作られているかどうかの確認を、PUT/DELETEの場合はリソースをGETした結果で成否をご確認ください。

HTTPステータスコードとエラー内容

ステータス 概要 errorの値 意味
400 Bad Request exceptionまたはapi_exception OPENLOGI APIが処理できないリクエスト形式です。なお、リクエストデータ形式の誤りは422となります。
401 Unauthorized unauthorized 無効なAPIアクセストークンです。トークン値の確認または再発行をお願いします。
402 Payment Required payment_required ご利用するにはお支払い方法の登録が必要になります。詳細はこちらをご確認ください。
403 Forbidden forbidden 指定のAPIアクセストークンでは許可されていないリクエストです。リクエストしているリソースとトークン発行元が整合しているかご確認ください。
404 Not Found not_found リクエストしているリソースがありません。または、HTTPメソッドやパスが間違っています。
422 Unprocessable Content validation_failed データバリデーション（検証）が失敗しました。多くの場合、「JSON構文に誤りがある」、「必須項目が不足している」、「項目の組み合わせの条件を満たしてない」などに該当します。これらはリトライでは解決しないため、リクエスト内容に間違いがないかご確認ください。
429 Too Many Requests Too Many Attempts. API制限に達しました。リクエスト間隔を空けてリトライをお願いします。
500 Internal Server Error internal_server_error OPENLOGI APIシステムに問題が発生しています。
503 Service Unavailable (注1) OPENLOGI APIのメンテナンス中です。メンテナンス終了後にリクエストをお願いします。メンテナンス予定についてはこちらをご確認ください。
504 Gateway Timeout (注1) OPENLOGI APIシステムに問題が発生しています。GETの場合は時間を置いてリトライを、POSTの場合は管理画面でリソースが作られているかどうかの確認を、PUT/DELETEの場合はリソースをGETした結果で成否をご確認ください。

注1: Content-Typeレスポンスヘッダーの値がtext/htmlの場合もあるため、レスポンスボディではなくステータスコードをご利用ください。

各エンドポイント共通のエラーレスポンススキーマ

429 Too Many Requests

HTTP/1.1 429 Too Many Requests
X-RateLimit-Limit: 60
X-RateLimit-Remaining: 0
Content-Type: application/json
{
  "error": "Too Many Attempts.",
  "error_description": "Too Many Attempts."
}

500 Internal Server Error

HTTP/1.1 500 Internal Server Error
Content-Type: application/json
{
  "error": "internal_server_error"
}

503 Service Unavailable

HTTP/1.1 503 Service Unavailable
Content-Type: text/html
<html><head><title>503</title></head><body>ただいま、メンテナンス中です</body></html>

504 Gateway Timeout

HTTP/1.1 504 Gateway Timeout

CHANGELOG

こちらを参照してください。

items

商品に関連する情報を取得します

商品一覧

商品の一覧を在庫情報と合わせて取得できます。

商品情報と同じフォーマットのJSONを配列で取得できます。

query Parameters
id
required
string
Example: id=TS001-I000001,AB001-I000003

商品ID指定

カンマ( , )区切りで複数IDを最大100件まで指定できます。

APIバージョン1.6 以降では任意のパラメータになります。

stock
integer
Example: stock=1

stock=1と指定すると、レスポンスに在庫情報を含めます。

Value: 1
cursor
string
Example: cursor=eyJrZXkiOjEwMDAwMCwic2FtcGxlTWV0YWRhdGEiOnRydWV9

APIバージョン1.6 以降で利用可能なカーソル。前回レスポンスの metadata.page.next_cursor を指定すると次ページを取得します。

limit
integer [ 1 .. 1000 ]
Default: 10
Example: limit=10

APIバージョン1.6 以降で利用可能な1ページあたりの取得件数

Responses

Response samples

Content type
application/json
Example
{
  • "items": [
    ],
  • "metadata": {
    }
}

商品登録

商品を登録します。

Request Body schema: application/json
code
required
string (商品コード) [ 1 .. 30 ] characters

商品に記載されたユーザー独自のコードや品番・型番を表す半角英数記号の文字列です。 入出荷時に商品を指定する場合に使うことができます。

商品コードは出荷時の同梱明細書にも記載されます。

name
string (商品名) <= 255 characters

商品名は出荷依頼作成時に変更することもできます。 出荷依頼作成時に商品名（.items[].name）の指定がない場合に、この商品名が出荷依頼の同梱明細書に記載されます。

価格（リクエストパラメータ） (integer) or 価格（レスポンス） (string)
is_reduced_tax
boolean (軽減税率適用商品)

軽減税率が適用される商品の場合はtrueを指定します。 出荷依頼作成時に軽減税率適用商品（.items[].is_reduced_tax）の指定がない場合に、この軽減税率適用商品の値が適用されます。

hs_code
string (HSコード) ^\d{4}\.?\d{2}((\.|-)?\d{3,4})?$

海外へ発送する場合の商品のHSコード。出荷依頼作成時に指定します。 出荷依頼作成時にHSコード（.items[].hs_code）の指定がない場合に、このHSコードの値が適用されます。

詳細はこちらのページをご確認ください。
barcode
string (管理バーコード) <= 30 characters

入荷依頼で検品タイプ：管理バーコードを選択した際に使用されます。 UPC-A形式またはJAN13形式のバーコードを指定します。

object

海外発送情報

Array of 商品ID指定 (object) or 商品コード指定 (object) (セット商品の子商品リスト) [ 1 .. 10 ] items

セット商品の場合に、組み合わせる商品を指定します。

詳細はこちらのページをご確認ください。
tags
Array of strings (商品タグリスト) non-empty [ items <= 255 characters ]

商品に付与するタグを複数指定します。,, ，, ､, 、はタグ文字列内で利用できません。

詳細はこちらのページをご確認ください。
temperature_zone
string or null (保管温度帯)
Default: "dry"
Enum: "dry" "constant" "chilled" "frozen"

※温度帯管理を利用するお客様のみ使用可能

商品をどの温度帯で管理するか指定します。 温度帯は概ねの目安となり実際の管理温度帯は倉庫によって異なります。

  • dry: 常温（5℃ ~ 35℃の範囲）
  • constant: 定温（10℃ ~ 25℃の範囲）
  • chilled: 冷蔵（-5℃ ~ 5℃の範囲）
  • frozen: 冷凍（-15℃以下）
詳細はこちらのページをご確認ください。
fifo
boolean or null (先入れ先出し)

※先入れ先出し管理を利用するお客様のみ使用可能

lot_limit_type
string or null (期限商品タイプ)
Enum: "expiry" "manufacture"

※期限管理を利用するお客様のみ使用可能

  • expiry: 賞味期限で管理する商品
  • manufacture: 製造年月日で管理する商品
詳細はこちらのページをご確認ください。
expiry_at_allocatable_days
integer or null (引当可能残期間（賞味期限）) >= 0

※期限管理を利用するお客様のみ使用可能

賞味期限から何日前まで引当てできるかを指定します。lot_limit_typeがexpiryの場合に指定します。

manufacture_date_allocatable_days
integer or null (引当可能残期間（製造年月日）) >= 0

※期限管理を利用するお客様のみ使用可能

製造年月日から何日前まで引当てできるかを指定します。lot_limit_typeがmanufactureの場合に指定します。

Responses

Request samples

Content type
application/json
{
  • "code": "item-002",
  • "name": "勇者の盾",
  • "price": 1000,
  • "is_reduced_tax": true,
  • "hs_code": "000000.000",
  • "barcode": "1234567890128",
  • "international_info": {
    },
  • "child_items": [
    ],
  • "tags": [
    ],
  • "temperature_zone": "frozen",
  • "fifo": true,
  • "lot_limit_type": "expiry",
  • "expiry_at_allocatable_days": 20,
  • "manufacture_date_allocatable_days": 20
}

Response samples

Content type
application/json
{
  • "id": "TS001-I000001",
  • "code": "item-002",
  • "name": "勇者の盾",
  • "price": 1000,
  • "is_reduced_tax": true,
  • "hs_code": "000000.000",
  • "barcode": "1234567890128",
  • "item_barcodes": [
    ],
  • "description": "玩具",
  • "international_info": {
    },
  • "child_items": [
    ],
  • "tags": [
    ],
  • "stock": {
    },
  • "stocks": [
    ],
  • "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 21:00:00",
  • "manufacture_date": "2021-04-01",
  • "lot_allocatable_at": "2021-04-05 18:00:00",
  • "lot_allocatable_priority": 1
}

商品一括登録

商品を一括登録します。

商品登録と同じフォーマットのJSONを配列で送信することで一括登録できます。

Request Body schema: application/json
Array of objects (ItemRequest)

商品リスト

Responses

Request samples

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

Response samples

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

商品情報取得

指定した1件の商品IDの商品情報を在庫情報と共に取得できます。

商品コードを指定して商品情報を取得する場合は、code指定の商品情報取得をご利用ください。

path Parameters
id
required
string
Example: TS001-I000001

商品ID

商品IDはオープンロジに商品を登録した際に自動で生成され、商品ごとに割り当てられる固有のIDです。

詳細はこちらのページをご確認ください。
query Parameters
stock
integer
Example: stock=1

stock=1と指定すると、レスポンスに在庫情報を含めます。

Value: 1

Responses

Response samples

Content type
application/json
{
  • "id": "TS001-I000001",
  • "code": "item-002",
  • "name": "勇者の盾",
  • "price": 1000,
  • "is_reduced_tax": true,
  • "hs_code": "000000.000",
  • "barcode": "1234567890128",
  • "item_barcodes": [
    ],
  • "description": "玩具",
  • "international_info": {
    },
  • "child_items": [
    ],
  • "tags": [
    ],
  • "stock": {
    },
  • "stocks": [
    ],
  • "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 21:00:00",
  • "manufacture_date": "2021-04-01",
  • "lot_allocatable_at": "2021-04-05 18:00:00",
  • "lot_allocatable_priority": 1
}

商品情報更新

指定した1件の商品IDの商品情報を更新します。

商品コードを指定して商品情報を更新する場合は、code指定の商品情報取得をご利用ください。

path Parameters
id
required
string
Example: TS001-I000001

商品ID

商品IDはオープンロジに商品を登録した際に自動で生成され、商品ごとに割り当てられる固有のIDです。

詳細はこちらのページをご確認ください。
Request Body schema: application/json
code
required
string (商品コード) [ 1 .. 30 ] characters

商品に記載されたユーザー独自のコードや品番・型番を表す半角英数記号の文字列です。 入出荷時に商品を指定する場合に使うことができます。

商品コードは出荷時の同梱明細書にも記載されます。

name
string (商品名) <= 255 characters

商品名は出荷依頼作成時に変更することもできます。 出荷依頼作成時に商品名（.items[].name）の指定がない場合に、この商品名が出荷依頼の同梱明細書に記載されます。

価格（リクエストパラメータ） (integer) or 価格（レスポンス） (string)
is_reduced_tax
boolean (軽減税率適用商品)

軽減税率が適用される商品の場合はtrueを指定します。 出荷依頼作成時に軽減税率適用商品（.items[].is_reduced_tax）の指定がない場合に、この軽減税率適用商品の値が適用されます。

hs_code
string (HSコード) ^\d{4}\.?\d{2}((\.|-)?\d{3,4})?$

海外へ発送する場合の商品のHSコード。出荷依頼作成時に指定します。 出荷依頼作成時にHSコード（.items[].hs_code）の指定がない場合に、このHSコードの値が適用されます。

詳細はこちらのページをご確認ください。
barcode
string (管理バーコード) <= 30 characters

入荷依頼で検品タイプ：管理バーコードを選択した際に使用されます。 UPC-A形式またはJAN13形式のバーコードを指定します。

object

海外発送情報

Array of 商品ID指定 (object) or 商品コード指定 (object) (セット商品の子商品リスト) [ 1 .. 10 ] items

セット商品の場合に、組み合わせる商品を指定します。

詳細はこちらのページをご確認ください。
tags
Array of strings (商品タグリスト) non-empty [ items <= 255 characters ]

商品に付与するタグを複数指定します。,, ，, ､, 、はタグ文字列内で利用できません。

詳細はこちらのページをご確認ください。
temperature_zone
string or null (保管温度帯)
Default: "dry"
Enum: "dry" "constant" "chilled" "frozen"

※温度帯管理を利用するお客様のみ使用可能

商品をどの温度帯で管理するか指定します。 温度帯は概ねの目安となり実際の管理温度帯は倉庫によって異なります。

  • dry: 常温（5℃ ~ 35℃の範囲）
  • constant: 定温（10℃ ~ 25℃の範囲）
  • chilled: 冷蔵（-5℃ ~ 5℃の範囲）
  • frozen: 冷凍（-15℃以下）
詳細はこちらのページをご確認ください。
fifo
boolean or null (先入れ先出し)

※先入れ先出し管理を利用するお客様のみ使用可能

lot_limit_type
string or null (期限商品タイプ)
Enum: "expiry" "manufacture"

※期限管理を利用するお客様のみ使用可能

  • expiry: 賞味期限で管理する商品
  • manufacture: 製造年月日で管理する商品
詳細はこちらのページをご確認ください。
expiry_at_allocatable_days
integer or null (引当可能残期間（賞味期限）) >= 0

※期限管理を利用するお客様のみ使用可能

賞味期限から何日前まで引当てできるかを指定します。lot_limit_typeがexpiryの場合に指定します。

manufacture_date_allocatable_days
integer or null (引当可能残期間（製造年月日）) >= 0

※期限管理を利用するお客様のみ使用可能

製造年月日から何日前まで引当てできるかを指定します。lot_limit_typeがmanufactureの場合に指定します。

bundled_item
boolean or null (同梱物)

trueの場合、この商品は同梱物となります。

詳細はこちらのページをご確認ください。

Responses

Request samples

Content type
application/json
{
  • "code": "item-002",
  • "name": "勇者の盾",
  • "price": 1000,
  • "is_reduced_tax": true,
  • "hs_code": "000000.000",
  • "barcode": "1234567890128",
  • "international_info": {
    },
  • "child_items": [
    ],
  • "tags": [
    ],
  • "temperature_zone": "frozen",
  • "fifo": true,
  • "lot_limit_type": "expiry",
  • "expiry_at_allocatable_days": 20,
  • "manufacture_date_allocatable_days": 20,
  • "bundled_item": true
}

Response samples

Content type
application/json
{
  • "id": "TS001-I000001",
  • "code": "item-002",
  • "name": "勇者の盾",
  • "price": 1000,
  • "is_reduced_tax": true,
  • "hs_code": "000000.000",
  • "barcode": "1234567890128",
  • "item_barcodes": [
    ],
  • "description": "玩具",
  • "international_info": {
    },
  • "child_items": [
    ],
  • "tags": [
    ],
  • "stock": {
    },
  • "stocks": [
    ],
  • "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 21:00:00",
  • "manufacture_date": "2021-04-01",
  • "lot_allocatable_at": "2021-04-05 18:00:00",
  • "lot_allocatable_priority": 1
}

商品削除

商品を削除します。

入荷依頼中および入荷実績があるアイテムは削除できません。

path Parameters
id
required
string
Example: TS001-I000001

商品ID

Request Body schema: application/json
any

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "TS001-I000001",
  • "code": "item-002",
  • "name": "勇者の盾",
  • "price": 1000,
  • "is_reduced_tax": true,
  • "hs_code": "000000.000",
  • "barcode": "1234567890128",
  • "item_barcodes": [
    ],
  • "description": "玩具",
  • "international_info": {
    },
  • "child_items": [
    ],
  • "tags": [
    ],
  • "stock": {
    },
  • "stocks": [
    ],
  • "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 21:00:00",
  • "manufacture_date": "2021-04-01",
  • "lot_allocatable_at": "2021-04-05 18:00:00",
  • "lot_allocatable_priority": 1
}

商品画像登録

商品の画像を登録します。 jpeg, png タイプのファイルを指定できます。

multipart/form-data 形式でファイルを送信します。

  • Content-Disposition の name は file を指定してください。

  • ファイル名は Content-Disposition の filename で指定してください。

  • ファイル名がマルチバイトの場合は UTF-8 エンコードした値を指定してください。

path Parameters
id
required
string
Example: TS001-I000001

商品ID

Request Body schema: multipart/form-data
name
string
filename
string

Responses

Response samples

Content type
application/json
{
  • "id": 1234
}

商品画像削除

商品画像を削除します。

同梱物の場合、画像を全て削除することはできません。

path Parameters
id
required
string
Example: TS001-I000001

商品ID

image_id
string
Example: 1

画像ID

Responses

Response samples

Content type
application/json
{ }

items(code指定)

商品コード（code）を指定して商品情報を操作します。

オープンロジが発行する商品IDが不明な場合にご利用ください。

パスパラメータに含まれるアカウントコードについては、こちらのページをご確認ください。

商品一覧

商品の一覧を在庫情報と合わせて取得できます。

商品情報と同じフォーマットのJSONが配列で取得できます。

path Parameters
account_id
required
string
Example: AB001

アカウントコード

query Parameters
identifier
required
string
Example: identifier=123456-098765,12345678,AB12345

商品識別番号

カンマ( , )区切りで複数IDを最大100件まで指定できます。

APIバージョン1.6 以降では任意のパラメータになります。

code
required
string
Example: code=DQ001,DQ002

商品コード

カンマ( , )区切りで複数IDを最大100件まで指定できます。

APIバージョン1.6 以降では任意のパラメータになります。

stock
integer
Example: stock=1

在庫情報を含むかどうか

cursor
string
Example: cursor=eyJrZXkiOjEwMDAwMCwic2FtcGxlTWV0YWRhdGEiOnRydWV9

APIバージョン1.6 以降で利用可能なカーソル。前回レスポンスの metadata.page.next_cursor を指定すると次ページを取得します。

limit
integer [ 1 .. 1000 ]
Default: 10
Example: limit=10

APIバージョン1.6 以降で利用可能な1ページあたりの取得件数

Responses

Response samples

Content type
application/json
Example
{
  • "items": [
    ],
  • "metadata": {
    }
}

商品情報取得

在庫情報を含んだ商品情報を取得できます。

path Parameters
account_id
required
string
Example: AB001

アカウントコード

code
required
string
Example: item-001

商品コード

query Parameters
stock
integer
Example: stock=1

在庫情報を含むかどうか

Responses

Response samples

Content type
application/json
{
  • "id": "TS001-I000001",
  • "code": "item-002",
  • "name": "勇者の盾",
  • "price": 1000,
  • "is_reduced_tax": true,
  • "hs_code": "000000.000",
  • "barcode": "1234567890128",
  • "item_barcodes": [
    ],
  • "description": "玩具",
  • "international_info": {
    },
  • "child_items": [
    ],
  • "tags": [
    ],
  • "stock": {
    },
  • "stocks": [
    ],
  • "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 21:00:00",
  • "manufacture_date": "2021-04-01",
  • "lot_allocatable_at": "2021-04-05 18:00:00",
  • "lot_allocatable_priority": 1
}

商品更新

商品情報を更新します。

path Parameters
account_id
required
string
Example: AB001

アカウントコード

code
required
string
Example: item-001

商品コード

Request Body schema: application/json
code
required
string (商品コード) [ 1 .. 30 ] characters

商品に記載されたユーザー独自のコードや品番・型番を表す半角英数記号の文字列です。 入出荷時に商品を指定する場合に使うことができます。

商品コードは出荷時の同梱明細書にも記載されます。

name
string (商品名) <= 255 characters

商品名は出荷依頼作成時に変更することもできます。 出荷依頼作成時に商品名（.items[].name）の指定がない場合に、この商品名が出荷依頼の同梱明細書に記載されます。

価格（リクエストパラメータ） (integer) or 価格（レスポンス） (string)
is_reduced_tax
boolean (軽減税率適用商品)

軽減税率が適用される商品の場合はtrueを指定します。 出荷依頼作成時に軽減税率適用商品（.items[].is_reduced_tax）の指定がない場合に、この軽減税率適用商品の値が適用されます。

hs_code
string (HSコード) ^\d{4}\.?\d{2}((\.|-)?\d{3,4})?$

海外へ発送する場合の商品のHSコード。出荷依頼作成時に指定します。 出荷依頼作成時にHSコード（.items[].hs_code）の指定がない場合に、このHSコードの値が適用されます。

詳細はこちらのページをご確認ください。
barcode
string (管理バーコード) <= 30 characters

入荷依頼で検品タイプ：管理バーコードを選択した際に使用されます。 UPC-A形式またはJAN13形式のバーコードを指定します。

object

海外発送情報

Array of 商品ID指定 (object) or 商品コード指定 (object) (セット商品の子商品リスト) [ 1 .. 10 ] items

セット商品の場合に、組み合わせる商品を指定します。

詳細はこちらのページをご確認ください。
tags
Array of strings (商品タグリスト) non-empty [ items <= 255 characters ]

商品に付与するタグを複数指定します。,, ，, ､, 、はタグ文字列内で利用できません。

詳細はこちらのページをご確認ください。
temperature_zone
string or null (保管温度帯)
Default: "dry"
Enum: "dry" "constant" "chilled" "frozen"

※温度帯管理を利用するお客様のみ使用可能

商品をどの温度帯で管理するか指定します。 温度帯は概ねの目安となり実際の管理温度帯は倉庫によって異なります。

  • dry: 常温（5℃ ~ 35℃の範囲）
  • constant: 定温（10℃ ~ 25℃の範囲）
  • chilled: 冷蔵（-5℃ ~ 5℃の範囲）
  • frozen: 冷凍（-15℃以下）
詳細はこちらのページをご確認ください。
fifo
boolean or null (先入れ先出し)

※先入れ先出し管理を利用するお客様のみ使用可能

lot_limit_type
string or null (期限商品タイプ)
Enum: "expiry" "manufacture"

※期限管理を利用するお客様のみ使用可能

  • expiry: 賞味期限で管理する商品
  • manufacture: 製造年月日で管理する商品
詳細はこちらのページをご確認ください。
expiry_at_allocatable_days
integer or null (引当可能残期間（賞味期限）) >= 0

※期限管理を利用するお客様のみ使用可能

賞味期限から何日前まで引当てできるかを指定します。lot_limit_typeがexpiryの場合に指定します。

manufacture_date_allocatable_days
integer or null (引当可能残期間（製造年月日）) >= 0

※期限管理を利用するお客様のみ使用可能

製造年月日から何日前まで引当てできるかを指定します。lot_limit_typeがmanufactureの場合に指定します。

bundled_item
boolean or null (同梱物)

trueの場合、この商品は同梱物となります。

詳細はこちらのページをご確認ください。

Responses

Request samples

Content type
application/json
{
  • "code": "item-002",
  • "name": "勇者の盾",
  • "price": 1000,
  • "is_reduced_tax": true,
  • "hs_code": "000000.000",
  • "barcode": "1234567890128",
  • "international_info": {
    },
  • "child_items": [
    ],
  • "tags": [
    ],
  • "temperature_zone": "frozen",
  • "fifo": true,
  • "lot_limit_type": "expiry",
  • "expiry_at_allocatable_days": 20,
  • "manufacture_date_allocatable_days": 20,
  • "bundled_item": true
}

Response samples

Content type
application/json
{
  • "id": "TS001-I000001",
  • "code": "item-002",
  • "name": "勇者の盾",
  • "price": 1000,
  • "is_reduced_tax": true,
  • "hs_code": "000000.000",
  • "barcode": "1234567890128",
  • "item_barcodes": [
    ],
  • "description": "玩具",
  • "international_info": {
    },
  • "child_items": [
    ],
  • "tags": [
    ],
  • "stock": {
    },
  • "stocks": [
    ],
  • "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 21:00:00",
  • "manufacture_date": "2021-04-01",
  • "lot_allocatable_at": "2021-04-05 18:00:00",
  • "lot_allocatable_priority": 1
}

商品削除

商品を削除します。

入荷依頼中および入荷実績があるアイテムは削除できません。

path Parameters
account_id
required
string
Example: AB001

アカウントコード

code
required
string
Example: item-001

商品コード

Request Body schema: application/json
any

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "TS001-I000001",
  • "code": "item-002",
  • "name": "勇者の盾",
  • "price": 1000,
  • "is_reduced_tax": true,
  • "hs_code": "000000.000",
  • "barcode": "1234567890128",
  • "item_barcodes": [
    ],
  • "description": "玩具",
  • "international_info": {
    },
  • "child_items": [
    ],
  • "tags": [
    ],
  • "stock": {
    },
  • "stocks": [
    ],
  • "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 21:00:00",
  • "manufacture_date": "2021-04-01",
  • "lot_allocatable_at": "2021-04-05 18:00:00",
  • "lot_allocatable_priority": 1
}

商品画像登録

商品の画像を登録します。 jpeg, png タイプのファイルを指定できます。

multipart/form-data 形式でファイルを送信します。

  • Content-Disposition の name は file を指定してください。

  • ファイル名は Content-Disposition の filename で指定してください。

  • ファイル名がマルチバイトの場合は UTF-8 エンコードした値を指定してください。

path Parameters
account_id
required
string
Example: AB001

アカウントコード

code
required
string
Example: item-001

商品コード

Request Body schema: multipart/form-data
name
string
filename
string

Responses

Response samples

Content type
application/json
{
  • "id": 1234
}

商品画像削除

商品画像を削除します。

同梱物の場合、画像を全て削除することはできません。

path Parameters
account_id
required
string
Example: AB001

アカウントコード

code
required
string
Example: item-001

商品コード

image_id
required
string
Example: 1

画像ID

Responses

Response samples

Content type
application/json
{ }

warehousings

入荷に関連する情報を取得します

入荷依頼一覧

入荷未完了状態の入荷依頼を取得します。

入荷情報と同じフォーマットのJSONが配列で取得できます。

Responses

Response samples

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

入荷依頼作成

入荷依頼を作成します。

実際の入荷処理をするには別途入荷明細書と入荷ラベルが必要になります。 入荷ラベル取得APIまたはオープンロジの入荷依頼中の画面より入荷明細書兼入荷ラベルのPDFを取得、印刷し、入荷明細書を同梱した上で入荷ラベルを箱に貼って倉庫宛に発送ください。 詳細はこちらのページをご確認ください。

Request Body schema: application/json
inspection_type
required
string (検品タイプ)
Enum: "ID" "NAME" "CODE" "BARCODE" "LABEL"

倉庫に届いた商品を検品する方法。

  • ID: オープンロジ商品ID
  • NAME: 商品名
  • CODE: 商品コード
  • BARCODE: 管理バーコード
  • LABEL: オープンロジ商品ラベル
詳細はこちらのページをご確認ください。
required
Array of objects (入荷商品リスト) [ 1 .. 25 ] items unique

入荷する商品情報を指定します。同梱物も通常の商品と同様に指定します。

arrival_date
required
string <date> (倉庫着予定日)

倉庫に該当の入荷が着荷する予定日です。未定の場合は、おおよその日付を指定します。

arrival_date_confirmed
boolean (確定情報として登録)

倉庫着予定日が確定されていればtrueを指定してください。

以下の場合は、大量入荷として入荷完了までに着荷日を除く2営業日以上かかる場合があります。

  • 商品数量が200点以上
  • 100サイズ以上の商品が20点以上

大量入荷になる場合は、必ず倉庫到着予定日の2日前までに、倉庫着予定日を確定情報として登録した上で入荷依頼を作成してください。

詳細はこちらのページをご確認ください。
arrival_time_from
integer (倉庫着予定時間(いつから)) [ 0 .. 23 ]

倉庫に該当の入荷が着荷する予定最短時刻です。

arrival_time_to
integer (倉庫着予定時間(いつまで)) [ 0 .. 23 ]

倉庫に該当の入荷が着荷する予定最長時刻です。

sales_method
string (販売方法)
Default: "INVENTORY"
Enum: "INVENTORY" "RESERVATION" "OTHER"

入荷した商品を出荷する際の販売方法です。倉庫の作業計画を立てるために必要な情報です。

  • INVENTORY: 在庫販売
  • RESERVATION: 予約販売
  • OTHER: その他
shipping_scheduled_date
string <date> (出荷予定日)

販売方法が RESERVATION の場合にのみ指定できます。倉庫の作業計画を立てるために必要な情報です。

warehouse
string or null (倉庫コード)

入荷する倉庫をコードで指定します。未指定または null を指定した場合は、標準倉庫へ入荷されます。

transport_mode
string (配送方法)
Default: "HOME_DELIVERY"
Enum: "" "HOME_DELIVERY" "CHARTER" "CONTAINER"

入荷する際の配送方法を指定します。

  • "" : 指定なし
  • HOME_DELIVERY : 宅配便
  • CHARTER : チャーター
  • CONTAINER : コンテナ
詳細はこちらのページをご確認ください。
identity_type
string (入荷特定項目)
Default: "ID_OR_LABEL"
Enum: "ID_OR_LABEL" "SUPPLIER" "TRACKING_CODE" "VEHICLE_CODE" "CONTAINER"

※入荷ラベルなし入荷を利用するお客様のみ使用可能

倉庫で入荷を特定する際のキーとなる項目を指定できます。 許可された項目のみ指定できます。

  • ID_OR_LABEL : 入荷ラベル・ID
  • SUPPLIER : 発注先名。この値を指定し、identity_valuesを指定すると、倉庫側で発注先名を使用して入荷を特定します
  • TRACKING_CODE : お問い合わせ伝票番号。この値を指定し、tracking_codesを指定すると、倉庫側でお問い合わせ伝票番号を使用して入荷を特定します
  • VEHICLE_CODE : 車両番号。この値を指定し、vehicle_codeを指定すると、倉庫側で車両番号を使用して入荷を特定します
  • CONTAINER : コンテナID。この値を指定し、container_noを指定すると、倉庫側でコンテナIDを使用して入荷を特定します
identity_values
Array of strings (入荷特定情報)

※入荷ラベルなし入荷を利用するお客様のみ使用可能

入荷特定項目に対応した値を指定できます。

  • 入荷特定項目がID_OR_LABELの場合は指定できません。
  • 入荷特定項目がSUPPLIERの場合、このパラメータに発注先名を指定すると、倉庫側で発注先名を使用して入荷を特定します。
tracking_codes
Array of strings (お問合せ伝票番号)

配送方法が HOME_DELIVERY または "" であれば、このパラメータを指定できます。

倉庫での入荷作業を円滑にしたり、トラブルの解決に必要な情報です。

vehicle_code
string (車両番号) <= 30 characters

商品を倉庫へ送る際のチャーターやコンテナを載せる車両の番号を指定します。倉庫での入荷作業を円滑にしたり、トラブルの解決に必要な情報です。

配送方法が CHARTER または CONTAINER の場合、指定できます。

vehicle_size
string (車両サイズ)
Enum: "UNDER_2T" "4T" "10T" "20FT" "40FT"

車両やコンテナのサイズを指定できます。倉庫での入荷作業を円滑にしたり、トラブルの解決に必要な情報です。

配送方法が CHARTER または CONTAINER の場合、指定できます。

  • UNDER_2T: 2t以下
  • 4T: 4t
  • 10T: 10t
  • 20FT: 20ft
  • 40FT: 40ft
carrying_method
string (積載方法)
Enum: "PALETTE" "BARA"

個口の積載方法を指定できます。 配送方法が CHARTER または CONTAINER の場合、指定できます。

  • PALETTE: パレット
  • BARA: バラ積み
container_no
string (コンテナID) <= 30 characters

配送方法が CONTAINER の場合、指定できます。倉庫での入荷作業を円滑にしたり、トラブルの解決に必要な情報です。

driver_info
string (ドライバー情報) <= 500 characters

ドライバーに関する補足情報を指定できます。チャーター便の会社名や運転手の連絡先などを倉庫へ共有するための情報です。 配送方法が CHARTER または CONTAINER の場合、指定できます。

company_memo
string (入荷メモ) <= 255 characters

ユーザー側で利用するメモ欄。倉庫には共有されません。

identifier
string (入荷依頼識別子) <= 30 characters

ユーザーが入荷依頼をユニークに特定するための符号です。 ユーザーが任意に指定するものです。 大文字・小文字のアルファベット、数字、一部の記号のみ利用可能です。

Responses

Request samples

Content type
application/json
{
  • "inspection_type": "CODE",
  • "items": [
    ],
  • "arrival_date": "2019-04-22",
  • "arrival_date_confirmed": true,
  • "arrival_time_from": 10,
  • "arrival_time_to": 13,
  • "sales_method": "RESERVATION",
  • "shipping_scheduled_date": "2019-04-29",
  • "warehouse": "OPL",
  • "transport_mode": "",
  • "identity_type": "ID_OR_LABEL",
  • "identity_values": [
    ],
  • "tracking_codes": [
    ],
  • "vehicle_code": "品川 100 あ ・・・1",
  • "vehicle_size": "4T",
  • "carrying_method": "PALETTE",
  • "container_no": "AAAU1234567",
  • "driver_info": "株式会社oo 田中: 090-XXXX-XXXX",
  • "company_memo": "キャンペーン用の商品です",
  • "identifier": "Identifier-001"
}

Response samples

Content type
application/json
{
  • "id": "TS001-W0001",
  • "status": "waiting",
  • "halfway": false,
  • "arrival_date": "2019-04-22",
  • "arrival_date_confirmed": true,
  • "arrival_time_from": 10,
  • "arrival_time_to": 13,
  • "sales_method": "RESERVATION",
  • "shipping_scheduled_date": "2019-04-29",
  • "stock_deadline_date": "2019-04-24",
  • "identifier": "Identifier-001",
  • "inspection_type": "CODE",
  • "inspection_type_label": "オープンロジ商品ID",
  • "transport_mode": "",
  • "identity_type": "ID_OR_LABEL",
  • "identity_values": [
    ],
  • "tracking_codes": [
    ],
  • "vehicle_code": "品川 100 あ ・・・1",
  • "vehicle_size": "4T",
  • "carrying_method": "PALETTE",
  • "container_no": "AAAU1234567",
  • "driver_info": "株式会社oo 田中: 090-XXXX-XXXX",
  • "company_memo": "キャンペーン用の商品です",
  • "items": [
    ],
  • "warehouse": "stri",
  • "warehouse_info": {
    },
  • "created_at": "2019-04-01T12:00:00+09:00",
  • "create_user": {
    }
}

入荷依頼情報

入荷情報を取得します。

path Parameters
id
required
string
Example: AB001-W0001

入荷ID

Responses

Response samples

Content type
application/json
{
  • "id": "TS001-W0001",
  • "status": "waiting",
  • "halfway": false,
  • "arrival_date": "2019-04-22",
  • "arrival_date_confirmed": true,
  • "arrival_time_from": 10,
  • "arrival_time_to": 13,
  • "sales_method": "RESERVATION",
  • "shipping_scheduled_date": "2019-04-29",
  • "stock_deadline_date": "2019-04-24",
  • "identifier": "Identifier-001",
  • "inspection_type": "CODE",
  • "inspection_type_label": "オープンロジ商品ID",
  • "transport_mode": "",
  • "identity_type": "ID_OR_LABEL",
  • "identity_values": [
    ],
  • "tracking_codes": [
    ],
  • "vehicle_code": "品川 100 あ ・・・1",
  • "vehicle_size": "4T",
  • "carrying_method": "PALETTE",
  • "container_no": "AAAU1234567",
  • "driver_info": "株式会社oo 田中: 090-XXXX-XXXX",
  • "company_memo": "キャンペーン用の商品です",
  • "items": [
    ],
  • "warehouse": "stri",
  • "warehouse_info": {
    },
  • "created_at": "2019-04-01T12:00:00+09:00",
  • "create_user": {
    },
  • "shipment_return": false
}

入荷依頼更新

依頼中の出荷依頼を更新します。

ステータスによっては更新できません。

path Parameters
id
required
string
Example: AB001-W0001

入荷ID

Request Body schema: application/json
inspection_type
required
string (検品タイプ)
Enum: "ID" "NAME" "CODE" "BARCODE" "LABEL"

倉庫に届いた商品を検品する方法。

  • ID: オープンロジ商品ID
  • NAME: 商品名
  • CODE: 商品コード
  • BARCODE: 管理バーコード
  • LABEL: オープンロジ商品ラベル
詳細はこちらのページをご確認ください。
required
Array of objects (入荷商品リスト) [ 1 .. 25 ] items unique

入荷する商品情報を指定します。同梱物も通常の商品と同様に指定します。

arrival_date
required
string <date> (倉庫着予定日)

倉庫に該当の入荷が着荷する予定日です。未定の場合は、おおよその日付を指定します。

arrival_date_confirmed
boolean (確定情報として登録)

倉庫着予定日が確定されていればtrueを指定してください。

以下の場合は、大量入荷として入荷完了までに着荷日を除く2営業日以上かかる場合があります。

  • 商品数量が200点以上
  • 100サイズ以上の商品が20点以上

大量入荷になる場合は、必ず倉庫到着予定日の2日前までに、倉庫着予定日を確定情報として登録した上で入荷依頼を作成してください。

詳細はこちらのページをご確認ください。
arrival_time_from
integer (倉庫着予定時間(いつから)) [ 0 .. 23 ]

倉庫に該当の入荷が着荷する予定最短時刻です。

arrival_time_to
integer (倉庫着予定時間(いつまで)) [ 0 .. 23 ]

倉庫に該当の入荷が着荷する予定最長時刻です。

sales_method
string (販売方法)
Default: "INVENTORY"
Enum: "INVENTORY" "RESERVATION" "OTHER"

入荷した商品を出荷する際の販売方法です。倉庫の作業計画を立てるために必要な情報です。

  • INVENTORY: 在庫販売
  • RESERVATION: 予約販売
  • OTHER: その他
shipping_scheduled_date
string <date> (出荷予定日)

販売方法が RESERVATION の場合にのみ指定できます。倉庫の作業計画を立てるために必要な情報です。

warehouse
string or null (倉庫コード)

入荷する倉庫をコードで指定します。未指定または null を指定した場合は、標準倉庫へ入荷されます。

transport_mode
string (配送方法)
Default: "HOME_DELIVERY"
Enum: "" "HOME_DELIVERY" "CHARTER" "CONTAINER"

入荷する際の配送方法を指定します。

  • "" : 指定なし
  • HOME_DELIVERY : 宅配便
  • CHARTER : チャーター
  • CONTAINER : コンテナ
詳細はこちらのページをご確認ください。
identity_type
string (入荷特定項目)
Default: "ID_OR_LABEL"
Enum: "ID_OR_LABEL" "SUPPLIER" "TRACKING_CODE" "VEHICLE_CODE" "CONTAINER"

※入荷ラベルなし入荷を利用するお客様のみ使用可能

倉庫で入荷を特定する際のキーとなる項目を指定できます。 許可された項目のみ指定できます。

  • ID_OR_LABEL : 入荷ラベル・ID
  • SUPPLIER : 発注先名。この値を指定し、identity_valuesを指定すると、倉庫側で発注先名を使用して入荷を特定します
  • TRACKING_CODE : お問い合わせ伝票番号。この値を指定し、tracking_codesを指定すると、倉庫側でお問い合わせ伝票番号を使用して入荷を特定します
  • VEHICLE_CODE : 車両番号。この値を指定し、vehicle_codeを指定すると、倉庫側で車両番号を使用して入荷を特定します
  • CONTAINER : コンテナID。この値を指定し、container_noを指定すると、倉庫側でコンテナIDを使用して入荷を特定します
identity_values
Array of strings (入荷特定情報)

※入荷ラベルなし入荷を利用するお客様のみ使用可能

入荷特定項目に対応した値を指定できます。

  • 入荷特定項目がID_OR_LABELの場合は指定できません。
  • 入荷特定項目がSUPPLIERの場合、このパラメータに発注先名を指定すると、倉庫側で発注先名を使用して入荷を特定します。
tracking_codes
Array of strings (お問合せ伝票番号)

配送方法が HOME_DELIVERY または "" であれば、このパラメータを指定できます。

倉庫での入荷作業を円滑にしたり、トラブルの解決に必要な情報です。

vehicle_code
string (車両番号) <= 30 characters

商品を倉庫へ送る際のチャーターやコンテナを載せる車両の番号を指定します。倉庫での入荷作業を円滑にしたり、トラブルの解決に必要な情報です。

配送方法が CHARTER または CONTAINER の場合、指定できます。

vehicle_size
string (車両サイズ)
Enum: "UNDER_2T" "4T" "10T" "20FT" "40FT"

車両やコンテナのサイズを指定できます。倉庫での入荷作業を円滑にしたり、トラブルの解決に必要な情報です。

配送方法が CHARTER または CONTAINER の場合、指定できます。

  • UNDER_2T: 2t以下
  • 4T: 4t
  • 10T: 10t
  • 20FT: 20ft
  • 40FT: 40ft
carrying_method
string (積載方法)
Enum: "PALETTE" "BARA"

個口の積載方法を指定できます。 配送方法が CHARTER または CONTAINER の場合、指定できます。

  • PALETTE: パレット
  • BARA: バラ積み
container_no
string (コンテナID) <= 30 characters

配送方法が CONTAINER の場合、指定できます。倉庫での入荷作業を円滑にしたり、トラブルの解決に必要な情報です。

driver_info
string (ドライバー情報) <= 500 characters

ドライバーに関する補足情報を指定できます。チャーター便の会社名や運転手の連絡先などを倉庫へ共有するための情報です。 配送方法が CHARTER または CONTAINER の場合、指定できます。

company_memo
string (入荷メモ) <= 255 characters

ユーザー側で利用するメモ欄。倉庫には共有されません。

identifier
string (入荷依頼識別子) <= 30 characters

ユーザーが入荷依頼をユニークに特定するための符号です。 ユーザーが任意に指定するものです。 大文字・小文字のアルファベット、数字、一部の記号のみ利用可能です。

Responses

Request samples

Content type
application/json
{
  • "inspection_type": "CODE",
  • "items": [
    ],
  • "arrival_date": "2019-04-22",
  • "arrival_date_confirmed": true,
  • "arrival_time_from": 10,
  • "arrival_time_to": 13,
  • "sales_method": "RESERVATION",
  • "shipping_scheduled_date": "2019-04-29",
  • "warehouse": "OPL",
  • "transport_mode": "",
  • "identity_type": "ID_OR_LABEL",
  • "identity_values": [
    ],
  • "tracking_codes": [
    ],
  • "vehicle_code": "品川 100 あ ・・・1",
  • "vehicle_size": "4T",
  • "carrying_method": "PALETTE",
  • "container_no": "AAAU1234567",
  • "driver_info": "株式会社oo 田中: 090-XXXX-XXXX",
  • "company_memo": "キャンペーン用の商品です",
  • "identifier": "Identifier-001"
}

Response samples

Content type
application/json
{
  • "id": "TS001-W0001",
  • "status": "waiting",
  • "halfway": false,
  • "arrival_date": "2019-04-22",
  • "arrival_date_confirmed": true,
  • "arrival_time_from": 10,
  • "arrival_time_to": 13,
  • "sales_method": "RESERVATION",
  • "shipping_scheduled_date": "2019-04-29",
  • "stock_deadline_date": "2019-04-24",
  • "identifier": "Identifier-001",
  • "inspection_type": "CODE",
  • "inspection_type_label": "オープンロジ商品ID",
  • "transport_mode": "",
  • "identity_type": "ID_OR_LABEL",
  • "identity_values": [
    ],
  • "tracking_codes": [
    ],
  • "vehicle_code": "品川 100 あ ・・・1",
  • "vehicle_size": "4T",
  • "carrying_method": "PALETTE",
  • "container_no": "AAAU1234567",
  • "driver_info": "株式会社oo 田中: 090-XXXX-XXXX",
  • "company_memo": "キャンペーン用の商品です",
  • "items": [
    ],
  • "warehouse": "stri",
  • "warehouse_info": {
    },
  • "created_at": "2019-04-01T12:00:00+09:00",
  • "create_user": {
    }
}

入荷依頼削除

入荷依頼をキャンセルします。

ステータスによってはキャンセルできません。

path Parameters
id
required
string
Example: AB001-W0001

入荷ID

Request Body schema: application/json
any

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "TS001-W0001",
  • "status": "waiting",
  • "halfway": false,
  • "arrival_date": "2019-04-22",
  • "arrival_date_confirmed": true,
  • "arrival_time_from": 10,
  • "arrival_time_to": 13,
  • "sales_method": "RESERVATION",
  • "shipping_scheduled_date": "2019-04-29",
  • "stock_deadline_date": "2019-04-24",
  • "identifier": "Identifier-001",
  • "inspection_type": "CODE",
  • "inspection_type_label": "オープンロジ商品ID",
  • "transport_mode": "",
  • "identity_type": "ID_OR_LABEL",
  • "identity_values": [
    ],
  • "tracking_codes": [
    ],
  • "vehicle_code": "品川 100 あ ・・・1",
  • "vehicle_size": "4T",
  • "carrying_method": "PALETTE",
  • "container_no": "AAAU1234567",
  • "driver_info": "株式会社oo 田中: 090-XXXX-XXXX",
  • "company_memo": "キャンペーン用の商品です",
  • "items": [
    ],
  • "warehouse": "stri",
  • "warehouse_info": {
    },
  • "created_at": "2019-04-01T12:00:00+09:00",
  • "create_user": {
    }
}

直近の入荷実績

指定日付の直近1日分の入荷実績（入荷済みの入荷依頼）を取得します。

date_beforeの指定がある場合は、指定日からさかのぼって入荷作業を行った直近の日付です。 指定した日に入荷実績があれば指定日、指定日に入荷実績がなく前日以前に入荷実績があればその入荷実績の日付です。 date_afterの場合は、指定日より後の直近の日付です。

クエリパラメータを指定しない場合は、date_beforeにリクエスト日を指定した場合と同一です。

例 下記表は、日付が異なる3回の入荷実績がある場合の例です。

入荷日 左記入荷日を含むdate_beforeの例 左記入荷日を含むdate_afterの例
2025-01-10 date_before=20250110, date_before=20250131 date_after=20250106, date_after=20250110
2025-01-05 date_before=20250105, date_before=20250109 date_after=20250102, date_after=20250105
2025-01-01 date_before=20250101, date_before=20250102 date_after=20241201, date_after=20250101
query Parameters
date_before
string^(?<year>\d{4})(?<month>\d{2})(?<day>\d{2})$
Example: date_before=20190101

指定日以前の最終入荷日の入荷実績を取得します。

date_afterと一緒に指定した場合は、date_afterの指定を無視します。

date_after
string^(?<year>\d{4})(?<month>\d{2})(?<day>\d{2})$
Example: date_after=20190401

指定日以降の初回入荷日の入荷実績を取得します。

date_beforeと一緒に指定した場合は、date_afterの指定を無視します。

Responses

Response samples

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

指定年月日の入荷実績

指定年月日の入荷実績（statusがstockedのもの）を取得します。

halfwayがtrueの場合、入荷依頼の一部の商品が入荷完了している状態を表します。

path Parameters
year
string^\d{4}$
Example: 2019

入荷年(YYYY)

month
string^\d{2}$
Example: 04

入荷月(MM)

day
string^\d{2}$
Example: 01

入荷日(DD)

指定しない場合は、指定年月の入荷実績を取得します。

Responses

Response samples

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

入荷ラベル取得

入荷ラベルを取得します。

path Parameters
id
required
string
Example: AB001-W0001

入荷ID

Responses

Response samples

Content type
application/json
{
  • "error": "exception",
  • "error_description": "キャンセルできませんでした"
}

shipments

出荷に関連する情報を取得します

出荷依頼一覧

依頼中（status: shipped以外）の出荷依頼を取得します。

クエリパラメータで出荷IDを指定した場合は、出荷済み（status: shipped）の出荷依頼も取得します。

query Parameters
id
string
Example: id=TS001-S000001,AB001-S000003

出荷IDをカンマ( , )区切りで最大100件まで指定できます。

出荷IDについてはこちらのページをご確認ください。
cursor
string
Example: cursor=eyJrZXkiOjEwMDAwMCwic2FtcGxlTWV0YWRhdGEiOnRydWV9

APIバージョン1.6 以降で利用可能なカーソル。前回レスポンスの metadata.page.next_cursor を指定すると次ページを取得します。

limit
integer [ 1 .. 1000 ]
Default: 10
Example: limit=10

APIバージョン1.6 以降で利用可能な1ページあたり取得件数

Responses

Response samples

Content type
application/json
Example
{
  • "shipments": [
    ],
  • "metadata": {
    }
}

出荷依頼作成

出荷依頼を1件作成します。 事前に商品登録が必要です。

識別番号と注文番号について

  • 出荷を特定するキーとして identifier が利用されます
  • identifier が指定されていない場合は order_no の値が identifier として保存されます
  • identifier と order_no のいずれかの指定が必須となります

在庫不足時の出荷依頼, 入荷前の商品の出荷依頼（出荷予約）の方法について

  • 出荷依頼単位のbackorder_if_unavailableにtrueを指定してください。
  • 出荷ルールによる商品追加で在庫不足が発生する場合も同様です。
Request Body schema: application/json
identifier
required
string or null (識別番号) [ 1 .. 100 ] characters

ユーザーが出荷依頼をユニークに識別するための符号です。 ユーザーが任意に指定します。

出荷依頼を作成する場合は、identifier と order_no のいずれかが必須となります。

order_no
string or null (注文番号) [ 1 .. 100 ] characters

ECサイトなどの注文に紐づくユニークな固有の符号です。 同梱明細書の「注文番号」に印刷されます。

出荷依頼を作成する場合は、identifier と order_no のいずれかが必須となります。

詳細はこちらのページをご確認ください。
subtotal_amount
any or null (納品書 小計)

同梱明細書に記載される「小計」。出荷依頼作成時に指定します。 計算の整合性のチェックは行われず、空欄の場合に自動計算、補完もされません。

delivery_charge
any or null (納品書 配送料)

同梱明細書に記載される「配送料」。出荷依頼作成時に指定します。

handling_charge
any or null (納品書 手数料)

同梱明細書に記載される「手数料」。出荷依頼作成時に指定します。

discount_amount
any or null (納品書 割引額)

同梱明細書に記載される「割引額」。出荷依頼作成時に指定します。

total_amount
any or null (納品書 合計)

同梱明細書に記載される「合計」。出荷依頼作成時に指定します。 計算の整合性のチェックは行われず、空欄の場合に自動計算、補完もされません。

cushioning_unit
string or null (緩衝材単位)
Enum: "ORDER" "ITEM"

注文単位、もしくは商品単位で緩衝材指定します。緩衝材は有料オプションで別途料金が発生します。

  • ORDER: 注文単位
  • ITEM: 商品単位
詳細はこちらのページをご確認ください。
cushioning_type
string or null (緩衝材種別)
Enum: "BUBBLE_PACK" "BUBBLE_DOUBLE_PACK"

緩衝材単位を注文単位で利用する場合に指定します。 「注文単位」を指定した場合は、緩衝材種別を下記から指定してください。

  • BUBBLE_PACK: プチプチ
  • BUBBLE_DOUBLE_PACK: プチプチ2重
詳細はこちらのページをご確認ください。
gift_wrapping_unit
string or null (ギフトラッピング単位)
Enum: "ORDER" "ITEM"

注文単位、もしくは商品単位でラッピングします。ギフトラッピングは有料オプションで別途料金が発生します。

  • ORDER: 注文単位
  • ITEM: 商品単位
詳細はこちらのページをご確認ください。
gift_wrapping_type
string or null (ギフトラッピングタイプ)
Enum: "NAVY" "RED"

ギフトラッピング単位を注文単位で利用する場合に、ラッピングの色を指定します。 「注文単位」でラッピングする場合は、ギフトラッピングタイプを下記から指定します。

  • NAVY: ネイビー
  • RED: レッド
詳細はこちらのページをご確認ください。
gift_sender_name
string or null (ギフト贈り主氏名)

同梱明細書や送り状の「贈り主」欄に記載される名前を指定します。

bundled_items
Array of strings or null (同梱指定) [ 1 .. 5 ] items unique

同梱物の商品IDまたは商品コード (重複のない5つまで指定できます)。

shipping_email
string or null <email> (配送先連絡メールアドレス)

お届け先へお荷物発送のお知らせメールを送信したい場合に指定します。

指定されたメールアドレス宛に「お荷物発送のお知らせ」メールをオープンロジドメインから自動送信します。 この項目が未指定または null の場合は、「発送通知メッセージ」が無効になります。

詳細はこちらのページをご確認ください。
delivery_note_type
string or null (明細書の同梱設定)
Enum: "NOT_INCLUDE_PII" "NONE"

明細書を同梱するかしないかを指定します。

値がない場合は、出荷設定の同梱明細書の同梱設定に従います。

  • NOT_INCLUDE_PII: 住所非表示の明細書を同梱する
  • NONE: 同梱しない
詳細はこちらのページをご確認ください。
price_on_delivery_note
boolean or null (明細書への金額印字指定)

明細書に金額を印字するかしないかを指定します。

  • true
    • 明細書へ金額を印字する（この指定が他の設定よりも優先されます）
  • false
    • 明細書へ金額を印字しない（この指定が他の設定よりも優先されます）
  • null または 未指定
    • 管理画面の設定（【出荷設定】 > 【その他設定】 > 「同梱明細書の金額印字」）に従います。ただし、ギフトラッピングの場合は管理画面の設定に関わらず印字しません。
詳細はこちらのページをご確認ください。
message
string or null (明細書メッセージ) <= 500 characters

同梱明細書に記載するメッセージです。

依頼主マスタで設定している明細書メッセージを上書きする場合に利用します。 ただし、依頼主UUID（sender.uuid）を指定した出荷依頼の場合は、messageでの上書きはできません。

suspend
boolean (保留フラグ)
Default: false

trueは、出荷作業が開始されない保留状態を表します。

保留状態の出荷依頼は、保留解除しない限り出荷作業が開始されません。 ただし、保留状態の出荷依頼にも在庫は引き当てられます。

出荷作業を開始したくない場合に、出荷依頼時にtrueを指定します。 保留状態を解除するには、出荷依頼更新を利用してください。

詳細はこちらのページをご確認ください。
shipping_date
string <date> (出荷希望日)

指定された日付以降に倉庫で出荷作業が行われます。倉庫の作業状況次第では希望日の翌日以降での出荷となる場合があります。

お届け希望日を指定したい場合は、delivery_dateをご利用ください。 delivery_dateと同時に指定された場合、「shipping_date < delivery_date <= shipping_date + 7日（クール便は3日）」を満たす必要があります。

詳細はこちらのページをご確認ください。
tax
integer or null (消費税) <= 999999999

同梱明細書に記載される「消費税」。出荷依頼作成時に指定します。

【出荷】 > 【出荷設定】 > 【その他の設定】 > 「消費税設定」が「税抜」の場合にだけ、指定します。

total_with_normal_tax
integer (合計通常税率) <= 999999999

「合計」のうち消費税10%が適用される金額。出荷依頼作成時に指定します。

「軽減税率適用商品」が含まれる場合のみ、指定した値が同梱明細書に記載されます。計算の整合性のチェックは行われず、空欄の場合に自動計算、補完もされません。

total_with_reduced_tax
integer (合計軽減税率) <= 999999999

「合計」のうち軽減税率の消費税8%が適用される金額。出荷依頼作成時に指定します。

「軽減税率適用商品」が含まれる場合のみ、指定した値が同梱明細書に記載されます。計算の整合性のチェックは行われず、空欄の場合に自動計算、補完もされません。

delivery_carrier
string or null (配送会社)
Enum: "YAMATO" "SAGAWA"

配送会社を指示したい場合に指定します。

国内発送の場合に指定でき、指定すると別途料金が発生します。

  • YAMATO: ヤマト運輸
  • SAGAWA: 佐川急便
詳細はこちらのページをご確認ください。
delivery_time_slot
string or null (希望時間指定)
Enum: "AM" "12" "14" "16" "18" "19"

国内発送の場合に、配達の時間帯を指示したい場合に指定します。

  • AM: 午前中
  • 12: 12時〜14時（佐川急便のみ指定可能）
  • 14: 14時〜16時
  • 16: 16時〜18時
  • 18: 18時〜20時
  • 19: 19時〜21時
詳細はこちらのページをご確認ください。
delivery_date
string or null <date> (配達希望日)

国内発送の場合に、お届け希望日を指示したい場合に指定します。

出荷作業の開始日を指定したい場合は、shipping_dateをご利用ください。

詳細はこちらのページをご確認ください。
cash_on_delivery
boolean (代金引換指定)
Default: false

trueを指定したときだけ代金引換となります。代金引換を利用する場合は、事前に配送会社とサービス契約している必要があります。

total_for_cash_on_delivery
integer (代金引換総計) <= 999999999

配送先に請求する、消費税や送料、手数料なども含めた代引きの請求金額。出荷依頼作成時に指定します。 代金引換の場合のみ指定します。

tax_for_cash_on_delivery
integer (代金引換消費税) <= 999999999

代金引換総計のうち、消費税に当たる金額。出荷依頼作成時に指定します。 代金引換の場合のみ指定します。

delivery_method
string or null (配送便指定)
Enum: "POST_EXPRESS" "HOME_BOX"

SSサイズの商品、入荷実績のない商品で「配送便」を指定したい場合に指定します。 SSサイズの商品のみ、かつポスト便のサイズに収まった場合に、このパラメータの省略時にはPOST_EXPRESSが設定されます。

  • POST_EXPRESS: ポスト便 (宅配便スピード)での配送 (SSサイズの商品で指定可能)
  • HOME_BOX: 宅配便 (段ボール梱包)での配送
詳細はこちらのページをご確認ください。
object or null (受取人からの希望)

受取人からの希望

詳細はこちらのページをご確認ください。
warehouse
string or null (倉庫コード)

出荷する倉庫をコードで指定します。未指定または null を指定した場合は、標準倉庫から出荷されます。

required
Array of objects (配送商品リスト)

出荷したい商品を指定します。同梱物を指定する場合は、bundled_itemsを利用します。

international
boolean (海外発送指定)
Default: false

海外発送する場合は、trueを指定します。

delivery_service
string
Enum: "SAGAWA-HIKYAKU-YU-PACKET" "SAGAWA-TAKUHAIBIN" "SAGAWA-COOLBIN" "YAMATO-NEKOPOSU" "YAMATO-TAKKYUBIN" "YAMATO-COOLBIN" "JAPANPOST-EMS" "JAPANPOST-YU-PACKET" "FEDEX-PRIORITY" "FEDEX-CONNECT-PLUS" "DHL-EXPRESS"

海外配送（internationalがtrue）の場合は必須です。

Sagawa

  • SAGAWA-HIKYAKU-YU-PACKET 佐川急便 飛脚ゆうパケット
  • SAGAWA-TAKUHAIBIN 佐川急便 宅配便
  • SAGAWA-COOLBIN 佐川急便 飛脚クール便

Yamato

  • YAMATO-NEKOPOSU ヤマト運輸 ネコポス
  • YAMATO-TAKKYUBIN ヤマト運輸 宅急便
  • YAMATO-COOLBIN ヤマト運輸 クール便

Japan Post

  • JAPANPOST-EMS EMS
  • JAPANPOST-YU-PACKET 日本郵便 ゆうパケット

Fedex

  • FEDEX-PRIORITY FedEx International Priority
  • FEDEX-CONNECT-PLUS FedEx International Connect Plus

DHL

  • DHL-EXPRESS DHL Express
currency_code
string (海外発送用通貨コード)

商品単価や合計金額で利用する通貨。 海外配送（internationalがtrue）の場合は必須です。

指定できる値は、通貨情報APIを参照してください。

insurance
boolean (海外発送用損害保証制度の加入希望)

海外配送（internationalがtrue）の場合は必須です。

損害保証制度の加入希望がある場合はtrueを指定します。

詳細はこちらのページをご確認ください。
backorder_if_unavailable
boolean (出荷単位の出荷予約フラグ)
Default: false

在庫不足時、出荷予約として出荷依頼を作成できるようにします。商品単位の指定よりも、出荷単位の指定が優先されます。

purpose
string (輸出目的)
Enum: "GIFT" "DOCUMENTS" "COMMERCIAL_SAMPLE" "SALE_OF_GOODS" "RETURNED_GOODS" "OTHERS"

EMS/DHL/Fedexの場合に指定します。 輸出目的が指す品目と実際の商品とが異なる場合には、通関手続きができない場合があります。

未指定の場合、【管理画面】 > 【設定】> 【配送情報】> 【配送設定】 > 「輸出目的設定」で選択した項目が適用されます。

  • GIFT : 贈物
  • DOCUMENTS : 書類
  • COMMERCIAL_SAMPLE : 商品見本
  • SALE_OF_GOODS : 販売品
  • RETURNED_GOODS : 返送品
  • OTHERS : その他
allocate_priority
integer (引当優先順位) [ 0 .. 100 ]

出荷依頼に対して、出荷の商品単位で配送可在庫を確保する処理（引当）をオープンロジで行なっています。 数字が大きいほど、優先的に引当されます。

詳細はこちらのページをご確認ください。
tax_number
string (納税者番号) [ 2 .. 30 ] characters

一部の海外配送先の場合に、インボイスに記載が必要となる納税者番号

詳細はこちらのページをご確認ください。
国内出荷 (object) or 海外出荷 (object) or 依頼主マスタ指定 (object) (発送元住所)

省略時は管理画面でデフォルトの依頼主に設定されている情報が使われます。

required
国内出荷 (object) or 海外出荷 (object) (発送先住所)

発送先住所 (海外出荷の場合はregion_codeを指定する必要が有ります)

apply_rule
boolean (出荷ルール適用フラグ)

出荷ルールによる商品追加で在庫不足が発生する場合、出荷依頼単位のbackorder_if_unavailableにtrueを指定します。

詳細はこちらのページをご確認ください。

Responses

Request samples

Content type
application/json
Example
{
  • "identifier": "2015-00001",
  • "order_no": "12345-67890",
  • "sender": {
    },
  • "subtotal_amount": 1000,
  • "delivery_charge": 500,
  • "handling_charge": 0,
  • "discount_amount": 0,
  • "total_amount": 1500,
  • "total_with_normal_tax": 0,
  • "total_with_reduced_tax": 1000,
  • "cushioning_unit": "ORDER",
  • "cushioning_type": "BUBBLE_PACK",
  • "gift_wrapping_unit": "ORDER",
  • "gift_wrapping_type": "NAVY",
  • "gift_sender_name": "オープン太郎",
  • "shipping_email": "test@example.com",
  • "delivery_note_type": "NOT_INCLUDE_PII",
  • "price_on_delivery_note": true,
  • "message": "お買上げありがとうございます。",
  • "suspend": false,
  • "shipping_date": "2019-04-02",
  • "recipient": {
    },
  • "delivery_carrier": "YAMATO",
  • "delivery_time_slot": "AM",
  • "delivery_date": "2019-04-05",
  • "cash_on_delivery": false,
  • "delivery_method": "HOME_BOX",
  • "delivery_options": {
    },
  • "warehouse": "OPL",
  • "items": [
    ],
  • "international": false
}

Response samples

Content type
application/json
{
  • "id": "TS001-S000001",
  • "identifier": "2015-00001",
  • "order_no": "#12345-67890",
  • "subtotal_amount": 1000,
  • "delivery_charge": 500,
  • "handling_charge": 0,
  • "discount_amount": 0,
  • "total_amount": 1500,
  • "cushioning_unit": "ORDER",
  • "cushioning_type": "BUBBLE_PACK",
  • "gift_wrapping_unit": "ITEM",
  • "gift_wrapping_type": "NAVY",
  • "gift_sender_name": "オープン太郎",
  • "bundled_items": [
    ],
  • "fba_shipment_id": "FBA123456789",
  • "shipping_email": "test@example.com",
  • "delivery_note_type": "NOT_INCLUDE_PII",
  • "price_on_delivery_note": true,
  • "message": "お買上げありがとうございます。",
  • "status": "waiting",
  • "suspend": false,
  • "label_note": "玩具",
  • "shipping_date": "2019-04-02",
  • "assigned_shipping_date": "2019-04-02",
  • "tax_included": true,
  • "tax": 100,
  • "total_with_normal_tax": 1000,
  • "total_with_reduced_tax": 500,
  • "delivery_carrier": "YAMATO",
  • "delivery_time_slot": "AM",
  • "delivery_date": "2019-04-05",
  • "delivery_day": "2019-04-05",
  • "cash_on_delivery": false,
  • "total_for_cash_on_delivery": 1100,
  • "tax_for_cash_on_delivery": 100,
  • "delivery_method": "HOME_BOX",
  • "delivery_options": {
    },
  • "bundle_shipping_label": "string",
  • "warehouse": "OPL",
  • "items": [
    ],
  • "purpose": "SALE_OF_GOODS",
  • "allocate_priority": 0,
  • "tax_number": "string",
  • "sender": {
    },
  • "recipient": {
    }
}

出荷依頼一括作成

出荷依頼作成と同じフォーマットのJSONを配列で送信することで一括作成できます。

単一の出荷依頼作成APIとは異なり、apply_ruleを出荷依頼単位ではなく、リクエスト単位で指定します。 そのため、一括で作成するすべての出荷依頼について出荷ルールが評価され、それぞれの条件を満たす出荷ルールが適用されます。

推奨事項

一括作成の件数には上限を設けていませんが、50件〜100件程度を推奨します。 件数が多いほど処理時間も長くなるため、クライアントシステムのタイムアウト値の設定にご注意ください。

エラー時の挙動について

このAPIはアトミックに処理をします。 よって、一部の出荷依頼の作成に失敗した場合は、すべての出荷依頼が作成されません。 この場合は、エラーを修正し、同じ内容で再度リクエストするか、個別に出荷依頼を作成してください。

Request Body schema: application/json
required
Array of objects (出荷依頼リスト)

一括で登録したい出荷依頼の配列です。

apply_rule
boolean (出荷ルール適用フラグ)

出荷ルールによる商品追加で在庫不足が発生する場合、出荷依頼単位のbackorder_if_unavailableにtrueを指定します。

詳細はこちらのページをご確認ください。

Responses

Request samples

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

Response samples

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

出荷依頼取得

指定した出荷IDの出荷依頼情報を取得します。

path Parameters
id
required
string
Example: TS001-S000001

出荷ID

詳細はこちらのページをご確認ください。

Responses

Response samples

Content type
application/json
{
  • "id": "TS001-S000001",
  • "identifier": "2015-00001",
  • "order_no": "#12345-67890",
  • "subtotal_amount": 1000,
  • "delivery_charge": 500,
  • "handling_charge": 0,
  • "discount_amount": 0,
  • "total_amount": 1500,
  • "cushioning_unit": "ORDER",
  • "cushioning_type": "BUBBLE_PACK",
  • "gift_wrapping_unit": "ITEM",
  • "gift_wrapping_type": "NAVY",
  • "gift_sender_name": "オープン太郎",
  • "bundled_items": [
    ],
  • "fba_shipment_id": "FBA123456789",
  • "shipping_email": "test@example.com",
  • "delivery_note_type": "NOT_INCLUDE_PII",
  • "price_on_delivery_note": true,
  • "message": "お買上げありがとうございます。",
  • "status": "waiting",
  • "suspend": false,
  • "label_note": "玩具",
  • "shipping_date": "2019-04-02",
  • "assigned_shipping_date": "2019-04-02",
  • "tax_included": true,
  • "tax": 100,
  • "total_with_normal_tax": 1000,
  • "total_with_reduced_tax": 500,
  • "delivery_carrier": "YAMATO",
  • "delivery_time_slot": "AM",
  • "delivery_date": "2019-04-05",
  • "delivery_day": "2019-04-05",
  • "cash_on_delivery": false,
  • "total_for_cash_on_delivery": 1100,
  • "tax_for_cash_on_delivery": 100,
  • "delivery_method": "HOME_BOX",
  • "delivery_options": {
    },
  • "bundle_shipping_label": null,
  • "warehouse": "OPL",
  • "shipment_return": true,
  • "items": [
    ],
  • "assigned_temperature_zone": "frozen",
  • "allocate_priority": 0,
  • "shipped_at": "2025-02-01T18:00:00+09:00",
  • "tracking_code": "123456789012",
  • "tracking_codes": [
    ],
  • "url": "http://example.com/",
  • "delivery_service": "YAMATO-TAKKYUBIN",
  • "package_quantity": 1,
  • "packages": [
    ],
  • "cases": {
    },
  • "international": true,
  • "currency_code": "USD",
  • "letter_of_attorney": false,
  • "insurance": false,
  • "purpose": "SALE_OF_GOODS",
  • "duty_paid": true,
  • "vat_number": "string",
  • "eori_number": "string",
  • "tax_number": "string",
  • "sender": {
    },
  • "recipient": {
    }
}

出荷依頼更新

依頼中の出荷依頼を更新します。

  • 更新できる出荷依頼は、ステータスがbackordered、waitingのものです
  • それ以外のステータスの出荷依頼を修正、キャンセルしたい場合は、それぞれ出荷依頼修正リクエストと出荷依頼キャンセルリクエストをご利用ください
  • 倉庫移動で作成された出荷依頼の更新には、倉庫移動更新をご利用ください
  • 出荷依頼を更新した結果、出荷ルールの実行条件を満たしても出荷ルールは適用されません
path Parameters
id
required
string
Example: TS001-S000001

出荷ID

詳細はこちらのページをご確認ください。
Request Body schema: application/json
identifier
required
string or null (識別番号) [ 1 .. 100 ] characters

ユーザーが出荷依頼をユニークに識別するための符号です。 ユーザーが任意に指定します。

出荷依頼を作成する場合は、identifier と order_no のいずれかが必須となります。

order_no
string or null (注文番号) [ 1 .. 100 ] characters

ECサイトなどの注文に紐づくユニークな固有の符号です。 同梱明細書の「注文番号」に印刷されます。

出荷依頼を作成する場合は、identifier と order_no のいずれかが必須となります。

詳細はこちらのページをご確認ください。
subtotal_amount
any or null (納品書 小計)

同梱明細書に記載される「小計」。出荷依頼作成時に指定します。 計算の整合性のチェックは行われず、空欄の場合に自動計算、補完もされません。

delivery_charge
any or null (納品書 配送料)

同梱明細書に記載される「配送料」。出荷依頼作成時に指定します。

handling_charge
any or null (納品書 手数料)

同梱明細書に記載される「手数料」。出荷依頼作成時に指定します。

discount_amount
any or null (納品書 割引額)

同梱明細書に記載される「割引額」。出荷依頼作成時に指定します。

total_amount
any or null (納品書 合計)

同梱明細書に記載される「合計」。出荷依頼作成時に指定します。 計算の整合性のチェックは行われず、空欄の場合に自動計算、補完もされません。

cushioning_unit
string or null (緩衝材単位)
Enum: "ORDER" "ITEM"

注文単位、もしくは商品単位で緩衝材指定します。緩衝材は有料オプションで別途料金が発生します。

  • ORDER: 注文単位
  • ITEM: 商品単位
詳細はこちらのページをご確認ください。
cushioning_type
string or null (緩衝材種別)
Enum: "BUBBLE_PACK" "BUBBLE_DOUBLE_PACK"

緩衝材単位を注文単位で利用する場合に指定します。 「注文単位」を指定した場合は、緩衝材種別を下記から指定してください。

  • BUBBLE_PACK: プチプチ
  • BUBBLE_DOUBLE_PACK: プチプチ2重
詳細はこちらのページをご確認ください。
gift_wrapping_unit
string or null (ギフトラッピング単位)
Enum: "ORDER" "ITEM"

注文単位、もしくは商品単位でラッピングします。ギフトラッピングは有料オプションで別途料金が発生します。

  • ORDER: 注文単位
  • ITEM: 商品単位
詳細はこちらのページをご確認ください。
gift_wrapping_type
string or null (ギフトラッピングタイプ)
Enum: "NAVY" "RED"

ギフトラッピング単位を注文単位で利用する場合に、ラッピングの色を指定します。 「注文単位」でラッピングする場合は、ギフトラッピングタイプを下記から指定します。

  • NAVY: ネイビー
  • RED: レッド
詳細はこちらのページをご確認ください。
gift_sender_name
string or null (ギフト贈り主氏名)

同梱明細書や送り状の「贈り主」欄に記載される名前を指定します。

bundled_items
Array of strings or null (同梱指定) [ 1 .. 5 ] items unique

同梱物の商品IDまたは商品コード (重複のない5つまで指定できます)。

shipping_email
string or null <email> (配送先連絡メールアドレス)

お届け先へお荷物発送のお知らせメールを送信したい場合に指定します。

指定されたメールアドレス宛に「お荷物発送のお知らせ」メールをオープンロジドメインから自動送信します。 この項目が未指定または null の場合は、「発送通知メッセージ」が無効になります。

詳細はこちらのページをご確認ください。
delivery_note_type
string or null (明細書の同梱設定)
Enum: "NOT_INCLUDE_PII" "NONE"

明細書を同梱するかしないかを指定します。

値がない場合は、出荷設定の同梱明細書の同梱設定に従います。

  • NOT_INCLUDE_PII: 住所非表示の明細書を同梱する
  • NONE: 同梱しない
詳細はこちらのページをご確認ください。
price_on_delivery_note
boolean or null (明細書への金額印字指定)

明細書に金額を印字するかしないかを指定します。

  • true
    • 明細書へ金額を印字する（この指定が他の設定よりも優先されます）
  • false
    • 明細書へ金額を印字しない（この指定が他の設定よりも優先されます）
  • null または 未指定
    • 管理画面の設定（【出荷設定】 > 【その他設定】 > 「同梱明細書の金額印字」）に従います。ただし、ギフトラッピングの場合は管理画面の設定に関わらず印字しません。
詳細はこちらのページをご確認ください。
message
string or null (明細書メッセージ) <= 500 characters

同梱明細書に記載するメッセージです。

依頼主マスタで設定している明細書メッセージを上書きする場合に利用します。 ただし、依頼主UUID（sender.uuid）を指定した出荷依頼の場合は、messageでの上書きはできません。

suspend
boolean (保留フラグ)
Default: false

trueは、出荷作業が開始されない保留状態を表します。

保留状態の出荷依頼は、保留解除しない限り出荷作業が開始されません。 ただし、保留状態の出荷依頼にも在庫は引き当てられます。

出荷作業を開始したくない場合に、出荷依頼時にtrueを指定します。 保留状態を解除するには、出荷依頼更新を利用してください。

詳細はこちらのページをご確認ください。
shipping_date
string <date> (出荷希望日)

指定された日付以降に倉庫で出荷作業が行われます。倉庫の作業状況次第では希望日の翌日以降での出荷となる場合があります。

お届け希望日を指定したい場合は、delivery_dateをご利用ください。 delivery_dateと同時に指定された場合、「shipping_date < delivery_date <= shipping_date + 7日（クール便は3日）」を満たす必要があります。

詳細はこちらのページをご確認ください。
tax
integer or null (消費税) <= 999999999

同梱明細書に記載される「消費税」。出荷依頼作成時に指定します。

【出荷】 > 【出荷設定】 > 【その他の設定】 > 「消費税設定」が「税抜」の場合にだけ、指定します。

total_with_normal_tax
integer (合計通常税率) <= 999999999

「合計」のうち消費税10%が適用される金額。出荷依頼作成時に指定します。

「軽減税率適用商品」が含まれる場合のみ、指定した値が同梱明細書に記載されます。計算の整合性のチェックは行われず、空欄の場合に自動計算、補完もされません。

total_with_reduced_tax
integer (合計軽減税率) <= 999999999

「合計」のうち軽減税率の消費税8%が適用される金額。出荷依頼作成時に指定します。

「軽減税率適用商品」が含まれる場合のみ、指定した値が同梱明細書に記載されます。計算の整合性のチェックは行われず、空欄の場合に自動計算、補完もされません。

delivery_carrier
string or null (配送会社)
Enum: "YAMATO" "SAGAWA"

配送会社を指示したい場合に指定します。

国内発送の場合に指定でき、指定すると別途料金が発生します。

  • YAMATO: ヤマト運輸
  • SAGAWA: 佐川急便
詳細はこちらのページをご確認ください。
delivery_time_slot
string or null (希望時間指定)
Enum: "AM" "12" "14" "16" "18" "19"

国内発送の場合に、配達の時間帯を指示したい場合に指定します。

  • AM: 午前中
  • 12: 12時〜14時（佐川急便のみ指定可能）
  • 14: 14時〜16時
  • 16: 16時〜18時
  • 18: 18時〜20時
  • 19: 19時〜21時
詳細はこちらのページをご確認ください。
delivery_date
string or null <date> (配達希望日)

国内発送の場合に、お届け希望日を指示したい場合に指定します。

出荷作業の開始日を指定したい場合は、shipping_dateをご利用ください。

詳細はこちらのページをご確認ください。
cash_on_delivery
boolean (代金引換指定)
Default: false

trueを指定したときだけ代金引換となります。代金引換を利用する場合は、事前に配送会社とサービス契約している必要があります。

total_for_cash_on_delivery
integer (代金引換総計) <= 999999999

配送先に請求する、消費税や送料、手数料なども含めた代引きの請求金額。出荷依頼作成時に指定します。 代金引換の場合のみ指定します。

tax_for_cash_on_delivery
integer (代金引換消費税) <= 999999999

代金引換総計のうち、消費税に当たる金額。出荷依頼作成時に指定します。 代金引換の場合のみ指定します。

delivery_method
string or null (配送便指定)
Enum: "POST_EXPRESS" "HOME_BOX"

SSサイズの商品、入荷実績のない商品で「配送便」を指定したい場合に指定します。 SSサイズの商品のみ、かつポスト便のサイズに収まった場合に、このパラメータの省略時にはPOST_EXPRESSが設定されます。

  • POST_EXPRESS: ポスト便 (宅配便スピード)での配送 (SSサイズの商品で指定可能)
  • HOME_BOX: 宅配便 (段ボール梱包)での配送
詳細はこちらのページをご確認ください。
object or null (受取人からの希望)

受取人からの希望

詳細はこちらのページをご確認ください。
warehouse
string or null (倉庫コード)

出荷する倉庫をコードで指定します。未指定または null を指定した場合は、標準倉庫から出荷されます。

required
Array of objects (配送商品リスト)

出荷したい商品を指定します。同梱物を指定する場合は、bundled_itemsを利用します。

international
boolean (海外発送指定)
Default: false

海外発送する場合は、trueを指定します。

delivery_service
string
Enum: "SAGAWA-HIKYAKU-YU-PACKET" "SAGAWA-TAKUHAIBIN" "SAGAWA-COOLBIN" "YAMATO-NEKOPOSU" "YAMATO-TAKKYUBIN" "YAMATO-COOLBIN" "JAPANPOST-EMS" "JAPANPOST-YU-PACKET" "FEDEX-PRIORITY" "FEDEX-CONNECT-PLUS" "DHL-EXPRESS"

海外配送（internationalがtrue）の場合は必須です。

Sagawa

  • SAGAWA-HIKYAKU-YU-PACKET 佐川急便 飛脚ゆうパケット
  • SAGAWA-TAKUHAIBIN 佐川急便 宅配便
  • SAGAWA-COOLBIN 佐川急便 飛脚クール便

Yamato

  • YAMATO-NEKOPOSU ヤマト運輸 ネコポス
  • YAMATO-TAKKYUBIN ヤマト運輸 宅急便
  • YAMATO-COOLBIN ヤマト運輸 クール便

Japan Post

  • JAPANPOST-EMS EMS
  • JAPANPOST-YU-PACKET 日本郵便 ゆうパケット

Fedex

  • FEDEX-PRIORITY FedEx International Priority
  • FEDEX-CONNECT-PLUS FedEx International Connect Plus

DHL

  • DHL-EXPRESS DHL Express
currency_code
string (海外発送用通貨コード)

商品単価や合計金額で利用する通貨。 海外配送（internationalがtrue）の場合は必須です。

指定できる値は、通貨情報APIを参照してください。

insurance
boolean (海外発送用損害保証制度の加入希望)

海外配送（internationalがtrue）の場合は必須です。

損害保証制度の加入希望がある場合はtrueを指定します。

詳細はこちらのページをご確認ください。
backorder_if_unavailable
boolean (出荷単位の出荷予約フラグ)
Default: false

在庫不足時、出荷予約として出荷依頼を作成できるようにします。商品単位の指定よりも、出荷単位の指定が優先されます。

purpose
string (輸出目的)
Enum: "GIFT" "DOCUMENTS" "COMMERCIAL_SAMPLE" "SALE_OF_GOODS" "RETURNED_GOODS" "OTHERS"

EMS/DHL/Fedexの場合に指定します。 輸出目的が指す品目と実際の商品とが異なる場合には、通関手続きができない場合があります。

未指定の場合、【管理画面】 > 【設定】> 【配送情報】> 【配送設定】 > 「輸出目的設定」で選択した項目が適用されます。

  • GIFT : 贈物
  • DOCUMENTS : 書類
  • COMMERCIAL_SAMPLE : 商品見本
  • SALE_OF_GOODS : 販売品
  • RETURNED_GOODS : 返送品
  • OTHERS : その他
allocate_priority
integer (引当優先順位) [ 0 .. 100 ]

出荷依頼に対して、出荷の商品単位で配送可在庫を確保する処理（引当）をオープンロジで行なっています。 数字が大きいほど、優先的に引当されます。

詳細はこちらのページをご確認ください。
tax_number
string (納税者番号) [ 2 .. 30 ] characters

一部の海外配送先の場合に、インボイスに記載が必要となる納税者番号

詳細はこちらのページをご確認ください。
国内出荷 (object) or 海外出荷 (object) or 依頼主マスタ指定 (object) (発送元住所)

省略時は管理画面でデフォルトの依頼主に設定されている情報が使われます。

required
国内出荷 (object) or 海外出荷 (object) (発送先住所)

発送先住所 (海外出荷の場合はregion_codeを指定する必要が有ります)

Responses

Request samples

Content type
application/json
{
  • "identifier": "2015-00001",
  • "order_no": "#12345-67890",
  • "subtotal_amount": 1000,
  • "delivery_charge": 500,
  • "handling_charge": 0,
  • "discount_amount": 0,
  • "total_amount": 1500,
  • "cushioning_unit": "ORDER",
  • "cushioning_type": "BUBBLE_PACK",
  • "gift_wrapping_unit": "ITEM",
  • "gift_wrapping_type": "NAVY",
  • "gift_sender_name": "オープン太郎",
  • "bundled_items": [
    ],
  • "shipping_email": "test@example.com",
  • "delivery_note_type": "NOT_INCLUDE_PII",
  • "price_on_delivery_note": true,
  • "message": "お買上げありがとうございます。",
  • "suspend": false,
  • "shipping_date": "2019-04-02",
  • "tax": 100,
  • "total_with_normal_tax": 1000,
  • "total_with_reduced_tax": 500,
  • "delivery_carrier": "YAMATO",
  • "delivery_time_slot": "AM",
  • "delivery_date": "2019-04-05",
  • "cash_on_delivery": false,
  • "total_for_cash_on_delivery": 1100,
  • "tax_for_cash_on_delivery": 100,
  • "delivery_method": "HOME_BOX",
  • "delivery_options": {
    },
  • "warehouse": "OPL",
  • "items": [
    ],
  • "international": false,
  • "delivery_service": "JAPANPOST-EMS",
  • "currency_code": "JP",
  • "insurance": false,
  • "backorder_if_unavailable": true,
  • "purpose": "SALE_OF_GOODS",
  • "allocate_priority": 0,
  • "tax_number": "string",
  • "sender": {
    },
  • "recipient": {
    }
}

Response samples

Content type
application/json
{
  • "id": "TS001-S000001",
  • "identifier": "2015-00001",
  • "order_no": "#12345-67890",
  • "subtotal_amount": 1000,
  • "delivery_charge": 500,
  • "handling_charge": 0,
  • "discount_amount": 0,
  • "total_amount": 1500,
  • "cushioning_unit": "ORDER",
  • "cushioning_type": "BUBBLE_PACK",
  • "gift_wrapping_unit": "ITEM",
  • "gift_wrapping_type": "NAVY",
  • "gift_sender_name": "オープン太郎",
  • "bundled_items": [
    ],
  • "fba_shipment_id": "FBA123456789",
  • "shipping_email": "test@example.com",
  • "delivery_note_type": "NOT_INCLUDE_PII",
  • "price_on_delivery_note": true,
  • "message": "お買上げありがとうございます。",
  • "status": "waiting",
  • "suspend": false,
  • "label_note": "玩具",
  • "shipping_date": "2019-04-02",
  • "assigned_shipping_date": "2019-04-02",
  • "tax_included": true,
  • "tax": 100,
  • "total_with_normal_tax": 1000,
  • "total_with_reduced_tax": 500,
  • "delivery_carrier": "YAMATO",
  • "delivery_time_slot": "AM",
  • "delivery_date": "2019-04-05",
  • "delivery_day": "2019-04-05",
  • "cash_on_delivery": false,
  • "total_for_cash_on_delivery": 1100,
  • "tax_for_cash_on_delivery": 100,
  • "delivery_method": "HOME_BOX",
  • "delivery_options": {
    },
  • "bundle_shipping_label": "string",
  • "warehouse": "OPL",
  • "items": [
    ],
  • "purpose": "SALE_OF_GOODS",
  • "allocate_priority": 0,
  • "tax_number": "string",
  • "sender": {
    },
  • "recipient": {
    }
}

出荷依頼削除

ステータスによっては削除できません。

path Parameters
id
required
string
Example: TS001-S000001

出荷ID指定

Request Body schema: application/json
any

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "TS001-S000001",
  • "identifier": "2015-00001",
  • "order_no": "#12345-67890",
  • "subtotal_amount": 1000,
  • "delivery_charge": 500,
  • "handling_charge": 0,
  • "discount_amount": 0,
  • "total_amount": 1500,
  • "cushioning_unit": "ORDER",
  • "cushioning_type": "BUBBLE_PACK",
  • "gift_wrapping_unit": "ITEM",
  • "gift_wrapping_type": "NAVY",
  • "gift_sender_name": "オープン太郎",
  • "bundled_items": [
    ],
  • "fba_shipment_id": "FBA123456789",
  • "shipping_email": "test@example.com",
  • "delivery_note_type": "NOT_INCLUDE_PII",
  • "price_on_delivery_note": true,
  • "message": "お買上げありがとうございます。",
  • "status": "waiting",
  • "suspend": false,
  • "label_note": "玩具",
  • "shipping_date": "2019-04-02",
  • "assigned_shipping_date": "2019-04-02",
  • "tax_included": true,
  • "tax": 100,
  • "total_with_normal_tax": 1000,
  • "total_with_reduced_tax": 500,
  • "delivery_carrier": "YAMATO",
  • "delivery_time_slot": "AM",
  • "delivery_date": "2019-04-05",
  • "delivery_day": "2019-04-05",
  • "cash_on_delivery": false,
  • "total_for_cash_on_delivery": 1100,
  • "tax_for_cash_on_delivery": 100,
  • "delivery_method": "HOME_BOX",
  • "delivery_options": {
    },
  • "bundle_shipping_label": "string",
  • "warehouse": "OPL",
  • "items": [
    ],
  • "purpose": "SALE_OF_GOODS",
  • "allocate_priority": 0,
  • "tax_number": "string",
  • "sender": {
    },
  • "recipient": {
    }
}

出荷依頼修正リクエスト

ステータスがピッキング中・ピッキング済み・梱包済みの出荷依頼の修正を依頼します。

データ取り込み後の修正となりますので、別途事務手数料＋作業進捗状況による作業費用がかかります。

海外発送の場合は梱包済みのステータス以降は依頼ができません。

キャンセル依頼を出していただき、別途新規の出荷依頼を作成してください。

また、作業進捗状況によってはご依頼にお応えすることができない場合がございます。

ご了承の上ご利用ください。

path Parameters
id
required
string
Example: TS001-S000001

出荷ID指定

Request Body schema: application/json
国内出荷 (object) or 海外出荷 (object)

発送先住所 (海外出荷の場合はregion_codeを指定する必要が有ります)

delivery_time_slot
string
Enum: "AM" "12" "14" "16" "18" "19"

希望時間指定 (12はSAGAWAの場合のみ)

delivery_date
string

配達希望日 (指定できる最短日付は配送会社によって変わります)

Responses

Request samples

Content type
application/json
{
  • "recipient": {
    },
  • "delivery_time_slot": "12",
  • "delivery_date": "2019-04-05"
}

Response samples

Content type
application/json
{
  • "id": "TS001-S000001",
  • "identifier": "2015-00001",
  • "order_no": "#12345-67890",
  • "subtotal_amount": 1000,
  • "delivery_charge": 500,
  • "handling_charge": 0,
  • "discount_amount": 0,
  • "total_amount": 1500,
  • "cushioning_unit": "ORDER",
  • "cushioning_type": "BUBBLE_PACK",
  • "gift_wrapping_unit": "ITEM",
  • "gift_wrapping_type": "NAVY",
  • "gift_sender_name": "オープン太郎",
  • "bundled_items": [
    ],
  • "fba_shipment_id": "FBA123456789",
  • "shipping_email": "test@example.com",
  • "delivery_note_type": "NOT_INCLUDE_PII",
  • "price_on_delivery_note": true,
  • "message": "お買上げありがとうございます。",
  • "status": "waiting",
  • "suspend": false,
  • "label_note": "玩具",
  • "shipping_date": "2019-04-02",
  • "assigned_shipping_date": "2019-04-02",
  • "tax_included": true,
  • "tax": 100,
  • "total_with_normal_tax": 1000,
  • "total_with_reduced_tax": 500,
  • "delivery_carrier": "YAMATO",
  • "delivery_time_slot": "AM",
  • "delivery_date": "2019-04-05",
  • "delivery_day": "2019-04-05",
  • "cash_on_delivery": false,
  • "total_for_cash_on_delivery": 1100,
  • "tax_for_cash_on_delivery": 100,
  • "delivery_method": "HOME_BOX",
  • "delivery_options": {
    },
  • "bundle_shipping_label": "string",
  • "warehouse": "OPL",
  • "items": [
    ],
  • "purpose": "SALE_OF_GOODS",
  • "allocate_priority": 0,
  • "tax_number": "string",
  • "sender": {
    },
  • "recipient": {
    }
}

出荷依頼キャンセルリクエスト

ステータスがピッキング中・ピッキング済み・梱包済みの出荷依頼の修正を依頼します。

データ取り込み後の修正となりますので、別途事務手数料＋作業進捗状況による作業費用がかかります。

海外発送の場合は梱包済みのステータス以降は依頼ができません。

キャンセル依頼を出していただき、別途新規の出荷依頼を作成してください。

また、作業進捗状況によってはご依頼にお応えすることができない場合がございます。

ご了承の上ご利用ください。

path Parameters
id
required
string
Example: TS001-S000001

出荷ID指定

Request Body schema: application/json
any

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "TS001-S000001",
  • "identifier": "2015-00001",
  • "order_no": "#12345-67890",
  • "subtotal_amount": 1000,
  • "delivery_charge": 500,
  • "handling_charge": 0,
  • "discount_amount": 0,
  • "total_amount": 1500,
  • "cushioning_unit": "ORDER",
  • "cushioning_type": "BUBBLE_PACK",
  • "gift_wrapping_unit": "ITEM",
  • "gift_wrapping_type": "NAVY",
  • "gift_sender_name": "オープン太郎",
  • "bundled_items": [
    ],
  • "fba_shipment_id": "FBA123456789",
  • "shipping_email": "test@example.com",
  • "delivery_note_type": "NOT_INCLUDE_PII",
  • "price_on_delivery_note": true,
  • "message": "お買上げありがとうございます。",
  • "status": "waiting",
  • "suspend": false,
  • "label_note": "玩具",
  • "shipping_date": "2019-04-02",
  • "assigned_shipping_date": "2019-04-02",
  • "tax_included": true,
  • "tax": 100,
  • "total_with_normal_tax": 1000,
  • "total_with_reduced_tax": 500,
  • "delivery_carrier": "YAMATO",
  • "delivery_time_slot": "AM",
  • "delivery_date": "2019-04-05",
  • "delivery_day": "2019-04-05",
  • "cash_on_delivery": false,
  • "total_for_cash_on_delivery": 1100,
  • "tax_for_cash_on_delivery": 100,
  • "delivery_method": "HOME_BOX",
  • "delivery_options": {
    },
  • "bundle_shipping_label": "string",
  • "warehouse": "OPL",
  • "items": [
    ],
  • "purpose": "SALE_OF_GOODS",
  • "allocate_priority": 0,
  • "tax_number": "string",
  • "sender": {
    },
  • "recipient": {
    }
}

直近の出荷実績

指定日付の直近1日分の出荷実績（出荷済みの出荷依頼）を取得します。

クエリパラメータを指定しない場合は、リクエスト日の直近1日分の出荷実績を取得します。

query Parameters
date_before
string^(?<year>\d{4})(?<month>\d{2})(?<day>\d{2})$
Example: date_before=20190320

指定日以前の最終出荷日の出荷実績を取得します。

date_afterと一緒に指定した場合は、date_afterの指定を無視します。

date_after
string^(?<year>\d{4})(?<month>\d{2})(?<day>\d{2})$
Example: date_after=20190420

指定日以降の初回出荷日の出荷実績を取得します。

date_beforeと一緒に指定した場合は、date_afterの指定を無視します。

cursor
string
Example: cursor=eyJrZXkiOjEwMDAwMCwic2FtcGxlTWV0YWRhdGEiOnRydWV9

APIバージョン1.6 以降で利用可能なカーソル。前回レスポンスの metadata.page.next_cursor を指定すると次ページを取得します。

limit
integer [ 1 .. 1000 ]
Default: 10
Example: limit=20

APIバージョン1.6 以降で利用可能な1ページあたりの取得件数。指定しない場合は10件を返却します。最大1,000件まで指定できます。

Responses

Response samples

Content type
application/json
Example
{
  • "shipments": [
    ],
  • "metadata": {
    }
}

指定年月日の出荷実績

指定年月日の出荷実績（出荷済みの出荷依頼）を取得します。

path Parameters
year
required
string^\d{4}$
Example: 2019

出荷年(YYYY)

month
required
string^\d{2}$
Example: 04

出荷月(MM)

day
string^\d{2}$
Example: 02

出荷日(DD)

指定しない場合は、指定年月の出荷実績を取得します。

query Parameters
cursor
string
Example: cursor=eyJrZXkiOjEwMDAwMCwic2FtcGxlTWV0YWRhdGEiOnRydWV9

APIバージョン1.6 以降で利用可能なカーソル。前回レスポンスの metadata.page.next_cursor を指定すると次ページを取得します。

limit
integer [ 1 .. 1000 ]
Default: 10
Example: limit=10

APIバージョン1.6 以降で利用可能な1ページあたり取得件数

Responses

Response samples

Content type
application/json
Example
{
  • "shipments": [
    ],
  • "metadata": {
    }
}

国コード情報

海外発送指定時に指定できる国コードの一覧を取得します。

Responses

Response samples

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

通貨情報

海外発送時に指定できる通貨の一覧を取得します。

Responses

Response samples

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

倉庫移動作成

指定商品の倉庫移動依頼をします。

発送元住所、発送先住所は指定された倉庫の住所となります。

通常出荷と同じ出荷依頼情報が作成され、同時に発送先倉庫での入荷依頼が作成されます。

Request Body schema: application/json
warehouse
required
string

移動元倉庫情報

required
object

移動先倉庫情報

required
Array of objects

移動商品リスト

Responses

Request samples

Content type
application/json
{
  • "warehouse": "BASE2",
  • "destination": {
    },
  • "items": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "TS001-S000001",
  • "identifier": "2015-00001",
  • "order_no": "#12345-67890",
  • "subtotal_amount": 1000,
  • "delivery_charge": 500,
  • "handling_charge": 0,
  • "discount_amount": 0,
  • "total_amount": 1500,
  • "cushioning_unit": "ORDER",
  • "cushioning_type": "BUBBLE_PACK",
  • "gift_wrapping_unit": "ITEM",
  • "gift_wrapping_type": "NAVY",
  • "gift_sender_name": "オープン太郎",
  • "bundled_items": [
    ],
  • "fba_shipment_id": "FBA123456789",
  • "shipping_email": "test@example.com",
  • "delivery_note_type": "NOT_INCLUDE_PII",
  • "price_on_delivery_note": true,
  • "message": "お買上げありがとうございます。",
  • "status": "waiting",
  • "suspend": false,
  • "label_note": "玩具",
  • "assigned_shipping_date": "2019-04-02",
  • "tax_included": true,
  • "tax": 100,
  • "total_with_normal_tax": 1000,
  • "total_with_reduced_tax": 500,
  • "delivery_carrier": "YAMATO",
  • "delivery_time_slot": "AM",
  • "delivery_date": "2019-04-05",
  • "delivery_day": "2019-04-05",
  • "cash_on_delivery": false,
  • "total_for_cash_on_delivery": 1100,
  • "tax_for_cash_on_delivery": 100,
  • "delivery_method": "HOME_BOX",
  • "delivery_options": {
    },
  • "bundle_shipping_label": "string",
  • "warehouse": "OPL",
  • "items": [
    ],
  • "destination": {
    },
  • "sender": {
    },
  • "recipient": {
    }
}

倉庫移動更新

ステータスによっては更新できません。

path Parameters
id
required
string
Example: TS001-S000001

出荷ID指定

Request Body schema: application/json
required
object

移動先倉庫情報

required
Array of objects

移動商品リスト

Responses

Request samples

Content type
application/json
{
  • "destination": {
    },
  • "items": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "TS001-S000001",
  • "identifier": "2015-00001",
  • "order_no": "#12345-67890",
  • "subtotal_amount": 1000,
  • "delivery_charge": 500,
  • "handling_charge": 0,
  • "discount_amount": 0,
  • "total_amount": 1500,
  • "cushioning_unit": "ORDER",
  • "cushioning_type": "BUBBLE_PACK",
  • "gift_wrapping_unit": "ITEM",
  • "gift_wrapping_type": "NAVY",
  • "gift_sender_name": "オープン太郎",
  • "bundled_items": [
    ],
  • "fba_shipment_id": "FBA123456789",
  • "shipping_email": "test@example.com",
  • "delivery_note_type": "NOT_INCLUDE_PII",
  • "price_on_delivery_note": true,
  • "message": "お買上げありがとうございます。",
  • "status": "waiting",
  • "suspend": false,
  • "label_note": "玩具",
  • "assigned_shipping_date": "2019-04-02",
  • "tax_included": true,
  • "tax": 100,
  • "total_with_normal_tax": 1000,
  • "total_with_reduced_tax": 500,
  • "delivery_carrier": "YAMATO",
  • "delivery_time_slot": "AM",
  • "delivery_date": "2019-04-05",
  • "delivery_day": "2019-04-05",
  • "cash_on_delivery": false,
  • "total_for_cash_on_delivery": 1100,
  • "tax_for_cash_on_delivery": 100,
  • "delivery_method": "HOME_BOX",
  • "delivery_options": {
    },
  • "bundle_shipping_label": "string",
  • "warehouse": "OPL",
  • "items": [
    ],
  • "destination": {
    },
  • "sender": {
    },
  • "recipient": {
    }
}

倉庫依頼修正リクエスト

ステータスがピッキング中になっている倉庫移動依頼の修正を依頼します。

データ取り込み後の修正となりますので、別途事務手数料＋作業進捗状況による作業費用がかかります。

また、作業進捗状況によってはご依頼にお応えすることができない場合がございます。

ご了承の上ご利用ください。

path Parameters
id
required
string
Example: TS001-S000001

出荷ID指定

Request Body schema: application/json
required
object

移動先倉庫情報

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": "TS001-S000001",
  • "identifier": "2015-00001",
  • "order_no": "#12345-67890",
  • "subtotal_amount": 1000,
  • "delivery_charge": 500,
  • "handling_charge": 0,
  • "discount_amount": 0,
  • "total_amount": 1500,
  • "cushioning_unit": "ORDER",
  • "cushioning_type": "BUBBLE_PACK",
  • "gift_wrapping_unit": "ITEM",
  • "gift_wrapping_type": "NAVY",
  • "gift_sender_name": "オープン太郎",
  • "bundled_items": [
    ],
  • "fba_shipment_id": "FBA123456789",
  • "shipping_email": "test@example.com",
  • "delivery_note_type": "NOT_INCLUDE_PII",
  • "price_on_delivery_note": true,
  • "message": "お買上げありがとうございます。",
  • "status": "waiting",
  • "suspend": false,
  • "label_note": "玩具",
  • "assigned_shipping_date": "2019-04-02",
  • "tax_included": true,
  • "tax": 100,
  • "total_with_normal_tax": 1000,
  • "total_with_reduced_tax": 500,
  • "delivery_carrier": "YAMATO",
  • "delivery_time_slot": "AM",
  • "delivery_date": "2019-04-05",
  • "delivery_day": "2019-04-05",
  • "cash_on_delivery": false,
  • "total_for_cash_on_delivery": 1100,
  • "tax_for_cash_on_delivery": 100,
  • "delivery_method": "HOME_BOX",
  • "delivery_options": {
    },
  • "bundle_shipping_label": "string",
  • "warehouse": "OPL",
  • "items": [
    ],
  • "destination": {
    },
  • "sender": {
    },
  • "recipient": {
    }
}

倉庫移動キャンセルリクエスト

ステータスがピッキング中になっている倉庫移動依頼のキャンセルを依頼します。

データ取り込み後のキャンセルとなりますので、別途事務手数料＋作業進捗状況による作業費用がかかります。

また、作業進捗状況によってはご依頼にお応えすることができない場合がございます。

ご了承の上ご利用ください。

path Parameters
id
required
string
Example: TS001-S000001

出荷ID

Request Body schema: application/json
any

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "TS001-S000001",
  • "identifier": "2015-00001",
  • "order_no": "#12345-67890",
  • "subtotal_amount": 1000,
  • "delivery_charge": 500,
  • "handling_charge": 0,
  • "discount_amount": 0,
  • "total_amount": 1500,
  • "cushioning_unit": "ORDER",
  • "cushioning_type": "BUBBLE_PACK",
  • "gift_wrapping_unit": "ITEM",
  • "gift_wrapping_type": "NAVY",
  • "gift_sender_name": "オープン太郎",
  • "bundled_items": [
    ],
  • "fba_shipment_id": "FBA123456789",
  • "shipping_email": "test@example.com",
  • "delivery_note_type": "NOT_INCLUDE_PII",
  • "price_on_delivery_note": true,
  • "message": "お買上げありがとうございます。",
  • "status": "waiting",
  • "suspend": false,
  • "label_note": "玩具",
  • "assigned_shipping_date": "2019-04-02",
  • "tax_included": true,
  • "tax": 100,
  • "total_with_normal_tax": 1000,
  • "total_with_reduced_tax": 500,
  • "delivery_carrier": "YAMATO",
  • "delivery_time_slot": "AM",
  • "delivery_date": "2019-04-05",
  • "delivery_day": "2019-04-05",
  • "cash_on_delivery": false,
  • "total_for_cash_on_delivery": 1100,
  • "tax_for_cash_on_delivery": 100,
  • "delivery_method": "HOME_BOX",
  • "delivery_options": {
    },
  • "bundle_shipping_label": "string",
  • "warehouse": "OPL",
  • "items": [
    ],
  • "destination": {
    },
  • "sender": {
    },
  • "recipient": {
    }
}

出荷商品の引当解除

対象の出荷依頼に含まれる全ての商品から引当が解除され入荷待ちに変更されます。

解除実行後は引当優先順位が高い入荷待ちの出荷依頼から引当処理が行われます。

ご了承の上ご利用ください。

path Parameters
id
required
string
Example: TS001-S000001

出荷ID

Request Body schema: application/json
any

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "TS001-S000001",
  • "identifier": "2015-00001",
  • "order_no": "#12345-67890",
  • "subtotal_amount": 1000,
  • "delivery_charge": 500,
  • "handling_charge": 0,
  • "discount_amount": 0,
  • "total_amount": 1500,
  • "cushioning_unit": "ORDER",
  • "cushioning_type": "BUBBLE_PACK",
  • "gift_wrapping_unit": "ITEM",
  • "gift_wrapping_type": "NAVY",
  • "gift_sender_name": "オープン太郎",
  • "bundled_items": [
    ],
  • "fba_shipment_id": "FBA123456789",
  • "shipping_email": "test@example.com",
  • "delivery_note_type": "NOT_INCLUDE_PII",
  • "price_on_delivery_note": true,
  • "message": "お買上げありがとうございます。",
  • "status": "waiting",
  • "suspend": false,
  • "label_note": "玩具",
  • "shipping_date": "2019-04-02",
  • "assigned_shipping_date": "2019-04-02",
  • "tax_included": true,
  • "tax": 100,
  • "total_with_normal_tax": 1000,
  • "total_with_reduced_tax": 500,
  • "delivery_carrier": "YAMATO",
  • "delivery_time_slot": "AM",
  • "delivery_date": "2019-04-05",
  • "delivery_day": "2019-04-05",
  • "cash_on_delivery": false,
  • "total_for_cash_on_delivery": 1100,
  • "tax_for_cash_on_delivery": 100,
  • "delivery_method": "HOME_BOX",
  • "delivery_options": {
    },
  • "bundle_shipping_label": "string",
  • "warehouse": "OPL",
  • "items": [
    ],
  • "purpose": "SALE_OF_GOODS",
  • "allocate_priority": 0,
  • "tax_number": "string",
  • "sender": {
    },
  • "recipient": {
    }
}

shipments(identifier指定)

出荷識別番号（identifier）を指定して出荷依頼を操作します

オープンロジが発行する出荷IDが不明な場合にご利用ください。

パスパラメータに含まれるアカウントコードについては、こちらのページをご確認ください。

出荷依頼一覧

依頼中（statusがshipped以外）の出荷依頼を取得します。

クエリパラメータで識別番号を指定した場合は、出荷済み（statusがshipped）の出荷依頼も取得します。

path Parameters
account_id
required
string
Example: TS001

アカウントコード

詳細はこちらのページをご確認ください。
query Parameters
identifier
required
string
Example: identifier=2015-00001,2015-00002

APIバージョン1.5以下では必須のパラメータです。1.6以上では任意パラメータとなります。

出荷依頼作成で指定した識別番号（identifier）をカンマ( , )区切りで最大100件まで指定できます。

識別番号を指定していない場合は、注文番号（order_no）を識別番号として利用できます。

cursor
string
Example: cursor=eyJrZXkiOjEwMDAwMCwic2FtcGxlTWV0YWRhdGEiOnRydWV9

APIバージョン1.6 以降で利用可能なカーソル。前回レスポンスの metadata.page.next_cursor を指定すると次ページを取得します。

limit
integer [ 1 .. 1000 ]
Default: 10
Example: limit=10

APIバージョン1.6 以降で利用可能な1ページあたり取得件数

Responses

Response samples

Content type
application/json
Example
{
  • "shipments": [
    ],
  • "metadata": {
    }
}

出荷依頼

出荷依頼を取得します。

path Parameters
account_id
required
string
Example: TS001

アカウントコード

identifier
required
string
Example: 2015-00001

識別番号

Responses

Response samples

Content type
application/json
{
  • "id": "TS001-S000001",
  • "identifier": "2015-00001",
  • "order_no": "#12345-67890",
  • "subtotal_amount": 1000,
  • "delivery_charge": 500,
  • "handling_charge": 0,
  • "discount_amount": 0,
  • "total_amount": 1500,
  • "cushioning_unit": "ORDER",
  • "cushioning_type": "BUBBLE_PACK",
  • "gift_wrapping_unit": "ITEM",
  • "gift_wrapping_type": "NAVY",
  • "gift_sender_name": "オープン太郎",
  • "bundled_items": [
    ],
  • "fba_shipment_id": "FBA123456789",
  • "shipping_email": "test@example.com",
  • "delivery_note_type": "NOT_INCLUDE_PII",
  • "price_on_delivery_note": true,
  • "message": "お買上げありがとうございます。",
  • "status": "waiting",
  • "suspend": false,
  • "label_note": "玩具",
  • "shipping_date": "2019-04-02",
  • "assigned_shipping_date": "2019-04-02",
  • "tax_included": true,
  • "tax": 100,
  • "total_with_normal_tax": 1000,
  • "total_with_reduced_tax": 500,
  • "delivery_carrier": "YAMATO",
  • "delivery_time_slot": "AM",
  • "delivery_date": "2019-04-05",
  • "delivery_day": "2019-04-05",
  • "cash_on_delivery": false,
  • "total_for_cash_on_delivery": 1100,
  • "tax_for_cash_on_delivery": 100,
  • "delivery_method": "HOME_BOX",
  • "delivery_options": {
    },
  • "bundle_shipping_label": null,
  • "warehouse": "OPL",
  • "shipment_return": true,
  • "items": [
    ],
  • "assigned_temperature_zone": "frozen",
  • "allocate_priority": 0,
  • "shipped_at": "2025-02-01T18:00:00+09:00",
  • "tracking_code": "123456789012",
  • "tracking_codes": [
    ],
  • "url": "http://example.com/",
  • "delivery_service": "YAMATO-TAKKYUBIN",
  • "package_quantity": 1,
  • "packages": [
    ],
  • "cases": {
    },
  • "international": true,
  • "currency_code": "USD",
  • "letter_of_attorney": false,
  • "insurance": false,
  • "purpose": "SALE_OF_GOODS",
  • "duty_paid": true,
  • "vat_number": "string",
  • "eori_number": "string",
  • "tax_number": "string",
  • "sender": {
    },
  • "recipient": {
    }
}

出荷依頼修正

ステータスによっては更新できません。

path Parameters
account_id
required
string
Example: TS001

アカウントコード

identifier
required
string
Example: 2015-00001

識別番号

Request Body schema: application/json
identifier
required
string or null (識別番号) [ 1 .. 100 ] characters

ユーザーが出荷依頼をユニークに識別するための符号です。 ユーザーが任意に指定します。

出荷依頼を作成する場合は、identifier と order_no のいずれかが必須となります。

order_no
string or null (注文番号) [ 1 .. 100 ] characters

ECサイトなどの注文に紐づくユニークな固有の符号です。 同梱明細書の「注文番号」に印刷されます。

出荷依頼を作成する場合は、identifier と order_no のいずれかが必須となります。

詳細はこちらのページをご確認ください。
subtotal_amount
any or null (納品書 小計)

同梱明細書に記載される「小計」。出荷依頼作成時に指定します。 計算の整合性のチェックは行われず、空欄の場合に自動計算、補完もされません。

delivery_charge
any or null (納品書 配送料)

同梱明細書に記載される「配送料」。出荷依頼作成時に指定します。

handling_charge
any or null (納品書 手数料)

同梱明細書に記載される「手数料」。出荷依頼作成時に指定します。

discount_amount
any or null (納品書 割引額)

同梱明細書に記載される「割引額」。出荷依頼作成時に指定します。

total_amount
any or null (納品書 合計)

同梱明細書に記載される「合計」。出荷依頼作成時に指定します。 計算の整合性のチェックは行われず、空欄の場合に自動計算、補完もされません。

cushioning_unit
string or null (緩衝材単位)
Enum: "ORDER" "ITEM"

注文単位、もしくは商品単位で緩衝材指定します。緩衝材は有料オプションで別途料金が発生します。

  • ORDER: 注文単位
  • ITEM: 商品単位
詳細はこちらのページをご確認ください。
cushioning_type
string or null (緩衝材種別)
Enum: "BUBBLE_PACK" "BUBBLE_DOUBLE_PACK"

緩衝材単位を注文単位で利用する場合に指定します。 「注文単位」を指定した場合は、緩衝材種別を下記から指定してください。

  • BUBBLE_PACK: プチプチ
  • BUBBLE_DOUBLE_PACK: プチプチ2重
詳細はこちらのページをご確認ください。
gift_wrapping_unit
string or null (ギフトラッピング単位)
Enum: "ORDER" "ITEM"

注文単位、もしくは商品単位でラッピングします。ギフトラッピングは有料オプションで別途料金が発生します。

  • ORDER: 注文単位
  • ITEM: 商品単位
詳細はこちらのページをご確認ください。
gift_wrapping_type
string or null (ギフトラッピングタイプ)
Enum: "NAVY" "RED"

ギフトラッピング単位を注文単位で利用する場合に、ラッピングの色を指定します。 「注文単位」でラッピングする場合は、ギフトラッピングタイプを下記から指定します。

  • NAVY: ネイビー
  • RED: レッド
詳細はこちらのページをご確認ください。
gift_sender_name
string or null (ギフト贈り主氏名)

同梱明細書や送り状の「贈り主」欄に記載される名前を指定します。

bundled_items
Array of strings or null (同梱指定) [ 1 .. 5 ] items unique

同梱物の商品IDまたは商品コード (重複のない5つまで指定できます)。

shipping_email
string or null <email> (配送先連絡メールアドレス)

お届け先へお荷物発送のお知らせメールを送信したい場合に指定します。

指定されたメールアドレス宛に「お荷物発送のお知らせ」メールをオープンロジドメインから自動送信します。 この項目が未指定または null の場合は、「発送通知メッセージ」が無効になります。

詳細はこちらのページをご確認ください。
delivery_note_type
string or null (明細書の同梱設定)
Enum: "NOT_INCLUDE_PII" "NONE"

明細書を同梱するかしないかを指定します。

値がない場合は、出荷設定の同梱明細書の同梱設定に従います。

  • NOT_INCLUDE_PII: 住所非表示の明細書を同梱する
  • NONE: 同梱しない
詳細はこちらのページをご確認ください。
price_on_delivery_note
boolean or null (明細書への金額印字指定)

明細書に金額を印字するかしないかを指定します。

  • true
    • 明細書へ金額を印字する（この指定が他の設定よりも優先されます）
  • false
    • 明細書へ金額を印字しない（この指定が他の設定よりも優先されます）
  • null または 未指定
    • 管理画面の設定（【出荷設定】 > 【その他設定】 > 「同梱明細書の金額印字」）に従います。ただし、ギフトラッピングの場合は管理画面の設定に関わらず印字しません。
詳細はこちらのページをご確認ください。
message
string or null (明細書メッセージ) <= 500 characters

同梱明細書に記載するメッセージです。

依頼主マスタで設定している明細書メッセージを上書きする場合に利用します。 ただし、依頼主UUID（sender.uuid）を指定した出荷依頼の場合は、messageでの上書きはできません。

suspend
boolean (保留フラグ)
Default: false

trueは、出荷作業が開始されない保留状態を表します。

保留状態の出荷依頼は、保留解除しない限り出荷作業が開始されません。 ただし、保留状態の出荷依頼にも在庫は引き当てられます。

出荷作業を開始したくない場合に、出荷依頼時にtrueを指定します。 保留状態を解除するには、出荷依頼更新を利用してください。

詳細はこちらのページをご確認ください。
shipping_date
string <date> (出荷希望日)

指定された日付以降に倉庫で出荷作業が行われます。倉庫の作業状況次第では希望日の翌日以降での出荷となる場合があります。

お届け希望日を指定したい場合は、delivery_dateをご利用ください。 delivery_dateと同時に指定された場合、「shipping_date < delivery_date <= shipping_date + 7日（クール便は3日）」を満たす必要があります。

詳細はこちらのページをご確認ください。
tax
integer or null (消費税) <= 999999999

同梱明細書に記載される「消費税」。出荷依頼作成時に指定します。

【出荷】 > 【出荷設定】 > 【その他の設定】 > 「消費税設定」が「税抜」の場合にだけ、指定します。

total_with_normal_tax
integer (合計通常税率) <= 999999999

「合計」のうち消費税10%が適用される金額。出荷依頼作成時に指定します。

「軽減税率適用商品」が含まれる場合のみ、指定した値が同梱明細書に記載されます。計算の整合性のチェックは行われず、空欄の場合に自動計算、補完もされません。

total_with_reduced_tax
integer (合計軽減税率) <= 999999999

「合計」のうち軽減税率の消費税8%が適用される金額。出荷依頼作成時に指定します。

「軽減税率適用商品」が含まれる場合のみ、指定した値が同梱明細書に記載されます。計算の整合性のチェックは行われず、空欄の場合に自動計算、補完もされません。

delivery_carrier
string or null (配送会社)
Enum: "YAMATO" "SAGAWA"

配送会社を指示したい場合に指定します。

国内発送の場合に指定でき、指定すると別途料金が発生します。

  • YAMATO: ヤマト運輸
  • SAGAWA: 佐川急便
詳細はこちらのページをご確認ください。
delivery_time_slot
string or null (希望時間指定)
Enum: "AM" "12" "14" "16" "18" "19"

国内発送の場合に、配達の時間帯を指示したい場合に指定します。

  • AM: 午前中
  • 12: 12時〜14時（佐川急便のみ指定可能）
  • 14: 14時〜16時
  • 16: 16時〜18時
  • 18: 18時〜20時
  • 19: 19時〜21時
詳細はこちらのページをご確認ください。
delivery_date
string or null <date> (配達希望日)

国内発送の場合に、お届け希望日を指示したい場合に指定します。

出荷作業の開始日を指定したい場合は、shipping_dateをご利用ください。

詳細はこちらのページをご確認ください。
cash_on_delivery
boolean (代金引換指定)
Default: false

trueを指定したときだけ代金引換となります。代金引換を利用する場合は、事前に配送会社とサービス契約している必要があります。

total_for_cash_on_delivery
integer (代金引換総計) <= 999999999

配送先に請求する、消費税や送料、手数料なども含めた代引きの請求金額。出荷依頼作成時に指定します。 代金引換の場合のみ指定します。

tax_for_cash_on_delivery
integer (代金引換消費税) <= 999999999

代金引換総計のうち、消費税に当たる金額。出荷依頼作成時に指定します。 代金引換の場合のみ指定します。

delivery_method
string or null (配送便指定)
Enum: "POST_EXPRESS" "HOME_BOX"

SSサイズの商品、入荷実績のない商品で「配送便」を指定したい場合に指定します。 SSサイズの商品のみ、かつポスト便のサイズに収まった場合に、このパラメータの省略時にはPOST_EXPRESSが設定されます。

  • POST_EXPRESS: ポスト便 (宅配便スピード)での配送 (SSサイズの商品で指定可能)
  • HOME_BOX: 宅配便 (段ボール梱包)での配送
詳細はこちらのページをご確認ください。
object or null (受取人からの希望)

受取人からの希望

詳細はこちらのページをご確認ください。
warehouse
string or null (倉庫コード)

出荷する倉庫をコードで指定します。未指定または null を指定した場合は、標準倉庫から出荷されます。

required
Array of objects (配送商品リスト)

出荷したい商品を指定します。同梱物を指定する場合は、bundled_itemsを利用します。

international
boolean (海外発送指定)
Default: false

海外発送する場合は、trueを指定します。

delivery_service
string
Enum: "SAGAWA-HIKYAKU-YU-PACKET" "SAGAWA-TAKUHAIBIN" "SAGAWA-COOLBIN" "YAMATO-NEKOPOSU" "YAMATO-TAKKYUBIN" "YAMATO-COOLBIN" "JAPANPOST-EMS" "JAPANPOST-YU-PACKET" "FEDEX-PRIORITY" "FEDEX-CONNECT-PLUS" "DHL-EXPRESS"

海外配送（internationalがtrue）の場合は必須です。

Sagawa

  • SAGAWA-HIKYAKU-YU-PACKET 佐川急便 飛脚ゆうパケット
  • SAGAWA-TAKUHAIBIN 佐川急便 宅配便
  • SAGAWA-COOLBIN 佐川急便 飛脚クール便

Yamato

  • YAMATO-NEKOPOSU ヤマト運輸 ネコポス
  • YAMATO-TAKKYUBIN ヤマト運輸 宅急便
  • YAMATO-COOLBIN ヤマト運輸 クール便

Japan Post

  • JAPANPOST-EMS EMS
  • JAPANPOST-YU-PACKET 日本郵便 ゆうパケット

Fedex

  • FEDEX-PRIORITY FedEx International Priority
  • FEDEX-CONNECT-PLUS FedEx International Connect Plus

DHL

  • DHL-EXPRESS DHL Express
currency_code
string (海外発送用通貨コード)

商品単価や合計金額で利用する通貨。 海外配送（internationalがtrue）の場合は必須です。

指定できる値は、通貨情報APIを参照してください。

insurance
boolean (海外発送用損害保証制度の加入希望)

海外配送（internationalがtrue）の場合は必須です。

損害保証制度の加入希望がある場合はtrueを指定します。

詳細はこちらのページをご確認ください。
backorder_if_unavailable
boolean (出荷単位の出荷予約フラグ)
Default: false

在庫不足時、出荷予約として出荷依頼を作成できるようにします。商品単位の指定よりも、出荷単位の指定が優先されます。

purpose
string (輸出目的)
Enum: "GIFT" "DOCUMENTS" "COMMERCIAL_SAMPLE" "SALE_OF_GOODS" "RETURNED_GOODS" "OTHERS"

EMS/DHL/Fedexの場合に指定します。 輸出目的が指す品目と実際の商品とが異なる場合には、通関手続きができない場合があります。

未指定の場合、【管理画面】 > 【設定】> 【配送情報】> 【配送設定】 > 「輸出目的設定」で選択した項目が適用されます。

  • GIFT : 贈物
  • DOCUMENTS : 書類
  • COMMERCIAL_SAMPLE : 商品見本
  • SALE_OF_GOODS : 販売品
  • RETURNED_GOODS : 返送品
  • OTHERS : その他
allocate_priority
integer (引当優先順位) [ 0 .. 100 ]

出荷依頼に対して、出荷の商品単位で配送可在庫を確保する処理（引当）をオープンロジで行なっています。 数字が大きいほど、優先的に引当されます。

詳細はこちらのページをご確認ください。
tax_number
string (納税者番号) [ 2 .. 30 ] characters

一部の海外配送先の場合に、インボイスに記載が必要となる納税者番号

詳細はこちらのページをご確認ください。
国内出荷 (object) or 海外出荷 (object) or 依頼主マスタ指定 (object) (発送元住所)

省略時は管理画面でデフォルトの依頼主に設定されている情報が使われます。

required
国内出荷 (object) or 海外出荷 (object) (発送先住所)

発送先住所 (海外出荷の場合はregion_codeを指定する必要が有ります)

Responses

Request samples

Content type
application/json
{
  • "identifier": "2015-00001",
  • "order_no": "12345-67890",
  • "sender": {
    },
  • "subtotal_amount": 1000,
  • "delivery_charge": 500,
  • "handling_charge": 0,
  • "discount_amount": 0,
  • "total_amount": 1500,
  • "total_with_normal_tax": 0,
  • "total_with_reduced_tax": 1000,
  • "cushioning_unit": "ORDER",
  • "cushioning_type": "BUBBLE_PACK",
  • "gift_wrapping_unit": "ORDER",
  • "gift_wrapping_type": "NAVY",
  • "gift_sender_name": "オープン太郎",
  • "shipping_email": "test@example.com",
  • "delivery_note_type": "NOT_INCLUDE_PII",
  • "price_on_delivery_note": true,
  • "message": "お買上げありがとうございます。",
  • "suspend": false,
  • "shipping_date": "2019-04-02",
  • "recipient": {
    },
  • "delivery_carrier": "YAMATO",
  • "delivery_time_slot": "AM",
  • "delivery_date": "2019-04-05",
  • "cash_on_delivery": false,
  • "delivery_method": "HOME_BOX",
  • "delivery_options": {
    },
  • "warehouse": "OPL",
  • "items": [
    ],
  • "international": false
}

Response samples

Content type
application/json
{
  • "id": "TS001-S000001",
  • "identifier": "2015-00001",
  • "order_no": "#12345-67890",
  • "subtotal_amount": 1000,
  • "delivery_charge": 500,
  • "handling_charge": 0,
  • "discount_amount": 0,
  • "total_amount": 1500,
  • "cushioning_unit": "ORDER",
  • "cushioning_type": "BUBBLE_PACK",
  • "gift_wrapping_unit": "ITEM",
  • "gift_wrapping_type": "NAVY",
  • "gift_sender_name": "オープン太郎",
  • "bundled_items": [
    ],
  • "fba_shipment_id": "FBA123456789",
  • "shipping_email": "test@example.com",
  • "delivery_note_type": "NOT_INCLUDE_PII",
  • "price_on_delivery_note": true,
  • "message": "お買上げありがとうございます。",
  • "status": "waiting",
  • "suspend": false,
  • "label_note": "玩具",
  • "shipping_date": "2019-04-02",
  • "assigned_shipping_date": "2019-04-02",
  • "tax_included": true,
  • "tax": 100,
  • "total_with_normal_tax": 1000,
  • "total_with_reduced_tax": 500,
  • "delivery_carrier": "YAMATO",
  • "delivery_time_slot": "AM",
  • "delivery_date": "2019-04-05",
  • "delivery_day": "2019-04-05",
  • "cash_on_delivery": false,
  • "total_for_cash_on_delivery": 1100,
  • "tax_for_cash_on_delivery": 100,
  • "delivery_method": "HOME_BOX",
  • "delivery_options": {
    },
  • "bundle_shipping_label": "string",
  • "warehouse": "OPL",
  • "items": [
    ],
  • "purpose": "SALE_OF_GOODS",
  • "allocate_priority": 0,
  • "tax_number": "string",
  • "sender": {
    },
  • "recipient": {
    }
}

出荷依頼削除

ステータスによっては削除できません。

path Parameters
account_id
required
string
Example: TS001

アカウントコード

identifier
required
string
Example: 2015-00001

識別番号

Request Body schema: application/json
any

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "TS001-S000001",
  • "identifier": "2015-00001",
  • "order_no": "#12345-67890",
  • "subtotal_amount": 1000,
  • "delivery_charge": 500,
  • "handling_charge": 0,
  • "discount_amount": 0,
  • "total_amount": 1500,
  • "cushioning_unit": "ORDER",
  • "cushioning_type": "BUBBLE_PACK",
  • "gift_wrapping_unit": "ITEM",
  • "gift_wrapping_type": "NAVY",
  • "gift_sender_name": "オープン太郎",
  • "bundled_items": [
    ],
  • "fba_shipment_id": "FBA123456789",
  • "shipping_email": "test@example.com",
  • "delivery_note_type": "NOT_INCLUDE_PII",
  • "price_on_delivery_note": true,
  • "message": "お買上げありがとうございます。",
  • "status": "waiting",
  • "suspend": false,
  • "label_note": "玩具",
  • "shipping_date": "2019-04-02",
  • "assigned_shipping_date": "2019-04-02",
  • "tax_included": true,
  • "tax": 100,
  • "total_with_normal_tax": 1000,
  • "total_with_reduced_tax": 500,
  • "delivery_carrier": "YAMATO",
  • "delivery_time_slot": "AM",
  • "delivery_date": "2019-04-05",
  • "delivery_day": "2019-04-05",
  • "cash_on_delivery": false,
  • "total_for_cash_on_delivery": 1100,
  • "tax_for_cash_on_delivery": 100,
  • "delivery_method": "HOME_BOX",
  • "delivery_options": {
    },
  • "bundle_shipping_label": "string",
  • "warehouse": "OPL",
  • "items": [
    ],
  • "purpose": "SALE_OF_GOODS",
  • "allocate_priority": 0,
  • "tax_number": "string",
  • "sender": {
    },
  • "recipient": {
    }
}

出荷依頼修正リクエスト

ステータスがピッキング中・ピッキング済み・梱包済みの出荷依頼の修正を依頼します。

データ取り込み後の修正となりますので、別途事務手数料＋作業進捗状況による作業費用がかかります。

海外発送の場合は梱包済みのステータス以降は依頼ができません。

キャンセル依頼を出していただき、別途新規の出荷依頼を作成してください。

また、作業進捗状況によってはご依頼にお応えすることができない場合がございます。

ご了承の上ご利用ください。

path Parameters
account_id
required
string
Example: TS001

アカウントコード

identifier
required
string
Example: 2015-00001

識別番号

Request Body schema: application/json
国内出荷 (object) or 海外出荷 (object)

発送先住所 (海外出荷の場合はregion_codeを指定する必要が有ります)

delivery_time_slot
string
Enum: "AM" "12" "14" "16" "18" "19"

希望時間指定 (12はSAGAWAの場合のみ)

delivery_date
string

配達希望日 (指定できる最短日付は配送会社によって変わります)

Responses

Request samples

Content type
application/json
{
  • "recipient": {
    },
  • "delivery_time_slot": "12",
  • "delivery_date": "2019-04-05"
}

Response samples

Content type
application/json
{
  • "id": "TS001-S000001",
  • "identifier": "2015-00001",
  • "order_no": "#12345-67890",
  • "subtotal_amount": 1000,
  • "delivery_charge": 500,
  • "handling_charge": 0,
  • "discount_amount": 0,
  • "total_amount": 1500,
  • "cushioning_unit": "ORDER",
  • "cushioning_type": "BUBBLE_PACK",
  • "gift_wrapping_unit": "ITEM",
  • "gift_wrapping_type": "NAVY",
  • "gift_sender_name": "オープン太郎",
  • "bundled_items": [
    ],
  • "fba_shipment_id": "FBA123456789",
  • "shipping_email": "test@example.com",
  • "delivery_note_type": "NOT_INCLUDE_PII",
  • "price_on_delivery_note": true,
  • "message": "お買上げありがとうございます。",
  • "status": "waiting",
  • "suspend": false,
  • "label_note": "玩具",
  • "shipping_date": "2019-04-02",
  • "assigned_shipping_date": "2019-04-02",
  • "tax_included": true,
  • "tax": 100,
  • "total_with_normal_tax": 1000,
  • "total_with_reduced_tax": 500,
  • "delivery_carrier": "YAMATO",
  • "delivery_time_slot": "AM",
  • "delivery_date": "2019-04-05",
  • "delivery_day": "2019-04-05",
  • "cash_on_delivery": false,
  • "total_for_cash_on_delivery": 1100,
  • "tax_for_cash_on_delivery": 100,
  • "delivery_method": "HOME_BOX",
  • "delivery_options": {
    },
  • "bundle_shipping_label": "string",
  • "warehouse": "OPL",
  • "items": [
    ],
  • "purpose": "SALE_OF_GOODS",
  • "allocate_priority": 0,
  • "tax_number": "string",
  • "sender": {
    },
  • "recipient": {
    }
}

出荷依頼キャンセルリクエスト

ステータスがピッキング中・ピッキング済み・梱包済みの出荷依頼の修正を依頼します。

データ取り込み後の修正となりますので、別途事務手数料＋作業進捗状況による作業費用がかかります。

海外発送の場合は梱包済みのステータス以降は依頼ができません。

キャンセル依頼を出していただき、別途新規の出荷依頼を作成してください。

また、作業進捗状況によってはご依頼にお応えすることができない場合がございます。

ご了承の上ご利用ください。

path Parameters
account_id
required
string
Example: TS001

アカウントコード

identifier
required
string
Example: 2015-00001

識別番号

Request Body schema: application/json
any

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "TS001-S000001",
  • "identifier": "2015-00001",
  • "order_no": "#12345-67890",
  • "subtotal_amount": 1000,
  • "delivery_charge": 500,
  • "handling_charge": 0,
  • "discount_amount": 0,
  • "total_amount": 1500,
  • "cushioning_unit": "ORDER",
  • "cushioning_type": "BUBBLE_PACK",
  • "gift_wrapping_unit": "ITEM",
  • "gift_wrapping_type": "NAVY",
  • "gift_sender_name": "オープン太郎",
  • "bundled_items": [
    ],
  • "fba_shipment_id": "FBA123456789",
  • "shipping_email": "test@example.com",
  • "delivery_note_type": "NOT_INCLUDE_PII",
  • "price_on_delivery_note": true,
  • "message": "お買上げありがとうございます。",
  • "status": "waiting",
  • "suspend": false,
  • "label_note": "玩具",
  • "shipping_date": "2019-04-02",
  • "assigned_shipping_date": "2019-04-02",
  • "tax_included": true,
  • "tax": 100,
  • "total_with_normal_tax": 1000,
  • "total_with_reduced_tax": 500,
  • "delivery_carrier": "YAMATO",
  • "delivery_time_slot": "AM",
  • "delivery_date": "2019-04-05",
  • "delivery_day": "2019-04-05",
  • "cash_on_delivery": false,
  • "total_for_cash_on_delivery": 1100,
  • "tax_for_cash_on_delivery": 100,
  • "delivery_method": "HOME_BOX",
  • "delivery_options": {
    },
  • "bundle_shipping_label": "string",
  • "warehouse": "OPL",
  • "items": [
    ],
  • "purpose": "SALE_OF_GOODS",
  • "allocate_priority": 0,
  • "tax_number": "string",
  • "sender": {
    },
  • "recipient": {
    }
}
\n```\n\n### 504 Gateway Timeout\n```\nHTTP/1.1 504 Gateway Timeout\n```\n\n# CHANGELOG\n\n[こちら](/doc/CHANGELOG.html)を参照してください。\n"},"servers":[{"url":"https://api.openlogi.com/api","description":"本番環境"},{"url":"https://api-demo.openlogi.com/api","description":"デモ環境"}],"tags":[{"name":"items","description":"商品に関連する情報を取得します"},{"name":"items(code指定)","description":"商品コード（`code`）を指定して商品情報を操作します。\n\nオープンロジが発行する[商品ID](https://help.openlogi.com/faq/show/220)が不明な場合にご利用ください。\n\nパスパラメータに含まれるアカウントコードについては、[こちらのページ](https://help.openlogi.com/faq/show/263)をご確認ください。"},{"name":"warehousings","description":"入荷に関連する情報を取得します"},{"name":"shipments","description":"出荷に関連する情報を取得します"},{"name":"shipments(identifier指定)","description":"出荷識別番号（`identifier`）を指定して出荷依頼を操作します\n\nオープンロジが発行する[出荷ID](https://help.openlogi.com/faq/show/269)が不明な場合にご利用ください。\n\nパスパラメータに含まれるアカウントコードについては、[こちらのページ](https://help.openlogi.com/faq/show/263)をご確認ください。"}],"paths":{"/items":{"get":{"tags":["items"],"summary":"商品一覧","description":"商品の一覧を在庫情報と合わせて取得できます。\n\n商品情報と同じフォーマットのJSONを配列で取得できます。\n","operationId":"listItems","parameters":[{"name":"id","in":"query","description":"商品ID指定\n\nカンマ( `,` )区切りで複数IDを最大100件まで指定できます。\n\nAPIバージョン1.6 以降では任意のパラメータになります。\n","required":true,"schema":{"type":"string","example":"TS001-I000001,AB001-I000003"},"style":"form","explode":false},{"name":"stock","in":"query","description":"`stock=1`と指定すると、レスポンスに在庫情報を含めます。","required":false,"schema":{"type":"integer","const":1,"example":1}},{"name":"cursor","in":"query","description":"APIバージョン1.6 以降で利用可能なカーソル。前回レスポンスの `metadata.page.next_cursor` を指定すると次ページを取得します。\n","required":false,"schema":{"type":"string","example":"eyJrZXkiOjEwMDAwMCwic2FtcGxlTWV0YWRhdGEiOnRydWV9"}},{"name":"limit","in":"query","description":"APIバージョン1.6 以降で利用可能な1ページあたりの取得件数\n","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000,"default":10,"example":10}}],"responses":{"200":{"description":"成功","content":{"application/json":{"schema":{"anyOf":[{"title":"v1.6（ページネーションあり）","description":"APIバージョン1.6 以降でページネーションに対応しています。","type":"object","required":["items","metadata"],"properties":{"items":{"type":"array","title":"商品情報の配列","description":"商品IDの昇順で商品の一覧を返却します。","minItems":0,"items":{"$ref":"#/components/schemas/ItemResponse"}},"metadata":{"type":"object","title":"メタデータ","description":"レスポンスのメタデータ","required":["page"],"properties":{"page":{"$ref":"#/components/schemas/PagingInfo"}}}}},{"title":"v1.5以下（ページネーション無し）","type":"object","required":["items"],"properties":{"items":{"type":"array","title":"商品情報の配列","items":{"$ref":"#/components/schemas/ItemResponse"}}}}]}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"422":{"$ref":"#/components/responses/UnprocessableContent"}}},"post":{"tags":["items"],"summary":"商品登録","description":"商品を登録します。","operationId":"postItem","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemRequest"}}}},"responses":{"201":{"description":"成功（セット商品含む）","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"422":{"$ref":"#/components/responses/UnprocessableContent"}}}},"/items/bulk":{"post":{"tags":["items"],"summary":"商品一括登録","description":"商品を一括登録します。\n\n商品登録と同じフォーマットのJSONを配列で送信することで一括登録できます。\n","operationId":"bulkPostItems","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","description":"商品リスト","items":{"$ref":"#/components/schemas/ItemRequest"}}}}}}},"responses":{"200":{"description":"成功（セット商品含む）","content":{"application/json":{"schema":{"required":["items"],"type":"object","properties":{"items":{"type":"array","description":"商品リスト","items":{"$ref":"#/components/schemas/ItemResponse"}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"422":{"$ref":"#/components/responses/UnprocessableContent"}}}},"/items/{id}":{"get":{"tags":["items"],"summary":"商品情報取得","description":"指定した1件の商品IDの商品情報を在庫情報と共に取得できます。\n\n商品コードを指定して商品情報を取得する場合は、[code指定の商品情報取得](#tag/items(code)/operation/getItemByCode)をご利用ください。","operationId":"getItemById","parameters":[{"name":"id","in":"path","description":"商品ID\n\n商品IDはオープンロジに商品を登録した際に自動で生成され、商品ごとに割り当てられる固有のIDです。","required":true,"schema":{"type":"string","example":"TS001-I000001","externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/220"}}},{"name":"stock","in":"query","description":"`stock=1`と指定すると、レスポンスに在庫情報を含めます。","required":false,"schema":{"type":"integer","const":1,"example":1}}],"responses":{"200":{"description":"成功","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}}},"put":{"tags":["items"],"summary":"商品情報更新","description":"指定した1件の商品IDの商品情報を更新します。\n\n商品コードを指定して商品情報を更新する場合は、[code指定の商品情報取得](#tag/items(code)/operation/putItemByCode)をご利用ください。","operationId":"putItem","parameters":[{"name":"id","in":"path","description":"商品ID\n\n商品IDはオープンロジに商品を登録した際に自動で生成され、商品ごとに割り当てられる固有のIDです。","required":true,"schema":{"type":"string","example":"TS001-I000001","externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/220"}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemRequestWithBundledItem"}}}},"responses":{"200":{"description":"成功（セット商品含む）","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/UnprocessableContent"}}},"delete":{"tags":["items"],"summary":"商品削除","description":"商品を削除します。\n\n入荷依頼中および入荷実績があるアイテムは削除できません。\n","operationId":"deleteItem","parameters":[{"name":"id","in":"path","description":"商品ID","required":true,"schema":{"type":"string","example":"TS001-I000001"}}],"requestBody":{"content":{"application/json":{"schema":{"example":{}}}}},"responses":{"200":{"description":"成功","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/UnprocessableContent"}}}},"/items/{id}/images":{"post":{"tags":["items"],"summary":"商品画像登録","description":"商品の画像を登録します。 jpeg, png タイプのファイルを指定できます。\n\nmultipart/form-data 形式でファイルを送信します。\n\n- Content-Disposition の name は file を指定してください。\n\n- ファイル名は Content-Disposition の filename で指定してください。\n\n- ファイル名がマルチバイトの場合は UTF-8 エンコードした値を指定してください。\n","operationId":"postItemImage","parameters":[{"name":"id","in":"path","description":"商品ID","required":true,"schema":{"type":"string","example":"TS001-I000001"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/ImageRequest"}}}},"responses":{"200":{"description":"成功","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImageResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/UnprocessableContent"}}}},"/items/{id}/images/{image_id}":{"delete":{"tags":["items"],"summary":"商品画像削除","description":"商品画像を削除します。\n\n同梱物の場合、画像を全て削除することはできません。\n","operationId":"deleteItemImage","parameters":[{"name":"id","in":"path","description":"商品ID","required":true,"schema":{"type":"string","example":"TS001-I000001"}},{"name":"image_id","in":"path","description":"画像ID","required":false,"schema":{"type":"string","example":1}}],"responses":{"200":{"description":"成功","content":{"application/json":{"schema":{"example":{}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/UnprocessableContent"}}}},"/items/{account_id}":{"get":{"tags":["items(code指定)"],"summary":"商品一覧","description":"商品の一覧を在庫情報と合わせて取得できます。\n\n商品情報と同じフォーマットのJSONが配列で取得できます。\n","operationId":"listItemsByAccountId","parameters":[{"name":"account_id","in":"path","description":"アカウントコード","required":true,"schema":{"type":"string","example":"AB001"}},{"name":"identifier","in":"query","description":"商品識別番号\n\nカンマ( `,` )区切りで複数IDを最大100件まで指定できます。\n\nAPIバージョン1.6 以降では任意のパラメータになります。\n","required":true,"schema":{"type":"string","example":"123456-098765,12345678,AB12345"}},{"name":"code","in":"query","description":"商品コード\n\nカンマ( `,` )区切りで複数IDを最大100件まで指定できます。\n\nAPIバージョン1.6 以降では任意のパラメータになります。\n","required":true,"schema":{"type":"string","example":"DQ001,DQ002"}},{"name":"stock","in":"query","description":"在庫情報を含むかどうか","required":false,"schema":{"type":"integer","example":1}},{"name":"cursor","in":"query","description":"APIバージョン1.6 以降で利用可能なカーソル。前回レスポンスの `metadata.page.next_cursor` を指定すると次ページを取得します。\n","required":false,"schema":{"type":"string","example":"eyJrZXkiOjEwMDAwMCwic2FtcGxlTWV0YWRhdGEiOnRydWV9"}},{"name":"limit","in":"query","description":"APIバージョン1.6 以降で利用可能な1ページあたりの取得件数\n","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000,"default":10,"example":10}}],"responses":{"200":{"description":"成功","content":{"application/json":{"schema":{"anyOf":[{"title":"v1.6（ページネーションあり）","description":"APIバージョン1.6 以降でページネーションに対応しています。","type":"object","required":["items","metadata"],"properties":{"items":{"type":"array","title":"商品情報の配列","description":"商品IDの昇順で商品の一覧を返却します。","minItems":0,"items":{"$ref":"#/components/schemas/ItemResponse"}},"metadata":{"type":"object","title":"メタデータ","description":"レスポンスのメタデータ","required":["page"],"properties":{"page":{"$ref":"#/components/schemas/PagingInfo"}}}}},{"title":"v1.5以下（ページネーション無し）","type":"object","required":["items"],"properties":{"items":{"type":"array","title":"商品情報の配列","items":{"$ref":"#/components/schemas/ItemResponse"}}}}]}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"422":{"$ref":"#/components/responses/UnprocessableContent"}}}},"/items/{account_id}/{code}":{"get":{"tags":["items(code指定)"],"summary":"商品情報取得","description":"在庫情報を含んだ商品情報を取得できます。","operationId":"getItemByCode","parameters":[{"name":"account_id","in":"path","description":"アカウントコード","required":true,"schema":{"type":"string","example":"AB001"}},{"name":"code","in":"path","description":"商品コード","required":true,"schema":{"type":"string","example":"item-001"}},{"name":"stock","in":"query","description":"在庫情報を含むかどうか","required":false,"schema":{"type":"integer","example":1}}],"responses":{"200":{"description":"成功","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}}},"put":{"tags":["items(code指定)"],"summary":"商品更新","description":"商品情報を更新します。","operationId":"putItemByCode","parameters":[{"name":"account_id","in":"path","description":"アカウントコード","required":true,"schema":{"type":"string","example":"AB001"}},{"name":"code","in":"path","description":"商品コード","required":true,"schema":{"type":"string","example":"item-001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemRequestWithBundledItem"}}}},"responses":{"200":{"description":"成功（セット商品含む）","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/UnprocessableContent"}}},"delete":{"tags":["items(code指定)"],"summary":"商品削除","description":"商品を削除します。\n\n入荷依頼中および入荷実績があるアイテムは削除できません。\n","operationId":"deleteItemByCode","parameters":[{"name":"account_id","in":"path","description":"アカウントコード","required":true,"schema":{"type":"string","example":"AB001"}},{"name":"code","in":"path","description":"商品コード","required":true,"schema":{"type":"string","example":"item-001"}}],"requestBody":{"content":{"application/json":{"schema":{"example":{}}}}},"responses":{"200":{"description":"成功","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/UnprocessableContent"}}}},"/items/{account_id}/{code}/images":{"post":{"tags":["items(code指定)"],"summary":"商品画像登録","description":"商品の画像を登録します。 jpeg, png タイプのファイルを指定できます。\n\nmultipart/form-data 形式でファイルを送信します。\n\n- Content-Disposition の name は file を指定してください。\n\n- ファイル名は Content-Disposition の filename で指定してください。\n\n- ファイル名がマルチバイトの場合は UTF-8 エンコードした値を指定してください。\n","operationId":"postItemImageByCode","parameters":[{"name":"account_id","in":"path","description":"アカウントコード","required":true,"schema":{"type":"string","example":"AB001"}},{"name":"code","in":"path","description":"商品コード","required":true,"schema":{"type":"string","example":"item-001"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/ImageRequest"}}}},"responses":{"200":{"description":"成功","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImageResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/UnprocessableContent"}}}},"/items/{account_id}/{code}/{image_id}":{"delete":{"tags":["items(code指定)"],"summary":"商品画像削除","description":"商品画像を削除します。\n\n同梱物の場合、画像を全て削除することはできません。\n","operationId":"deleteItemImageByCode","parameters":[{"name":"account_id","in":"path","description":"アカウントコード","required":true,"schema":{"type":"string","example":"AB001"}},{"name":"code","in":"path","description":"商品コード","required":true,"schema":{"type":"string","example":"item-001"}},{"name":"image_id","in":"path","description":"画像ID","required":true,"schema":{"type":"string","example":1}}],"responses":{"200":{"description":"成功","content":{"application/json":{"schema":{"example":{}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/UnprocessableContent"}}}},"/warehousings":{"get":{"tags":["warehousings"],"summary":"入荷依頼一覧","description":"入荷未完了状態の入荷依頼を取得します。\n\n入荷情報と同じフォーマットのJSONが配列で取得できます。\n","operationId":"listWarehousings","responses":{"200":{"description":"成功","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WarehousingIndexResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}}},"post":{"tags":["warehousings"],"summary":"入荷依頼作成","description":"入荷依頼を作成します。\n\n実際の入荷処理をするには別途入荷明細書と入荷ラベルが必要になります。\n[入荷ラベル取得API](#tag/warehousings/operation/getWarehousingPdf)またはオープンロジの入荷依頼中の画面より入荷明細書兼入荷ラベルのPDFを取得、印刷し、入荷明細書を同梱した上で入荷ラベルを箱に貼って倉庫宛に発送ください。\n[詳細はこちらのページをご確認ください。](https://help.openlogi.com/faq/show/16)\n","operationId":"postWarehousing","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WarehousingRequest"}}}},"responses":{"201":{"description":"成功","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WarehousingResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"},"403":{"$ref":"#/components/responses/Forbidden"},"422":{"$ref":"#/components/responses/UnprocessableContent"}}}},"/warehousings/{id}":{"get":{"tags":["warehousings"],"summary":"入荷依頼情報","description":"入荷情報を取得します。","operationId":"getWarehousing","parameters":[{"name":"id","in":"path","description":"入荷ID","required":true,"schema":{"type":"string","example":"AB001-W0001"}}],"responses":{"200":{"description":"成功","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WarehousingResponseWithWarehousedData"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}}},"put":{"tags":["warehousings"],"summary":"入荷依頼更新","description":"依頼中の出荷依頼を更新します。\n\nステータスによっては更新できません。\n","operationId":"putWarehousing","parameters":[{"name":"id","in":"path","description":"入荷ID","required":true,"schema":{"type":"string","example":"AB001-W0001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WarehousingRequest"}}}},"responses":{"200":{"description":"成功","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WarehousingResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/UnprocessableContent"}}},"delete":{"tags":["warehousings"],"summary":"入荷依頼削除","description":"入荷依頼をキャンセルします。\n\nステータスによってはキャンセルできません。\n","operationId":"deleteWarehousing","parameters":[{"name":"id","in":"path","description":"入荷ID","required":true,"schema":{"type":"string","example":"AB001-W0001"}}],"requestBody":{"content":{"application/json":{"schema":{"example":{}}}}},"responses":{"200":{"description":"成功","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WarehousingResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/UnprocessableContent"}}}},"/warehousings/stocked":{"get":{"tags":["warehousings"],"summary":"直近の入荷実績","description":"指定日付の直近1日分の入荷実績（入荷済みの入荷依頼）を取得します。\n\n`date_before`の指定がある場合は、指定日からさかのぼって入荷作業を行った直近の日付です。\n指定した日に入荷実績があれば指定日、指定日に入荷実績がなく前日以前に入荷実績があればその入荷実績の日付です。\n`date_after`の場合は、指定日より後の直近の日付です。\n\nクエリパラメータを指定しない場合は、`date_before`にリクエスト日を指定した場合と同一です。\n\n**例**\n下記表は、日付が異なる3回の入荷実績がある場合の例です。\n\n入荷日 | 左記入荷日を含む`date_before`の例 | 左記入荷日を含む`date_after`の例\n---|---|---\n2025-01-10 | `date_before=20250110`, `date_before=20250131` | `date_after=20250106`, `date_after=20250110`\n2025-01-05 | `date_before=20250105`, `date_before=20250109` | `date_after=20250102`, `date_after=20250105`\n2025-01-01 | `date_before=20250101`, `date_before=20250102` | `date_after=20241201`, `date_after=20250101`","operationId":"listRecentWarehousings","parameters":[{"name":"date_before","in":"query","description":"指定日以前の最終入荷日の入荷実績を取得します。\n\n`date_after`と一緒に指定した場合は、`date_after`の指定を無視します。","required":false,"schema":{"type":"string","pattern":"^(?\\d{4})(?\\d{2})(?\\d{2})$","example":"20190101"}},{"name":"date_after","in":"query","description":"指定日以降の初回入荷日の入荷実績を取得します。\n\n`date_before`と一緒に指定した場合は、`date_after`の指定を無視します。","required":false,"schema":{"type":"string","pattern":"^(?\\d{4})(?\\d{2})(?\\d{2})$","example":"20190401"}}],"responses":{"200":{"description":"成功","content":{"application/json":{"schema":{"required":["warehousings"],"type":"object","properties":{"warehousings":{"type":"array","title":"入荷実績リスト","items":{"$ref":"#/components/schemas/WarehousingResponseWithWarehousedData"}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"422":{"$ref":"#/components/responses/UnprocessableContent"}}}},"/warehousings/stocked/{year}/{month}/{day}":{"get":{"tags":["warehousings"],"summary":"指定年月日の入荷実績","description":"指定年月日の入荷実績（`status`が`stocked`のもの）を取得します。\n\n`halfway`が`true`の場合、入荷依頼の一部の商品が入荷完了している状態を表します。","operationId":"getWarehousingsByDate","parameters":[{"name":"year","in":"path","description":"入荷年(YYYY)","required":false,"schema":{"type":"string","pattern":"^\\d{4}$","example":"2019"}},{"name":"month","in":"path","description":"入荷月(MM)","required":false,"schema":{"type":"string","pattern":"^\\d{2}$","example":"04"}},{"name":"day","in":"path","description":"入荷日(DD)\n\n指定しない場合は、指定年月の入荷実績を取得します。","required":false,"schema":{"type":"string","pattern":"^\\d{2}$","example":"01"}}],"responses":{"200":{"description":"成功","content":{"application/json":{"schema":{"required":["warehousings"],"type":"object","properties":{"warehousings":{"type":"array","title":"入荷実績リスト","items":{"$ref":"#/components/schemas/WarehousingResponseWithWarehousedData"}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/UnprocessableContent"}}}},"/warehousings/{id}.pdf":{"get":{"tags":["warehousings"],"summary":"入荷ラベル取得","description":"入荷ラベルを取得します。","operationId":"getWarehousingPdf","parameters":[{"name":"id","in":"path","description":"入荷ID","required":true,"schema":{"type":"string","example":"AB001-W0001"}}],"responses":{"200":{"description":"成功","content":{"application/pdf":{"schema":{"example":{}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/shipments":{"get":{"tags":["shipments"],"summary":"出荷依頼一覧","description":"依頼中（`status: shipped`以外）の出荷依頼を取得します。\n\nクエリパラメータで出荷IDを指定した場合は、出荷済み（`status: shipped`）の出荷依頼も取得します。\n","operationId":"listShipments","parameters":[{"name":"id","in":"query","description":"出荷IDをカンマ( `,` )区切りで最大100件まで指定できます。\n","required":false,"schema":{"type":"string","example":"TS001-S000001,AB001-S000003","externalDocs":{"description":"出荷IDについてはこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/269"}},"style":"form","explode":false},{"name":"cursor","in":"query","description":"APIバージョン1.6 以降で利用可能なカーソル。前回レスポンスの `metadata.page.next_cursor` を指定すると次ページを取得します。\n","required":false,"schema":{"type":"string","example":"eyJrZXkiOjEwMDAwMCwic2FtcGxlTWV0YWRhdGEiOnRydWV9"}},{"name":"limit","in":"query","description":"APIバージョン1.6 以降で利用可能な1ページあたり取得件数\n","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000,"default":10,"example":10}}],"responses":{"200":{"description":"成功","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/PaginatedShipmentsResponse"},{"title":"v1.5以下（ページネーション無し）","type":"object","required":["shipments"],"properties":{"shipments":{"type":"array","title":"出荷依頼一覧","minItems":0,"items":{"$ref":"#/components/schemas/GetShipmentResponse"}},"metadata":{"type":"object","title":"メタデータ","description":"`id`クエリパラメータ指定時に付与されるスキーマですが、APIバージョン1.5以下ではこの値の読み取りを想定していないので読み捨ててください。","properties":{"page":{"$ref":"#/components/schemas/EmptyPagingInfo"}}}}}]}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"}}},"post":{"tags":["shipments"],"summary":"出荷依頼作成","description":"出荷依頼を1件作成します。\n事前に商品登録が必要です。\n\n#### 識別番号と注文番号について\n- 出荷を特定するキーとして `identifier` が利用されます\n- `identifier` が指定されていない場合は `order_no` の値が `identifier` として保存されます\n- `identifier` と `order_no` のいずれかの指定が必須となります\n\n#### 在庫不足時の出荷依頼, 入荷前の商品の出荷依頼（出荷予約）の方法について\n- 出荷依頼単位の`backorder_if_unavailable`に`true`を指定してください。\n- 出荷ルールによる商品追加で在庫不足が発生する場合も同様です。\n","operationId":"postShipment","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostShipmentRequest"},"examples":{"domesticShipment":{"$ref":"#/components/examples/DomesticShipmentRequest"},"internationalShipment":{"$ref":"#/components/examples/InternationalShipmentRequest"}}}}},"responses":{"201":{"description":"成功","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostShipmentResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"},"422":{"$ref":"#/components/responses/UnprocessableContent"}}}},"/shipments/bulk":{"post":{"tags":["shipments"],"summary":"出荷依頼一括作成","description":"出荷依頼作成と同じフォーマットのJSONを配列で送信することで一括作成できます。\n\n単一の出荷依頼作成APIとは異なり、`apply_rule`を出荷依頼単位ではなく、リクエスト単位で指定します。\nそのため、一括で作成するすべての出荷依頼について出荷ルールが評価され、それぞれの条件を満たす出荷ルールが適用されます。\n\n#### 推奨事項\n一括作成の件数には上限を設けていませんが、50件〜100件程度を推奨します。\n件数が多いほど処理時間も長くなるため、クライアントシステムのタイムアウト値の設定にご注意ください。\n\n#### エラー時の挙動について\nこのAPIはアトミックに処理をします。\nよって、一部の出荷依頼の作成に失敗した場合は、すべての出荷依頼が作成されません。\nこの場合は、エラーを修正し、同じ内容で再度リクエストするか、個別に出荷依頼を作成してください。","operationId":"bulkPostShipments","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostShipmentsRequest"},"examples":{"domesticShipments":{"$ref":"#/components/examples/DomesticShipmentRequestList"},"internationalShipment":{"$ref":"#/components/examples/InternationalShipmentRequest"}}}}},"responses":{"200":{"description":"成功","content":{"application/json":{"schema":{"required":["shipments"],"type":"object","properties":{"shipments":{"title":"出荷依頼リスト","description":"一括作成された出荷依頼の配列です。","type":"array","items":{"$ref":"#/components/schemas/PostShipmentResponse"}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"},"422":{"$ref":"#/components/responses/BulkPostShipmentsUnprocessableContent"}}}},"/shipments/{id}":{"get":{"tags":["shipments"],"summary":"出荷依頼取得","description":"指定した出荷IDの出荷依頼情報を取得します。\n","operationId":"getShipment","parameters":[{"name":"id","in":"path","description":"出荷ID","required":true,"schema":{"type":"string","externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/269"}},"example":"TS001-S000001"}],"responses":{"200":{"description":"成功","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetShipmentResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"}}},"put":{"tags":["shipments"],"summary":"出荷依頼更新","description":"依頼中の出荷依頼を更新します。\n\n- 更新できる出荷依頼は、ステータスが`backordered`、`waiting`のものです\n- それ以外のステータスの出荷依頼を修正、キャンセルしたい場合は、それぞれ[出荷依頼修正リクエスト](#tag/shipments/operation/modifyShipment)と[出荷依頼キャンセルリクエスト](#tag/shipments/operation/cancelShipment)をご利用ください\n- 倉庫移動で作成された出荷依頼の更新には、[倉庫移動更新](#tag/shipments/operation/putTransfer)をご利用ください\n- 出荷依頼を更新した結果、出荷ルールの実行条件を満たしても出荷ルールは適用されません","operationId":"putShipment","parameters":[{"name":"id","in":"path","description":"出荷ID","required":true,"schema":{"type":"string","example":"TS001-S000001","externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/269"}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShipmentRequest"}}}},"responses":{"200":{"description":"成功","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostShipmentResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/UnprocessableContent"}}},"delete":{"tags":["shipments"],"summary":"出荷依頼削除","description":"ステータスによっては削除できません。","operationId":"deleteShipment","parameters":[{"name":"id","in":"path","description":"出荷ID指定","required":true,"schema":{"type":"string","example":"TS001-S000001"}}],"requestBody":{"content":{"application/json":{"schema":{"example":{}}}}},"responses":{"200":{"description":"成功","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostShipmentResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/UnprocessableContent"}}}},"/shipments/{id}/modify":{"post":{"tags":["shipments"],"summary":"出荷依頼修正リクエスト","description":"ステータスがピッキング中・ピッキング済み・梱包済みの出荷依頼の修正を依頼します。\n\nデータ取り込み後の修正となりますので、別途事務手数料＋作業進捗状況による作業費用がかかります。\n\n海外発送の場合は梱包済みのステータス以降は依頼ができません。\n\nキャンセル依頼を出していただき、別途新規の出荷依頼を作成してください。\n\nまた、作業進捗状況によってはご依頼にお応えすることができない場合がございます。\n\nご了承の上ご利用ください。\n","operationId":"modifyShipment","parameters":[{"name":"id","in":"path","description":"出荷ID指定","required":true,"schema":{"type":"string","example":"TS001-S000001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModifyShipmentRequest"}}}},"responses":{"200":{"description":"成功","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostShipmentResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/UnprocessableContent"}}}},"/shipments/{id}/cancel":{"post":{"tags":["shipments"],"summary":"出荷依頼キャンセルリクエスト","description":"ステータスがピッキング中・ピッキング済み・梱包済みの出荷依頼の修正を依頼します。\n\nデータ取り込み後の修正となりますので、別途事務手数料＋作業進捗状況による作業費用がかかります。\n\n海外発送の場合は梱包済みのステータス以降は依頼ができません。\n\nキャンセル依頼を出していただき、別途新規の出荷依頼を作成してください。\n\nまた、作業進捗状況によってはご依頼にお応えすることができない場合がございます。\n\nご了承の上ご利用ください。\n","operationId":"cancelShipment","parameters":[{"name":"id","in":"path","description":"出荷ID指定","required":true,"schema":{"type":"string","example":"TS001-S000001"}}],"requestBody":{"content":{"application/json":{"schema":{"example":{}}}}},"responses":{"200":{"description":"成功","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostShipmentResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/UnprocessableContent"}}}},"/shipments/{account_id}":{"get":{"tags":["shipments(identifier指定)"],"summary":"出荷依頼一覧","description":"依頼中（`status`が`shipped`以外）の出荷依頼を取得します。\n\nクエリパラメータで識別番号を指定した場合は、出荷済み（`status`が`shipped`）の出荷依頼も取得します。","operationId":"listShipmentsByAccountId","parameters":[{"name":"account_id","in":"path","description":"アカウントコード","required":true,"schema":{"type":"string","example":"TS001","externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/263"}}},{"name":"identifier","in":"query","description":"APIバージョン1.5以下では必須のパラメータです。1.6以上では任意パラメータとなります。\n\n[出荷依頼作成](#tag/shipments/operation/postShipment)で指定した識別番号（`identifier`）をカンマ( `,` )区切りで最大100件まで指定できます。\n\n識別番号を指定していない場合は、注文番号（`order_no`）を識別番号として利用できます。","required":true,"schema":{"type":"string","example":"2015-00001,2015-00002"},"style":"form","explode":false},{"name":"cursor","in":"query","required":false,"description":"APIバージョン1.6 以降で利用可能なカーソル。前回レスポンスの `metadata.page.next_cursor` を指定すると次ページを取得します。","schema":{"type":"string","example":"eyJrZXkiOjEwMDAwMCwic2FtcGxlTWV0YWRhdGEiOnRydWV9"}},{"name":"limit","in":"query","required":false,"description":"APIバージョン1.6 以降で利用可能な1ページあたり取得件数","schema":{"type":"integer","minimum":1,"maximum":1000,"default":10,"example":10}}],"responses":{"200":{"description":"成功","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/PaginatedShipmentsResponse"},{"title":"v1.5以下（ページネーション無し）","type":"object","required":["shipments"],"properties":{"shipments":{"type":"array","title":"出荷依頼一覧","minItems":0,"items":{"$ref":"#/components/schemas/GetShipmentResponse"}},"metadata":{"type":"object","title":"メタデータ","description":"`identifier`クエリパラメータ指定時に付与されるスキーマですが、APIバージョン1.5以下ではこの値の読み取りを想定していないので読み捨ててください。","properties":{"page":{"$ref":"#/components/schemas/EmptyPagingInfo"}}}}}]}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/UnprocessableContent"}}}},"/shipments/{account_id}/{identifier}":{"get":{"tags":["shipments(identifier指定)"],"summary":"出荷依頼","description":"出荷依頼を取得します。\n","operationId":"getShipmentByAccountId","parameters":[{"name":"account_id","in":"path","description":"アカウントコード","required":true,"schema":{"type":"string","example":"TS001"}},{"name":"identifier","in":"path","description":"識別番号","required":true,"schema":{"type":"string","example":"2015-00001"}}],"responses":{"200":{"description":"成功","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetShipmentResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}}},"put":{"tags":["shipments(identifier指定)"],"summary":"出荷依頼修正","description":"ステータスによっては更新できません。","operationId":"putShipmentByAccountId","parameters":[{"name":"account_id","in":"path","description":"アカウントコード","required":true,"schema":{"type":"string","example":"TS001"}},{"name":"identifier","in":"path","description":"識別番号","required":true,"schema":{"type":"string","example":"2015-00001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShipmentRequest"},"examples":{"domesticShipments":{"$ref":"#/components/examples/DomesticShipmentRequest"}}}}},"responses":{"200":{"description":"成功","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostShipmentResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/UnprocessableContent"}}},"delete":{"tags":["shipments(identifier指定)"],"summary":"出荷依頼削除","description":"ステータスによっては削除できません。","operationId":"deleteShipmentByAccountId","parameters":[{"name":"account_id","in":"path","description":"アカウントコード","required":true,"schema":{"type":"string","example":"TS001"}},{"name":"identifier","in":"path","description":"識別番号","required":true,"schema":{"type":"string","example":"2015-00001"}}],"requestBody":{"content":{"application/json":{"schema":{"example":{}}}}},"responses":{"200":{"description":"成功","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostShipmentResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/UnprocessableContent"}}}},"/shipments/{account_id}/{identifier}/modify":{"post":{"tags":["shipments(identifier指定)"],"summary":"出荷依頼修正リクエスト","description":"ステータスがピッキング中・ピッキング済み・梱包済みの出荷依頼の修正を依頼します。\n\nデータ取り込み後の修正となりますので、別途事務手数料＋作業進捗状況による作業費用がかかります。\n\n海外発送の場合は梱包済みのステータス以降は依頼ができません。\n\nキャンセル依頼を出していただき、別途新規の出荷依頼を作成してください。\n\nまた、作業進捗状況によってはご依頼にお応えすることができない場合がございます。\n\nご了承の上ご利用ください。\n","operationId":"modifyShipmentByAccountId","parameters":[{"name":"account_id","in":"path","description":"アカウントコード","required":true,"schema":{"type":"string","example":"TS001"}},{"name":"identifier","in":"path","description":"識別番号","required":true,"schema":{"type":"string","example":"2015-00001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModifyShipmentRequest"}}}},"responses":{"200":{"description":"成功","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostShipmentResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/UnprocessableContent"}}}},"/shipments/{account_id}/{identifier}/cancel":{"post":{"tags":["shipments(identifier指定)"],"summary":"出荷依頼キャンセルリクエスト","description":"ステータスがピッキング中・ピッキング済み・梱包済みの出荷依頼の修正を依頼します。\n\nデータ取り込み後の修正となりますので、別途事務手数料＋作業進捗状況による作業費用がかかります。\n\n海外発送の場合は梱包済みのステータス以降は依頼ができません。\n\nキャンセル依頼を出していただき、別途新規の出荷依頼を作成してください。\n\nまた、作業進捗状況によってはご依頼にお応えすることができない場合がございます。\n\nご了承の上ご利用ください。\n","operationId":"cancelShipmentByAccountId","parameters":[{"name":"account_id","in":"path","description":"アカウントコード","required":true,"schema":{"type":"string","example":"TS001"}},{"name":"identifier","in":"path","description":"識別番号","required":true,"schema":{"type":"string","example":"2015-00001"}}],"requestBody":{"content":{"application/json":{"schema":{"example":{}}}}},"responses":{"200":{"description":"成功","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostShipmentResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/UnprocessableContent"}}}},"/shipments/shipped":{"get":{"tags":["shipments"],"summary":"直近の出荷実績","description":"指定日付の直近1日分の出荷実績（出荷済みの出荷依頼）を取得します。\n\nクエリパラメータを指定しない場合は、リクエスト日の直近1日分の出荷実績を取得します。\n","operationId":"listShippedShipments","parameters":[{"name":"date_before","in":"query","description":"指定日以前の最終出荷日の出荷実績を取得します。\n\n`date_after`と一緒に指定した場合は、`date_after`の指定を無視します。","schema":{"type":"string","pattern":"^(?\\d{4})(?\\d{2})(?\\d{2})$","example":"20190320"}},{"name":"date_after","in":"query","description":"指定日以降の初回出荷日の出荷実績を取得します。\n\n`date_before`と一緒に指定した場合は、`date_after`の指定を無視します。","schema":{"type":"string","pattern":"^(?\\d{4})(?\\d{2})(?\\d{2})$","example":"20190420"}},{"name":"cursor","in":"query","description":"APIバージョン1.6 以降で利用可能なカーソル。前回レスポンスの `metadata.page.next_cursor` を指定すると次ページを取得します。\n","required":false,"schema":{"type":"string","example":"eyJrZXkiOjEwMDAwMCwic2FtcGxlTWV0YWRhdGEiOnRydWV9"}},{"name":"limit","in":"query","description":"APIバージョン1.6 以降で利用可能な1ページあたりの取得件数。指定しない場合は10件を返却します。最大1,000件まで指定できます。\n","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000,"default":10,"example":20}}],"responses":{"200":{"description":"成功","content":{"application/json":{"schema":{"anyOf":[{"title":"v1.6以降（ページネーションあり）","type":"object","required":["shipments","metadata"],"properties":{"shipments":{"type":"array","title":"出荷実績リスト","description":"出荷完了日時（`shipped_at`）と出荷IDの昇順で出荷実績の一覧を返却します。","minItems":0,"items":{"allOf":[{"$ref":"#/components/schemas/GetShipmentResponse"},{"properties":{"status":{"example":"shipped"}}}]}},"metadata":{"type":"object","title":"メタデータ","description":"レスポンスのメタデータ","required":["page"],"properties":{"page":{"$ref":"#/components/schemas/PagingInfo"}}}}},{"title":"v1.5以下（ページネーション無し）","required":["shipments"],"type":"object","properties":{"shipments":{"type":"array","title":"出荷実績リスト","items":{"allOf":[{"$ref":"#/components/schemas/GetShipmentResponse"},{"properties":{"status":{"example":"shipped"}}}]}}}}]}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"422":{"$ref":"#/components/responses/UnprocessableContent"}}}},"/shipments/shipped/{year}/{month}/{day}":{"get":{"tags":["shipments"],"summary":"指定年月日の出荷実績","description":"指定年月日の出荷実績（出荷済みの出荷依頼）を取得します。\n","operationId":"getShippedShipment","parameters":[{"name":"year","in":"path","description":"出荷年(YYYY)","required":true,"schema":{"type":"string","pattern":"^\\d{4}$","example":"2019"}},{"name":"month","in":"path","description":"出荷月(MM)","required":true,"schema":{"type":"string","pattern":"^\\d{2}$","example":"04"}},{"name":"day","in":"path","description":"出荷日(DD)\n\n指定しない場合は、指定年月の出荷実績を取得します。","required":false,"schema":{"type":"string","pattern":"^\\d{2}$","example":"02"}},{"name":"cursor","in":"query","description":"APIバージョン1.6 以降で利用可能なカーソル。前回レスポンスの `metadata.page.next_cursor` を指定すると次ページを取得します。\n","required":false,"schema":{"type":"string","example":"eyJrZXkiOjEwMDAwMCwic2FtcGxlTWV0YWRhdGEiOnRydWV9"}},{"name":"limit","in":"query","description":"APIバージョン1.6 以降で利用可能な1ページあたり取得件数\n","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000,"default":10,"example":10}}],"responses":{"200":{"description":"成功","content":{"application/json":{"schema":{"anyOf":[{"title":"v1.6以降（ページネーションあり）","type":"object","required":["shipments","metadata"],"properties":{"shipments":{"type":"array","title":"出荷実績リスト","description":"出荷完了日時（`shipped_at`）と出荷IDの昇順で出荷実績の一覧を返却します。","minItems":0,"items":{"allOf":[{"$ref":"#/components/schemas/GetShipmentResponse"},{"properties":{"status":{"example":"shipped"}}}]}},"metadata":{"type":"object","title":"メタデータ","description":"レスポンスのメタデータ","required":["page"],"properties":{"page":{"$ref":"#/components/schemas/PagingInfo"}}}}},{"title":"v1.5以下（ページネーション無し）","required":["shipments"],"type":"object","properties":{"shipments":{"type":"array","title":"出荷実績リスト","items":{"allOf":[{"$ref":"#/components/schemas/GetShipmentResponse"},{"properties":{"status":{"example":"shipped"}}}]}}}}]}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/UnprocessableContent"}}}},"/shipments/international/regions/ems":{"get":{"tags":["shipments"],"summary":"国コード情報","description":"海外発送指定時に指定できる国コードの一覧を取得します。","operationId":"getInternationalRegion","responses":{"200":{"description":"成功","content":{"application/json":{"schema":{"required":["regions"],"type":"object","properties":{"regions":{"type":"array","description":"国コード情報リスト","items":{"type":"object","properties":{"code":{"description":"国コード","type":"string"},"name":{"description":"名称","type":"string"},"name_english":{"description":"名称(英名)","type":"string"},"region_ems":{"description":"地帯","type":"string"}}}}}},"examples":{"currency":{"$ref":"#/components/examples/Region"}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"}}}},"/shipments/international/currencies":{"get":{"tags":["shipments"],"summary":"通貨情報","description":"海外発送時に指定できる通貨の一覧を取得します。","operationId":"getInternationalCurrency","responses":{"200":{"description":"成功","content":{"application/json":{"schema":{"required":["currencies"],"type":"object","properties":{"currencies":{"type":"array","description":"通貨情報リスト","items":{"type":"object","properties":{"code":{"description":"通貨コード","type":"string"},"name":{"description":"名称","type":"string"}}}}}},"examples":{"currency":{"$ref":"#/components/examples/Currency"}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"}}}},"/shipments/transfer":{"post":{"tags":["shipments"],"summary":"倉庫移動作成","description":"指定商品の倉庫移動依頼をします。\n\n発送元住所、発送先住所は指定された倉庫の住所となります。\n\n通常出荷と同じ出荷依頼情報が作成され、同時に発送先倉庫での入荷依頼が作成されます。\n","operationId":"postTransfer","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["warehouse","destination","items"],"properties":{"warehouse":{"type":"string","description":"移動元倉庫情報","example":"BASE2"},"destination":{"type":"object","description":"移動先倉庫情報","properties":{"warehouse":{"type":"string","description":"倉庫コード","example":"BASE3"}}},"items":{"type":"array","description":"移動商品リスト","items":{"type":"object","required":["code","quantity"],"properties":{"code":{"type":"string","description":"商品コード","example":"item-001"},"quantity":{"type":"integer","description":"数量","example":1},"name":{"type":"string","description":"商品名","example":"勇者の盾"}}}}}}}}},"responses":{"201":{"description":"成功","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransferResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"422":{"$ref":"#/components/responses/UnprocessableContent"}}}},"/shipments/transfer/{id}":{"put":{"tags":["shipments"],"summary":"倉庫移動更新","description":"ステータスによっては更新できません。","operationId":"putTransfer","parameters":[{"name":"id","in":"path","description":"出荷ID指定","required":true,"schema":{"type":"string","example":"TS001-S000001"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["destination","items"],"properties":{"destination":{"type":"object","description":"移動先倉庫情報","properties":{"warehouse":{"type":"string","description":"倉庫コード","example":"BASE3"}}},"items":{"type":"array","description":"移動商品リスト","items":{"type":"object","required":["code","quantity"],"properties":{"code":{"type":"string","description":"商品コード","example":"item-001"},"quantity":{"type":"integer","description":"数量","example":1},"name":{"type":"string","description":"商品名","example":"勇者の盾"}}}}}}}}},"responses":{"200":{"description":"成功","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransferResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/UnprocessableContent"}}}},"/shipments/transfer/{id}/modify":{"post":{"tags":["shipments"],"summary":"倉庫依頼修正リクエスト","description":"ステータスがピッキング中になっている倉庫移動依頼の修正を依頼します。\n\nデータ取り込み後の修正となりますので、別途事務手数料＋作業進捗状況による作業費用がかかります。\n\nまた、作業進捗状況によってはご依頼にお応えすることができない場合がございます。\n\nご了承の上ご利用ください。\n","operationId":"postTransferModify","parameters":[{"name":"id","in":"path","description":"出荷ID指定","required":true,"schema":{"type":"string","example":"TS001-S000001"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["destination"],"properties":{"destination":{"type":"object","description":"移動先倉庫情報","properties":{"warehouse":{"type":"string","description":"倉庫コード","example":"BASE3"}}}}}}}},"responses":{"200":{"description":"成功","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransferResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/UnprocessableContent"}}}},"/shipments/transfer/{id}/cancel":{"post":{"tags":["shipments"],"summary":"倉庫移動キャンセルリクエスト","description":"ステータスがピッキング中になっている倉庫移動依頼のキャンセルを依頼します。\n\nデータ取り込み後のキャンセルとなりますので、別途事務手数料＋作業進捗状況による作業費用がかかります。\n\nまた、作業進捗状況によってはご依頼にお応えすることができない場合がございます。\n\nご了承の上ご利用ください。\n","operationId":"postTransferCancel","parameters":[{"name":"id","in":"path","description":"出荷ID","required":true,"schema":{"type":"string","example":"TS001-S000001"}}],"requestBody":{"content":{"application/json":{"schema":{"example":{}}}}},"responses":{"200":{"description":"成功","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransferResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/UnprocessableContent"}}}},"/shipments/allocation/{id}/clear":{"post":{"tags":["shipments"],"summary":"出荷商品の引当解除","description":"対象の出荷依頼に含まれる全ての商品から引当が解除され入荷待ちに変更されます。\n\n解除実行後は引当優先順位が高い入荷待ちの出荷依頼から引当処理が行われます。\n\nご了承の上ご利用ください。\n","operationId":"postAllocationClear","parameters":[{"name":"id","in":"path","description":"出荷ID","required":true,"schema":{"type":"string","example":"TS001-S000001"}}],"requestBody":{"content":{"application/json":{"schema":{"example":{}}}}},"responses":{"200":{"description":"成功","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostShipmentResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/UnprocessableContent"}}}}},"components":{"schemas":{"child_item":{"anyOf":[{"title":"商品ID指定","type":"object","required":["id","quantity"],"properties":{"id":{"type":"string","title":"商品ID","example":"TS001-I000001"},"quantity":{"type":"integer","minimum":1,"title":"数量","example":1}}},{"title":"商品コード指定","type":"object","required":["code","quantity"],"properties":{"code":{"type":"string","title":"商品コード","example":"item-001"},"quantity":{"type":"integer","minimum":1,"title":"数量","example":1}}}]},"Stock":{"type":"object","required":["quantity","available","shipping","requesting","processing"],"properties":{"quantity":{"type":"integer","title":"総数","description":"倉庫に存在する在庫の総数。\n\n期限切れの在庫は含みません。","example":100},"available":{"type":"integer","title":"配送可在庫数","description":"総数のうち、追加で出荷依頼可能な数量（`quantity`から`shipping`、`reserved`、`processing`を減算した数量）。`backordered` > 0の場合は、0となります。","example":70},"shipping":{"type":"integer","title":"出荷作業中","description":"総数のうち、引当済みおよび出荷作業中の数量。\n\n管理画面における取込待ち、ピッキング中、ピッキング済、梱包済みの状況となっている在庫数のことを指します。","example":20},"requesting":{"type":"integer","title":"依頼中","description":"出荷に必要な数量（`shipping`、`reserved`、`backordered`の和）\n\n同梱物の場合は、`shipping`と一致します。","example":10},"processing":{"type":"integer","title":"処理中","description":"総数のうち、入荷作業中など出荷準備が整っておらず引当できない数量。","example":2}}},"ReservedStock":{"type":"object","required":["reserved"],"properties":{"reserved":{"type":"integer","title":"引当待ち数","description":"総数のうち、引当待ちの出荷依頼向けに確保されている数量。\n\n場合によって正確な数量とならないプロパティのため、利用は非推奨です。","deprecated":true,"example":10}}},"BackorderedStock":{"type":"object","required":["backordered"],"properties":{"backordered":{"type":"integer","title":"入荷待ち数","description":"すでに出荷依頼が作成されて入荷待ちとなっている数量。\n\n期限切れとなった数量は含みません。","example":5}}},"UnallocatableStock":{"type":"object","properties":{"unallocatable":{"type":"integer","title":"期限切れ在庫数","description":"※期限管理を利用するお客様のみ使用可能\n\n期限管理商品の場合に、期限切れとなった数量","example":5}}},"StockSize":{"type":"object","required":["size"],"properties":{"size":{"type":"string","enum":["SS","S","60","80","100","120","140","150","160","170","180","190","200","210","220","230","240","250","260"],"title":"サイズ","description":"入荷時に測定された商品サイズ。ユーザーや倉庫によって取り扱い可能なサイズは異なります。","example":"60","externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/42"}}}},"StockWeight":{"type":"object","required":["weight"],"properties":{"weight":{"type":"integer","title":"重さ(グラム)","description":"入荷時に測定された商品重量","example":200}}},"stock_summary":{"type":"object","title":"在庫情報","anyOf":[{"title":"通常商品","allOf":[{"$ref":"#/components/schemas/Stock"},{"$ref":"#/components/schemas/ReservedStock"},{"$ref":"#/components/schemas/BackorderedStock"},{"$ref":"#/components/schemas/UnallocatableStock"},{"$ref":"#/components/schemas/StockSize"},{"$ref":"#/components/schemas/StockWeight"}]},{"title":"同梱物","allOf":[{"$ref":"#/components/schemas/Stock"}]}]},"warehousebase_stock":{"type":"object","title":"各倉庫の在庫情報","anyOf":[{"title":"通常商品","allOf":[{"type":"object","required":["warehouse"],"properties":{"warehouse":{"type":"string","title":"倉庫コード","example":"NBZ"}}},{"$ref":"#/components/schemas/Stock"},{"$ref":"#/components/schemas/ReservedStock"},{"$ref":"#/components/schemas/BackorderedStock"},{"$ref":"#/components/schemas/UnallocatableStock"},{"type":"object","properties":{"dispose":{"type":"string","description":"廃棄依頼（waiting,processing）","example":"waiting"}}}]},{"title":"同梱物","allOf":[{"type":"object","required":["warehouse"],"properties":{"warehouse":{"type":"string","title":"倉庫コード","example":"NBZ"}}},{"$ref":"#/components/schemas/Stock"},{"$ref":"#/components/schemas/UnallocatableStock"}]}]},"ItemResponse":{"type":"object","required":["id","code","name"],"properties":{"id":{"type":"string","title":"商品ID","description":"オープンロジに商品を登録した際に自動で生成され、商品ごとに割り当てられる固有のIDです。","externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/220"},"example":"TS001-I000001"},"code":{"type":"string","minLength":1,"maxLength":30,"title":"商品コード","description":"商品に記載されたユーザー独自のコードや品番・型番を表す半角英数記号の文字列です。\n入出荷時に商品を指定する場合に使うことができます。\n\n商品コードは出荷時の同梱明細書にも記載されます。","example":"item-002"},"name":{"type":"string","maxLength":255,"title":"商品名","description":"商品名は出荷依頼作成時に変更することもできます。\n出荷依頼作成時に商品名（`.items[].name`）の指定がない場合に、この商品名が出荷依頼の同梱明細書に記載されます。","example":"勇者の盾"},"price":{"oneOf":[{"title":"価格（リクエストパラメータ）","type":"integer","description":"商品マスタに登録された価格は、管理画面で出荷依頼を作成する際に自動入力されます。\nAPIで出荷依頼作成する際、価格（`.items[].unit_price`）の指定が無い場合には自動入力されません。","example":1000},{"title":"価格（レスポンス）","type":"string","description":"商品登録時に指定した`price`を文字列として返却します。桁区切りや通貨記号付与などの整形処理はされません。\n\n商品マスタに登録された価格は、管理画面で出荷依頼を作成する際に自動入力されます。\nAPIで出荷依頼作成する際、価格（`.items[].unit_price`）の指定が無い場合には自動入力されません。","example":"1000"}]},"is_reduced_tax":{"type":"boolean","title":"軽減税率適用商品","description":"軽減税率が適用される商品の場合は`true`を指定します。\n出荷依頼作成時に軽減税率適用商品（`.items[].is_reduced_tax`）の指定がない場合に、この軽減税率適用商品の値が適用されます。","example":true},"hs_code":{"type":"string","pattern":"^\\d{4}\\.?\\d{2}((\\.|-)?\\d{3,4})?$","title":"HSコード","description":"海外へ発送する場合の商品のHSコード。出荷依頼作成時に指定します。\n出荷依頼作成時にHSコード（`.items[].hs_code`）の指定がない場合に、このHSコードの値が適用されます。","example":"000000.000","externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/249"}},"barcode":{"type":"string","maxLength":30,"title":"管理バーコード","description":"入荷依頼で検品タイプ：管理バーコードを選択した際に使用されます。\nUPC-A形式またはJAN13形式のバーコードを指定します。","example":"1234567890128"},"item_barcodes":{"type":"array","title":"関連バーコード","description":"FBAに登録されている商品との紐づけに利用されるFNSKUを指定します。","items":{"type":"string","example":"TEST1"},"externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/8"}},"description":{"type":"string","maxLength":16,"title":"品名","description":"国内発送時の送り状に記載する品名","example":"玩具","externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/21"}},"international_info":{"type":"object","description":"海外発送情報","properties":{"invoice_summary":{"type":"string","minLength":3,"maxLength":75,"title":"品名（英語）","description":"海外発送時の送り状/INVOICEに記載される品名です。","example":"Toy","externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/256"}},"origin":{"type":"string","pattern":"^[A-Z][A-Z]$","minLength":2,"maxLength":2,"title":"原産国","description":"海外発送時の送り状/INVOICEに記載される原産国です。\n国連LOCODEの国名2文字を指定します。","example":"JP"}}},"child_items":{"type":"array","minItems":1,"maxItems":10,"items":{"$ref":"#/components/schemas/child_item"},"title":"セット商品の子商品リスト","description":"セット商品の場合に、組み合わせる商品を指定します。","externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/59"}},"tags":{"type":"array","minItems":1,"title":"商品タグリスト","items":{"type":"string","maxLength":255},"description":"商品に付与するタグを複数指定します。`,`, `，`, `､`, `、`はタグ文字列内で利用できません。","example":["water gun"],"externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/235"}},"stock":{"$ref":"#/components/schemas/stock_summary"},"stocks":{"type":"array","items":{"$ref":"#/components/schemas/warehousebase_stock"},"description":"各倉庫の在庫情報"},"bundled_item":{"type":"boolean","title":"同梱物","description":"この商品が同梱物の場合は、`true`となります。","example":true,"externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/19"}},"externalCode":{"type":"string","title":"AMAZON FBA 用の FNSKU","description":"関連付けたいFBA商品のFNSKU","example":"TEST1","externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/8"}},"hidden":{"type":"boolean","title":"非表示","description":"管理画面で商品を非表示設定した場合に、`true`となります。","externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/201"}},"temperature_zone":{"type":"string","nullable":true,"enum":["dry","constant","chilled","frozen"],"title":"保管温度帯","description":"※温度帯管理を利用するお客様のみ使用可能\n\n商品をどの温度帯で管理するか指定します。\n温度帯は概ねの目安となり実際の管理温度帯は倉庫によって異なります。\n\n- `dry`: 常温（5℃ ~ 35℃の範囲）\n- `constant`: 定温（10℃ ~ 25℃の範囲）\n- `chilled`: 冷蔵（-5℃ ~ 5℃の範囲）\n- `frozen`: 冷凍（-15℃以下）","default":"dry","example":"frozen","externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/267"}},"fifo":{"type":"boolean","nullable":true,"title":"先入れ先出し","description":"※先入れ先出し管理を利用するお客様のみ使用可能","example":true},"lot_limit_type":{"type":"string","nullable":true,"enum":["expiry","manufacture"],"title":"期限商品タイプ","description":"※期限管理を利用するお客様のみ使用可能\n\n- `expiry`: 賞味期限で管理する商品\n- `manufacture`: 製造年月日で管理する商品","example":"expiry","externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/210"}},"expiry_at_allocatable_days":{"type":"integer","minimum":0,"nullable":true,"title":"引当可能残期間（賞味期限）","description":"※期限管理を利用するお客様のみ使用可能\n\n賞味期限から何日前まで引当てできるかを指定します。`lot_limit_type`が`expiry`の場合に指定します。","example":20},"manufacture_date_allocatable_days":{"type":"integer","minimum":0,"nullable":true,"title":"引当可能残期間（製造年月日）","description":"※期限管理を利用するお客様のみ使用可能\n\n製造年月日から何日前まで引当てできるかを指定します。`lot_limit_type`が`manufacture`の場合に指定します。","example":20},"expiry_at":{"type":"string","format":"date-time","nullable":true,"title":"賞味期限","description":"※期限管理を利用するお客様のみ使用可能\n\n入荷作業時に倉庫で賞味期限を入力します。","example":"2021-04-05 21:00:00"},"manufacture_date":{"type":"string","format":"date","nullable":true,"title":"製造年月日","description":"※期限管理を利用するお客様のみ使用可能\n\n入荷作業時に倉庫で製造年月日を入力します。","example":"2021-04-01"},"lot_allocatable_at":{"type":"string","format":"date-time","nullable":true,"title":"引当可能期限","description":"※期限管理を利用するお客様のみ使用可能\n\n賞味期限、製造年月日と商品情報の引当可能残期間から自動で計算された引当期限日です。","example":"2021-04-05 18:00:00"},"lot_allocatable_priority":{"type":"integer","nullable":true,"title":"ロット引当順","description":"※先入れ先出し管理を利用するお客様のみ使用可能。期限商品では固定値が入ります。","example":1}}},"PagingInfo":{"type":"object","title":"ページ情報","description":"ページを制御するための情報が入ります","required":["next_cursor","has_more"],"properties":{"next_cursor":{"type":"string","nullable":true,"title":"カーソル","description":"次ページ取得に使用するカーソル。続くリクエストの`cursor`パラメータにそのまま指定することで、続きのデータを取得できます。\n最終ページでは`null`となります。"},"has_more":{"type":"boolean","title":"次ページ有無","description":"次ページが存在する場合 `true`。"}},"example":{"next_cursor":"eyJrZXkiOjEwMDAwMCwic2FtcGxlTWV0YWRhdGEiOnRydWV9","has_more":true}},"ItemRequest":{"type":"object","required":["code"],"properties":{"code":{"type":"string","minLength":1,"maxLength":30,"title":"商品コード","description":"商品に記載されたユーザー独自のコードや品番・型番を表す半角英数記号の文字列です。\n入出荷時に商品を指定する場合に使うことができます。\n\n商品コードは出荷時の同梱明細書にも記載されます。","example":"item-002"},"name":{"type":"string","maxLength":255,"title":"商品名","description":"商品名は出荷依頼作成時に変更することもできます。\n出荷依頼作成時に商品名（`.items[].name`）の指定がない場合に、この商品名が出荷依頼の同梱明細書に記載されます。","example":"勇者の盾"},"price":{"oneOf":[{"title":"価格（リクエストパラメータ）","type":"integer","description":"商品マスタに登録された価格は、管理画面で出荷依頼を作成する際に自動入力されます。\nAPIで出荷依頼作成する際、価格（`.items[].unit_price`）の指定が無い場合には自動入力されません。","example":1000},{"title":"価格（レスポンス）","type":"string","description":"商品登録時に指定した`price`を文字列として返却します。桁区切りや通貨記号付与などの整形処理はされません。\n\n商品マスタに登録された価格は、管理画面で出荷依頼を作成する際に自動入力されます。\nAPIで出荷依頼作成する際、価格（`.items[].unit_price`）の指定が無い場合には自動入力されません。","example":"1000"}]},"is_reduced_tax":{"type":"boolean","title":"軽減税率適用商品","description":"軽減税率が適用される商品の場合は`true`を指定します。\n出荷依頼作成時に軽減税率適用商品（`.items[].is_reduced_tax`）の指定がない場合に、この軽減税率適用商品の値が適用されます。","example":true},"hs_code":{"type":"string","pattern":"^\\d{4}\\.?\\d{2}((\\.|-)?\\d{3,4})?$","title":"HSコード","description":"海外へ発送する場合の商品のHSコード。出荷依頼作成時に指定します。\n出荷依頼作成時にHSコード（`.items[].hs_code`）の指定がない場合に、このHSコードの値が適用されます。","example":"000000.000","externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/249"}},"barcode":{"type":"string","maxLength":30,"title":"管理バーコード","description":"入荷依頼で検品タイプ：管理バーコードを選択した際に使用されます。\nUPC-A形式またはJAN13形式のバーコードを指定します。","example":"1234567890128"},"international_info":{"type":"object","description":"海外発送情報","properties":{"invoice_summary":{"type":"string","minLength":3,"maxLength":75,"title":"品名（英語）","description":"海外発送時の送り状/INVOICEに記載される品名です。","example":"Toy","externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/256"}},"origin":{"type":"string","pattern":"^[A-Z][A-Z]$","minLength":2,"maxLength":2,"title":"原産国","description":"海外発送時の送り状/INVOICEに記載される原産国です。\n国連LOCODEの国名2文字を指定します。","example":"JP"}}},"child_items":{"type":"array","minItems":1,"maxItems":10,"items":{"$ref":"#/components/schemas/child_item"},"title":"セット商品の子商品リスト","description":"セット商品の場合に、組み合わせる商品を指定します。","externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/59"}},"tags":{"type":"array","minItems":1,"title":"商品タグリスト","items":{"type":"string","maxLength":255},"description":"商品に付与するタグを複数指定します。`,`, `，`, `､`, `、`はタグ文字列内で利用できません。","example":["water gun"],"externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/235"}},"temperature_zone":{"type":"string","nullable":true,"enum":["dry","constant","chilled","frozen"],"title":"保管温度帯","description":"※温度帯管理を利用するお客様のみ使用可能\n\n商品をどの温度帯で管理するか指定します。\n温度帯は概ねの目安となり実際の管理温度帯は倉庫によって異なります。\n\n- `dry`: 常温（5℃ ~ 35℃の範囲）\n- `constant`: 定温（10℃ ~ 25℃の範囲）\n- `chilled`: 冷蔵（-5℃ ~ 5℃の範囲）\n- `frozen`: 冷凍（-15℃以下）","default":"dry","example":"frozen","externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/267"}},"fifo":{"type":"boolean","nullable":true,"title":"先入れ先出し","description":"※先入れ先出し管理を利用するお客様のみ使用可能","example":true},"lot_limit_type":{"type":"string","nullable":true,"enum":["expiry","manufacture"],"title":"期限商品タイプ","description":"※期限管理を利用するお客様のみ使用可能\n\n- `expiry`: 賞味期限で管理する商品\n- `manufacture`: 製造年月日で管理する商品","example":"expiry","externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/210"}},"expiry_at_allocatable_days":{"type":"integer","minimum":0,"nullable":true,"title":"引当可能残期間（賞味期限）","description":"※期限管理を利用するお客様のみ使用可能\n\n賞味期限から何日前まで引当てできるかを指定します。`lot_limit_type`が`expiry`の場合に指定します。","example":20},"manufacture_date_allocatable_days":{"type":"integer","minimum":0,"nullable":true,"title":"引当可能残期間（製造年月日）","description":"※期限管理を利用するお客様のみ使用可能\n\n製造年月日から何日前まで引当てできるかを指定します。`lot_limit_type`が`manufacture`の場合に指定します。","example":20}}},"ItemRequestWithBundledItem":{"type":"object","required":["code"],"properties":{"code":{"type":"string","minLength":1,"maxLength":30,"title":"商品コード","description":"商品に記載されたユーザー独自のコードや品番・型番を表す半角英数記号の文字列です。\n入出荷時に商品を指定する場合に使うことができます。\n\n商品コードは出荷時の同梱明細書にも記載されます。","example":"item-002"},"name":{"type":"string","maxLength":255,"title":"商品名","description":"商品名は出荷依頼作成時に変更することもできます。\n出荷依頼作成時に商品名（`.items[].name`）の指定がない場合に、この商品名が出荷依頼の同梱明細書に記載されます。","example":"勇者の盾"},"price":{"oneOf":[{"title":"価格（リクエストパラメータ）","type":"integer","description":"商品マスタに登録された価格は、管理画面で出荷依頼を作成する際に自動入力されます。\nAPIで出荷依頼作成する際、価格（`.items[].unit_price`）の指定が無い場合には自動入力されません。","example":1000},{"title":"価格（レスポンス）","type":"string","description":"商品登録時に指定した`price`を文字列として返却します。桁区切りや通貨記号付与などの整形処理はされません。\n\n商品マスタに登録された価格は、管理画面で出荷依頼を作成する際に自動入力されます。\nAPIで出荷依頼作成する際、価格（`.items[].unit_price`）の指定が無い場合には自動入力されません。","example":"1000"}]},"is_reduced_tax":{"type":"boolean","title":"軽減税率適用商品","description":"軽減税率が適用される商品の場合は`true`を指定します。\n出荷依頼作成時に軽減税率適用商品（`.items[].is_reduced_tax`）の指定がない場合に、この軽減税率適用商品の値が適用されます。","example":true},"hs_code":{"type":"string","pattern":"^\\d{4}\\.?\\d{2}((\\.|-)?\\d{3,4})?$","title":"HSコード","description":"海外へ発送する場合の商品のHSコード。出荷依頼作成時に指定します。\n出荷依頼作成時にHSコード（`.items[].hs_code`）の指定がない場合に、このHSコードの値が適用されます。","example":"000000.000","externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/249"}},"barcode":{"type":"string","maxLength":30,"title":"管理バーコード","description":"入荷依頼で検品タイプ：管理バーコードを選択した際に使用されます。\nUPC-A形式またはJAN13形式のバーコードを指定します。","example":"1234567890128"},"international_info":{"type":"object","description":"海外発送情報","properties":{"invoice_summary":{"type":"string","minLength":3,"maxLength":75,"title":"品名（英語）","description":"海外発送時の送り状/INVOICEに記載される品名です。","example":"Toy","externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/256"}},"origin":{"type":"string","pattern":"^[A-Z][A-Z]$","minLength":2,"maxLength":2,"title":"原産国","description":"海外発送時の送り状/INVOICEに記載される原産国です。\n国連LOCODEの国名2文字を指定します。","example":"JP"}}},"child_items":{"type":"array","minItems":1,"maxItems":10,"items":{"$ref":"#/components/schemas/child_item"},"title":"セット商品の子商品リスト","description":"セット商品の場合に、組み合わせる商品を指定します。","externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/59"}},"tags":{"type":"array","minItems":1,"title":"商品タグリスト","items":{"type":"string","maxLength":255},"description":"商品に付与するタグを複数指定します。`,`, `，`, `､`, `、`はタグ文字列内で利用できません。","example":["water gun"],"externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/235"}},"temperature_zone":{"type":"string","nullable":true,"enum":["dry","constant","chilled","frozen"],"title":"保管温度帯","description":"※温度帯管理を利用するお客様のみ使用可能\n\n商品をどの温度帯で管理するか指定します。\n温度帯は概ねの目安となり実際の管理温度帯は倉庫によって異なります。\n\n- `dry`: 常温（5℃ ~ 35℃の範囲）\n- `constant`: 定温（10℃ ~ 25℃の範囲）\n- `chilled`: 冷蔵（-5℃ ~ 5℃の範囲）\n- `frozen`: 冷凍（-15℃以下）","default":"dry","example":"frozen","externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/267"}},"fifo":{"type":"boolean","nullable":true,"title":"先入れ先出し","description":"※先入れ先出し管理を利用するお客様のみ使用可能","example":true},"lot_limit_type":{"type":"string","nullable":true,"enum":["expiry","manufacture"],"title":"期限商品タイプ","description":"※期限管理を利用するお客様のみ使用可能\n\n- `expiry`: 賞味期限で管理する商品\n- `manufacture`: 製造年月日で管理する商品","example":"expiry","externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/210"}},"expiry_at_allocatable_days":{"type":"integer","minimum":0,"nullable":true,"title":"引当可能残期間（賞味期限）","description":"※期限管理を利用するお客様のみ使用可能\n\n賞味期限から何日前まで引当てできるかを指定します。`lot_limit_type`が`expiry`の場合に指定します。","example":20},"manufacture_date_allocatable_days":{"type":"integer","minimum":0,"nullable":true,"title":"引当可能残期間（製造年月日）","description":"※期限管理を利用するお客様のみ使用可能\n\n製造年月日から何日前まで引当てできるかを指定します。`lot_limit_type`が`manufacture`の場合に指定します。","example":20},"bundled_item":{"type":"boolean","nullable":true,"title":"同梱物","description":"`true`の場合、この商品は同梱物となります。","example":true,"externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/19"}}}},"ImageRequest":{"type":"object","properties":{"name":{"type":"string","example":"file"},"filename":{"type":"string","example":"DQ003.jpg"}}},"ImageResponse":{"type":"object","required":["id"],"properties":{"id":{"type":"string","example":1234}}},"schemas-ItemResponse":{"type":"object","description":"商品","required":["id","code","name","quantity"],"additionalProperties":false,"properties":{"id":{"type":"string","title":"商品ID","example":"TS001-I00001","externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/220"}},"code":{"type":"string","title":"商品コード","description":"商品登録時に指定した商品コード。入荷依頼作成時に指定します。","example":"sword-001"},"name":{"type":"string","title":"商品名","description":"商品マスタに登録されている商品名","example":"勇者の盾"},"quantity":{"type":"integer","title":"数量","description":"入荷依頼で指定した数量","example":1}}},"WarehousingResponse":{"type":"object","description":"入荷依頼情報","required":["id","status","inspection_type","items"],"properties":{"id":{"type":"string","title":"入荷ID","description":"オープンロジで入荷依頼を作成した際に自動で生成され、入荷依頼ごとに割り当てられる固有のIDです。","example":"TS001-W0001","externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/199"}},"status":{"type":"string","enum":["waiting","received","checking","stocked"],"title":"入荷ステータス","description":"現在の入荷状況です。括弧内は管理画面での文言です。\n\n- `waiting` : 依頼中（着荷待ち）\n- `received` : 着荷済（検品待ち）\n- `checking` : 検品中\n- `stocked` : 完了","example":"waiting","externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/74"}},"halfway":{"type":"boolean","title":"一部完了フラグ","description":"`true`の場合、入荷依頼の一部の商品が入荷完了している状態を表します。","example":false,"externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/74"}},"arrival_date":{"type":"string","format":"date","title":"倉庫着予定日","description":"倉庫に該当の入荷が着荷する予定日です。入荷依頼作成時に指定します。","example":"2019-04-22"},"arrival_date_confirmed":{"type":"boolean","title":"確定情報として登録","description":"`true`の場合、倉庫着予定日が確定していることを表します。","example":true},"arrival_time_from":{"type":"integer","minimum":0,"maximum":23,"title":"倉庫着予定時間(いつから)","description":"倉庫に該当の入荷が着荷する予定最短時刻です。入荷依頼作成時に指定します。","example":10},"arrival_time_to":{"type":"integer","minimum":0,"maximum":23,"title":"倉庫着予定時間(いつまで)","description":"倉庫に該当の入荷が着荷する予定最長時刻です。入荷依頼作成時に指定します。","example":13},"sales_method":{"type":"string","title":"販売方法","description":"入荷した商品を出荷する際の販売方法です。倉庫の作業計画を立てるために必要な情報です。\n\n- `INVENTORY`: 在庫販売\n- `RESERVATION`: 予約販売\n- `OTHER`: その他","example":"RESERVATION","enum":["INVENTORY","RESERVATION","OTHER"]},"shipping_scheduled_date":{"type":"string","format":"date","title":"出荷予定日","description":"販売方法が `RESERVATION` の場合、返却されます。入荷依頼作成時に指定します。倉庫の作業計画を立てるために必要な情報です。","example":"2019-04-29"},"stock_deadline_date":{"type":"string","format":"date","title":"入荷完了期限日","description":"入荷作業の完了予定日です。デフォルトはシステムで自動算出されます。倉庫と交渉された場合は、交渉して決定された日付が返却されます。","example":"2019-04-24","externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/7"}},"identifier":{"type":"string","maxLength":30,"title":"入荷依頼識別子","description":"ユーザーが入荷依頼をユニークに特定するための符号です。\nユーザーが任意に指定するものです。","example":"Identifier-001"},"inspection_type":{"type":"string","enum":["ID","NAME","CODE","BARCODE","LABEL"],"title":"検品タイプ","description":"倉庫に届いた商品を検品する方法。\n\n- `ID`: オープンロジ商品ID\n- `NAME`: 商品名\n- `CODE`: 商品コード\n- `BARCODE`: 管理バーコード\n- `LABEL`: オープンロジ商品ラベル","example":"CODE","externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/11"}},"inspection_type_label":{"type":"string","enum":["オープンロジ商品ID","商品名","商品コード","管理バーコード","オープンロジ商品ラベル"],"title":"検品タイプラベル","description":"`inspection_type`の値の日本語名称","example":"オープンロジ商品ID"},"transport_mode":{"type":"string","title":"配送方法","description":"入荷する際の配送方法を指定します。\n\n- `\"\"` : 指定なし\n- `HOME_DELIVERY` : 宅配便\n- `CHARTER` : チャーター\n- `CONTAINER` : コンテナ","enum":["","HOME_DELIVERY","CHARTER","CONTAINER"],"externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/40"}},"identity_type":{"type":"string","title":"入荷特定項目","description":"倉庫で入荷を特定する際のキーとなる項目。\n\n- `ID_OR_LABEL` : 入荷ラベル・ID\n- `SUPPLIER` : 発注先名\n- `TRACKING_CODE` : お問い合わせ伝票番号\n- `VEHICLE_CODE` : 車両番号\n- `CONTAINER` : コンテナID","enum":["ID_OR_LABEL","SUPPLIER","TRACKING_CODE","VEHICLE_CODE","CONTAINER"],"default":"ID_OR_LABEL"},"identity_values":{"type":"array","nullable":true,"title":"入荷特定情報","description":"入荷特定項目（`identity_type`）に対応した値の配列。\n\n入荷特定項目（`identity_type`）の値 | セットされる値\n---|---\n`ID_OR_LABEL` | `null`\n`SUPPLIER` | 入荷依頼作成時に指定した`identity_values`の値\n`TRACKING_CODE` | `tracking_codes`の値\n`VEHICLE_CODE` | `vehicle_code`の値\n`CONTAINER` | `container_no`の値","items":{"type":"string","example":"株式会社オープンロジ"}},"tracking_codes":{"type":"array","title":"お問合せ伝票番号","description":"配送方法が`HOME_DELIVERY` または `\"\"` であれば、このパラメータが返却されます。\n\n倉庫での入荷作業を円滑にしたり、トラブルの解決に必要な情報です。","items":{"type":"string","example":"TrackingCode001"}},"vehicle_code":{"type":"string","maxLength":30,"title":"車両番号","description":"商品を倉庫へ送る際のチャーターやコンテナを載せる車両の番号。倉庫での入荷作業を円滑にしたり、トラブルの解決に必要な情報です。\n\n配送方法が `CHARTER` または `CONTAINER` の場合、返却されます。","example":"品川 100 あ ・・・1"},"vehicle_size":{"type":"string","title":"車両サイズ","description":"車両やコンテナのサイズ。倉庫での入荷作業を円滑にしたり、トラブルの解決に必要な情報です。\n\n配送方法が `CHARTER` または `CONTAINER` の場合、返却されます。\n\n- `UNDER_2T`: 2t以下\n- `4T`: 4t\n- `10T`: 10t\n- `20FT`: 20ft\n- `40FT`: 40ft","enum":["UNDER_2T","4T","10T","20FT","40FT"],"example":"4T"},"carrying_method":{"type":"string","title":"積載方法","description":"配送方法が `CHARTER` または `CONTAINER` の場合、返却されます。\n\n- `PALETTE`: パレット\n- `BARA`: バラ積み","enum":["PALETTE","BARA"],"example":"PALETTE"},"container_no":{"type":"string","maxLength":30,"title":"コンテナID","description":"配送方法が `CONTAINER` の場合、返却されます。倉庫での入荷作業を円滑にしたり、トラブルの解決に必要な情報です。","example":"AAAU1234567"},"driver_info":{"title":"ドライバー情報","maxLength":500,"description":"ドライバーに関する補足情報を指定できます。チャーター便の会社名や運転手の連絡先などを倉庫へ共有するための情報です。\n配送方法が `CHARTER` または `CONTAINER` の場合、指定できます。","example":"株式会社oo 田中: 090-XXXX-XXXX"},"company_memo":{"type":"string","maxLength":255,"title":"入荷メモ","description":"ユーザー側で利用するメモ欄。倉庫には共有されません。","example":"キャンペーン用の商品です"},"items":{"type":"array","title":"入荷商品リスト","items":{"$ref":"#/components/schemas/schemas-ItemResponse"}},"warehouse":{"type":"string","maxLength":4,"title":"倉庫コード","description":"入荷先倉庫の識別子"},"warehouse_info":{"type":"object","title":"倉庫情報","description":"入荷商品の送付先の情報","additionalProperties":false,"properties":{"postcode":{"type":"string","title":"郵便番号","description":"入荷商品の送付先郵便番号","example":"170-0013"},"address":{"type":"string","title":"住所","description":"入荷商品の送付先住所","example":"東京都 豊島区東池袋1-34-5 いちご東池袋ビル9F"},"name":{"type":"string","title":"倉庫名","description":"入荷商品の送付先宛名","example":"XXX倉庫"}},"externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/37"}},"created_at":{"type":"string","format":"date-time","title":"入荷作成日時","example":"2019-04-01T12:00:00+09:00"},"create_user":{"type":"object","title":"入荷依頼者","description":"当該入荷依頼を作成したユーザー情報","required":["name"],"properties":{"name":{"type":"string","title":"入荷依頼者名"}},"example":{"name":"オープン太郎"}}}},"ShipmentReturn":{"type":"object","properties":{"shipment_return":{"type":"boolean","title":"返品フラグ","description":"`true`の場合、返品によって作成された入荷依頼となります。\n返品された荷物は倉庫側で返品登録および再入荷が行われ、自動で在庫に戻ります。","example":false,"externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/14"}}}},"ItemReceivedResponse":{"type":"object","properties":{"received":{"type":"integer","title":"入荷実績数","description":"実際に入荷された件数です。\n\n不明商品を配送可在庫に戻して、倉庫で追加検品された場合、この入荷実績数に追加されます。\n不良商品の場合は新規で入荷依頼が作成されるため、この入荷実績数には追加されません。","example":1,"externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/218"}}}},"WarehousingIndexResponse":{"type":"object","required":["warehousings"],"properties":{"warehousings":{"title":"入荷依頼情報一覧","description":"入荷作業が未完了の入荷依頼情報を配列で返却します。","type":"array","items":{"allOf":[{"$ref":"#/components/schemas/WarehousingResponse"},{"$ref":"#/components/schemas/ShipmentReturn"},{"type":"object","properties":{"items":{"type":"array","description":"入荷商品リスト","items":{"allOf":[{"$ref":"#/components/schemas/schemas-ItemResponse"},{"$ref":"#/components/schemas/ItemReceivedResponse"}]}}}}]}}}},"schemas-ItemRequest":{"type":"object","title":"入荷商品","required":["code","quantity"],"additionalProperties":false,"properties":{"code":{"type":"string","title":"商品コード","description":"商品登録時に指定した商品コード","example":"sword-001"},"quantity":{"type":"integer","maximum":999999999,"title":"数量","example":1}}},"WarehousingRequest":{"type":"object","description":"入荷依頼情報","required":["arrival_date","inspection_type","items"],"additionalProperties":false,"properties":{"inspection_type":{"type":"string","enum":["ID","NAME","CODE","BARCODE","LABEL"],"title":"検品タイプ","description":"倉庫に届いた商品を検品する方法。\n\n- `ID`: オープンロジ商品ID\n- `NAME`: 商品名\n- `CODE`: 商品コード\n- `BARCODE`: 管理バーコード\n- `LABEL`: オープンロジ商品ラベル","example":"CODE","externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/11"}},"items":{"type":"array","minItems":1,"maxItems":25,"uniqueItems":true,"title":"入荷商品リスト","description":"入荷する商品情報を指定します。同梱物も通常の商品と同様に指定します。","items":{"$ref":"#/components/schemas/schemas-ItemRequest"}},"arrival_date":{"type":"string","format":"date","title":"倉庫着予定日","description":"倉庫に該当の入荷が着荷する予定日です。未定の場合は、おおよその日付を指定します。","example":"2019-04-22"},"arrival_date_confirmed":{"type":"boolean","title":"確定情報として登録","description":"倉庫着予定日が確定されていれば`true`を指定してください。\n\n以下の場合は、大量入荷として入荷完了までに着荷日を除く2営業日以上かかる場合があります。\n- 商品数量が200点以上\n- 100サイズ以上の商品が20点以上\n\n大量入荷になる場合は、必ず倉庫到着予定日の2日前までに、倉庫着予定日を確定情報として登録した上で入荷依頼を作成してください。","example":true,"externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/57"}},"arrival_time_from":{"type":"integer","minimum":0,"maximum":23,"title":"倉庫着予定時間(いつから)","description":"倉庫に該当の入荷が着荷する予定最短時刻です。","example":10},"arrival_time_to":{"type":"integer","minimum":0,"maximum":23,"title":"倉庫着予定時間(いつまで)","description":"倉庫に該当の入荷が着荷する予定最長時刻です。","example":13},"sales_method":{"type":"string","title":"販売方法","description":"入荷した商品を出荷する際の販売方法です。倉庫の作業計画を立てるために必要な情報です。\n\n- `INVENTORY`: 在庫販売\n- `RESERVATION`: 予約販売\n- `OTHER`: その他","example":"RESERVATION","enum":["INVENTORY","RESERVATION","OTHER"],"default":"INVENTORY"},"shipping_scheduled_date":{"type":"string","format":"date","title":"出荷予定日","description":"販売方法が `RESERVATION` の場合にのみ指定できます。倉庫の作業計画を立てるために必要な情報です。","example":"2019-04-29"},"warehouse":{"type":"string","nullable":true,"title":"倉庫コード","description":"入荷する倉庫をコードで指定します。未指定または null を指定した場合は、標準倉庫へ入荷されます。","example":"OPL"},"transport_mode":{"type":"string","title":"配送方法","description":"入荷する際の配送方法を指定します。\n\n- `\"\"` : 指定なし\n- `HOME_DELIVERY` : 宅配便\n- `CHARTER` : チャーター\n- `CONTAINER` : コンテナ","enum":["","HOME_DELIVERY","CHARTER","CONTAINER"],"default":"HOME_DELIVERY","externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/40"}},"identity_type":{"type":"string","title":"入荷特定項目","description":"※入荷ラベルなし入荷を利用するお客様のみ使用可能\n\n倉庫で入荷を特定する際のキーとなる項目を指定できます。\n許可された項目のみ指定できます。\n\n- `ID_OR_LABEL` : 入荷ラベル・ID\n- `SUPPLIER` : 発注先名。この値を指定し、`identity_values`を指定すると、倉庫側で発注先名を使用して入荷を特定します\n- `TRACKING_CODE` : お問い合わせ伝票番号。この値を指定し、`tracking_codes`を指定すると、倉庫側でお問い合わせ伝票番号を使用して入荷を特定します\n- `VEHICLE_CODE` : 車両番号。この値を指定し、`vehicle_code`を指定すると、倉庫側で車両番号を使用して入荷を特定します\n- `CONTAINER` : コンテナID。この値を指定し、`container_no`を指定すると、倉庫側でコンテナIDを使用して入荷を特定します","enum":["ID_OR_LABEL","SUPPLIER","TRACKING_CODE","VEHICLE_CODE","CONTAINER"],"default":"ID_OR_LABEL"},"identity_values":{"type":"array","title":"入荷特定情報","description":"※入荷ラベルなし入荷を利用するお客様のみ使用可能\n\n入荷特定項目に対応した値を指定できます。\n\n- 入荷特定項目が`ID_OR_LABEL`の場合は指定できません。\n- 入荷特定項目が`SUPPLIER`の場合、このパラメータに発注先名を指定すると、倉庫側で発注先名を使用して入荷を特定します。","items":{"type":"string","example":"株式会社オープンロジ"}},"tracking_codes":{"type":"array","title":"お問合せ伝票番号","description":"配送方法が `HOME_DELIVERY` または `\"\"` であれば、このパラメータを指定できます。\n\n倉庫での入荷作業を円滑にしたり、トラブルの解決に必要な情報です。","items":{"type":"string","example":"TrackingCode001"}},"vehicle_code":{"type":"string","maxLength":30,"title":"車両番号","description":"商品を倉庫へ送る際のチャーターやコンテナを載せる車両の番号を指定します。倉庫での入荷作業を円滑にしたり、トラブルの解決に必要な情報です。\n\n配送方法が `CHARTER` または `CONTAINER` の場合、指定できます。","example":"品川 100 あ ・・・1"},"vehicle_size":{"type":"string","title":"車両サイズ","description":"車両やコンテナのサイズを指定できます。倉庫での入荷作業を円滑にしたり、トラブルの解決に必要な情報です。\n\n配送方法が `CHARTER` または `CONTAINER` の場合、指定できます。\n\n- `UNDER_2T`: 2t以下\n- `4T`: 4t\n- `10T`: 10t\n- `20FT`: 20ft\n- `40FT`: 40ft","enum":["UNDER_2T","4T","10T","20FT","40FT"],"example":"4T"},"carrying_method":{"type":"string","title":"積載方法","description":"個口の積載方法を指定できます。\n配送方法が `CHARTER` または `CONTAINER` の場合、指定できます。\n\n- `PALETTE`: パレット\n- `BARA`: バラ積み","enum":["PALETTE","BARA"],"example":"PALETTE"},"container_no":{"type":"string","maxLength":30,"title":"コンテナID","description":"配送方法が `CONTAINER` の場合、指定できます。倉庫での入荷作業を円滑にしたり、トラブルの解決に必要な情報です。","example":"AAAU1234567"},"driver_info":{"type":"string","maxLength":500,"title":"ドライバー情報","description":"ドライバーに関する補足情報を指定できます。チャーター便の会社名や運転手の連絡先などを倉庫へ共有するための情報です。\n配送方法が `CHARTER` または `CONTAINER` の場合、指定できます。","example":"株式会社oo 田中: 090-XXXX-XXXX"},"company_memo":{"type":"string","maxLength":255,"title":"入荷メモ","description":"ユーザー側で利用するメモ欄。倉庫には共有されません。","example":"キャンペーン用の商品です"},"identifier":{"type":"string","maxLength":30,"title":"入荷依頼識別子","description":"ユーザーが入荷依頼をユニークに特定するための符号です。\nユーザーが任意に指定するものです。\n大文字・小文字のアルファベット、数字、一部の記号のみ利用可能です。","example":"Identifier-001"}}},"lotItemResponse":{"type":"object","title":"期限管理商品","required":["id","quantity"],"additionalProperties":false,"properties":{"id":{"type":"string","title":"商品ID","description":"※期限管理を利用するお客様のみ使用可能\n\nオープンロジに商品を登録した際に自動で生成され、商品ごとに割り当てられる固有のIDです。","example":"TS001-I00001","externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/220"}},"expiry_at":{"type":"string","format":"date","nullable":true,"title":"賞味期限","description":"※期限管理を利用するお客様のみ使用可能\n\n入荷作業時に倉庫で賞味期限を入力しています。","example":"2022-04-22"},"manufacture_date":{"type":"string","format":"date","nullable":true,"title":"製造年月日","description":"※期限管理を利用するお客様のみ使用可能\n\n入荷作業時に倉庫で製造年月日を入力しています。","example":"2022-04-22"},"lot_allocatable_at":{"type":"string","format":"date","nullable":true,"title":"引当期限日","description":"※期限管理を利用するお客様のみ使用可能\n\n賞味期限、製造年月日と商品情報の引当可能残期間から自動で計算された引当期限日です。","example":"2022-04-22"},"received":{"type":"integer","title":"入荷実績数","description":"※期限管理を利用するお客様のみ使用可能","example":1,"externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/218"}}}},"caseItemResponse":{"type":"object","title":"ケース入荷情報","required":["quantity_in_case","quantity"],"additionalProperties":false,"properties":{"quantity_in_case":{"type":"integer","title":"ケース入り数","description":"※ケース入出荷機能を利用するお客様のみ使用可能\n\n端数となってピースとして入荷された場合は1となります。","example":10},"quantity":{"type":"integer","title":"ケース数","description":"※ケース入出荷機能を利用するお客様のみ使用可能\n\n端数となってピースとして入荷された場合はピース数となります。","example":3}}},"WarehousingResponseWithWarehousedData":{"allOf":[{"$ref":"#/components/schemas/WarehousingResponse"},{"$ref":"#/components/schemas/ShipmentReturn"},{"type":"object","properties":{"items":{"type":"array","description":"入荷商品リスト","items":{"allOf":[{"$ref":"#/components/schemas/schemas-ItemResponse"},{"$ref":"#/components/schemas/ItemReceivedResponse"},{"type":"object","properties":{"lot_items":{"type":"array","description":"※期限管理を利用するお客様のみ使用可能","items":{"$ref":"#/components/schemas/lotItemResponse"},"externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/210"}}}},{"type":"object","properties":{"cases":{"type":"array","description":"※ケース入出荷機能を利用するお客様のみ使用可能","items":{"$ref":"#/components/schemas/caseItemResponse"}}}},{"type":"object","properties":{"warehoused_count":{"type":"integer","title":"入荷総数","description":"入荷実績数に不良商品数を合算した入荷総数","example":1,"externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/39"}}}}]}}}}]},"DeliveryOption":{"type":"object","nullable":true,"title":"受取人からの希望","description":"受取人からの希望","properties":{"box_delivery":{"type":"boolean","title":"不在時宅配ボックス","description":"「不在時宅配ボックス」を指示したい場合は`true`を指定します。","example":true},"fragile_item":{"type":"boolean","title":"割れ物注意","description":"「割れ物注意」を指示したい場合は`true`を指定します。","example":true}},"externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/221"}},"components-schemas-ItemResponse":{"type":"object","required":["code"],"properties":{"id":{"type":"string","title":"商品ID","example":"TS001-I000004","externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/284#item_id"}},"name":{"type":"string","maxLength":255,"title":"納品書 商品名","description":"同梱明細書に記載したい商品名。出荷依頼作成時に指定します。\n\n出荷依頼作成時に何も指定しない場合は、商品マスタに登録されている商品名が同梱明細書に記載されます。","example":"勇者の盾"},"code":{"type":"string","title":"商品コード","description":"商品登録時に指定した商品コード。出荷依頼作成時に指定します。","example":"item-001"},"quantity":{"type":"integer","minimum":1,"maximum":999999999,"title":"数量","description":"出荷する商品点数。出荷依頼作成時に指定します。","example":1},"unit_price":{"title":"納品書 単価","nullable":true,"description":"同梱明細書に記載する「単価」。出荷依頼作成時に指定します。\n\n商品マスタに登録されている商品価格は自動入力されません。","example":1000},"price":{"title":"納品書 金額","description":"同梱明細書に記載される「金額」。出荷依頼作成時に指定します。\n\n指定した値が同梱明細書に記載されます。計算の整合性のチェックは行われず、空欄の場合に自動計算、補完もされません。","nullable":true,"example":1000},"is_reduced_tax":{"type":"boolean","title":"軽減税率適用商品","description":"軽減税率が適用される商品の場合は`true`を指定します。\n\n何も指定しない場合は、商品マスタに登録されている軽減税率適用商品の設定が適用されます。","example":true},"hs_code":{"type":"string","pattern":"^\\d{4}\\.?\\d{2}((\\.|-)?\\d{3,4})?$","title":"HSコード","description":"海外へ発送する場合の商品のHSコード。出荷依頼作成時に指定します。","example":"000000.000","externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/249"}},"gift_wrapping_type":{"type":"string","nullable":true,"enum":["NAVY","RED"],"title":"ギフトラッピングタイプ","description":"商品単位に指定するラッピングタイプ。出荷依頼作成時に指定します。\n\n- `NAVY`: ネイビー\n- `RED`: レッド","externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/30"}},"cushioning_type":{"type":"string","nullable":true,"enum":["BUBBLE_PACK","BUBBLE_DOUBLE_PACK"],"title":"緩衝材種別","description":"商品単位に指定する緩衝材の種別。出荷依頼作成時に指定します。\n\n- `BUBBLE_PACK`: プチプチ\n- `BUBBLE_DOUBLE_PACK`: プチプチ2重\n","example":"BUBBLE_PACK","externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/62"}},"backordered":{"type":"boolean","title":"入荷待ちフラグ","description":"`backorder_if_unavailable`を指定している場合に、在庫不足となっている商品に対して`true`となります。\n\n倉庫で出荷作業できるようにするには、このフラグが`true`のすべての商品を入荷する必要があります。","example":false}}},"Package":{"oneOf":[{"title":"国内配送","type":"object","required":["size"],"properties":{"size":{"type":"string","title":"個口サイズ","description":"`S`, `60`などで表現する個口サイズ","example":"S","externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/239"}}}},{"title":"海外配送","type":"object","required":["size","weight","tracking_code"],"properties":{"size":{"type":"string","title":"個口サイズ","description":"`S`, `60`などで表現する個口サイズ","example":"120","externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/239"}},"weight":{"type":"integer","title":"重量（グラム）","description":"グラム単位での個口の重量","example":1000},"tracking_code":{"type":"string","title":"伝票番号（追跡番号）","example":"EL999999999JP"}}}]},"ActualCase":{"type":"object","properties":{"quantity_in_case":{"type":"string","description":"ケース入り数（ピース実績の場合は1）","example":10},"quantity":{"type":"integer","description":"ケース数（ピース実績の場合はピース数）","example":2}}},"ActualCases":{"type":"object","title":"ケース実績情報詳細","description":"※ケース入出荷機能を利用するお客様のみ使用可能","properties":{"item_id":{"type":"string","title":"商品ID","example":10},"details":{"type":"array","title":"明細","items":{"$ref":"#/components/schemas/ActualCase"}}}},"ActualShipmentToOverseas":{"type":"object","properties":{"international":{"type":"boolean","title":"海外配送フラグ","description":"海外配送の場合に`true`となります。","example":true},"currency_code":{"type":"string","enum":["JPY","USD","CNY","EUR","GBP","IDR","AUD"],"title":"通貨コード","description":"海外配送の場合に適用される通貨","example":"USD"},"letter_of_attorney":{"type":"boolean","default":false,"title":"通関委任状の代理発行","description":"日本郵便株式会社に対し通関委任状（輸出）の発行を行った場合は、`true`となります。","example":false,"externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/10"}},"insurance":{"type":"boolean","title":"海外発送用損害保証制度の加入希望","description":"海外配送の場合に、損害保証制度の加入希望がある場合は`true`となります。","example":false,"externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/10"}},"purpose":{"type":"string","enum":["GIFT","DOCUMENTS","COMMERCIAL_SAMPLE","SALE_OF_GOODS","RETURNED_GOODS","OTHERS"],"title":"輸出目的","description":"EMS/DHL/Fedexの場合に指定します。\n輸出目的が指す品目と実際の商品とが異なる場合には、通関手続きができない場合があります。\n\n未指定の場合、【管理画面】 > 【設定】> 【配送情報】> 【配送設定】 > 「輸出目的設定」で選択した項目が適用されます。\n\n- `GIFT` : 贈物\n- `DOCUMENTS` : 書類\n- `COMMERCIAL_SAMPLE` : 商品見本\n- `SALE_OF_GOODS` : 販売品\n- `RETURNED_GOODS` : 返送品\n- `OTHERS` : その他\n","example":"SALE_OF_GOODS"},"duty_paid":{"type":"boolean","title":"DDP (Deliver Duty Paid)","description":"海外配送の場合に、ユーザーが関税を支払う義務がある場合に`true`になります。"},"vat_number":{"type":"string","title":"VAT番号","description":"海外配送の場合に、付加価値税処理に必要な登録番号","externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/257"}},"eori_number":{"type":"string","title":"EORI番号","description":"海外配送の場合に、EUにおける輸入・輸出を行う際のEU内での登録及び識別番号","externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/257"}},"tax_number":{"type":"string","title":"納税者番号","minLength":2,"maxLength":30,"description":"一部の海外配送先の場合に、インボイスに記載が必要となる納税者番号","externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/257"}}}},"Address":{"type":"object","title":"国内出荷","required":["postcode","prefecture","address1","name"],"properties":{"postcode":{"type":"string","pattern":"^\\d{3}-?\\d{4}$","title":"郵便番号","description":"日本郵便から提供される郵便番号マスタに収録されている必要があります。\n\n- 末尾が0000の郵便番号はその他地域扱いとなるため、ご利用できません\n- 事業所個別の郵便番号 はご利用できません\n- ハイフンは任意です","example":1700013},"name":{"type":"string","title":"氏名","description":"半角、全角区別なく15文字以内の文字数制限があります。\n**超過した16文字目以降は切り捨てられます。**","example":"open 太郎"},"phone":{"type":"string","minLength":10,"maxLength":13,"nullable":true,"title":"電話番号","description":"電話番号の形式は以下のとおりです。\n- 0で始まる\n- 10~13文字\n- ハイフンは文字数に含まれません","example":"03-3333-3333"},"prefecture":{"type":"string","title":"都道府県","example":"東京都"},"address1":{"type":"string","maxLength":64,"title":"住所","description":"市区町村から始まるマンション・ビル名を除く住所。\n\n`address1`と`address2`を合わせた住所に対して、市・区を除いて全角32文字、半角64文字以内にしてください。","example":"豊島区東池袋1-34-5"},"address2":{"type":"string","maxLength":64,"nullable":true,"title":"マンション・ビル名","description":"`address1`と`address2`を合わせた住所に対して、市・区を除いて全角32文字、半角64文字以内にしてください。","example":"いちご東池袋ビル9F"},"company":{"type":"string","nullable":true,"title":"会社名","description":"半角、全角区別なく16文字以内の文字数制限があります。\n**超過した17文字目以降は切り捨てられます。**","example":"スライム株式会社"},"division":{"type":"string","maxLength":255,"nullable":true,"title":"部署","example":"メタル部"}}},"Sender":{"type":"object","properties":{"sender":{"type":"object","title":"発送元住所","description":"省略時は管理画面でデフォルトの依頼主に設定されている情報が使われます。","allOf":[{"$ref":"#/components/schemas/Address"},{"type":"object","properties":{"name":{"type":"string","maxLength":15},"company":{"type":"string","maxLength":16,"nullable":true}}}]}}},"InternationalAddress":{"type":"object","title":"海外出荷","required":["region_code","postcode","city","address","name","phone"],"properties":{"region_code":{"type":"string","pattern":"^[A-Z][A-Z](-[A-Z]+)?$","title":"国コード","description":"国コード（ISO 3166-1）を指定します。\n\nEMSの場合は、国コード情報APIを参照してください。\n\n配送キャリアごとに国コードの取り扱いを別途ご確認ください。","example":"AU"},"postcode":{"type":"string","maxLength":10,"title":"郵便番号","description":"郵便番号がない国の場合は、`---`と指定してください。","example":94043},"name":{"type":"string","maxLength":255,"title":"氏名","example":"open太郎"},"phone":{"type":"string","maxLength":40,"title":"電話番号","example":"03-3333-3333"},"city":{"type":"string","maxLength":100,"title":"都市名","example":"Mountain View, CA"},"address":{"type":"string","maxLength":255,"title":"住所","example":"1600 Amphitheatre Parkway"}}},"Recipient":{"type":"object","properties":{"recipient":{"type":"object","title":"発送先住所","description":"発送先住所 (海外出荷の場合は`region_code`を指定する必要が有ります)","oneOf":[{"allOf":[{"$ref":"#/components/schemas/Address"},{"type":"object","properties":{"name":{"type":"string","maxLength":15},"company":{"type":"string","maxLength":16,"nullable":true}}}]},{"$ref":"#/components/schemas/InternationalAddress"}]}}},"GetShipmentResponse":{"allOf":[{"type":"object","required":["id"],"properties":{"id":{"type":"string","title":"出荷ID","description":"オープンロジで出荷依頼を作成した際に自動で生成され、出荷依頼ごとに割り当てられる固有のIDです。","example":"TS001-S000001","externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/269"}},"identifier":{"type":"string","minLength":1,"maxLength":100,"nullable":true,"title":"識別番号","description":"ユーザーが出荷依頼をユニークに識別するための符号です。\nユーザーが任意に指定します。\n\n出荷依頼を作成する場合は、`identifier` と `order_no` のいずれかが必須となります。","example":"2015-00001"},"order_no":{"type":"string","minLength":1,"maxLength":100,"nullable":true,"title":"注文番号","description":"ECサイトなどの注文に紐づくユニークな固有の符号です。\n同梱明細書の「注文番号」に印刷されます。\n\n出荷依頼を作成する場合は、`identifier` と `order_no` のいずれかが必須となります。\n","externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/289"},"example":"#12345-67890"},"subtotal_amount":{"title":"納品書 小計","description":"同梱明細書に記載される「小計」。出荷依頼作成時に指定します。\n計算の整合性のチェックは行われず、空欄の場合に自動計算、補完もされません。","nullable":true,"example":1000},"delivery_charge":{"title":"納品書 配送料","description":"同梱明細書に記載される「配送料」。出荷依頼作成時に指定します。","nullable":true,"example":500},"handling_charge":{"title":"納品書 手数料","description":"同梱明細書に記載される「手数料」。出荷依頼作成時に指定します。","nullable":true,"example":0},"discount_amount":{"title":"納品書 割引額","description":"同梱明細書に記載される「割引額」。出荷依頼作成時に指定します。","nullable":true,"example":0},"total_amount":{"title":"納品書 合計","description":"同梱明細書に記載される「合計」。出荷依頼作成時に指定します。\n計算の整合性のチェックは行われず、空欄の場合に自動計算、補完もされません。","nullable":true,"example":1500},"cushioning_unit":{"type":"string","nullable":true,"enum":["ORDER","ITEM"],"title":"緩衝材単位","description":"注文単位、もしくは商品単位で緩衝材指定します。緩衝材は有料オプションで別途料金が発生します。\n\n- `ORDER`: 注文単位\n- `ITEM`: 商品単位","example":"ORDER","externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/62"}},"cushioning_type":{"type":"string","nullable":true,"enum":["BUBBLE_PACK","BUBBLE_DOUBLE_PACK"],"title":"緩衝材種別","description":"緩衝材単位を注文単位で利用する場合に指定します。\n「注文単位」を指定した場合は、緩衝材種別を下記から指定してください。\n\n- `BUBBLE_PACK`: プチプチ\n- `BUBBLE_DOUBLE_PACK`: プチプチ2重\n","example":"BUBBLE_PACK","externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/62"}},"gift_wrapping_unit":{"type":"string","nullable":true,"enum":["ORDER","ITEM"],"title":"ギフトラッピング単位","description":"注文単位、もしくは商品単位でラッピングします。ギフトラッピングは有料オプションで別途料金が発生します。\n\n- `ORDER`: 注文単位\n- `ITEM`: 商品単位","example":"ITEM","externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/30"}},"gift_wrapping_type":{"type":"string","nullable":true,"enum":["NAVY","RED"],"title":"ギフトラッピングタイプ","description":"ギフトラッピング単位を注文単位で利用する場合に、ラッピングの色を指定します。\n「注文単位」でラッピングする場合は、ギフトラッピングタイプを下記から指定します。\n\n- `NAVY`: ネイビー\n- `RED`: レッド","externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/30"}},"gift_sender_name":{"type":"string","nullable":true,"title":"ギフト贈り主氏名","description":"同梱明細書や送り状の「贈り主」欄に記載される名前を指定します。","example":"オープン太郎"},"bundled_items":{"type":"array","minItems":1,"maxItems":5,"uniqueItems":true,"nullable":true,"title":"同梱指定","description":"同梱物の商品IDまたは商品コード (重複のない5つまで指定できます)。","items":{"type":"string","example":"TS001-I000001"}},"fba_shipment_id":{"type":"string","title":"FBA納品番号","description":"FBA納品向けの出荷の場合に、FBA納品番号がセットされます。","example":"FBA123456789","nullable":true},"shipping_email":{"type":"string","format":"email","nullable":true,"title":"配送先連絡メールアドレス","description":"お届け先へお荷物発送のお知らせメールを送信したい場合に指定します。\n\n指定されたメールアドレス宛に「お荷物発送のお知らせ」メールをオープンロジドメインから自動送信します。\nこの項目が未指定または `null` の場合は、「発送通知メッセージ」が無効になります。","example":"test@example.com","externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/81"}},"delivery_note_type":{"type":"string","nullable":true,"enum":["NOT_INCLUDE_PII","NONE"],"title":"明細書の同梱設定","description":"明細書を同梱するかしないかを指定します。\n\n値がない場合は、出荷設定の同梱明細書の同梱設定に従います。\n\n- `NOT_INCLUDE_PII`: 住所非表示の明細書を同梱する\n- `NONE`: 同梱しない\n","example":"NOT_INCLUDE_PII","externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/70"}},"price_on_delivery_note":{"type":"boolean","nullable":true,"title":"明細書への金額印字指定","description":"明細書に金額を印字するかしないかを指定します。\n\n- `true`\n - 明細書へ金額を印字する（この指定が他の設定よりも優先されます）\n- `false`\n - 明細書へ金額を印字しない（この指定が他の設定よりも優先されます）\n- `null` または 未指定\n - 管理画面の設定（【出荷設定】 > 【その他設定】 > 「同梱明細書の金額印字」）に従います。ただし、ギフトラッピングの場合は管理画面の設定に関わらず印字しません。","example":true,"externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/225"}},"message":{"type":"string","maxLength":500,"nullable":true,"title":"明細書メッセージ","description":"同梱明細書に記載するメッセージです。\n\n依頼主マスタで設定している明細書メッセージを上書きする場合に利用します。\nただし、依頼主UUID（`sender.uuid`）を指定した出荷依頼の場合は、`message`での上書きはできません。","example":"お買上げありがとうございます。"},"status":{"type":"string","enum":["backordered","allocating","waiting","working","picking","picked","packed","shipped","suspended","modify_request","cancel_request"],"description":"出荷ステータス\n\n`backordered` : 入荷待ち\n\n`allocating` : 引当中(`X-Api-Version` が `1.3` の場合)\n\n`waiting` : 引当済\n\n`working` : ピッキング中または検品済(`X-Api-Version` が `1.3` の場合)\n\n`picking` : ピッキング中(`X-Api-Version` が `1.4` 以降の場合)\n\n`picked` : 検品済(`X-Api-Version` が `1.4` 以降の場合)\n\n`packed` : 梱包済\n\n`shipped` : 出荷済\n\n`suspended` : 保留\n\n`modify_request` : 変更依頼中\n\n`cancel_request` : キャンセル依頼中\n","example":"waiting"},"suspend":{"type":"boolean","title":"保留フラグ","description":"`true`は、出荷作業が開始されない保留状態を表します。\n\n保留状態の出荷依頼は、保留解除しない限り出荷作業が開始されません。\nただし、保留状態の出荷依頼にも在庫は引き当てられます。\n\n出荷作業を開始したくない場合に、出荷依頼時に`true`を指定します。\n保留状態を解除するには、[出荷依頼更新](#tag/shipments/operation/putShipment)を利用してください。","default":false,"example":false,"externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/213"}},"label_note":{"type":"string","title":"品名","description":"国内配送の送り状に記載される商品種別。\n\n出荷依頼作成時に、デフォルト品名（【出荷設定】 > 【その他設定】 > 「品名設定」）が未設定の場合に必須です。\n設定済みの場合は、その値が自動で使用されます。\n","example":"玩具","externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/21"}},"shipping_date":{"type":"string","format":"date","title":"出荷希望日","description":"指定された日付以降に倉庫で出荷作業が行われます。倉庫の作業状況次第では希望日の翌日以降での出荷となる場合があります。\n\nお届け希望日を指定したい場合は、`delivery_date`をご利用ください。\n`delivery_date`と同時に指定された場合、「`shipping_date` < `delivery_date` <= `shipping_date` + 7日（クール便は3日）」を満たす必要があります。","example":"2019-04-02","externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/203"}},"assigned_shipping_date":{"type":"string","format":"date","title":"発送予定日","description":"配送会社へ引き渡す予定の日付で、変動する場合があります。","example":"2019-04-02"},"tax_included":{"type":"boolean","title":"税込みフラグ","description":"商品の登録価格、出荷明細の表示金額が税込み（`true`)か税抜き（`false`)かを表します。\n出荷依頼作成時の【出荷】 > 【出荷設定】 > 【その他設定】 > 「消費税設定」の設定内容が反映されます。","example":true},"tax":{"type":"integer","maximum":999999999,"title":"消費税","description":"同梱明細書に記載される「消費税」。出荷依頼作成時に指定します。\n\n【出荷】 > 【出荷設定】 > 【その他の設定】 > 「消費税設定」が「税抜」の場合にだけ、指定します。","nullable":true,"example":100},"total_with_normal_tax":{"type":"integer","maximum":999999999,"title":"合計通常税率","description":"「合計」のうち消費税10%が適用される金額。出荷依頼作成時に指定します。\n\n「軽減税率適用商品」が含まれる場合のみ、指定した値が同梱明細書に記載されます。計算の整合性のチェックは行われず、空欄の場合に自動計算、補完もされません。","example":1000},"total_with_reduced_tax":{"type":"integer","maximum":999999999,"title":"合計軽減税率","description":"「合計」のうち軽減税率の消費税8%が適用される金額。出荷依頼作成時に指定します。\n\n「軽減税率適用商品」が含まれる場合のみ、指定した値が同梱明細書に記載されます。計算の整合性のチェックは行われず、空欄の場合に自動計算、補完もされません。","example":500},"delivery_carrier":{"type":"string","nullable":true,"enum":["YAMATO","SAGAWA"],"title":"配送会社","description":"配送会社を指示したい場合に指定します。\n\n国内発送の場合に指定でき、指定すると別途料金が発生します。\n\n- `YAMATO`: ヤマト運輸\n- `SAGAWA`: 佐川急便\n","example":"YAMATO","externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/67"}},"delivery_time_slot":{"type":"string","nullable":true,"enum":["AM","12","14","16","18","19"],"title":"希望時間指定","description":"国内発送の場合に、配達の時間帯を指示したい場合に指定します。\n\n- `AM`: 午前中\n- `12`: 12時〜14時（佐川急便のみ指定可能）\n- `14`: 14時〜16時\n- `16`: 16時〜18時\n- `18`: 18時〜20時\n- `19`: 19時〜21時\n","example":"AM","externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/75"}},"delivery_date":{"type":"string","format":"date","nullable":true,"title":"配達希望日","description":"国内発送の場合に、お届け希望日を指示したい場合に指定します。\n\n出荷作業の開始日を指定したい場合は、`shipping_date`をご利用ください。\n","example":"2019-04-05","externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/96"}},"delivery_day":{"type":"string","format":"date","nullable":true,"title":"お届け予定日","description":"出荷前、海外や離島へのお届けの場合に`null`（お届け予定なし）となります。","example":"2019-04-05"},"cash_on_delivery":{"type":"boolean","title":"代金引換指定","description":"`true`を指定したときだけ代金引換となります。代金引換を利用する場合は、事前に配送会社とサービス契約している必要があります。","default":false,"example":false},"total_for_cash_on_delivery":{"type":"integer","maximum":999999999,"title":"代金引換総計","description":"配送先に請求する、消費税や送料、手数料なども含めた代引きの請求金額。出荷依頼作成時に指定します。\n代金引換の場合のみ指定します。","example":1100},"tax_for_cash_on_delivery":{"type":"integer","maximum":999999999,"title":"代金引換消費税","description":"代金引換総計のうち、消費税に当たる金額。出荷依頼作成時に指定します。\n代金引換の場合のみ指定します。","example":100},"delivery_method":{"type":"string","nullable":true,"enum":["POST_EXPRESS","HOME_BOX"],"title":"配送便指定","description":"SSサイズの商品、入荷実績のない商品で「配送便」を指定したい場合に指定します。\nSSサイズの商品のみ、かつポスト便のサイズに収まった場合に、このパラメータの省略時には`POST_EXPRESS`が設定されます。\n\n- `POST_EXPRESS`: ポスト便 (宅配便スピード)での配送 (SSサイズの商品で指定可能)\n- `HOME_BOX`: 宅配便 (段ボール梱包)での配送\n","example":"HOME_BOX","externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/212"}},"delivery_options":{"$ref":"#/components/schemas/DeliveryOption"},"bundle_shipping_label":{"type":"string","nullable":true,"enum":[null,"FREIGHT_COLLECT","FREIGHT_PREPAID"],"title":"引き取り交換ラベル","description":"引き取り交換の希望内容を指定します。\n\n- `null`: 引き取り交換ではない出荷依頼\n- `FREIGHT_COLLECT`: 着払い伝票を同梱した交換のための出荷依頼\n- `FREIGHT_PREPAID`: 元払い伝票を同梱した交換のための出荷依頼"},"warehouse":{"type":"string","title":"倉庫コード","description":"出荷作業が行われる倉庫のコード","example":"OPL"},"shipment_return":{"type":"boolean","title":"返品フラグ","description":"返品によって作成された出荷依頼かどうかを示します。\n返品された荷物は倉庫側で返品登録および再入荷が行われ、自動で在庫に戻ります。\n再出荷用の出荷依頼は自動で作成されます。","example":true,"externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/14"}},"items":{"type":"array","title":"配送商品リスト","items":{"$ref":"#/components/schemas/components-schemas-ItemResponse"}},"assigned_temperature_zone":{"type":"string","enum":["chilled","frozen"],"title":"温度帯","description":"クール便の場合の温度帯。出荷商品の保管温度帯によって自動で指定されます。\n\n- `chilled`: 冷蔵\n- `frozen`: 冷凍","example":"frozen","externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/267"}},"allocate_priority":{"type":"integer","minimum":0,"maximum":100,"title":"引当優先順位","description":"出荷依頼に対して、出荷の商品単位で配送可在庫を確保する処理（引当）をオープンロジで行なっています。\n数字が大きいほど、優先的に引当されます。","example":0,"externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/294"}},"shipped_at":{"type":"string","format":"date-time","title":"出荷完了日時","description":"出荷された（倉庫から発送された）日時","example":"2025-02-01T18:00:00+09:00"},"tracking_code":{"type":"string","title":"伝票番号（追跡番号）略式","description":"`tracking_codes`のうち、任意の1つの伝票番号（追跡番号）の値","example":"123456789012"},"tracking_codes":{"type":"array","title":"伝票番号（追跡番号）","description":"伝票番号（追跡番号）の配列","items":{"type":"string"},"example":["123456789012","135791113170"]},"url":{"type":"string","nullable":true,"format":"uri","title":"配送状況取得URL","description":"伝票番号（追跡番号）を利用して、配送状況を確認するためのURL","example":"http://example.com/"},"delivery_service":{"type":"string","title":"配送サービス","description":"出荷時に利用する配送方法を指定します。\n\n佐川急便\n - `SAGAWA-HIKYAKU-YU-PACKET`: 佐川急便 飛脚ゆうパケット\n - `SAGAWA-TAKUHAIBIN`: 佐川急便 宅配便\n - `SAGAWA-COOLBIN`: 佐川急便 飛脚クール便\n\nヤマト運輸\n - `YAMATO-NEKOPOSU`: ヤマト運輸 ネコポス\n - `YAMATO-TAKKYUBIN`: ヤマト運輸 宅急便\n - `YAMATO-COOLBIN`: ヤマト運輸 クール便\n\n日本郵便\n - `JAPANPOST-EMS`: EMS\n - `JAPANPOST-EPACKET`: 小形包装物 書留（サービス終了済み）\n - `JAPANPOST-YU-PACKET`: 日本郵便 ゆうパケット\n\nFedex\n - `FEDEX-PRIORITY`: FedEx International Priority\n - `FEDEX-CONNECT-PLUS`: FedEx International Connect Plus\n\nDHL\n - `DHL-EXPRESS`: DHL Express","enum":["SAGAWA-HIKYAKU-YU-PACKET","SAGAWA-TAKUHAIBIN","SAGAWA-COOLBIN","YAMATO-NEKOPOSU","YAMATO-TAKKYUBIN","YAMATO-COOLBIN","JAPANPOST-EMS","JAPANPOST-EPACKET","JAPANPOST-YU-PACKET","FEDEX-PRIORITY","FEDEX-CONNECT-PLUS","DHL-EXPRESS"],"example":"YAMATO-TAKKYUBIN"},"package_quantity":{"type":"integer","title":"個口数","description":"発送された個口数","example":1},"packages":{"type":"array","title":"個口実績情報詳細","description":"発送された各個口の詳細情報","items":{"$ref":"#/components/schemas/Package"}},"cases":{"$ref":"#/components/schemas/ActualCases"}}},{"$ref":"#/components/schemas/ActualShipmentToOverseas"},{"$ref":"#/components/schemas/Sender"},{"$ref":"#/components/schemas/Recipient"}]},"PaginatedShipmentsResponse":{"title":"v1.6（ページネーションあり）","type":"object","required":["shipments","metadata"],"properties":{"shipments":{"type":"array","title":"出荷依頼一覧","description":"出荷IDの昇順で出荷依頼の一覧を返却します。","minItems":0,"items":{"$ref":"#/components/schemas/GetShipmentResponse"}},"metadata":{"type":"object","title":"メタデータ","description":"レスポンスのメタデータ","required":["page"],"properties":{"page":{"$ref":"#/components/schemas/PagingInfo"}}}}},"EmptyPagingInfo":{"type":"object","title":"ページ情報","description":"ページを制御するための情報が入ります","required":["next_cursor","has_more"],"properties":{"next_cursor":{"type":"string","nullable":true,"enum":[null],"title":"カーソル","description":"常に`null`となります"},"has_more":{"type":"boolean","enum":[false],"title":"次ページ有無","description":"常に`false`となります"}},"example":{"next_cursor":null,"has_more":false}},"components-schemas-ItemRequest":{"title":"商品情報","type":"object","required":["code","quantity"],"properties":{"name":{"type":"string","maxLength":255,"title":"納品書 商品名","description":"同梱明細書に記載したい商品名。出荷依頼作成時に指定します。\n\n出荷依頼作成時に何も指定しない場合は、商品マスタに登録されている商品名が同梱明細書に記載されます。","example":"勇者の盾"},"code":{"type":"string","title":"商品コード","description":"商品登録時に指定した商品コード。出荷依頼作成時に指定します。","example":"item-001"},"quantity":{"type":"integer","minimum":1,"maximum":999999999,"title":"数量","description":"出荷する商品点数。出荷依頼作成時に指定します。","example":1},"unit_price":{"title":"納品書 単価","nullable":true,"description":"同梱明細書に記載する「単価」。出荷依頼作成時に指定します。\n\n商品マスタに登録されている商品価格は自動入力されません。","example":1000},"price":{"title":"納品書 金額","description":"同梱明細書に記載される「金額」。出荷依頼作成時に指定します。\n\n指定した値が同梱明細書に記載されます。計算の整合性のチェックは行われず、空欄の場合に自動計算、補完もされません。","nullable":true,"example":1000},"is_reduced_tax":{"type":"boolean","title":"軽減税率適用商品","description":"軽減税率が適用される商品の場合は`true`を指定します。\n\n何も指定しない場合は、商品マスタに登録されている軽減税率適用商品の設定が適用されます。","example":true},"hs_code":{"type":"string","pattern":"^\\d{4}\\.?\\d{2}((\\.|-)?\\d{3,4})?$","title":"HSコード","description":"海外へ発送する場合の商品のHSコード。出荷依頼作成時に指定します。","example":"000000.000","externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/249"}},"gift_wrapping_type":{"type":"string","nullable":true,"enum":["NAVY","RED"],"title":"ギフトラッピングタイプ","description":"商品単位に指定するラッピングタイプ。出荷依頼作成時に指定します。\n\n- `NAVY`: ネイビー\n- `RED`: レッド","externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/30"}},"cushioning_type":{"type":"string","nullable":true,"enum":["BUBBLE_PACK","BUBBLE_DOUBLE_PACK"],"title":"緩衝材種別","description":"商品単位に指定する緩衝材の種別。出荷依頼作成時に指定します。\n\n- `BUBBLE_PACK`: プチプチ\n- `BUBBLE_DOUBLE_PACK`: プチプチ2重\n","example":"BUBBLE_PACK","externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/62"}},"backorder_if_unavailable":{"title":"商品単位の出荷予約フラグ","type":"boolean","default":false,"description":"在庫不足時、出荷予約として出荷依頼を作成できるようにします。商品単位の指定よりも、出荷単位の指定が優先されます。","example":true}}},"InternationalSenderAddress":{"type":"object","title":"海外出荷","required":["postcode","prefecture","address1","name","company","phone"],"properties":{"postcode":{"type":"string","pattern":"^\\d{3}-?\\d{4}$","title":"郵便番号"},"prefecture":{"type":"string","maxLength":9,"title":"都道府県"},"address1":{"type":"string","maxLength":64,"title":"住所"},"address2":{"type":"string","maxLength":64,"nullable":true,"title":"マンション・ビル名"},"name":{"type":"string","maxLength":255,"title":"氏名"},"company":{"type":"string","maxLength":255,"nullable":true,"title":"会社名"},"division":{"type":"string","maxLength":255,"nullable":true,"title":"部署名"},"phone":{"type":"string","maxLength":20,"title":"電話番号"}}},"SenderID":{"type":"object","title":"依頼主マスタ指定","required":["uuid"],"properties":{"uuid":{"type":"string","format":"uuid","nullable":false,"title":"依頼主UUID","description":"管理画面で登録した依頼主をUUIDで指定することができます。\n`uuid`を指定すると、依頼主マスタとして登録している住所、氏名、お問合せ先、ロゴ画像、明細書メッセージ、発送通知メッセージが適用されます。\n\nUUIDは依頼主マスタ画面よりご確認ください。\n海外発送指定（`international`）がある場合は、海外発送用の依頼主を指定してください。\n\nこのプロパティを利用する場合は、`sender`の他のプロパティ、`message`と同時に指定できません。","externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/56"}}}},"SenderRequest":{"type":"object","properties":{"sender":{"type":"object","title":"発送元住所","description":"省略時は管理画面でデフォルトの依頼主に設定されている情報が使われます。","oneOf":[{"allOf":[{"$ref":"#/components/schemas/Address"},{"type":"object","properties":{"name":{"type":"string","maxLength":15},"company":{"type":"string","maxLength":16,"nullable":true}}}]},{"$ref":"#/components/schemas/InternationalSenderAddress"},{"$ref":"#/components/schemas/SenderID"}]}}},"ShipmentRequest":{"allOf":[{"type":"object","required":["identifier","recipient","items"],"properties":{"identifier":{"type":"string","minLength":1,"maxLength":100,"nullable":true,"title":"識別番号","description":"ユーザーが出荷依頼をユニークに識別するための符号です。\nユーザーが任意に指定します。\n\n出荷依頼を作成する場合は、`identifier` と `order_no` のいずれかが必須となります。","example":"2015-00001"},"order_no":{"type":"string","minLength":1,"maxLength":100,"nullable":true,"title":"注文番号","description":"ECサイトなどの注文に紐づくユニークな固有の符号です。\n同梱明細書の「注文番号」に印刷されます。\n\n出荷依頼を作成する場合は、`identifier` と `order_no` のいずれかが必須となります。\n","externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/289"},"example":"#12345-67890"},"subtotal_amount":{"title":"納品書 小計","description":"同梱明細書に記載される「小計」。出荷依頼作成時に指定します。\n計算の整合性のチェックは行われず、空欄の場合に自動計算、補完もされません。","nullable":true,"example":1000},"delivery_charge":{"title":"納品書 配送料","description":"同梱明細書に記載される「配送料」。出荷依頼作成時に指定します。","nullable":true,"example":500},"handling_charge":{"title":"納品書 手数料","description":"同梱明細書に記載される「手数料」。出荷依頼作成時に指定します。","nullable":true,"example":0},"discount_amount":{"title":"納品書 割引額","description":"同梱明細書に記載される「割引額」。出荷依頼作成時に指定します。","nullable":true,"example":0},"total_amount":{"title":"納品書 合計","description":"同梱明細書に記載される「合計」。出荷依頼作成時に指定します。\n計算の整合性のチェックは行われず、空欄の場合に自動計算、補完もされません。","nullable":true,"example":1500},"cushioning_unit":{"type":"string","nullable":true,"enum":["ORDER","ITEM"],"title":"緩衝材単位","description":"注文単位、もしくは商品単位で緩衝材指定します。緩衝材は有料オプションで別途料金が発生します。\n\n- `ORDER`: 注文単位\n- `ITEM`: 商品単位","example":"ORDER","externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/62"}},"cushioning_type":{"type":"string","nullable":true,"enum":["BUBBLE_PACK","BUBBLE_DOUBLE_PACK"],"title":"緩衝材種別","description":"緩衝材単位を注文単位で利用する場合に指定します。\n「注文単位」を指定した場合は、緩衝材種別を下記から指定してください。\n\n- `BUBBLE_PACK`: プチプチ\n- `BUBBLE_DOUBLE_PACK`: プチプチ2重\n","example":"BUBBLE_PACK","externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/62"}},"gift_wrapping_unit":{"type":"string","nullable":true,"enum":["ORDER","ITEM"],"title":"ギフトラッピング単位","description":"注文単位、もしくは商品単位でラッピングします。ギフトラッピングは有料オプションで別途料金が発生します。\n\n- `ORDER`: 注文単位\n- `ITEM`: 商品単位","example":"ITEM","externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/30"}},"gift_wrapping_type":{"type":"string","nullable":true,"enum":["NAVY","RED"],"title":"ギフトラッピングタイプ","description":"ギフトラッピング単位を注文単位で利用する場合に、ラッピングの色を指定します。\n「注文単位」でラッピングする場合は、ギフトラッピングタイプを下記から指定します。\n\n- `NAVY`: ネイビー\n- `RED`: レッド","externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/30"}},"gift_sender_name":{"type":"string","nullable":true,"title":"ギフト贈り主氏名","description":"同梱明細書や送り状の「贈り主」欄に記載される名前を指定します。","example":"オープン太郎"},"bundled_items":{"type":"array","minItems":1,"maxItems":5,"uniqueItems":true,"nullable":true,"title":"同梱指定","description":"同梱物の商品IDまたは商品コード (重複のない5つまで指定できます)。","items":{"type":"string","example":"TS001-I000001"}},"shipping_email":{"type":"string","format":"email","nullable":true,"title":"配送先連絡メールアドレス","description":"お届け先へお荷物発送のお知らせメールを送信したい場合に指定します。\n\n指定されたメールアドレス宛に「お荷物発送のお知らせ」メールをオープンロジドメインから自動送信します。\nこの項目が未指定または `null` の場合は、「発送通知メッセージ」が無効になります。","example":"test@example.com","externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/81"}},"delivery_note_type":{"type":"string","nullable":true,"enum":["NOT_INCLUDE_PII","NONE"],"title":"明細書の同梱設定","description":"明細書を同梱するかしないかを指定します。\n\n値がない場合は、出荷設定の同梱明細書の同梱設定に従います。\n\n- `NOT_INCLUDE_PII`: 住所非表示の明細書を同梱する\n- `NONE`: 同梱しない\n","example":"NOT_INCLUDE_PII","externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/70"}},"price_on_delivery_note":{"type":"boolean","nullable":true,"title":"明細書への金額印字指定","description":"明細書に金額を印字するかしないかを指定します。\n\n- `true`\n - 明細書へ金額を印字する（この指定が他の設定よりも優先されます）\n- `false`\n - 明細書へ金額を印字しない（この指定が他の設定よりも優先されます）\n- `null` または 未指定\n - 管理画面の設定（【出荷設定】 > 【その他設定】 > 「同梱明細書の金額印字」）に従います。ただし、ギフトラッピングの場合は管理画面の設定に関わらず印字しません。","example":true,"externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/225"}},"message":{"type":"string","maxLength":500,"nullable":true,"title":"明細書メッセージ","description":"同梱明細書に記載するメッセージです。\n\n依頼主マスタで設定している明細書メッセージを上書きする場合に利用します。\nただし、依頼主UUID（`sender.uuid`）を指定した出荷依頼の場合は、`message`での上書きはできません。","example":"お買上げありがとうございます。"},"suspend":{"type":"boolean","title":"保留フラグ","description":"`true`は、出荷作業が開始されない保留状態を表します。\n\n保留状態の出荷依頼は、保留解除しない限り出荷作業が開始されません。\nただし、保留状態の出荷依頼にも在庫は引き当てられます。\n\n出荷作業を開始したくない場合に、出荷依頼時に`true`を指定します。\n保留状態を解除するには、[出荷依頼更新](#tag/shipments/operation/putShipment)を利用してください。","default":false,"example":false,"externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/213"}},"shipping_date":{"type":"string","format":"date","title":"出荷希望日","description":"指定された日付以降に倉庫で出荷作業が行われます。倉庫の作業状況次第では希望日の翌日以降での出荷となる場合があります。\n\nお届け希望日を指定したい場合は、`delivery_date`をご利用ください。\n`delivery_date`と同時に指定された場合、「`shipping_date` < `delivery_date` <= `shipping_date` + 7日（クール便は3日）」を満たす必要があります。","example":"2019-04-02","externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/203"}},"tax":{"type":"integer","maximum":999999999,"title":"消費税","description":"同梱明細書に記載される「消費税」。出荷依頼作成時に指定します。\n\n【出荷】 > 【出荷設定】 > 【その他の設定】 > 「消費税設定」が「税抜」の場合にだけ、指定します。","nullable":true,"example":100},"total_with_normal_tax":{"type":"integer","maximum":999999999,"title":"合計通常税率","description":"「合計」のうち消費税10%が適用される金額。出荷依頼作成時に指定します。\n\n「軽減税率適用商品」が含まれる場合のみ、指定した値が同梱明細書に記載されます。計算の整合性のチェックは行われず、空欄の場合に自動計算、補完もされません。","example":1000},"total_with_reduced_tax":{"type":"integer","maximum":999999999,"title":"合計軽減税率","description":"「合計」のうち軽減税率の消費税8%が適用される金額。出荷依頼作成時に指定します。\n\n「軽減税率適用商品」が含まれる場合のみ、指定した値が同梱明細書に記載されます。計算の整合性のチェックは行われず、空欄の場合に自動計算、補完もされません。","example":500},"delivery_carrier":{"type":"string","nullable":true,"enum":["YAMATO","SAGAWA"],"title":"配送会社","description":"配送会社を指示したい場合に指定します。\n\n国内発送の場合に指定でき、指定すると別途料金が発生します。\n\n- `YAMATO`: ヤマト運輸\n- `SAGAWA`: 佐川急便\n","example":"YAMATO","externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/67"}},"delivery_time_slot":{"type":"string","nullable":true,"enum":["AM","12","14","16","18","19"],"title":"希望時間指定","description":"国内発送の場合に、配達の時間帯を指示したい場合に指定します。\n\n- `AM`: 午前中\n- `12`: 12時〜14時（佐川急便のみ指定可能）\n- `14`: 14時〜16時\n- `16`: 16時〜18時\n- `18`: 18時〜20時\n- `19`: 19時〜21時\n","example":"AM","externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/75"}},"delivery_date":{"type":"string","format":"date","nullable":true,"title":"配達希望日","description":"国内発送の場合に、お届け希望日を指示したい場合に指定します。\n\n出荷作業の開始日を指定したい場合は、`shipping_date`をご利用ください。\n","example":"2019-04-05","externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/96"}},"cash_on_delivery":{"type":"boolean","title":"代金引換指定","description":"`true`を指定したときだけ代金引換となります。代金引換を利用する場合は、事前に配送会社とサービス契約している必要があります。","default":false,"example":false},"total_for_cash_on_delivery":{"type":"integer","maximum":999999999,"title":"代金引換総計","description":"配送先に請求する、消費税や送料、手数料なども含めた代引きの請求金額。出荷依頼作成時に指定します。\n代金引換の場合のみ指定します。","example":1100},"tax_for_cash_on_delivery":{"type":"integer","maximum":999999999,"title":"代金引換消費税","description":"代金引換総計のうち、消費税に当たる金額。出荷依頼作成時に指定します。\n代金引換の場合のみ指定します。","example":100},"delivery_method":{"type":"string","nullable":true,"enum":["POST_EXPRESS","HOME_BOX"],"title":"配送便指定","description":"SSサイズの商品、入荷実績のない商品で「配送便」を指定したい場合に指定します。\nSSサイズの商品のみ、かつポスト便のサイズに収まった場合に、このパラメータの省略時には`POST_EXPRESS`が設定されます。\n\n- `POST_EXPRESS`: ポスト便 (宅配便スピード)での配送 (SSサイズの商品で指定可能)\n- `HOME_BOX`: 宅配便 (段ボール梱包)での配送\n","example":"HOME_BOX","externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/212"}},"delivery_options":{"$ref":"#/components/schemas/DeliveryOption"},"warehouse":{"type":"string","nullable":true,"title":"倉庫コード","description":"出荷する倉庫をコードで指定します。未指定または null を指定した場合は、標準倉庫から出荷されます。","example":"OPL"},"items":{"type":"array","title":"配送商品リスト","description":"出荷したい商品を指定します。同梱物を指定する場合は、`bundled_items`を利用します。\n","items":{"$ref":"#/components/schemas/components-schemas-ItemRequest"}},"international":{"type":"boolean","title":"海外発送指定","default":false,"description":"海外発送する場合は、`true`を指定します。","example":false},"delivery_service":{"type":"string","description":"海外配送（`international`が`true`）の場合は必須です。\n\nSagawa\n - SAGAWA-HIKYAKU-YU-PACKET 佐川急便 飛脚ゆうパケット\n - SAGAWA-TAKUHAIBIN 佐川急便 宅配便\n - SAGAWA-COOLBIN 佐川急便 飛脚クール便\n\nYamato\n - YAMATO-NEKOPOSU ヤマト運輸 ネコポス\n - YAMATO-TAKKYUBIN ヤマト運輸 宅急便\n - YAMATO-COOLBIN ヤマト運輸 クール便\n\nJapan Post\n - JAPANPOST-EMS EMS\n - JAPANPOST-YU-PACKET 日本郵便 ゆうパケット\n\nFedex\n - FEDEX-PRIORITY FedEx International Priority\n - FEDEX-CONNECT-PLUS FedEx International Connect Plus\n\nDHL\n - DHL-EXPRESS DHL Express\n","enum":["SAGAWA-HIKYAKU-YU-PACKET","SAGAWA-TAKUHAIBIN","SAGAWA-COOLBIN","YAMATO-NEKOPOSU","YAMATO-TAKKYUBIN","YAMATO-COOLBIN","JAPANPOST-EMS","JAPANPOST-YU-PACKET","FEDEX-PRIORITY","FEDEX-CONNECT-PLUS","DHL-EXPRESS"],"example":"JAPANPOST-EMS"},"currency_code":{"type":"string","title":"海外発送用通貨コード","description":"商品単価や合計金額で利用する通貨。\n海外配送（`international`が`true`）の場合は必須です。\n\n指定できる値は、[通貨情報API](#tag/shipments/operation/getInternationalCurrency)を参照してください。","example":"JP"},"insurance":{"type":"boolean","title":"海外発送用損害保証制度の加入希望","description":"海外配送（`international`が`true`）の場合は必須です。\n\n損害保証制度の加入希望がある場合は`true`を指定します。","example":false,"externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/10"}},"backorder_if_unavailable":{"title":"出荷単位の出荷予約フラグ","type":"boolean","default":false,"description":"在庫不足時、出荷予約として出荷依頼を作成できるようにします。商品単位の指定よりも、出荷単位の指定が優先されます。","example":true},"purpose":{"type":"string","enum":["GIFT","DOCUMENTS","COMMERCIAL_SAMPLE","SALE_OF_GOODS","RETURNED_GOODS","OTHERS"],"title":"輸出目的","description":"EMS/DHL/Fedexの場合に指定します。\n輸出目的が指す品目と実際の商品とが異なる場合には、通関手続きができない場合があります。\n\n未指定の場合、【管理画面】 > 【設定】> 【配送情報】> 【配送設定】 > 「輸出目的設定」で選択した項目が適用されます。\n\n- `GIFT` : 贈物\n- `DOCUMENTS` : 書類\n- `COMMERCIAL_SAMPLE` : 商品見本\n- `SALE_OF_GOODS` : 販売品\n- `RETURNED_GOODS` : 返送品\n- `OTHERS` : その他\n","example":"SALE_OF_GOODS"},"allocate_priority":{"type":"integer","minimum":0,"maximum":100,"title":"引当優先順位","description":"出荷依頼に対して、出荷の商品単位で配送可在庫を確保する処理（引当）をオープンロジで行なっています。\n数字が大きいほど、優先的に引当されます。","example":0,"externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/294"}},"tax_number":{"type":"string","title":"納税者番号","minLength":2,"maxLength":30,"description":"一部の海外配送先の場合に、インボイスに記載が必要となる納税者番号","externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/257"}}}},{"$ref":"#/components/schemas/SenderRequest"},{"$ref":"#/components/schemas/Recipient"}]},"PostShipmentRequest":{"allOf":[{"$ref":"#/components/schemas/ShipmentRequest"},{"type":"object","properties":{"apply_rule":{"type":"boolean","title":"出荷ルール適用フラグ","description":"出荷ルールによる商品追加で在庫不足が発生する場合、出荷依頼単位の`backorder_if_unavailable`に`true`を指定します。\n","example":true,"externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/101"}}}}]},"PostShipmentResponse":{"allOf":[{"type":"object","required":["id"],"properties":{"id":{"type":"string","title":"出荷ID","description":"オープンロジで出荷依頼を作成した際に自動で生成され、出荷依頼ごとに割り当てられる固有のIDです。","example":"TS001-S000001","externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/269"}},"identifier":{"type":"string","minLength":1,"maxLength":100,"nullable":true,"title":"識別番号","description":"ユーザーが出荷依頼をユニークに識別するための符号です。\nユーザーが任意に指定します。\n\n出荷依頼を作成する場合は、`identifier` と `order_no` のいずれかが必須となります。","example":"2015-00001"},"order_no":{"type":"string","minLength":1,"maxLength":100,"nullable":true,"title":"注文番号","description":"ECサイトなどの注文に紐づくユニークな固有の符号です。\n同梱明細書の「注文番号」に印刷されます。\n\n出荷依頼を作成する場合は、`identifier` と `order_no` のいずれかが必須となります。\n","externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/289"},"example":"#12345-67890"},"subtotal_amount":{"title":"納品書 小計","description":"同梱明細書に記載される「小計」。出荷依頼作成時に指定します。\n計算の整合性のチェックは行われず、空欄の場合に自動計算、補完もされません。","nullable":true,"example":1000},"delivery_charge":{"title":"納品書 配送料","description":"同梱明細書に記載される「配送料」。出荷依頼作成時に指定します。","nullable":true,"example":500},"handling_charge":{"title":"納品書 手数料","description":"同梱明細書に記載される「手数料」。出荷依頼作成時に指定します。","nullable":true,"example":0},"discount_amount":{"title":"納品書 割引額","description":"同梱明細書に記載される「割引額」。出荷依頼作成時に指定します。","nullable":true,"example":0},"total_amount":{"title":"納品書 合計","description":"同梱明細書に記載される「合計」。出荷依頼作成時に指定します。\n計算の整合性のチェックは行われず、空欄の場合に自動計算、補完もされません。","nullable":true,"example":1500},"cushioning_unit":{"type":"string","nullable":true,"enum":["ORDER","ITEM"],"title":"緩衝材単位","description":"注文単位、もしくは商品単位で緩衝材指定します。緩衝材は有料オプションで別途料金が発生します。\n\n- `ORDER`: 注文単位\n- `ITEM`: 商品単位","example":"ORDER","externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/62"}},"cushioning_type":{"type":"string","nullable":true,"enum":["BUBBLE_PACK","BUBBLE_DOUBLE_PACK"],"title":"緩衝材種別","description":"緩衝材単位を注文単位で利用する場合に指定します。\n「注文単位」を指定した場合は、緩衝材種別を下記から指定してください。\n\n- `BUBBLE_PACK`: プチプチ\n- `BUBBLE_DOUBLE_PACK`: プチプチ2重\n","example":"BUBBLE_PACK","externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/62"}},"gift_wrapping_unit":{"type":"string","nullable":true,"enum":["ORDER","ITEM"],"title":"ギフトラッピング単位","description":"注文単位、もしくは商品単位でラッピングします。ギフトラッピングは有料オプションで別途料金が発生します。\n\n- `ORDER`: 注文単位\n- `ITEM`: 商品単位","example":"ITEM","externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/30"}},"gift_wrapping_type":{"type":"string","nullable":true,"enum":["NAVY","RED"],"title":"ギフトラッピングタイプ","description":"ギフトラッピング単位を注文単位で利用する場合に、ラッピングの色を指定します。\n「注文単位」でラッピングする場合は、ギフトラッピングタイプを下記から指定します。\n\n- `NAVY`: ネイビー\n- `RED`: レッド","externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/30"}},"gift_sender_name":{"type":"string","nullable":true,"title":"ギフト贈り主氏名","description":"同梱明細書や送り状の「贈り主」欄に記載される名前を指定します。","example":"オープン太郎"},"bundled_items":{"type":"array","minItems":1,"maxItems":5,"uniqueItems":true,"nullable":true,"title":"同梱指定","description":"同梱物の商品IDまたは商品コード (重複のない5つまで指定できます)。","items":{"type":"string","example":"TS001-I000001"}},"fba_shipment_id":{"type":"string","title":"FBA納品番号","description":"FBA納品向けの出荷の場合に、FBA納品番号がセットされます。","example":"FBA123456789","nullable":true},"shipping_email":{"type":"string","format":"email","nullable":true,"title":"配送先連絡メールアドレス","description":"お届け先へお荷物発送のお知らせメールを送信したい場合に指定します。\n\n指定されたメールアドレス宛に「お荷物発送のお知らせ」メールをオープンロジドメインから自動送信します。\nこの項目が未指定または `null` の場合は、「発送通知メッセージ」が無効になります。","example":"test@example.com","externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/81"}},"delivery_note_type":{"type":"string","nullable":true,"enum":["NOT_INCLUDE_PII","NONE"],"title":"明細書の同梱設定","description":"明細書を同梱するかしないかを指定します。\n\n値がない場合は、出荷設定の同梱明細書の同梱設定に従います。\n\n- `NOT_INCLUDE_PII`: 住所非表示の明細書を同梱する\n- `NONE`: 同梱しない\n","example":"NOT_INCLUDE_PII","externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/70"}},"price_on_delivery_note":{"type":"boolean","nullable":true,"title":"明細書への金額印字指定","description":"明細書に金額を印字するかしないかを指定します。\n\n- `true`\n - 明細書へ金額を印字する（この指定が他の設定よりも優先されます）\n- `false`\n - 明細書へ金額を印字しない（この指定が他の設定よりも優先されます）\n- `null` または 未指定\n - 管理画面の設定（【出荷設定】 > 【その他設定】 > 「同梱明細書の金額印字」）に従います。ただし、ギフトラッピングの場合は管理画面の設定に関わらず印字しません。","example":true,"externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/225"}},"message":{"type":"string","maxLength":500,"nullable":true,"title":"明細書メッセージ","description":"同梱明細書に記載するメッセージです。\n\n依頼主マスタで設定している明細書メッセージを上書きする場合に利用します。\nただし、依頼主UUID（`sender.uuid`）を指定した出荷依頼の場合は、`message`での上書きはできません。","example":"お買上げありがとうございます。"},"status":{"type":"string","enum":["backordered","allocating","waiting","working","picking","picked","packed","shipped","suspended","modify_request","cancel_request"],"title":"出荷ステータス","description":"出荷状況を確認できます。\n出荷依頼は営業日の9:00と12:30に倉庫側にデータが取り込まれ、作業されます。\n\n`backordered` : 入荷待ち\n\n`allocating` : 引当中(`X-Api-Version` が `1.3` の場合)\n\n`waiting` : 引当済\n\n`working` : ピッキング中または検品済(`X-Api-Version` が `1.3` の場合)\n\n`picking` : ピッキング中(`X-Api-Version` が `1.4` 以降の場合)\n\n`picked` : 検品済(`X-Api-Version` が `1.4` 以降の場合)\n\n`packed` : 梱包済\n\n`shipped` : 出荷済\n\n`suspended` : 保留\n\n`modify_request` : 変更依頼中\n\n`cancel_request` : キャンセル依頼中\n","example":"waiting","externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/49"}},"suspend":{"type":"boolean","title":"保留フラグ","description":"`true`は、出荷作業が開始されない保留状態を表します。\n\n保留状態の出荷依頼は、保留解除しない限り出荷作業が開始されません。\nただし、保留状態の出荷依頼にも在庫は引き当てられます。\n\n出荷作業を開始したくない場合に、出荷依頼時に`true`を指定します。\n保留状態を解除するには、[出荷依頼更新](#tag/shipments/operation/putShipment)を利用してください。","default":false,"example":false,"externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/213"}},"label_note":{"type":"string","title":"品名","description":"国内配送の送り状に記載される商品種別。\n\n出荷依頼作成時に、デフォルト品名（【出荷設定】 > 【その他設定】 > 「品名設定」）が未設定の場合に必須です。\n設定済みの場合は、その値が自動で使用されます。\n","example":"玩具","externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/21"}},"shipping_date":{"type":"string","format":"date","title":"出荷希望日","description":"指定された日付以降に倉庫で出荷作業が行われます。倉庫の作業状況次第では希望日の翌日以降での出荷となる場合があります。\n\nお届け希望日を指定したい場合は、`delivery_date`をご利用ください。\n`delivery_date`と同時に指定された場合、「`shipping_date` < `delivery_date` <= `shipping_date` + 7日（クール便は3日）」を満たす必要があります。","example":"2019-04-02","externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/203"}},"assigned_shipping_date":{"type":"string","format":"date","title":"発送予定日","description":"配送会社へ引き渡す予定の日付で、変動する場合があります。","example":"2019-04-02"},"tax_included":{"type":"boolean","title":"税込みフラグ","description":"商品の登録価格、出荷明細の表示金額が税込み（`true`)か税抜き（`false`)かを表します。\n出荷依頼作成時の【出荷】 > 【出荷設定】 > 【その他設定】 > 「消費税設定」の設定内容が反映されます。","example":true},"tax":{"type":"integer","maximum":999999999,"title":"消費税","description":"同梱明細書に記載される「消費税」。出荷依頼作成時に指定します。\n\n【出荷】 > 【出荷設定】 > 【その他の設定】 > 「消費税設定」が「税抜」の場合にだけ、指定します。","nullable":true,"example":100},"total_with_normal_tax":{"type":"integer","maximum":999999999,"title":"合計通常税率","description":"「合計」のうち消費税10%が適用される金額。出荷依頼作成時に指定します。\n\n「軽減税率適用商品」が含まれる場合のみ、指定した値が同梱明細書に記載されます。計算の整合性のチェックは行われず、空欄の場合に自動計算、補完もされません。","example":1000},"total_with_reduced_tax":{"type":"integer","maximum":999999999,"title":"合計軽減税率","description":"「合計」のうち軽減税率の消費税8%が適用される金額。出荷依頼作成時に指定します。\n\n「軽減税率適用商品」が含まれる場合のみ、指定した値が同梱明細書に記載されます。計算の整合性のチェックは行われず、空欄の場合に自動計算、補完もされません。","example":500},"delivery_carrier":{"type":"string","nullable":true,"enum":["YAMATO","SAGAWA"],"title":"配送会社","description":"配送会社を指示したい場合に指定します。\n\n国内発送の場合に指定でき、指定すると別途料金が発生します。\n\n- `YAMATO`: ヤマト運輸\n- `SAGAWA`: 佐川急便\n","example":"YAMATO","externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/67"}},"delivery_time_slot":{"type":"string","nullable":true,"enum":["AM","12","14","16","18","19"],"title":"希望時間指定","description":"国内発送の場合に、配達の時間帯を指示したい場合に指定します。\n\n- `AM`: 午前中\n- `12`: 12時〜14時（佐川急便のみ指定可能）\n- `14`: 14時〜16時\n- `16`: 16時〜18時\n- `18`: 18時〜20時\n- `19`: 19時〜21時\n","example":"AM","externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/75"}},"delivery_date":{"type":"string","format":"date","nullable":true,"title":"配達希望日","description":"国内発送の場合に、お届け希望日を指示したい場合に指定します。\n\n出荷作業の開始日を指定したい場合は、`shipping_date`をご利用ください。\n","example":"2019-04-05","externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/96"}},"delivery_day":{"type":"string","format":"date","nullable":true,"title":"お届け予定日","description":"出荷前、海外や離島へのお届けの場合に`null`（お届け予定なし）となります。","example":"2019-04-05"},"cash_on_delivery":{"type":"boolean","title":"代金引換指定","description":"`true`を指定したときだけ代金引換となります。代金引換を利用する場合は、事前に配送会社とサービス契約している必要があります。","default":false,"example":false},"total_for_cash_on_delivery":{"type":"integer","maximum":999999999,"title":"代金引換総計","description":"配送先に請求する、消費税や送料、手数料なども含めた代引きの請求金額。出荷依頼作成時に指定します。\n代金引換の場合のみ指定します。","example":1100},"tax_for_cash_on_delivery":{"type":"integer","maximum":999999999,"title":"代金引換消費税","description":"代金引換総計のうち、消費税に当たる金額。出荷依頼作成時に指定します。\n代金引換の場合のみ指定します。","example":100},"delivery_method":{"type":"string","nullable":true,"enum":["POST_EXPRESS","HOME_BOX"],"title":"配送便指定","description":"SSサイズの商品、入荷実績のない商品で「配送便」を指定したい場合に指定します。\nSSサイズの商品のみ、かつポスト便のサイズに収まった場合に、このパラメータの省略時には`POST_EXPRESS`が設定されます。\n\n- `POST_EXPRESS`: ポスト便 (宅配便スピード)での配送 (SSサイズの商品で指定可能)\n- `HOME_BOX`: 宅配便 (段ボール梱包)での配送\n","example":"HOME_BOX","externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/212"}},"delivery_options":{"$ref":"#/components/schemas/DeliveryOption"},"bundle_shipping_label":{"type":"string","title":"引き取り交換フラグ","description":"引き取り交換で出荷する場合に`true`になります。","nullable":true},"warehouse":{"type":"string","title":"倉庫コード","description":"出荷作業が行われる倉庫のコード","nullable":true,"example":"OPL"},"items":{"type":"array","description":"配送商品リスト","items":{"$ref":"#/components/schemas/components-schemas-ItemResponse"}},"purpose":{"type":"string","enum":["GIFT","DOCUMENTS","COMMERCIAL_SAMPLE","SALE_OF_GOODS","RETURNED_GOODS","OTHERS"],"title":"輸出目的","description":"EMS/DHL/Fedexの場合に指定します。\n輸出目的が指す品目と実際の商品とが異なる場合には、通関手続きができない場合があります。\n\n未指定の場合、【管理画面】 > 【設定】> 【配送情報】> 【配送設定】 > 「輸出目的設定」で選択した項目が適用されます。\n\n- `GIFT` : 贈物\n- `DOCUMENTS` : 書類\n- `COMMERCIAL_SAMPLE` : 商品見本\n- `SALE_OF_GOODS` : 販売品\n- `RETURNED_GOODS` : 返送品\n- `OTHERS` : その他\n","example":"SALE_OF_GOODS"},"allocate_priority":{"type":"integer","minimum":0,"maximum":100,"title":"引当優先順位","description":"出荷依頼に対して、出荷の商品単位で配送可在庫を確保する処理（引当）をオープンロジで行なっています。\n数字が大きいほど、優先的に引当されます。","example":0,"externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/294"}},"tax_number":{"type":"string","title":"納税者番号","minLength":2,"maxLength":30,"description":"一部の海外配送先の場合に、インボイスに記載が必要となる納税者番号","externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/257"}}}},{"$ref":"#/components/schemas/Sender"},{"$ref":"#/components/schemas/Recipient"}]},"PostShipmentsRequest":{"required":["shipments"],"type":"object","properties":{"shipments":{"title":"出荷依頼リスト","description":"一括で登録したい出荷依頼の配列です。","type":"array","items":{"$ref":"#/components/schemas/ShipmentRequest"}},"apply_rule":{"type":"boolean","title":"出荷ルール適用フラグ","description":"出荷ルールによる商品追加で在庫不足が発生する場合、出荷依頼単位の`backorder_if_unavailable`に`true`を指定します。\n","example":true,"externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/101"}}}},"ModifyShipmentRequest":{"type":"object","properties":{"recipient":{"type":"object","description":"発送先住所 (海外出荷の場合はregion_codeを指定する必要が有ります)","oneOf":[{"$ref":"#/components/schemas/Address"},{"$ref":"#/components/schemas/InternationalAddress"}]},"delivery_time_slot":{"type":"string","enum":["AM","12","14","16","18","19"],"description":"希望時間指定 (12はSAGAWAの場合のみ)","example":"12"},"delivery_date":{"type":"string","description":"配達希望日 (指定できる最短日付は配送会社によって変わります)","example":"2019-04-05"}}},"WarehouseBaseTransferAddress":{"allOf":[{"type":"object","properties":{"name":{"type":"string","maxLength":32,"description":"文字数制限があります。\n- ヤマト運輸で配送する場合: 全角16文字、半角32文字以内\n- それ以外で配送する場合: 全角12文字、半角25文字以内\n\n配送キャリアごとの制限を事前にご確認願います。"},"company":{"type":"string","maxLength":50,"nullable":true,"description":"文字数制限があります。\n- ヤマト運輸をご指定の場合: 全角25文字、半角50文字以内\n- それ以外の場合: 全角12文字、半角25文字以内\n\n配送キャリアごとの制限を事前にご確認願います。"}}},{"$ref":"#/components/schemas/Address"},{"type":"object","properties":{"name":{"type":"string","maxLength":32},"company":{"type":"string","maxLength":50,"nullable":true}}}]},"WarehouseBaseTransferSender":{"type":"object","properties":{"sender":{"type":"object","title":"発送元住所","description":"発送元倉庫の住所が自動で設定されます。","allOf":[{"$ref":"#/components/schemas/WarehouseBaseTransferAddress"}]}}},"WarehouseBaseTransferRecipient":{"type":"object","properties":{"recipient":{"type":"object","title":"発送先住所","description":"発送先倉庫の住所が自動で設定されます。","allOf":[{"$ref":"#/components/schemas/WarehouseBaseTransferAddress"}]}}},"TransferResponse":{"allOf":[{"type":"object","required":["id","warehouse","items"],"properties":{"id":{"type":"string","description":"出荷ID","example":"TS001-S000001"},"identifier":{"type":"string","minLength":1,"maxLength":100,"nullable":true,"title":"識別番号","description":"ユーザーが出荷依頼をユニークに識別するための符号です。\nユーザーが任意に指定します。\n\n出荷依頼を作成する場合は、`identifier` と `order_no` のいずれかが必須となります。","example":"2015-00001"},"order_no":{"type":"string","minLength":1,"maxLength":100,"nullable":true,"title":"注文番号","description":"ECサイトなどの注文に紐づくユニークな固有の符号です。\n同梱明細書の「注文番号」に印刷されます。\n\n出荷依頼を作成する場合は、`identifier` と `order_no` のいずれかが必須となります。\n","externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/289"},"example":"#12345-67890"},"subtotal_amount":{"title":"納品書 小計","description":"同梱明細書に記載される「小計」。出荷依頼作成時に指定します。\n計算の整合性のチェックは行われず、空欄の場合に自動計算、補完もされません。","nullable":true,"example":1000},"delivery_charge":{"title":"納品書 配送料","description":"同梱明細書に記載される「配送料」。出荷依頼作成時に指定します。","nullable":true,"example":500},"handling_charge":{"title":"納品書 手数料","description":"同梱明細書に記載される「手数料」。出荷依頼作成時に指定します。","nullable":true,"example":0},"discount_amount":{"title":"納品書 割引額","description":"同梱明細書に記載される「割引額」。出荷依頼作成時に指定します。","nullable":true,"example":0},"total_amount":{"title":"納品書 合計","description":"同梱明細書に記載される「合計」。出荷依頼作成時に指定します。\n計算の整合性のチェックは行われず、空欄の場合に自動計算、補完もされません。","nullable":true,"example":1500},"cushioning_unit":{"type":"string","nullable":true,"enum":["ORDER","ITEM"],"title":"緩衝材単位","description":"注文単位、もしくは商品単位で緩衝材指定します。緩衝材は有料オプションで別途料金が発生します。\n\n- `ORDER`: 注文単位\n- `ITEM`: 商品単位","example":"ORDER","externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/62"}},"cushioning_type":{"type":"string","nullable":true,"enum":["BUBBLE_PACK","BUBBLE_DOUBLE_PACK"],"title":"緩衝材種別","description":"緩衝材単位を注文単位で利用する場合に指定します。\n「注文単位」を指定した場合は、緩衝材種別を下記から指定してください。\n\n- `BUBBLE_PACK`: プチプチ\n- `BUBBLE_DOUBLE_PACK`: プチプチ2重\n","example":"BUBBLE_PACK","externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/62"}},"gift_wrapping_unit":{"type":"string","nullable":true,"enum":["ORDER","ITEM"],"title":"ギフトラッピング単位","description":"注文単位、もしくは商品単位でラッピングします。ギフトラッピングは有料オプションで別途料金が発生します。\n\n- `ORDER`: 注文単位\n- `ITEM`: 商品単位","example":"ITEM","externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/30"}},"gift_wrapping_type":{"type":"string","nullable":true,"enum":["NAVY","RED"],"title":"ギフトラッピングタイプ","description":"ギフトラッピング単位を注文単位で利用する場合に、ラッピングの色を指定します。\n「注文単位」でラッピングする場合は、ギフトラッピングタイプを下記から指定します。\n\n- `NAVY`: ネイビー\n- `RED`: レッド","externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/30"}},"gift_sender_name":{"type":"string","nullable":true,"title":"ギフト贈り主氏名","description":"同梱明細書や送り状の「贈り主」欄に記載される名前を指定します。","example":"オープン太郎"},"bundled_items":{"type":"array","minItems":1,"maxItems":5,"uniqueItems":true,"nullable":true,"title":"同梱指定","description":"同梱物の商品IDまたは商品コード (重複のない5つまで指定できます)。","items":{"type":"string","example":"TS001-I000001"}},"fba_shipment_id":{"type":"string","description":"FBA納品番号","example":"FBA123456789","nullable":true},"shipping_email":{"type":"string","format":"email","nullable":true,"title":"配送先連絡メールアドレス","description":"お届け先へお荷物発送のお知らせメールを送信したい場合に指定します。\n\n指定されたメールアドレス宛に「お荷物発送のお知らせ」メールをオープンロジドメインから自動送信します。\nこの項目が未指定または `null` の場合は、「発送通知メッセージ」が無効になります。","example":"test@example.com","externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/81"}},"delivery_note_type":{"type":"string","nullable":true,"enum":["NOT_INCLUDE_PII","NONE"],"title":"明細書の同梱設定","description":"明細書を同梱するかしないかを指定します。\n\n値がない場合は、出荷設定の同梱明細書の同梱設定に従います。\n\n- `NOT_INCLUDE_PII`: 住所非表示の明細書を同梱する\n- `NONE`: 同梱しない\n","example":"NOT_INCLUDE_PII","externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/70"}},"price_on_delivery_note":{"type":"boolean","nullable":true,"title":"明細書への金額印字指定","description":"明細書に金額を印字するかしないかを指定します。\n\n- `true`\n - 明細書へ金額を印字する（この指定が他の設定よりも優先されます）\n- `false`\n - 明細書へ金額を印字しない（この指定が他の設定よりも優先されます）\n- `null` または 未指定\n - 管理画面の設定（【出荷設定】 > 【その他設定】 > 「同梱明細書の金額印字」）に従います。ただし、ギフトラッピングの場合は管理画面の設定に関わらず印字しません。","example":true,"externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/225"}},"message":{"type":"string","maxLength":500,"nullable":true,"title":"明細書メッセージ","description":"同梱明細書に記載するメッセージです。\n\n依頼主マスタで設定している明細書メッセージを上書きする場合に利用します。\nただし、依頼主UUID（`sender.uuid`）を指定した出荷依頼の場合は、`message`での上書きはできません。","example":"お買上げありがとうございます。"},"status":{"type":"string","enum":["backordered","allocating","waiting","working","picking","picked","packed","shipped","suspended","modify_request","cancel_request"],"description":"出荷ステータス\n\n`backordered` : 入荷待ち\n\n`allocating` : 引当中(`X-Api-Version` が `1.3` の場合)\n\n`waiting` : 引当済\n\n`working` : ピッキング中または検品済(`X-Api-Version` が `1.3` の場合)\n\n`picking` : ピッキング中(`X-Api-Version` が `1.4` 以降の場合)\n\n`picked` : 検品済(`X-Api-Version` が `1.4` 以降の場合)\n\n`packed` : 梱包済\n\n`shipped` : 出荷済\n\n`suspended` : 保留\n\n`modify_request` : 変更依頼中\n\n`cancel_request` : キャンセル依頼中\n","example":"waiting"},"suspend":{"type":"boolean","title":"保留フラグ","description":"`true`は、出荷作業が開始されない保留状態を表します。\n\n保留状態の出荷依頼は、保留解除しない限り出荷作業が開始されません。\nただし、保留状態の出荷依頼にも在庫は引き当てられます。\n\n出荷作業を開始したくない場合に、出荷依頼時に`true`を指定します。\n保留状態を解除するには、[出荷依頼更新](#tag/shipments/operation/putShipment)を利用してください。","default":false,"example":false,"externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/213"}},"label_note":{"type":"string","title":"品名","description":"国内配送の送り状に記載される商品種別。\n\n出荷依頼作成時に、デフォルト品名（【出荷設定】 > 【その他設定】 > 「品名設定」）が未設定の場合に必須です。\n設定済みの場合は、その値が自動で使用されます。\n","example":"玩具","externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/21"}},"assigned_shipping_date":{"type":"string","description":"発送予定日 (配送会社へ引き渡す予定の日付で、変動する場合があります)","example":"2019-04-02"},"tax_included":{"type":"boolean","description":"税込みフラグ","example":true},"tax":{"type":"integer","maximum":999999999,"title":"消費税","description":"同梱明細書に記載される「消費税」。出荷依頼作成時に指定します。\n\n【出荷】 > 【出荷設定】 > 【その他の設定】 > 「消費税設定」が「税抜」の場合にだけ、指定します。","nullable":true,"example":100},"total_with_normal_tax":{"type":"integer","maximum":999999999,"title":"合計通常税率","description":"「合計」のうち消費税10%が適用される金額。出荷依頼作成時に指定します。\n\n「軽減税率適用商品」が含まれる場合のみ、指定した値が同梱明細書に記載されます。計算の整合性のチェックは行われず、空欄の場合に自動計算、補完もされません。","example":1000},"total_with_reduced_tax":{"type":"integer","maximum":999999999,"title":"合計軽減税率","description":"「合計」のうち軽減税率の消費税8%が適用される金額。出荷依頼作成時に指定します。\n\n「軽減税率適用商品」が含まれる場合のみ、指定した値が同梱明細書に記載されます。計算の整合性のチェックは行われず、空欄の場合に自動計算、補完もされません。","example":500},"delivery_carrier":{"type":"string","nullable":true,"enum":["YAMATO","SAGAWA"],"title":"配送会社","description":"配送会社を指示したい場合に指定します。\n\n国内発送の場合に指定でき、指定すると別途料金が発生します。\n\n- `YAMATO`: ヤマト運輸\n- `SAGAWA`: 佐川急便\n","example":"YAMATO","externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/67"}},"delivery_time_slot":{"type":"string","nullable":true,"enum":["AM","12","14","16","18","19"],"title":"希望時間指定","description":"国内発送の場合に、配達の時間帯を指示したい場合に指定します。\n\n- `AM`: 午前中\n- `12`: 12時〜14時（佐川急便のみ指定可能）\n- `14`: 14時〜16時\n- `16`: 16時〜18時\n- `18`: 18時〜20時\n- `19`: 19時〜21時\n","example":"AM","externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/75"}},"delivery_date":{"type":"string","format":"date","nullable":true,"title":"配達希望日","description":"国内発送の場合に、お届け希望日を指示したい場合に指定します。\n\n出荷作業の開始日を指定したい場合は、`shipping_date`をご利用ください。\n","example":"2019-04-05","externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/96"}},"delivery_day":{"type":"string","nullable":true,"description":"お届け予定日","example":"2019-04-05"},"cash_on_delivery":{"type":"boolean","title":"代金引換指定","description":"`true`を指定したときだけ代金引換となります。代金引換を利用する場合は、事前に配送会社とサービス契約している必要があります。","default":false,"example":false},"total_for_cash_on_delivery":{"type":"integer","maximum":999999999,"title":"代金引換総計","description":"配送先に請求する、消費税や送料、手数料なども含めた代引きの請求金額。出荷依頼作成時に指定します。\n代金引換の場合のみ指定します。","example":1100},"tax_for_cash_on_delivery":{"type":"integer","maximum":999999999,"title":"代金引換消費税","description":"代金引換総計のうち、消費税に当たる金額。出荷依頼作成時に指定します。\n代金引換の場合のみ指定します。","example":100},"delivery_method":{"type":"string","nullable":true,"enum":["POST_EXPRESS","HOME_BOX"],"title":"配送便指定","description":"SSサイズの商品、入荷実績のない商品で「配送便」を指定したい場合に指定します。\nSSサイズの商品のみ、かつポスト便のサイズに収まった場合に、このパラメータの省略時には`POST_EXPRESS`が設定されます。\n\n- `POST_EXPRESS`: ポスト便 (宅配便スピード)での配送 (SSサイズの商品で指定可能)\n- `HOME_BOX`: 宅配便 (段ボール梱包)での配送\n","example":"HOME_BOX","externalDocs":{"description":"詳細はこちらのページをご確認ください。","url":"https://help.openlogi.com/faq/show/212"}},"delivery_options":{"$ref":"#/components/schemas/DeliveryOption"},"bundle_shipping_label":{"type":"string","description":"引き取り交換フラグ","nullable":true},"warehouse":{"type":"string","description":"倉庫コード","example":"OPL"},"items":{"type":"array","description":"配送商品リスト","items":{"$ref":"#/components/schemas/components-schemas-ItemResponse"}},"destination":{"type":"object","description":"移動先倉庫情報","properties":{"warehouse":{"type":"string","description":"倉庫コード","example":"BASE3"},"warehousing":{"type":"object","description":"入荷情報","properties":{"id":{"type":"string","description":"入荷ID","example":"TS001-W0001"}}}}}}},{"$ref":"#/components/schemas/WarehouseBaseTransferSender"},{"$ref":"#/components/schemas/WarehouseBaseTransferRecipient"}]}},"responses":{"BadRequest":{"description":"エラー（Bad Request）","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"description":"エラーの種類を示します","type":"string","example":"exception"},"error_description":{"description":"エラーの概要メッセージが入ります","type":"string","example":"キャンセルできませんでした"}}}}}},"Unauthorized":{"description":"エラー（Unauthorized）","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"description":"エラーの種類を示します","type":"string","example":"unauthorized"},"error_description":{"description":"エラーの概要メッセージが入ります","type":"string","example":"Unauthenticated"}}}}}},"Forbidden":{"description":"エラー（Forbidden）","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"description":"エラーの種類を示します","type":"string","example":"forbidden"},"error_description":{"description":"エラーの概要メッセージが入ります","type":"string","example":"Forbidden"}}}}}},"UnprocessableContent":{"description":"エラー（Unprocessable Content）","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"description":"エラーの種類を示します","type":"string","example":"validation_failed"},"error_description":{"description":"エラーの概要メッセージが入ります","type":"string","example":"Invalid Request"},"errors":{"description":"リクエスト内容の検査エラーとなったプロパティとエラー内容が入ります","type":"object","additionalProperties":{"type":["string","array"]},"example":{"example_name":"example_nameは必ず指定してください","example_items.0.example_quantity":"example_quantityには、1以上の数字をご指定ください。"}}}}}}},"NotFound":{"description":"エラー（Not Found）","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"description":"エラーの種類を示します","type":"string","example":"not_found"},"error_description":{"description":"エラーの概要メッセージが入ります","type":"string","example":"Not Found"}}}}}},"PaymentRequired":{"description":"エラー（Payment Required）","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"description":"エラーの種類を示します","type":"string","example":"payment_required"},"error_description":{"description":"エラーの概要メッセージが入ります","type":"string","example":"ご利用するにはお支払い方法の登録が必要になります"}}}}}},"BulkPostShipmentsUnprocessableContent":{"description":"エラー（Unprocessable Content）","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"description":"エラーの種類を示します","type":"string"},"error_description":{"description":"エラーの概要メッセージが入ります","type":"string"},"errors":{"description":"リクエスト内容の検査エラーとなったプロパティとエラー内容が入ります","type":"object","additionalProperties":{"description":"検査エラーとなったプロパティごとにエラー内容が入ります。\n`shipments`配列の0番目のリクエストに含まれる`identifier`が検査エラーとなった場合は、例の様に`shipments.0.identifier`にエラー内容の配列がセットされます。","type":"string"},"properties":{"shipments.index":{"description":"検査エラーとなったリクエストの配列位置。0から始まります。","type":"array","items":{"type":"integer","minimum":0}}}}}},"examples":{"リクエスト全体に対するエラー":{"value":{"error":"validation_failed","error_description":"Invalid Request","errors":{"shipments":["shipmentsは必ず指定してください。"]}}},"個々の出荷依頼に対するエラー":{"value":{"error":"validation_failed","error_description":"Bulk Shipments Validation Failed","errors":{"shipments.index":[0,2],"shipments.0.identifier":["identifierに正しい形式をご指定ください。"],"shipments.2.purpose":["指定したpurposeは使用できません"]}}}}}}}},"examples":{"DomesticShipmentRequest":{"summary":"国内向け出荷依頼","value":{"identifier":"2015-00001","order_no":"12345-67890","sender":{"postcode":"170-0013","prefecture":"東京都","address1":"豊島区東池袋1-34-5","address2":"いちご東池袋ビル9F","name":"山田 太郎","company":"スライム株式会社","division":"メタル部","phone":"03-3333-3333"},"subtotal_amount":1000,"delivery_charge":500,"handling_charge":0,"discount_amount":0,"total_amount":1500,"total_with_normal_tax":0,"total_with_reduced_tax":1000,"cushioning_unit":"ORDER","cushioning_type":"BUBBLE_PACK","gift_wrapping_unit":"ORDER","gift_wrapping_type":"NAVY","gift_sender_name":"オープン太郎","shipping_email":"test@example.com","delivery_note_type":"NOT_INCLUDE_PII","price_on_delivery_note":true,"message":"お買上げありがとうございます。","suspend":false,"shipping_date":"2019-04-02","recipient":{"postcode":"170-0013","prefecture":"東京都","address1":"豊島区東池袋1-34-5","address2":"いちご東池袋ビル9F","name":"山田 太郎","company":"スライム株式会社","division":"メタル部","phone":"03-3333-3333"},"delivery_carrier":"YAMATO","delivery_time_slot":"AM","delivery_date":"2019-04-05","cash_on_delivery":false,"delivery_method":"HOME_BOX","delivery_options":{"box_delivery":true,"fragile_item":true},"warehouse":"OPL","items":[{"code":"item-001","quantity":1,"name":"勇者の盾","unit_price":1000,"price":1000,"is_reduced_tax":true,"backorder_if_unavailable":false}],"international":false}},"InternationalShipmentRequest":{"summary":"海外向け出荷依頼","value":{"identifier":"2015-00002","order_no":"12345-67890","sender":{"region_code":"JP","postcode":"170-0013","prefecture":"Tokyo","address1":"Tshima-ku 1-34-5","address2":"Ichigo-HigashiIkebkuroBuilding 9F","name":"yamada taro","phone":"03-3333-3333"},"subtotal_amount":1000,"delivery_charge":500,"handling_charge":0,"discount_amount":0,"total_amount":1500,"cushioning_unit":"ORDER","cushioning_type":"BUBBLE_PACK","gift_wrapping_unit":"ORDER","gift_wrapping_type":"NAVY","gift_sender_name":"オープン太郎","shipping_email":"test@example.com","delivery_note_type":"NOT_INCLUDE_PII","price_on_delivery_note":true,"message":"お買上げありがとうございます。","suspend":false,"shipping_date":"2019-04-02","recipient":{"region_code":"AU","postcode":"94043","city":"Mountain View, CA","address":"1600 Amphitheatre Parkway","name":"open太郎","phone":"03-3333-3333"},"cash_on_delivery":false,"delivery_method":"HOME_BOX","delivery_options":{"box_delivery":true,"fragile_item":true},"warehouse":"OPL","items":[{"code":"item-001","quantity":1,"name":"勇者の盾","unit_price":1000,"price":1000,"backorder_if_unavailable":false}],"international":true,"delivery_service":"JAPANPOST-EMS","currency_code":"JPY","insurance":true,"purpose":"GIFT"}},"DomesticShipmentRequestList":{"summary":"国内向け出荷依頼","value":{"shipments":[{"identifier":"2015-00001","order_no":"12345-67890","sender":{"postcode":"170-0013","prefecture":"東京都","address1":"豊島区東池袋1-34-5","address2":"いちご東池袋ビル9F","name":"山田 太郎","company":"スライム株式会社","division":"メタル部","phone":"03-3333-3333"},"subtotal_amount":1000,"delivery_charge":500,"handling_charge":0,"discount_amount":0,"total_amount":1500,"total_with_normal_tax":0,"total_with_reduced_tax":1000,"cushioning_unit":"ORDER","cushioning_type":"BUBBLE_PACK","gift_wrapping_unit":"ORDER","gift_wrapping_type":"NAVY","gift_sender_name":"オープン太郎","shipping_email":"test@example.com","delivery_note_type":"NOT_INCLUDE_PII","price_on_delivery_note":true,"message":"お買上げありがとうございます。","suspend":false,"shipping_date":"2019-04-02","recipient":{"postcode":"170-0013","prefecture":"東京都","address1":"豊島区東池袋1-34-5","address2":"いちご東池袋ビル9F","name":"山田 太郎","company":"スライム株式会社","division":"メタル部","phone":"03-3333-3333"},"delivery_carrier":"YAMATO","delivery_time_slot":"AM","delivery_date":"2019-04-05","cash_on_delivery":false,"delivery_method":"HOME_BOX","delivery_options":{"box_delivery":true,"fragile_item":true},"warehouse":"OPL","items":[{"code":"item-001","quantity":1,"name":"勇者の盾","unit_price":1000,"price":1000,"is_reduced_tax":true,"backorder_if_unavailable":false}],"international":false}]}},"Region":{"summary":"国コード情報リスト","value":{"regions":[{"code":"AU","name":"オーストラリア","name_english":"AUSTRALIA","region_ems":"2-2"},{"code":"BB","name":"バルバドス","name_english":"BARBADOS","region_ems":"2-1"},{"code":"FR","name":"フランス","name_english":"FRANCE","region_ems":"2-2"},{"code":"FR-CORSICA","name":"コルシカ","name_english":"CORSICA","region_ems":"2-2"}]}},"Currency":{"summary":"通貨情報","value":{"currencies":[{"code":"JPY","name":"日本円"},{"code":"USD","name":"ドル"},{"code":"CNY","name":"人民元"},{"code":"EUR","name":"ユーロ"},{"code":"GBP","name":"ポンド"},{"code":"AUD","name":"豪ドル"}]}}}}}},"searchIndex":{"store":["section/ご利用方法","section/ご利用方法/アクセストークンの取得","section/ご利用方法/認証方法","section/ご利用方法/URL","section/ご利用方法/バージョン","section/ご利用方法/レートリミット","section/エラーについて","section/エラーについて/HTTP","section/エラーについて/各エンドポイント共通のエラーレスポンススキーマ","section/CHANGELOG","tag/items","tag/items/operation/listItems","tag/items/operation/postItem","tag/items/operation/bulkPostItems","tag/items/operation/getItemById","tag/items/operation/putItem","tag/items/operation/deleteItem","tag/items/operation/postItemImage","tag/items/operation/deleteItemImage","tag/items(code)","tag/items(code)/operation/listItemsByAccountId","tag/items(code)/operation/getItemByCode","tag/items(code)/operation/putItemByCode","tag/items(code)/operation/deleteItemByCode","tag/items(code)/operation/postItemImageByCode","tag/items(code)/operation/deleteItemImageByCode","tag/warehousings","tag/warehousings/operation/listWarehousings","tag/warehousings/operation/postWarehousing","tag/warehousings/operation/getWarehousing","tag/warehousings/operation/putWarehousing","tag/warehousings/operation/deleteWarehousing","tag/warehousings/operation/listRecentWarehousings","tag/warehousings/operation/getWarehousingsByDate","tag/warehousings/operation/getWarehousingPdf","tag/shipments","tag/shipments/operation/listShipments","tag/shipments/operation/postShipment","tag/shipments/operation/bulkPostShipments","tag/shipments/operation/getShipment","tag/shipments/operation/putShipment","tag/shipments/operation/deleteShipment","tag/shipments/operation/modifyShipment","tag/shipments/operation/cancelShipment","tag/shipments/operation/listShippedShipments","tag/shipments/operation/getShippedShipment","tag/shipments/operation/getInternationalRegion","tag/shipments/operation/getInternationalCurrency","tag/shipments/operation/postTransfer","tag/shipments/operation/putTransfer","tag/shipments/operation/postTransferModify","tag/shipments/operation/postTransferCancel","tag/shipments/operation/postAllocationClear","tag/shipments(identifier)","tag/shipments(identifier)/operation/listShipmentsByAccountId","tag/shipments(identifier)/operation/getShipmentByAccountId","tag/shipments(identifier)/operation/putShipmentByAccountId","tag/shipments(identifier)/operation/deleteShipmentByAccountId","tag/shipments(identifier)/operation/modifyShipmentByAccountId","tag/shipments(identifier)/operation/cancelShipmentByAccountId"],"index":{"version":"2.3.9","fields":["title","description"],"fieldVectors":[["title/0",[0,0.34]],["description/0",[0,0.541,1,3.791,2,3.791,3,3.361,4,2.291]],["title/1",[0,0.34]],["description/1",[0,0.582,3,2.646,4,1.642,5,2.717,6,2.717,7,2.717,8,2.717,9,2.717,10,2.717]],["title/2",[0,0.34]],["description/2",[0,0.509,11,4.207,12,4.207,13,4.207,14,4.207]],["title/3",[15,3.195]],["description/3",[0,0.618,4,1.837,15,2.621,16,3.04,17,3.04,18,3.04]],["title/4",[0,0.34]],["description/4",[0,0.542,3,2.718,4,1.702,19,2.816,20,2.816,21,4.186,22,2.816,23,2.816,24,2.816]],["title/5",[0,0.34]],["description/5",[0,0.551,25,2.924,26,2.924,27,2.255,28,2.255,29,2.924,30,2.521,31,2.521,32,2.521,33,2.924]],["title/6",[0,0.34]],["description/6",[0,0.408,4,2.69,34,4.451,35,4.451,36,4.451]],["title/7",[37,3.195]],["description/7",[0,0.586,3,1.493,4,1.389,27,1.032,28,1.032,37,0.628,38,1.153,39,0.729,40,0.729,41,0.729,42,0.729,43,0.729,44,1.338,45,0.729,46,0.729,47,0.729,48,0.729,49,0.729,50,0.729,51,1.338,52,0.729,53,0.729,54,0.729,55,0.729,56,0.729,57,0.729,58,0.729,59,0.44,60,0.628,61,0.628,62,0.628,63,0.628,64,0.628,65,0.628,66,0.628,67,0.628,68,0.628,69,1.305,70,0.729,71,0.628,72,0.628,73,0.628,74,0.729,75,0.729]],["title/8",[0,0.34]],["description/8",[0,0.516,27,2.244,28,1.366,30,0.856,31,0.856,32,0.856,38,2.508,60,1.526,61,1.526,62,1.526,63,1.526,64,1.526,65,0.856,66,1.526,67,1.526,68,1.526,71,1.526,72,1.526,73,1.526,76,2.909,77,0.993,78,2.395,79,1.77,80,0.993,81,0.993,82,0.993]],["title/9",[83,3.705]],["description/9",[84,5.797]],["title/10",[85,2.858]],["description/10",[0,0.532]],["title/11",[0,0.34]],["description/11",[0,0.462,59,3.043,85,3.884]],["title/12",[0,0.34]],["description/12",[0,0.494,85,4.157]],["title/13",[0,0.34]],["description/13",[0,0.462,59,3.043,86,5.035]],["title/14",[0,0.34]],["description/14",[87,4.341,88,5.035,89,3.884]],["title/15",[0,0.34]],["description/15",[87,4.341,89,3.884,90,5.035]],["title/16",[0,0.34]],["description/16",[0,0.571,89,3.884]],["title/17",[0,0.34]],["description/17",[0,0.621,91,1.825,92,1.825,93,1.825,94,2.897,95,1.825,96,1.825,97,1.825,98,1.825,99,2.117]],["title/18",[0,0.34]],["description/18",[0,0.571,100,5.035]],["title/19",[101,3.705]],["description/19",[102,5.035,103,5.035,104,4.341]],["title/20",[0,0.34]],["description/20",[0,0.462,59,3.043,105,5.035]],["title/21",[0,0.34]],["description/21",[0,0.494,106,4.157]],["title/22",[0,0.34]],["description/22",[0,0.494,106,4.157]],["title/23",[0,0.34]],["description/23",[0,0.571,106,3.884]],["title/24",[0,0.34]],["description/24",[0,0.621,91,1.825,92,1.825,93,1.825,94,2.897,95,1.825,96,1.825,97,1.825,98,1.825,107,2.117]],["title/25",[0,0.34]],["description/25",[0,0.571,108,5.035]],["title/26",[109,2.858]],["description/26",[0,0.532]],["title/27",[0,0.34]],["description/27",[0,0.462,59,3.043,109,3.884]],["title/28",[0,0.34]],["description/28",[0,0.528,109,3.433,110,4.451,111,4.451]],["title/29",[0,0.34]],["description/29",[0,0.494,112,4.157]],["title/30",[0,0.34]],["description/30",[0,0.571,112,3.884]],["title/31",[0,0.34]],["description/31",[0,0.571,112,3.884]],["title/32",[0,0.34]],["description/32",[0,0.56,69,1.142,113,3.483,114,2.708,115,1.624,116,1.624,117,1.624,118,1.624,119,1.624,120,1.624,121,1.624,122,1.624,123,1.624,124,1.624,125,1.624,126,1.624,127,1.624,128,1.624,129,1.624,130,1.624,131,1.624]],["title/33",[0,0.34]],["description/33",[132,5.035,133,5.035,134,5.035]],["title/34",[0,0.34]],["description/34",[0,0.494,135,5.389]],["title/35",[136,2.858]],["description/35",[0,0.532]],["title/36",[0,0.34]],["description/36",[136,3.433,137,4.451,138,5.758,139,4.451]],["title/37",[0,0.34]],["description/37",[0,0.638,69,1.341,136,1.47,140,3.864,141,3.09,142,1.906]],["title/38",[0,0.34]],["description/38",[0,0.618,3,1.974,59,1.837,143,3.04,144,3.04,145,3.04]],["title/39",[0,0.34]],["description/39",[146,5.389,147,4.157]],["title/40",[0,0.34]],["description/40",[0,0.609,147,2.661,148,3.45,149,3.45,150,3.45]],["title/41",[0,0.34]],["description/41",[0,0.494,147,4.157]],["title/42",[0,0.34]],["description/42",[0,0.637,151,3.988]],["title/43",[0,0.34]],["description/43",[0,0.637,152,3.988]],["title/44",[0,0.34]],["description/44",[69,4.38,153,5.035]],["title/45",[0,0.34]],["description/45",[0,0.494,154,5.389]],["title/46",[0,0.34]],["description/46",[0,0.494,155,5.389]],["title/47",[0,0.34]],["description/47",[0,0.494,156,5.389]],["title/48",[0,0.34]],["description/48",[0,0.602,157,4.725]],["title/49",[0,0.34]],["description/49",[0,0.494,158,5.389]],["title/50",[0,0.34]],["description/50",[0,0.619,159,4.451]],["title/51",[0,0.34]],["description/51",[0,0.619,160,4.451]],["title/52",[0,0.34]],["description/52",[0,0.602,161,4.725]],["title/53",[162,3.705]],["description/53",[104,4.341,140,4.341,163,5.035]],["title/54",[0,0.34]],["description/54",[164,6.225,165,5.035]],["title/55",[0,0.34]],["description/55",[0,0.494,166,4.157]],["title/56",[0,0.34]],["description/56",[0,0.494,166,4.157]],["title/57",[0,0.34]],["description/57",[0,0.494,166,4.157]],["title/58",[0,0.34]],["description/58",[0,0.637,167,3.988]],["title/59",[0,0.34]],["description/59",[0,0.637,168,3.988]]],"invertedIndex":[["",{"_index":0,"title":{"0":{},"1":{},"2":{},"4":{},"5":{},"6":{},"8":{},"11":{},"12":{},"13":{},"14":{},"15":{},"16":{},"17":{},"18":{},"20":{},"21":{},"22":{},"23":{},"24":{},"25":{},"27":{},"28":{},"29":{},"30":{},"31":{},"32":{},"33":{},"34":{},"36":{},"37":{},"38":{},"39":{},"40":{},"41":{},"42":{},"43":{},"44":{},"45":{},"46":{},"47":{},"48":{},"49":{},"50":{},"51":{},"52":{},"54":{},"55":{},"56":{},"57":{},"58":{},"59":{}},"description":{"0":{},"1":{},"2":{},"3":{},"4":{},"5":{},"6":{},"7":{},"8":{},"10":{},"11":{},"12":{},"13":{},"16":{},"17":{},"18":{},"20":{},"21":{},"22":{},"23":{},"24":{},"25":{},"26":{},"27":{},"28":{},"29":{},"30":{},"31":{},"32":{},"34":{},"35":{},"37":{},"38":{},"40":{},"41":{},"42":{},"43":{},"45":{},"46":{},"47":{},"48":{},"49":{},"50":{},"51":{},"52":{},"55":{},"56":{},"57":{},"58":{},"59":{}}}],["0",{"_index":77,"title":{},"description":{"8":{}}}],["1",{"_index":69,"title":{},"description":{"7":{},"32":{},"37":{},"44":{}}}],["1.5",{"_index":21,"title":{},"description":{"4":{}}}],["1.6",{"_index":19,"title":{},"description":{"4":{}}}],["1件の商品id",{"_index":87,"title":{},"description":{"14":{},"15":{}}}],["1分間に60回を超えるリクエストを行うと、httpステータスコード429（too",{"_index":26,"title":{},"description":{"5":{}}}],["2025-01-01",{"_index":126,"title":{},"description":{"32":{}}}],["2025-01-05",{"_index":121,"title":{},"description":{"32":{}}}],["2025-01-10",{"_index":116,"title":{},"description":{"32":{}}}],["3",{"_index":115,"title":{},"description":{"32":{}}}],["400",{"_index":39,"title":{},"description":{"7":{}}}],["401",{"_index":43,"title":{},"description":{"7":{}}}],["402",{"_index":45,"title":{},"description":{"7":{}}}],["403",{"_index":50,"title":{},"description":{"7":{}}}],["404",{"_index":52,"title":{},"description":{"7":{}}}],["422",{"_index":55,"title":{},"description":{"7":{}}}],["429",{"_index":60,"title":{},"description":{"7":{},"8":{}}}],["500",{"_index":62,"title":{},"description":{"7":{},"8":{}}}],["503",{"_index":66,"title":{},"description":{"7":{},"8":{}}}],["504",{"_index":71,"title":{},"description":{"7":{},"8":{}}}],["50件〜100",{"_index":144,"title":{},"description":{"38":{}}}],["59",{"_index":33,"title":{},"description":{"5":{}}}],["5xx",{"_index":35,"title":{},"description":{"6":{}}}],["60",{"_index":31,"title":{},"description":{"5":{},"8":{}}}],["activ",{"_index":22,"title":{},"description":{"4":{}}}],["api",{"_index":3,"title":{},"description":{"0":{},"1":{},"4":{},"7":{},"38":{}}}],["api](#tag/warehousings/operation/getwarehousingpdf)またはオープンロジの入荷依頼中の画面より入荷明細書兼入荷ラベルのpdf",{"_index":110,"title":{},"description":{"28":{}}}],["apiが処理できないリクエスト形式です。なお、リクエストデータ形式の誤りは422",{"_index":42,"title":{},"description":{"7":{}}}],["apiでは、http",{"_index":34,"title":{},"description":{"6":{}}}],["apiとは異なり、`apply_rul",{"_index":143,"title":{},"description":{"38":{}}}],["apiのメンテナンス中です。メンテナンス終了後にリクエストをお願いします。メンテナンス予定については[こちら](https://help.openlogi.com/faq/show/252",{"_index":70,"title":{},"description":{"7":{}}}],["apiを提供するベースurl",{"_index":16,"title":{},"description":{"3":{}}}],["apiエンドポイントへのリクエスト時に、`x-api-vers",{"_index":23,"title":{},"description":{"4":{}}}],["apiエンドポイントへのリクエスト時に、取得したアクセストークンを`author",{"_index":11,"title":{},"description":{"2":{}}}],["apiシステムに問題が発生しています。getの場合は時間を置いてリトライを、postの場合は管理画面でリソースが作られているかどうかの確認を、put/deleteの場合はリソースをget",{"_index":74,"title":{},"description":{"7":{}}}],["apiリクエストは1分間に60",{"_index":25,"title":{},"description":{"5":{}}}],["application/json",{"_index":79,"title":{},"description":{"8":{}}}],["attempt",{"_index":61,"title":{},"description":{"7":{},"8":{}}}],["author",{"_index":12,"title":{},"description":{"2":{}}}],["backorder_if_unavailable`に`tru",{"_index":142,"title":{},"description":{"37":{}}}],["backordered`、`wait",{"_index":148,"title":{},"description":{"40":{}}}],["bad",{"_index":40,"title":{},"description":{"7":{}}}],["bearer",{"_index":13,"title":{},"description":{"2":{}}}],["changelog",{"_index":83,"title":{"9":{}},"description":{}}],["code",{"_index":102,"title":{},"description":{"19":{}}}],["code指定の商品情報取得](#tag/items(code)/operation/getitembycod",{"_index":88,"title":{},"description":{"14":{}}}],["code指定の商品情報取得](#tag/items(code)/operation/putitembycod",{"_index":90,"title":{},"description":{"15":{}}}],["content",{"_index":57,"title":{},"description":{"7":{}}}],["content-disposit",{"_index":94,"title":{},"description":{"17":{},"24":{}}}],["content-typ",{"_index":78,"title":{},"description":{"8":{}}}],["content-type`レスポンスヘッダーの値が`text/html",{"_index":75,"title":{},"description":{"7":{}}}],["date_aft",{"_index":114,"title":{},"description":{"32":{}}}],["date_after=20241201",{"_index":129,"title":{},"description":{"32":{}}}],["date_after=20250101",{"_index":130,"title":{},"description":{"32":{}}}],["date_after=20250102",{"_index":124,"title":{},"description":{"32":{}}}],["date_after=20250105",{"_index":125,"title":{},"description":{"32":{}}}],["date_after=20250106",{"_index":119,"title":{},"description":{"32":{}}}],["date_after=20250110",{"_index":120,"title":{},"description":{"32":{}}}],["date_befor",{"_index":113,"title":{},"description":{"32":{}}}],["date_before=20250101",{"_index":127,"title":{},"description":{"32":{}}}],["date_before=20250102",{"_index":128,"title":{},"description":{"32":{}}}],["date_before=20250105",{"_index":122,"title":{},"description":{"32":{}}}],["date_before=20250109",{"_index":123,"title":{},"description":{"32":{}}}],["date_before=20250110",{"_index":117,"title":{},"description":{"32":{}}}],["date_before=20250131",{"_index":118,"title":{},"description":{"32":{}}}],["doc/changelog.html",{"_index":84,"title":{},"description":{"9":{}}}],["error",{"_index":38,"title":{},"description":{"7":{},"8":{}}}],["error_descript",{"_index":80,"title":{},"description":{"8":{}}}],["exceptionまたはapi_except",{"_index":41,"title":{},"description":{"7":{}}}],["file",{"_index":96,"title":{},"description":{"17":{},"24":{}}}],["filenam",{"_index":97,"title":{},"description":{"17":{},"24":{}}}],["forbidden",{"_index":51,"title":{},"description":{"7":{}}}],["found",{"_index":53,"title":{},"description":{"7":{}}}],["gateway",{"_index":72,"title":{},"description":{"7":{},"8":{}}}],["halfway`が`tru",{"_index":133,"title":{},"description":{"33":{}}}],["href=\"https://app-demo.openlogi.com/portal/token",{"_index":9,"title":{},"description":{"1":{}}}],["href=\"https://app.openlogi.com/portal/token",{"_index":7,"title":{},"description":{"1":{}}}],["html>503ただいま、メンテナンス中ですデモ環境でトークンを発行する本番環境でトークンを発行する