Download OpenAPI specification:Download
物流アウトソーシングサービスの オープンロジ が提供する Web API です。
OPENLOGI APIを活用することで物流業務の自動化を行うことができるようになります。
こちらを参照してください。
OPENLOGI APIを利用してユーザリソースにアクセスするにはアクセストークンが必要となります。
アクセストークンは以下URLのAPI設定画面より発行することができます。
https://app.openlogi.com/portal/tokens (本番環境)
https://app-demo.openlogi.com/portal/tokens (デモ環境)
※ユーザー管理
より追加したサブアカウントでのアクセストークンの発行はできません
複数クライアントから利用する場合はそれぞれ別のアクセストークンを発行し利用してください。
ここで発行されるアクセストークンは有効期限が無い状態で発行されますので取り扱いにはくれぐれもご注意ください。 不要になったアクセストークンは必ず削除してください。 (アクセストークン漏洩による被害に関しては一切の責任を負いません)
OPENLOGI APIを提供するホストは以下のURLになります。
https://api.openlogi.com (本番環境)
https://api-demo.openlogi.com (デモ環境)
アクセスする際には指定のリクエストヘッダーを付与する必要があります。
Key | Description |
---|---|
X-Api-Version | 利用するAPIのバージョン (1.3 / 1.4 / 1.5) |
Authorization | API設定画面にて取得したBearer Token |
例)
X-Api-Version: 1.5
Authorization: Bearer wz2FvCW3NRm4GZgLC7GMlW3XbM2qIIbuCDv8RZ8F
APIリクエストは1分間に約60回を上限とします。
それ以上の頻度で送信する必要がある場合は、弊社までお問い合わせください。
※仕様は変更となる場合があります。
OPENLOGI APIでは、HTTPステータスコードを用いてリクエストの成否を表現しています。 以下の表をご参考にエラーハンドリングをお願いします。
リクエストがタイムアウトした(ステータスコードが460, 5xxとなった)際は、ネットワーク接続が閉じられてもサーバー側で処理を継続し処理が成功している場合があります。 この場合、GETの場合は時間を置いてリトライをお願いします。 また、POSTの場合は管理画面でリソースが作られているかどうかの確認を、PUT/DELETEの場合はリソースをGETした結果で成否をご確認ください。
ステータス | 概要 | 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制限に達しました。リクエスト間隔を空けてリトライをお願いします。 |
460 | (注1) | リクエスト処理中に、クライアント側で接続を閉じました。GETの場合は時間を置いてリトライを、POSTの場合は管理画面でリソースが作られているかどうかの確認を、PUT/DELETEの場合はリソースをGETした結果で成否をご確認ください。なお、推奨するクライアント側での接続タイムアウトは60秒です。 | |
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
の場合もあるため、レスポンスボディではなくステータスコードをご利用ください。
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."
}
HTTP/1.1 460
HTTP/1.1 500 Internal Server Error
Content-Type: application/json
{
"error": "internal_server_error"
}
HTTP/1.1 503 Service Unavailable
Content-Type: text/html
<html><head><title>503</title></head><body>ただいま、メンテナンス中です</body></html>
HTTP/1.1 504 Gateway Timeout
商品の一覧を在庫情報と合わせて取得できます。
商品情報と同じフォーマットのJSONが配列で取得できます。
id required | string Example: id=TS001-I000001,AB001-I000003 商品ID指定 カンマ( |
stock | integer Example: stock=1 在庫情報を含むかどうか |
{- "items": [
- {
- "id": "TS001-I000001",
- "code": "item-002",
- "name": "勇者の盾",
- "price": "1000",
- "is_reduced_tax": true,
- "hs_code": "000000.000",
- "barcode": "1234567890128",
- "item_barcodes": [
- "TEST1"
], - "description": "玩具",
- "international_info": {
- "invoice_summary": "Toy",
- "origin": "JP"
}, - "child_items": [
- {
- "id": "TS001-I000003",
- "code": "item-001",
- "quantity": 1
}
], - "tags": [
- "water gun"
], - "stock": {
- "available": 1,
- "shipping": 1,
- "reserved": 1,
- "backordered": 1,
- "quantity": 1,
- "size": "S",
- "weight": 200
}, - "stocks": [
- {
- "warehouse": "NBZ",
- "available": 1,
- "shipping": 1,
- "reserved": 1,
- "backordered": 1,
- "quantity": 1,
- "dispose": "waiting"
}
], - "bundled_item": true,
- "externalCode": "TEST1",
- "hidden": true,
- "temperature_zone": "frozen",
- "fifo": true,
- "lot_limit_type": "expiry",
- "expiry_at_allocatable_days": 20,
- "manufacture_date_allocatable_days": 20,
- "expiry_at": "2021-04-05",
- "manufacture_date": "2021-04-01",
- "lot_allocatable_at": "2021-04-05",
- "lot_allocatable_priority": 1
}
]
}
商品を登録します。
code required | string 商品コード |
name | string 商品名 |
price | any 価格 |
is_reduced_tax | boolean 軽減税率適用商品 |
hs_code | string^\d{4}\.?\d{2}((\.|-)?\d{3,4})?$ HSコード |
barcode | string バーコード |
object 海外発送情報 | |
Array of objects (child_item) セット商品の子商品リスト | |
tags | Array of strings 商品タグ |
temperature_zone | string or null Enum: "dry" "constant" "chilled" "frozen" 保管温度帯 ※温度帯管理を利用するお客様のみ使用可能 |
fifo | boolean or null 先入れ先出し ※先入れ先出し管理を利用するお客様のみ使用可能 |
lot_limit_type | string or null Enum: "expiry" "manufacture" 期限商品タイプ ※商品マスタ情報。期限管理を利用するお客様のみ使用可能 |
expiry_at_allocatable_days | integer or null 引当可能残期間(賞味期限) ※商品マスタ情報。期限管理を利用するお客様のみ使用可能 |
manufacture_date_allocatable_days | integer or null 引当可能残期間(製造年月日) ※商品マスタ情報。期限管理を利用するお客様のみ使用可能 |
{- "code": "item-002",
- "name": "勇者の盾",
- "price": "1000",
- "is_reduced_tax": true,
- "hs_code": "000000.000",
- "barcode": "1234567890128",
- "international_info": {
- "invoice_summary": "Toy",
- "origin": "JP"
}, - "child_items": [
- {
- "id": "TS001-I000003",
- "code": "item-001",
- "quantity": 1
}
], - "tags": [
- "water gun"
], - "temperature_zone": "frozen",
- "fifo": true,
- "lot_limit_type": "expiry",
- "expiry_at_allocatable_days": 20,
- "manufacture_date_allocatable_days": 20
}
{- "id": "TS001-I000001",
- "code": "item-002",
- "name": "勇者の盾",
- "price": "1000",
- "is_reduced_tax": true,
- "hs_code": "000000.000",
- "barcode": "1234567890128",
- "item_barcodes": [
- "TEST1"
], - "description": "玩具",
- "international_info": {
- "invoice_summary": "Toy",
- "origin": "JP"
}, - "child_items": [
- {
- "id": "TS001-I000003",
- "code": "item-001",
- "quantity": 1
}
], - "tags": [
- "water gun"
], - "stock": {
- "available": 1,
- "shipping": 1,
- "reserved": 1,
- "backordered": 1,
- "quantity": 1,
- "size": "S",
- "weight": 200
}, - "stocks": [
- {
- "warehouse": "NBZ",
- "available": 1,
- "shipping": 1,
- "reserved": 1,
- "backordered": 1,
- "quantity": 1,
- "dispose": "waiting"
}
], - "bundled_item": true,
- "externalCode": "TEST1",
- "hidden": true,
- "temperature_zone": "frozen",
- "fifo": true,
- "lot_limit_type": "expiry",
- "expiry_at_allocatable_days": 20,
- "manufacture_date_allocatable_days": 20,
- "expiry_at": "2021-04-05",
- "manufacture_date": "2021-04-01",
- "lot_allocatable_at": "2021-04-05",
- "lot_allocatable_priority": 1
}
商品を一括登録します。
商品登録と同じフォーマットのJSONを配列で送信することで一括登録できます。
Array of objects (ItemRequest) 商品リスト |
{- "items": [
- {
- "code": "item-002",
- "name": "勇者の盾",
- "price": "1000",
- "is_reduced_tax": true,
- "hs_code": "000000.000",
- "barcode": "1234567890128",
- "international_info": {
- "invoice_summary": "Toy",
- "origin": "JP"
}, - "child_items": [
- {
- "id": "TS001-I000003",
- "code": "item-001",
- "quantity": 1
}
], - "tags": [
- "water gun"
], - "temperature_zone": "frozen",
- "fifo": true,
- "lot_limit_type": "expiry",
- "expiry_at_allocatable_days": 20,
- "manufacture_date_allocatable_days": 20
}
]
}
{- "items": [
- {
- "id": "TS001-I000001",
- "code": "item-002",
- "name": "勇者の盾",
- "price": "1000",
- "is_reduced_tax": true,
- "hs_code": "000000.000",
- "barcode": "1234567890128",
- "item_barcodes": [
- "TEST1"
], - "description": "玩具",
- "international_info": {
- "invoice_summary": "Toy",
- "origin": "JP"
}, - "child_items": [
- {
- "id": "TS001-I000003",
- "code": "item-001",
- "quantity": 1
}
], - "tags": [
- "water gun"
], - "stock": {
- "available": 1,
- "shipping": 1,
- "reserved": 1,
- "backordered": 1,
- "quantity": 1,
- "size": "S",
- "weight": 200
}, - "stocks": [
- {
- "warehouse": "NBZ",
- "available": 1,
- "shipping": 1,
- "reserved": 1,
- "backordered": 1,
- "quantity": 1,
- "dispose": "waiting"
}
], - "bundled_item": true,
- "externalCode": "TEST1",
- "hidden": true,
- "temperature_zone": "frozen",
- "fifo": true,
- "lot_limit_type": "expiry",
- "expiry_at_allocatable_days": 20,
- "manufacture_date_allocatable_days": 20,
- "expiry_at": "2021-04-05",
- "manufacture_date": "2021-04-01",
- "lot_allocatable_at": "2021-04-05",
- "lot_allocatable_priority": 1
}
]
}
在庫情報を含んだ商品情報を取得できます。
id required | string Example: TS001-I000001 商品ID |
stock | integer Example: stock=1 在庫情報を含むかどうか |
{- "id": "TS001-I000001",
- "code": "item-002",
- "name": "勇者の盾",
- "price": "1000",
- "is_reduced_tax": true,
- "hs_code": "000000.000",
- "barcode": "1234567890128",
- "item_barcodes": [
- "TEST1"
], - "description": "玩具",
- "international_info": {
- "invoice_summary": "Toy",
- "origin": "JP"
}, - "child_items": [
- {
- "id": "TS001-I000003",
- "code": "item-001",
- "quantity": 1
}
], - "tags": [
- "water gun"
], - "stock": {
- "available": 1,
- "shipping": 1,
- "reserved": 1,
- "backordered": 1,
- "quantity": 1,
- "size": "S",
- "weight": 200
}, - "stocks": [
- {
- "warehouse": "NBZ",
- "available": 1,
- "shipping": 1,
- "reserved": 1,
- "backordered": 1,
- "quantity": 1,
- "dispose": "waiting"
}
], - "bundled_item": true,
- "externalCode": "TEST1",
- "hidden": true,
- "temperature_zone": "frozen",
- "fifo": true,
- "lot_limit_type": "expiry",
- "expiry_at_allocatable_days": 20,
- "manufacture_date_allocatable_days": 20,
- "expiry_at": "2021-04-05",
- "manufacture_date": "2021-04-01",
- "lot_allocatable_at": "2021-04-05",
- "lot_allocatable_priority": 1
}
商品情報を更新します。
id required | string Example: TS001-I000001 商品ID |
code required | string 商品コード |
name | string 商品名 |
price | any 価格 |
is_reduced_tax | boolean 軽減税率適用商品 |
hs_code | string^\d{4}\.?\d{2}((\.|-)?\d{3,4})?$ HSコード |
barcode | string バーコード |
object 海外発送情報 | |
Array of objects (child_item) セット商品の子商品リスト | |
tags | Array of strings 商品タグ |
temperature_zone | string or null Enum: "dry" "constant" "chilled" "frozen" 保管温度帯 ※温度帯管理を利用するお客様のみ使用可能 |
fifo | boolean or null 先入れ先出し ※先入れ先出し管理を利用するお客様のみ使用可能 |
lot_limit_type | string or null Enum: "expiry" "manufacture" 期限商品タイプ ※商品マスタ情報。期限管理を利用するお客様のみ使用可能 |
expiry_at_allocatable_days | integer or null 引当可能残期間(賞味期限) ※商品マスタ情報。期限管理を利用するお客様のみ使用可能 |
manufacture_date_allocatable_days | integer or null 引当可能残期間(製造年月日) ※商品マスタ情報。期限管理を利用するお客様のみ使用可能 |
bundled_item | boolean or null 同梱物 |
{- "code": "item-002",
- "name": "勇者の盾",
- "price": "1000",
- "is_reduced_tax": true,
- "hs_code": "000000.000",
- "barcode": "1234567890128",
- "international_info": {
- "invoice_summary": "Toy",
- "origin": "JP"
}, - "child_items": [
- {
- "id": "TS001-I000003",
- "code": "item-001",
- "quantity": 1
}
], - "tags": [
- "water gun"
], - "temperature_zone": "frozen",
- "fifo": true,
- "lot_limit_type": "expiry",
- "expiry_at_allocatable_days": 20,
- "manufacture_date_allocatable_days": 20,
- "bundled_item": true
}
{- "id": "TS001-I000001",
- "code": "item-002",
- "name": "勇者の盾",
- "price": "1000",
- "is_reduced_tax": true,
- "hs_code": "000000.000",
- "barcode": "1234567890128",
- "item_barcodes": [
- "TEST1"
], - "description": "玩具",
- "international_info": {
- "invoice_summary": "Toy",
- "origin": "JP"
}, - "child_items": [
- {
- "id": "TS001-I000003",
- "code": "item-001",
- "quantity": 1
}
], - "tags": [
- "water gun"
], - "stock": {
- "available": 1,
- "shipping": 1,
- "reserved": 1,
- "backordered": 1,
- "quantity": 1,
- "size": "S",
- "weight": 200
}, - "stocks": [
- {
- "warehouse": "NBZ",
- "available": 1,
- "shipping": 1,
- "reserved": 1,
- "backordered": 1,
- "quantity": 1,
- "dispose": "waiting"
}
], - "bundled_item": true,
- "externalCode": "TEST1",
- "hidden": true,
- "temperature_zone": "frozen",
- "fifo": true,
- "lot_limit_type": "expiry",
- "expiry_at_allocatable_days": 20,
- "manufacture_date_allocatable_days": 20,
- "expiry_at": "2021-04-05",
- "manufacture_date": "2021-04-01",
- "lot_allocatable_at": "2021-04-05",
- "lot_allocatable_priority": 1
}
商品を削除します。
入庫依頼中および入庫実績があるアイテムは削除できません。
id required | string Example: TS001-I000001 商品ID |
{ }
{- "id": "TS001-I000001",
- "code": "item-002",
- "name": "勇者の盾",
- "price": "1000",
- "is_reduced_tax": true,
- "hs_code": "000000.000",
- "barcode": "1234567890128",
- "item_barcodes": [
- "TEST1"
], - "description": "玩具",
- "international_info": {
- "invoice_summary": "Toy",
- "origin": "JP"
}, - "child_items": [
- {
- "id": "TS001-I000003",
- "code": "item-001",
- "quantity": 1
}
], - "tags": [
- "water gun"
], - "stock": {
- "available": 1,
- "shipping": 1,
- "reserved": 1,
- "backordered": 1,
- "quantity": 1,
- "size": "S",
- "weight": 200
}, - "stocks": [
- {
- "warehouse": "NBZ",
- "available": 1,
- "shipping": 1,
- "reserved": 1,
- "backordered": 1,
- "quantity": 1,
- "dispose": "waiting"
}
], - "bundled_item": true,
- "externalCode": "TEST1",
- "hidden": true,
- "temperature_zone": "frozen",
- "fifo": true,
- "lot_limit_type": "expiry",
- "expiry_at_allocatable_days": 20,
- "manufacture_date_allocatable_days": 20,
- "expiry_at": "2021-04-05",
- "manufacture_date": "2021-04-01",
- "lot_allocatable_at": "2021-04-05",
- "lot_allocatable_priority": 1
}
商品の画像を登録します。 jpeg, png タイプのファイルを指定できます。
multipart/form-data 形式でファイルを送信します。
Content-Disposition の name は file を指定してください。
ファイル名は Content-Disposition の filename で指定してください。
ファイル名がマルチバイトの場合は UTF-8 エンコードした値を指定してください。
id required | string Example: TS001-I000001 商品ID |
name | string |
filename | string |
{- "id": 1234
}
商品コード(code
)を指定して商品情報を操作します。
オープンロジが発行する商品IDが不明な場合にご利用ください。
商品の一覧を在庫情報と合わせて取得できます。
商品情報と同じフォーマットのJSONが配列で取得できます。
account_id required | string Example: AB001 アカウントコード |
identifier required | string Example: identifier=123456-098765,12345678,AB12345 商品識別番号 カンマ( |
code required | string Example: code=DQ001,DQ002 商品コード カンマ( |
stock | integer Example: stock=1 在庫情報を含むかどうか |
{- "items": [
- {
- "id": "TS001-I000001",
- "code": "item-002",
- "name": "勇者の盾",
- "price": "1000",
- "is_reduced_tax": true,
- "hs_code": "000000.000",
- "barcode": "1234567890128",
- "item_barcodes": [
- "TEST1"
], - "description": "玩具",
- "international_info": {
- "invoice_summary": "Toy",
- "origin": "JP"
}, - "child_items": [
- {
- "id": "TS001-I000003",
- "code": "item-001",
- "quantity": 1
}
], - "tags": [
- "water gun"
], - "stock": {
- "available": 1,
- "shipping": 1,
- "reserved": 1,
- "backordered": 1,
- "quantity": 1,
- "size": "S",
- "weight": 200
}, - "stocks": [
- {
- "warehouse": "NBZ",
- "available": 1,
- "shipping": 1,
- "reserved": 1,
- "backordered": 1,
- "quantity": 1,
- "dispose": "waiting"
}
], - "bundled_item": true,
- "externalCode": "TEST1",
- "hidden": true,
- "temperature_zone": "frozen",
- "fifo": true,
- "lot_limit_type": "expiry",
- "expiry_at_allocatable_days": 20,
- "manufacture_date_allocatable_days": 20,
- "expiry_at": "2021-04-05",
- "manufacture_date": "2021-04-01",
- "lot_allocatable_at": "2021-04-05",
- "lot_allocatable_priority": 1
}
]
}
在庫情報を含んだ商品情報を取得できます。
account_id required | string Example: AB001 アカウントコード |
code required | string Example: item-001 商品コード |
stock | integer Example: stock=1 在庫情報を含むかどうか |
{- "id": "TS001-I000001",
- "code": "item-002",
- "name": "勇者の盾",
- "price": "1000",
- "is_reduced_tax": true,
- "hs_code": "000000.000",
- "barcode": "1234567890128",
- "item_barcodes": [
- "TEST1"
], - "description": "玩具",
- "international_info": {
- "invoice_summary": "Toy",
- "origin": "JP"
}, - "child_items": [
- {
- "id": "TS001-I000003",
- "code": "item-001",
- "quantity": 1
}
], - "tags": [
- "water gun"
], - "stock": {
- "available": 1,
- "shipping": 1,
- "reserved": 1,
- "backordered": 1,
- "quantity": 1,
- "size": "S",
- "weight": 200
}, - "stocks": [
- {
- "warehouse": "NBZ",
- "available": 1,
- "shipping": 1,
- "reserved": 1,
- "backordered": 1,
- "quantity": 1,
- "dispose": "waiting"
}
], - "bundled_item": true,
- "externalCode": "TEST1",
- "hidden": true,
- "temperature_zone": "frozen",
- "fifo": true,
- "lot_limit_type": "expiry",
- "expiry_at_allocatable_days": 20,
- "manufacture_date_allocatable_days": 20,
- "expiry_at": "2021-04-05",
- "manufacture_date": "2021-04-01",
- "lot_allocatable_at": "2021-04-05",
- "lot_allocatable_priority": 1
}
商品情報を更新します。
account_id required | string Example: AB001 アカウントコード |
code required | string Example: item-001 商品コード |
code required | string 商品コード |
name | string 商品名 |
price | any 価格 |
is_reduced_tax | boolean 軽減税率適用商品 |
hs_code | string^\d{4}\.?\d{2}((\.|-)?\d{3,4})?$ HSコード |
barcode | string バーコード |
object 海外発送情報 | |
Array of objects (child_item) セット商品の子商品リスト | |
tags | Array of strings 商品タグ |
temperature_zone | string or null Enum: "dry" "constant" "chilled" "frozen" 保管温度帯 ※温度帯管理を利用するお客様のみ使用可能 |
fifo | boolean or null 先入れ先出し ※先入れ先出し管理を利用するお客様のみ使用可能 |
lot_limit_type | string or null Enum: "expiry" "manufacture" 期限商品タイプ ※商品マスタ情報。期限管理を利用するお客様のみ使用可能 |
expiry_at_allocatable_days | integer or null 引当可能残期間(賞味期限) ※商品マスタ情報。期限管理を利用するお客様のみ使用可能 |
manufacture_date_allocatable_days | integer or null 引当可能残期間(製造年月日) ※商品マスタ情報。期限管理を利用するお客様のみ使用可能 |
bundled_item | boolean or null 同梱物 |
{- "code": "item-002",
- "name": "勇者の盾",
- "price": "1000",
- "is_reduced_tax": true,
- "hs_code": "000000.000",
- "barcode": "1234567890128",
- "international_info": {
- "invoice_summary": "Toy",
- "origin": "JP"
}, - "child_items": [
- {
- "id": "TS001-I000003",
- "code": "item-001",
- "quantity": 1
}
], - "tags": [
- "water gun"
], - "temperature_zone": "frozen",
- "fifo": true,
- "lot_limit_type": "expiry",
- "expiry_at_allocatable_days": 20,
- "manufacture_date_allocatable_days": 20,
- "bundled_item": true
}
{- "id": "TS001-I000001",
- "code": "item-002",
- "name": "勇者の盾",
- "price": "1000",
- "is_reduced_tax": true,
- "hs_code": "000000.000",
- "barcode": "1234567890128",
- "item_barcodes": [
- "TEST1"
], - "description": "玩具",
- "international_info": {
- "invoice_summary": "Toy",
- "origin": "JP"
}, - "child_items": [
- {
- "id": "TS001-I000003",
- "code": "item-001",
- "quantity": 1
}
], - "tags": [
- "water gun"
], - "stock": {
- "available": 1,
- "shipping": 1,
- "reserved": 1,
- "backordered": 1,
- "quantity": 1,
- "size": "S",
- "weight": 200
}, - "stocks": [
- {
- "warehouse": "NBZ",
- "available": 1,
- "shipping": 1,
- "reserved": 1,
- "backordered": 1,
- "quantity": 1,
- "dispose": "waiting"
}
], - "bundled_item": true,
- "externalCode": "TEST1",
- "hidden": true,
- "temperature_zone": "frozen",
- "fifo": true,
- "lot_limit_type": "expiry",
- "expiry_at_allocatable_days": 20,
- "manufacture_date_allocatable_days": 20,
- "expiry_at": "2021-04-05",
- "manufacture_date": "2021-04-01",
- "lot_allocatable_at": "2021-04-05",
- "lot_allocatable_priority": 1
}
商品を削除します。
入庫依頼中および入庫実績があるアイテムは削除できません。
account_id required | string Example: AB001 アカウントコード |
code required | string Example: item-001 商品コード |
{ }
{- "id": "TS001-I000001",
- "code": "item-002",
- "name": "勇者の盾",
- "price": "1000",
- "is_reduced_tax": true,
- "hs_code": "000000.000",
- "barcode": "1234567890128",
- "item_barcodes": [
- "TEST1"
], - "description": "玩具",
- "international_info": {
- "invoice_summary": "Toy",
- "origin": "JP"
}, - "child_items": [
- {
- "id": "TS001-I000003",
- "code": "item-001",
- "quantity": 1
}
], - "tags": [
- "water gun"
], - "stock": {
- "available": 1,
- "shipping": 1,
- "reserved": 1,
- "backordered": 1,
- "quantity": 1,
- "size": "S",
- "weight": 200
}, - "stocks": [
- {
- "warehouse": "NBZ",
- "available": 1,
- "shipping": 1,
- "reserved": 1,
- "backordered": 1,
- "quantity": 1,
- "dispose": "waiting"
}
], - "bundled_item": true,
- "externalCode": "TEST1",
- "hidden": true,
- "temperature_zone": "frozen",
- "fifo": true,
- "lot_limit_type": "expiry",
- "expiry_at_allocatable_days": 20,
- "manufacture_date_allocatable_days": 20,
- "expiry_at": "2021-04-05",
- "manufacture_date": "2021-04-01",
- "lot_allocatable_at": "2021-04-05",
- "lot_allocatable_priority": 1
}
商品の画像を登録します。 jpeg, png タイプのファイルを指定できます。
multipart/form-data 形式でファイルを送信します。
Content-Disposition の name は file を指定してください。
ファイル名は Content-Disposition の filename で指定してください。
ファイル名がマルチバイトの場合は UTF-8 エンコードした値を指定してください。
account_id required | string Example: AB001 アカウントコード |
code required | string Example: item-001 商品コード |
name | string |
filename | string |
{- "id": 1234
}
{- "warehousings": [
- {
- "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": [
- "TrackingCode001"
], - "vehicle_code": "品川 100 あ ・・・1",
- "vehicle_size": "4T",
- "carrying_method": "PALETTE",
- "container_no": "AAAU1234567",
- "driver_info": "株式会社oo 田中: 090-XXXX-XXXX",
- "company_memo": "キャンペーン用の商品です",
- "items": [
- {
- "id": "TS001-I00001",
- "code": "sword-001",
- "name": "勇者の盾",
- "quantity": 1,
- "received": 1
}
], - "warehouse": "stri",
- "warehouse_info": {
- "postcode": "170-0013",
- "address": "東京都 豊島区東池袋1-34-5 いちご東池袋ビル9F",
- "name": "XXX倉庫"
}, - "created_at": "2019-04-01T12:00:00+09:00",
- "create_user": {
- "name": "オープン太郎"
}, - "shipment_return": false
}
]
}
入庫依頼を作成します。
実際の入庫処理をするには別途入庫明細書と入庫ラベルが必要になります。 入庫ラベル取得APIまたはオープンロジの入庫依頼中の画面より入庫明細書兼入庫ラベルのPDFを取得、印刷し、入庫明細書を同梱した上で入庫ラベルを箱に貼って倉庫宛に発送ください。 詳細はこちらのページをご確認ください。
inspection_type required | string (検品タイプ) Enum: "ID" "NAME" "CODE" "BARCODE" "LABEL" 倉庫に届いた商品を検品する方法。
|
required | Array of objects (入庫商品リスト) [ 1 .. 25 ] items unique 入庫する商品情報を指定します。同梱物も通常の商品と同様に指定します。 |
arrival_date required | string <date> (倉庫着予定日) 倉庫に該当の入庫が着荷する予定日です。未定の場合は、おおよその日付を指定します。 |
arrival_date_confirmed | boolean (確定情報として登録) 倉庫着予定日が確定されていれば 以下の場合は、大量入庫として入庫完了までに着荷日を除く2営業日以上かかる場合があります。
大量入庫になる場合は、必ず倉庫到着予定日の2日前までに、倉庫着予定日を確定情報として登録した上で入庫依頼を作成してください。 |
arrival_time_from | integer (倉庫着予定時間(いつから)) [ 0 .. 23 ] 倉庫に該当の入庫が着荷する予定最短時刻です。 |
arrival_time_to | integer (倉庫着予定時間(いつまで)) [ 0 .. 23 ] 倉庫に該当の入庫が着荷する予定最長時刻です。 |
sales_method | string (販売方法) Default: "INVENTORY" Enum: "INVENTORY" "RESERVATION" "OTHER" 入庫した商品を出庫する際の販売方法です。倉庫の作業計画を立てるために必要な情報です。
|
shipping_scheduled_date | string <date> (出庫予定日) 販売方法が |
transport_mode | string (配送方法) Default: "HOME_DELIVERY" Enum: "" "HOME_DELIVERY" "CHARTER" "CONTAINER" 入庫する際の配送方法を指定します。
|
identity_type | string (入庫特定項目) Default: "ID_OR_LABEL" Enum: "ID_OR_LABEL" "SUPPLIER" "TRACKING_CODE" "VEHICLE_CODE" "CONTAINER" ※入庫ラベルなし入庫を利用するお客様のみ使用可能 倉庫で入庫を特定する際のキーとなる項目を指定できます。 許可された項目のみ指定できます。
|
identity_values | Array of strings (入庫特定情報) ※入庫ラベルなし入庫を利用するお客様のみ使用可能 入庫特定項目に対応した値を指定できます。
|
tracking_codes | Array of strings (お問合せ伝票番号) 配送方法が 倉庫での入庫作業を円滑にしたり、トラブルの解決に必要な情報です。 |
vehicle_code | string (車両番号) <= 30 characters 商品を倉庫へ送る際のチャーターやコンテナを載せる車両の番号を指定します。倉庫での入庫作業を円滑にしたり、トラブルの解決に必要な情報です。 配送方法が |
vehicle_size | string (車両サイズ) Enum: "UNDER_2T" "4T" "10T" "20FT" "40FT" 車両やコンテナのサイズを指定できます。倉庫での入庫作業を円滑にしたり、トラブルの解決に必要な情報です。 配送方法が
|
carrying_method | string (積載方法) Enum: "PALETTE" "BARA" 個口の積載方法を指定できます。
配送方法が
|
container_no | string (コンテナID) <= 30 characters 配送方法が |
driver_info | string (ドライバー情報) <= 500 characters ドライバーに関する補足情報を指定できます。チャーター便の会社名や運転手の連絡先などを倉庫へ共有するための情報です。
配送方法が |
company_memo | string (入庫メモ) <= 255 characters ユーザー側で利用するメモ欄。倉庫には共有されません。 |
identifier | string (入庫依頼識別子) <= 30 characters ユーザーが入庫依頼をユニークに特定するための符号です。 ユーザーが任意に指定するものです。 大文字・小文字のアルファベット、数字、一部の記号のみ利用可能です。 |
{- "inspection_type": "CODE",
- "items": [
- {
- "code": "sword-001",
- "quantity": 1
}
], - "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",
- "transport_mode": "",
- "identity_type": "ID_OR_LABEL",
- "identity_values": [
- "株式会社オープンロジ"
], - "tracking_codes": [
- "TrackingCode001"
], - "vehicle_code": "品川 100 あ ・・・1",
- "vehicle_size": "4T",
- "carrying_method": "PALETTE",
- "container_no": "AAAU1234567",
- "driver_info": "株式会社oo 田中: 090-XXXX-XXXX",
- "company_memo": "キャンペーン用の商品です",
- "identifier": "Identifier-001"
}
{- "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": [
- "TrackingCode001"
], - "vehicle_code": "品川 100 あ ・・・1",
- "vehicle_size": "4T",
- "carrying_method": "PALETTE",
- "container_no": "AAAU1234567",
- "driver_info": "株式会社oo 田中: 090-XXXX-XXXX",
- "company_memo": "キャンペーン用の商品です",
- "items": [
- {
- "id": "TS001-I00001",
- "code": "sword-001",
- "name": "勇者の盾",
- "quantity": 1
}
], - "warehouse": "stri",
- "warehouse_info": {
- "postcode": "170-0013",
- "address": "東京都 豊島区東池袋1-34-5 いちご東池袋ビル9F",
- "name": "XXX倉庫"
}, - "created_at": "2019-04-01T12:00:00+09:00",
- "create_user": {
- "name": "オープン太郎"
}
}
{- "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": [
- "TrackingCode001"
], - "vehicle_code": "品川 100 あ ・・・1",
- "vehicle_size": "4T",
- "carrying_method": "PALETTE",
- "container_no": "AAAU1234567",
- "driver_info": "株式会社oo 田中: 090-XXXX-XXXX",
- "company_memo": "キャンペーン用の商品です",
- "items": [
- {
- "id": "TS001-I00001",
- "code": "sword-001",
- "name": "勇者の盾",
- "quantity": 1,
- "received": 1,
- "lot_items": [
- {
- "id": "TS001-I00001",
- "expiry_at": "2022-04-22",
- "manufacture_date": "2022-04-22",
- "lot_allocatable_at": "2022-04-22",
- "received": 1
}
], - "cases": [
- {
- "quantity_in_case": 10,
- "quantity": 3
}
], - "warehoused_count": 1
}
], - "warehouse": "stri",
- "warehouse_info": {
- "postcode": "170-0013",
- "address": "東京都 豊島区東池袋1-34-5 いちご東池袋ビル9F",
- "name": "XXX倉庫"
}, - "created_at": "2019-04-01T12:00:00+09:00",
- "create_user": {
- "name": "オープン太郎"
}, - "shipment_return": false
}
依頼中の出庫依頼を更新します。
ステータスによっては更新できません。
id required | string Example: AB001-W0001 入庫ID |
inspection_type required | string (検品タイプ) Enum: "ID" "NAME" "CODE" "BARCODE" "LABEL" 倉庫に届いた商品を検品する方法。
|
required | Array of objects (入庫商品リスト) [ 1 .. 25 ] items unique 入庫する商品情報を指定します。同梱物も通常の商品と同様に指定します。 |
arrival_date required | string <date> (倉庫着予定日) 倉庫に該当の入庫が着荷する予定日です。未定の場合は、おおよその日付を指定します。 |
arrival_date_confirmed | boolean (確定情報として登録) 倉庫着予定日が確定されていれば 以下の場合は、大量入庫として入庫完了までに着荷日を除く2営業日以上かかる場合があります。
大量入庫になる場合は、必ず倉庫到着予定日の2日前までに、倉庫着予定日を確定情報として登録した上で入庫依頼を作成してください。 |
arrival_time_from | integer (倉庫着予定時間(いつから)) [ 0 .. 23 ] 倉庫に該当の入庫が着荷する予定最短時刻です。 |
arrival_time_to | integer (倉庫着予定時間(いつまで)) [ 0 .. 23 ] 倉庫に該当の入庫が着荷する予定最長時刻です。 |
sales_method | string (販売方法) Default: "INVENTORY" Enum: "INVENTORY" "RESERVATION" "OTHER" 入庫した商品を出庫する際の販売方法です。倉庫の作業計画を立てるために必要な情報です。
|
shipping_scheduled_date | string <date> (出庫予定日) 販売方法が |
transport_mode | string (配送方法) Default: "HOME_DELIVERY" Enum: "" "HOME_DELIVERY" "CHARTER" "CONTAINER" 入庫する際の配送方法を指定します。
|
identity_type | string (入庫特定項目) Default: "ID_OR_LABEL" Enum: "ID_OR_LABEL" "SUPPLIER" "TRACKING_CODE" "VEHICLE_CODE" "CONTAINER" ※入庫ラベルなし入庫を利用するお客様のみ使用可能 倉庫で入庫を特定する際のキーとなる項目を指定できます。 許可された項目のみ指定できます。
|
identity_values | Array of strings (入庫特定情報) ※入庫ラベルなし入庫を利用するお客様のみ使用可能 入庫特定項目に対応した値を指定できます。
|
tracking_codes | Array of strings (お問合せ伝票番号) 配送方法が 倉庫での入庫作業を円滑にしたり、トラブルの解決に必要な情報です。 |
vehicle_code | string (車両番号) <= 30 characters 商品を倉庫へ送る際のチャーターやコンテナを載せる車両の番号を指定します。倉庫での入庫作業を円滑にしたり、トラブルの解決に必要な情報です。 配送方法が |
vehicle_size | string (車両サイズ) Enum: "UNDER_2T" "4T" "10T" "20FT" "40FT" 車両やコンテナのサイズを指定できます。倉庫での入庫作業を円滑にしたり、トラブルの解決に必要な情報です。 配送方法が
|
carrying_method | string (積載方法) Enum: "PALETTE" "BARA" 個口の積載方法を指定できます。
配送方法が
|
container_no | string (コンテナID) <= 30 characters 配送方法が |
driver_info | string (ドライバー情報) <= 500 characters ドライバーに関する補足情報を指定できます。チャーター便の会社名や運転手の連絡先などを倉庫へ共有するための情報です。
配送方法が |
company_memo | string (入庫メモ) <= 255 characters ユーザー側で利用するメモ欄。倉庫には共有されません。 |
identifier | string (入庫依頼識別子) <= 30 characters ユーザーが入庫依頼をユニークに特定するための符号です。 ユーザーが任意に指定するものです。 大文字・小文字のアルファベット、数字、一部の記号のみ利用可能です。 |
{- "inspection_type": "CODE",
- "items": [
- {
- "code": "sword-001",
- "quantity": 1
}
], - "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",
- "transport_mode": "",
- "identity_type": "ID_OR_LABEL",
- "identity_values": [
- "株式会社オープンロジ"
], - "tracking_codes": [
- "TrackingCode001"
], - "vehicle_code": "品川 100 あ ・・・1",
- "vehicle_size": "4T",
- "carrying_method": "PALETTE",
- "container_no": "AAAU1234567",
- "driver_info": "株式会社oo 田中: 090-XXXX-XXXX",
- "company_memo": "キャンペーン用の商品です",
- "identifier": "Identifier-001"
}
{- "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": [
- "TrackingCode001"
], - "vehicle_code": "品川 100 あ ・・・1",
- "vehicle_size": "4T",
- "carrying_method": "PALETTE",
- "container_no": "AAAU1234567",
- "driver_info": "株式会社oo 田中: 090-XXXX-XXXX",
- "company_memo": "キャンペーン用の商品です",
- "items": [
- {
- "id": "TS001-I00001",
- "code": "sword-001",
- "name": "勇者の盾",
- "quantity": 1
}
], - "warehouse": "stri",
- "warehouse_info": {
- "postcode": "170-0013",
- "address": "東京都 豊島区東池袋1-34-5 いちご東池袋ビル9F",
- "name": "XXX倉庫"
}, - "created_at": "2019-04-01T12:00:00+09:00",
- "create_user": {
- "name": "オープン太郎"
}
}
入庫依頼をキャンセルします。
ステータスによってはキャンセルできません。
id required | string Example: AB001-W0001 入庫ID |
{ }
{- "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": [
- "TrackingCode001"
], - "vehicle_code": "品川 100 あ ・・・1",
- "vehicle_size": "4T",
- "carrying_method": "PALETTE",
- "container_no": "AAAU1234567",
- "driver_info": "株式会社oo 田中: 090-XXXX-XXXX",
- "company_memo": "キャンペーン用の商品です",
- "items": [
- {
- "id": "TS001-I00001",
- "code": "sword-001",
- "name": "勇者の盾",
- "quantity": 1
}
], - "warehouse": "stri",
- "warehouse_info": {
- "postcode": "170-0013",
- "address": "東京都 豊島区東池袋1-34-5 いちご東池袋ビル9F",
- "name": "XXX倉庫"
}, - "created_at": "2019-04-01T12:00:00+09:00",
- "create_user": {
- "name": "オープン太郎"
}
}
直近の入庫実績を取得します。
date_before | string Example: date_before=20190101 指定日以前の最終入庫日の入庫実績(YYYYMMDD) |
date_after | string Example: date_after=20190401 指定日以降の初回入庫日の入庫実績(YYYYMMDD) |
{- "warehousings": [
- {
- "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": [
- "TrackingCode001"
], - "vehicle_code": "品川 100 あ ・・・1",
- "vehicle_size": "4T",
- "carrying_method": "PALETTE",
- "container_no": "AAAU1234567",
- "driver_info": "株式会社oo 田中: 090-XXXX-XXXX",
- "company_memo": "キャンペーン用の商品です",
- "items": [
- {
- "id": "TS001-I00001",
- "code": "sword-001",
- "name": "勇者の盾",
- "quantity": 1,
- "received": 1,
- "lot_items": [
- {
- "id": "TS001-I00001",
- "expiry_at": "2022-04-22",
- "manufacture_date": "2022-04-22",
- "lot_allocatable_at": "2022-04-22",
- "received": 1
}
], - "cases": [
- {
- "quantity_in_case": 10,
- "quantity": 3
}
], - "warehoused_count": 1
}
], - "warehouse": "stri",
- "warehouse_info": {
- "postcode": "170-0013",
- "address": "東京都 豊島区東池袋1-34-5 いちご東池袋ビル9F",
- "name": "XXX倉庫"
}, - "created_at": "2019-04-01T12:00:00+09:00",
- "create_user": {
- "name": "オープン太郎"
}, - "shipment_return": false
}
]
}
指定年月日の入庫実績を取得します。
year | string Example: 2019 入庫年(YYYY) |
month | string Example: 04 入庫月(MM) |
day | string Example: 01 入庫日(DD) |
{- "warehousings": [
- {
- "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": [
- "TrackingCode001"
], - "vehicle_code": "品川 100 あ ・・・1",
- "vehicle_size": "4T",
- "carrying_method": "PALETTE",
- "container_no": "AAAU1234567",
- "driver_info": "株式会社oo 田中: 090-XXXX-XXXX",
- "company_memo": "キャンペーン用の商品です",
- "items": [
- {
- "id": "TS001-I00001",
- "code": "sword-001",
- "name": "勇者の盾",
- "quantity": 1,
- "received": 1,
- "lot_items": [
- {
- "id": "TS001-I00001",
- "expiry_at": "2022-04-22",
- "manufacture_date": "2022-04-22",
- "lot_allocatable_at": "2022-04-22",
- "received": 1
}
], - "cases": [
- {
- "quantity_in_case": 10,
- "quantity": 3
}
], - "warehoused_count": 1
}
], - "warehouse": "stri",
- "warehouse_info": {
- "postcode": "170-0013",
- "address": "東京都 豊島区東池袋1-34-5 いちご東池袋ビル9F",
- "name": "XXX倉庫"
}, - "created_at": "2019-04-01T12:00:00+09:00",
- "create_user": {
- "name": "オープン太郎"
}, - "shipment_return": false
}
]
}
依頼中の出庫依頼を取得します。
出庫IDまたは識別番号を指定した場合は、依頼中以外も取得します。
id | string Example: id=TS001-S000001,AB001-S000003 出庫ID指定 カンマ( |
{- "shipments": [
- {
- "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": [
- "TS001-I000001"
], - "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": {
- "box_delivery": true,
- "fragile_item": true
}, - "bundle_shipping_label": null,
- "warehouse": "OPL",
- "shipment_return": true,
- "items": [
- {
- "id": "TS001-I000004",
- "name": "勇者の盾",
- "code": "item-001",
- "quantity": 1,
- "unit_price": 1000,
- "price": 1000,
- "is_reduced_tax": true,
- "hs_code": "000000.000",
- "gift_wrapping_type": "NAVY",
- "cushioning_type": "BUBBLE_PACK",
- "backordered": false
}
], - "assigned_temperature_zone": "frozen",
- "allocate_priority": 0,
- "shipped_at": "2025-02-01T18:00:00+09:00",
- "tracking_code": "123456789012",
- "tracking_codes": [
- "123456789012",
- "135791113170"
], - "delivery_service": "YAMATO-TAKKYUBIN",
- "package_quantity": 1,
- "packages": [
- {
- "size": "S"
}
], - "cases": {
- "item_id": 10,
- "details": [
- {
- "quantity_in_case": 10,
- "quantity": 2
}
]
}, - "international": true,
- "currency_code": "USD",
- "letter_of_attorney": false,
- "insurance": false,
- "purpose": "SALE_OF_GOODS",
- "duty_paid": true,
- "vat_number": "string",
- "eori_number": "string",
- "sender": {
- "postcode": 1700013,
- "name": "string",
- "phone": "03-3333-3333",
- "prefecture": "東京都",
- "address1": "豊島区東池袋1-34-5",
- "address2": "いちご東池袋ビル9F",
- "company": "string",
- "division": "メタル部"
}, - "recipient": {
- "postcode": 1700013,
- "name": "string",
- "phone": "03-3333-3333",
- "prefecture": "東京都",
- "address1": "豊島区東池袋1-34-5",
- "address2": "いちご東池袋ビル9F",
- "company": "string",
- "division": "メタル部"
}
}
]
}
出庫依頼を1件作成します。 事前に商品登録が必要です。
identifier
が利用されますidentifier
が指定されていない場合は order_no
の値が identifier
として保存されますidentifier
と order_no
のいずれかの指定が必須となりますbackorder_if_unavailable
にtrue
を指定してください。identifier required | string or null (識別番号) [ 1 .. 100 ] characters ユーザーが出庫依頼をユニークに識別するための符号です。 ユーザーが任意に指定します。 出庫依頼を作成する場合は、 |
order_no | string or null (注文番号) [ 1 .. 100 ] characters ECサイトなどの注文に紐づくユニークな固有の符号です。 同梱明細書の「注文番号」に印刷されます。 出庫依頼を作成する場合は、 |
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" 注文単位、もしくは商品単位で緩衝材指定します。緩衝材は有料オプションで別途料金が発生します。
|
cushioning_type | string or null (緩衝材種別) Enum: "BUBBLE_PACK" "BUBBLE_DOUBLE_PACK" 緩衝材単位を注文単位で利用する場合に指定します。 「注文単位」を指定した場合は、緩衝材種別を下記から指定してください。
|
gift_wrapping_unit | string or null (ギフトラッピング単位) Enum: "ORDER" "ITEM" 注文単位、もしくは商品単位でラッピングします。ギフトラッピングは有料オプションで別途料金が発生します。
|
gift_wrapping_type | string or null (ギフトラッピングタイプ) Enum: "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> (配送先連絡メールアドレス) お届け先へお荷物発送のお知らせメールを送信したい場合に指定します。 指定されたメールアドレス宛に「お荷物発送のお知らせ」メールをオープンロジドメインから自動送信します。
この項目が未指定または |
delivery_note_type | string or null (明細書の同梱設定) Enum: "NOT_INCLUDE_PII" "NONE" 明細書を同梱するかしないかを指定します。 値がない場合は、出庫設定の同梱明細書の同梱設定に従います。
|
price_on_delivery_note | boolean or null (明細書への金額印字指定) 明細書に金額を印字するかしないかを指定します。
|
message | string or null (明細書メッセージ) <= 500 characters 同梱明細書に記載するメッセージです。 ご依頼主マスタで設定している明細書メッセージを上書きする場合に利用します。 |
suspend | boolean (保留フラグ) Default: false
保留状態の出庫依頼は、保留解除しない限り出庫作業が開始されません。 ただし、保留状態の出庫依頼にも在庫は引き当てられます。 出庫作業を開始したくない場合に、出庫依頼時に |
shipping_date | string <date> (出庫希望日) 指定された日付以降に倉庫で出荷作業が行われます。倉庫の作業状況次第では指定日以降に出荷となる場合があります。 お届け希望日を指定したい場合は、 |
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" 配送会社を指示したい場合に指定します。 国内発送の場合に指定でき、指定すると別途料金が発生します。
|
delivery_time_slot | string or null (希望時間指定) Enum: "AM" "12" "14" "16" "18" "19" 国内発送の場合に、配達の時間帯を指示したい場合に指定します。
|
delivery_date | |
cash_on_delivery | boolean (代金引換指定) Default: false
|
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サイズの商品のみ、かつポスト便のサイズに収まった場合に、このパラメータの省略時には
|
warehouse | string or null (倉庫コード) 出庫する倉庫をコードで指定します。未指定または null を指定した場合は、標準倉庫から出庫されます。 |
required | Array of objects (配送商品リスト) 出庫したい商品を指定します。同梱物を指定する場合は、 |
international | boolean (海外発送指定) Default: false 海外発送する場合は、 |
delivery_service | string 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" 海外配送( Sagawa
Yamato
Japan Post
Fedex
DHL
|
currency_code | string (海外発送用通貨コード) 商品単価や合計金額で利用する通貨。
海外配送( 指定できる値は、通貨情報APIを参照してください。 |
insurance | boolean (海外発送用損害保証制度の加入希望) 海外配送( 損害保証制度の加入希望がある場合は |
backorder_if_unavailable | boolean (出庫単位の出庫予約フラグ) Default: false 在庫不足時、出庫予約として出庫依頼を作成できるようにします。商品単位の指定よりも、出庫単位の指定が優先されます。 |
purpose | string (輸出目的) Enum: "GIFT" "DOCUMENTS" "COMMERCIAL_SAMPLE" "SALE_OF_GOODS" "RETURNED_GOODS" "OTHERS" EMS/小形包装物 書留/DHL/Fedexの場合に指定します。 輸出目的が指す品目と実際の商品とが異なる場合には、通関手続きができない場合があります。 未指定の場合、【管理画面】 > 【設定】> 【配送情報】> 【配送設定】 > 「輸出目的設定」で選択した項目が適用されます。
|
allocate_priority | integer (引当優先順位) [ 0 .. 100 ] 出庫依頼に対して、出庫の商品単位で配送可在庫を確保する処理(引当)をオープンロジで行なっています。 数字が大きいほど、優先的に引当されます。 |
国内住所 (object) or 海外住所 (object) (発送元住所) 省略時は管理画面から登録してある情報が使われます。 | |
required | 国内住所 (object) or 海外住所 (object) (発送先住所) 発送先住所 (海外出庫の場合は |
apply_rule | boolean (出庫ルール適用フラグ) 出庫ルールによる商品追加で在庫不足が発生する場合、出庫依頼単位の |
{- "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
}
{- "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": [
- "TS001-I000001"
], - "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": {
- "box_delivery": true,
- "fragile_item": true
}, - "bundle_shipping_label": "string",
- "warehouse": "OPL",
- "items": [
- {
- "id": "TS001-I000004",
- "name": "勇者の盾",
- "code": "item-001",
- "quantity": 1,
- "unit_price": 1000,
- "price": 1000,
- "is_reduced_tax": true,
- "hs_code": "000000.000",
- "gift_wrapping_type": "NAVY",
- "cushioning_type": "BUBBLE_PACK",
- "backordered": false
}
], - "purpose": "SALE_OF_GOODS",
- "allocate_priority": 0,
- "sender": {
- "postcode": 1700013,
- "name": "string",
- "phone": "03-3333-3333",
- "prefecture": "東京都",
- "address1": "豊島区東池袋1-34-5",
- "address2": "いちご東池袋ビル9F",
- "company": "string",
- "division": "メタル部"
}, - "recipient": {
- "postcode": 1700013,
- "name": "string",
- "phone": "03-3333-3333",
- "prefecture": "東京都",
- "address1": "豊島区東池袋1-34-5",
- "address2": "いちご東池袋ビル9F",
- "company": "string",
- "division": "メタル部"
}
}
出庫依頼作成と同じフォーマットのJSONを配列で送信することで一括作成できます。
単一の出庫依頼作成APIとは異なり、apply_rule
を出庫依頼単位ではなく、リクエスト単位で指定します。
そのため、一括で作成するすべての出庫依頼について出庫ルールが評価され、それぞれの条件を満たす出庫ルールが適用されます。
一括作成の件数には上限を設けていませんが、50件〜100件程度を推奨します。 件数が多いほど処理時間も長くなるため、クライアントシステムのタイムアウト値の設定にご注意ください。
このAPIはアトミックに処理をします。 よって、一部の出庫依頼の作成に失敗した場合は、すべての出庫依頼が作成されません。 この場合は、エラーを修正し、同じ内容で再度リクエストするか、個別に出庫依頼を作成してください。
required | Array of objects (出庫依頼リスト) 一括で登録したい出庫依頼の配列です。 |
apply_rule | boolean (出庫ルール適用フラグ) 出庫ルールによる商品追加で在庫不足が発生する場合、出庫依頼単位の |
{- "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
}
]
}
{- "shipments": [
- {
- "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": [
- "TS001-I000001"
], - "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": {
- "box_delivery": true,
- "fragile_item": true
}, - "bundle_shipping_label": "string",
- "warehouse": "OPL",
- "items": [
- {
- "id": "TS001-I000004",
- "name": "勇者の盾",
- "code": "item-001",
- "quantity": 1,
- "unit_price": 1000,
- "price": 1000,
- "is_reduced_tax": true,
- "hs_code": "000000.000",
- "gift_wrapping_type": "NAVY",
- "cushioning_type": "BUBBLE_PACK",
- "backordered": false
}
], - "purpose": "SALE_OF_GOODS",
- "allocate_priority": 0,
- "sender": {
- "postcode": 1700013,
- "name": "string",
- "phone": "03-3333-3333",
- "prefecture": "東京都",
- "address1": "豊島区東池袋1-34-5",
- "address2": "いちご東池袋ビル9F",
- "company": "string",
- "division": "メタル部"
}, - "recipient": {
- "postcode": 1700013,
- "name": "string",
- "phone": "03-3333-3333",
- "prefecture": "東京都",
- "address1": "豊島区東池袋1-34-5",
- "address2": "いちご東池袋ビル9F",
- "company": "string",
- "division": "メタル部"
}
}
]
}
{- "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": [
- "TS001-I000001"
], - "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": {
- "box_delivery": true,
- "fragile_item": true
}, - "bundle_shipping_label": null,
- "warehouse": "OPL",
- "shipment_return": true,
- "items": [
- {
- "id": "TS001-I000004",
- "name": "勇者の盾",
- "code": "item-001",
- "quantity": 1,
- "unit_price": 1000,
- "price": 1000,
- "is_reduced_tax": true,
- "hs_code": "000000.000",
- "gift_wrapping_type": "NAVY",
- "cushioning_type": "BUBBLE_PACK",
- "backordered": false
}
], - "assigned_temperature_zone": "frozen",
- "allocate_priority": 0,
- "shipped_at": "2025-02-01T18:00:00+09:00",
- "tracking_code": "123456789012",
- "tracking_codes": [
- "123456789012",
- "135791113170"
], - "delivery_service": "YAMATO-TAKKYUBIN",
- "package_quantity": 1,
- "packages": [
- {
- "size": "S"
}
], - "cases": {
- "item_id": 10,
- "details": [
- {
- "quantity_in_case": 10,
- "quantity": 2
}
]
}, - "international": true,
- "currency_code": "USD",
- "letter_of_attorney": false,
- "insurance": false,
- "purpose": "SALE_OF_GOODS",
- "duty_paid": true,
- "vat_number": "string",
- "eori_number": "string",
- "sender": {
- "postcode": 1700013,
- "name": "string",
- "phone": "03-3333-3333",
- "prefecture": "東京都",
- "address1": "豊島区東池袋1-34-5",
- "address2": "いちご東池袋ビル9F",
- "company": "string",
- "division": "メタル部"
}, - "recipient": {
- "postcode": 1700013,
- "name": "string",
- "phone": "03-3333-3333",
- "prefecture": "東京都",
- "address1": "豊島区東池袋1-34-5",
- "address2": "いちご東池袋ビル9F",
- "company": "string",
- "division": "メタル部"
}
}
依頼中の出庫依頼を更新します。 ステータスによっては更新できません。
id required | string Example: id=TS001-S000001 出庫ID指定 |
identifier required | string or null (識別番号) [ 1 .. 100 ] characters ユーザーが出庫依頼をユニークに識別するための符号です。 ユーザーが任意に指定します。 出庫依頼を作成する場合は、 |
order_no | string or null (注文番号) [ 1 .. 100 ] characters ECサイトなどの注文に紐づくユニークな固有の符号です。 同梱明細書の「注文番号」に印刷されます。 出庫依頼を作成する場合は、 |
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" 注文単位、もしくは商品単位で緩衝材指定します。緩衝材は有料オプションで別途料金が発生します。
|
cushioning_type | string or null (緩衝材種別) Enum: "BUBBLE_PACK" "BUBBLE_DOUBLE_PACK" 緩衝材単位を注文単位で利用する場合に指定します。 「注文単位」を指定した場合は、緩衝材種別を下記から指定してください。
|
gift_wrapping_unit | string or null (ギフトラッピング単位) Enum: "ORDER" "ITEM" 注文単位、もしくは商品単位でラッピングします。ギフトラッピングは有料オプションで別途料金が発生します。
|
gift_wrapping_type | string or null (ギフトラッピングタイプ) Enum: "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> (配送先連絡メールアドレス) お届け先へお荷物発送のお知らせメールを送信したい場合に指定します。 指定されたメールアドレス宛に「お荷物発送のお知らせ」メールをオープンロジドメインから自動送信します。
この項目が未指定または |
delivery_note_type | string or null (明細書の同梱設定) Enum: "NOT_INCLUDE_PII" "NONE" 明細書を同梱するかしないかを指定します。 値がない場合は、出庫設定の同梱明細書の同梱設定に従います。
|
price_on_delivery_note | boolean or null (明細書への金額印字指定) 明細書に金額を印字するかしないかを指定します。
|
message | string or null (明細書メッセージ) <= 500 characters 同梱明細書に記載するメッセージです。 ご依頼主マスタで設定している明細書メッセージを上書きする場合に利用します。 |
suspend | boolean (保留フラグ) Default: false
保留状態の出庫依頼は、保留解除しない限り出庫作業が開始されません。 ただし、保留状態の出庫依頼にも在庫は引き当てられます。 出庫作業を開始したくない場合に、出庫依頼時に |
shipping_date | string <date> (出庫希望日) 指定された日付以降に倉庫で出荷作業が行われます。倉庫の作業状況次第では指定日以降に出荷となる場合があります。 お届け希望日を指定したい場合は、 |
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" 配送会社を指示したい場合に指定します。 国内発送の場合に指定でき、指定すると別途料金が発生します。
|
delivery_time_slot | string or null (希望時間指定) Enum: "AM" "12" "14" "16" "18" "19" 国内発送の場合に、配達の時間帯を指示したい場合に指定します。
|
delivery_date | |
cash_on_delivery | boolean (代金引換指定) Default: false
|
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サイズの商品のみ、かつポスト便のサイズに収まった場合に、このパラメータの省略時には
|
warehouse | string or null (倉庫コード) 出庫する倉庫をコードで指定します。未指定または null を指定した場合は、標準倉庫から出庫されます。 |
required | Array of objects (配送商品リスト) 出庫したい商品を指定します。同梱物を指定する場合は、 |
international | boolean (海外発送指定) Default: false 海外発送する場合は、 |
delivery_service | string 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" 海外配送( Sagawa
Yamato
Japan Post
Fedex
DHL
|
currency_code | string (海外発送用通貨コード) 商品単価や合計金額で利用する通貨。
海外配送( 指定できる値は、通貨情報APIを参照してください。 |
insurance | boolean (海外発送用損害保証制度の加入希望) 海外配送( 損害保証制度の加入希望がある場合は |
backorder_if_unavailable | boolean (出庫単位の出庫予約フラグ) Default: false 在庫不足時、出庫予約として出庫依頼を作成できるようにします。商品単位の指定よりも、出庫単位の指定が優先されます。 |
purpose | string (輸出目的) Enum: "GIFT" "DOCUMENTS" "COMMERCIAL_SAMPLE" "SALE_OF_GOODS" "RETURNED_GOODS" "OTHERS" EMS/小形包装物 書留/DHL/Fedexの場合に指定します。 輸出目的が指す品目と実際の商品とが異なる場合には、通関手続きができない場合があります。 未指定の場合、【管理画面】 > 【設定】> 【配送情報】> 【配送設定】 > 「輸出目的設定」で選択した項目が適用されます。
|
allocate_priority | integer (引当優先順位) [ 0 .. 100 ] 出庫依頼に対して、出庫の商品単位で配送可在庫を確保する処理(引当)をオープンロジで行なっています。 数字が大きいほど、優先的に引当されます。 |
国内住所 (object) or 海外住所 (object) (発送元住所) 省略時は管理画面から登録してある情報が使われます。 | |
required | 国内住所 (object) or 海外住所 (object) (発送先住所) 発送先住所 (海外出庫の場合は |
{- "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": [
- "TS001-I000001"
], - "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": {
- "box_delivery": true,
- "fragile_item": true
}, - "warehouse": "OPL",
- "items": [
- {
- "name": "勇者の盾",
- "code": "item-001",
- "quantity": 1,
- "unit_price": 1000,
- "price": 1000,
- "is_reduced_tax": true,
- "hs_code": "000000.000",
- "gift_wrapping_type": "NAVY",
- "cushioning_type": "BUBBLE_PACK",
- "backorder_if_unavailable": true
}
], - "international": false,
- "delivery_service": "JAPANPOST-EMS",
- "currency_code": "JP",
- "insurance": false,
- "backorder_if_unavailable": true,
- "purpose": "SALE_OF_GOODS",
- "allocate_priority": 0,
- "sender": {
- "postcode": 1700013,
- "name": "string",
- "phone": "03-3333-3333",
- "prefecture": "東京都",
- "address1": "豊島区東池袋1-34-5",
- "address2": "いちご東池袋ビル9F",
- "company": "string",
- "division": "メタル部"
}, - "recipient": {
- "postcode": 1700013,
- "name": "string",
- "phone": "03-3333-3333",
- "prefecture": "東京都",
- "address1": "豊島区東池袋1-34-5",
- "address2": "いちご東池袋ビル9F",
- "company": "string",
- "division": "メタル部"
}
}
{- "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": [
- "TS001-I000001"
], - "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": {
- "box_delivery": true,
- "fragile_item": true
}, - "bundle_shipping_label": "string",
- "warehouse": "OPL",
- "items": [
- {
- "id": "TS001-I000004",
- "name": "勇者の盾",
- "code": "item-001",
- "quantity": 1,
- "unit_price": 1000,
- "price": 1000,
- "is_reduced_tax": true,
- "hs_code": "000000.000",
- "gift_wrapping_type": "NAVY",
- "cushioning_type": "BUBBLE_PACK",
- "backordered": false
}
], - "purpose": "SALE_OF_GOODS",
- "allocate_priority": 0,
- "sender": {
- "postcode": 1700013,
- "name": "string",
- "phone": "03-3333-3333",
- "prefecture": "東京都",
- "address1": "豊島区東池袋1-34-5",
- "address2": "いちご東池袋ビル9F",
- "company": "string",
- "division": "メタル部"
}, - "recipient": {
- "postcode": 1700013,
- "name": "string",
- "phone": "03-3333-3333",
- "prefecture": "東京都",
- "address1": "豊島区東池袋1-34-5",
- "address2": "いちご東池袋ビル9F",
- "company": "string",
- "division": "メタル部"
}
}
ステータスによっては削除できません。
id required | string Example: id=TS001-S000001 出庫ID指定 |
{ }
{- "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": [
- "TS001-I000001"
], - "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": {
- "box_delivery": true,
- "fragile_item": true
}, - "bundle_shipping_label": "string",
- "warehouse": "OPL",
- "items": [
- {
- "id": "TS001-I000004",
- "name": "勇者の盾",
- "code": "item-001",
- "quantity": 1,
- "unit_price": 1000,
- "price": 1000,
- "is_reduced_tax": true,
- "hs_code": "000000.000",
- "gift_wrapping_type": "NAVY",
- "cushioning_type": "BUBBLE_PACK",
- "backordered": false
}
], - "purpose": "SALE_OF_GOODS",
- "allocate_priority": 0,
- "sender": {
- "postcode": 1700013,
- "name": "string",
- "phone": "03-3333-3333",
- "prefecture": "東京都",
- "address1": "豊島区東池袋1-34-5",
- "address2": "いちご東池袋ビル9F",
- "company": "string",
- "division": "メタル部"
}, - "recipient": {
- "postcode": 1700013,
- "name": "string",
- "phone": "03-3333-3333",
- "prefecture": "東京都",
- "address1": "豊島区東池袋1-34-5",
- "address2": "いちご東池袋ビル9F",
- "company": "string",
- "division": "メタル部"
}
}
ステータスがピッキング中・ピッキング済み・梱包済みの出庫依頼の修正を依頼します。
データ取り込み後の修正となりますので、別途事務手数料+作業進捗状況による作業費用がかかります。
海外発送の場合は梱包済みのステータス以降は依頼ができません。
キャンセル依頼を出していただき、別途新規の出庫依頼を作成してください。
また、作業進捗状況によってはご依頼にお応えすることができない場合がございます。
ご了承の上ご利用ください。
id required | string Example: id=TS001-S000001 出庫ID指定 |
国内住所 (object) or 海外住所 (object) 発送先住所 (海外出庫の場合はregion_codeを指定する必要が有ります) | |
delivery_time_slot | string Enum: "AM" "12" "14" "16" "18" "19" 希望時間指定 (12はSAGAWAの場合のみ) |
delivery_date | string 配達希望日 (指定できる最短日付は配送会社によって変わります) |
{- "recipient": {
- "postcode": 1700013,
- "name": "open 太郎",
- "phone": "03-3333-3333",
- "prefecture": "東京都",
- "address1": "豊島区東池袋1-34-5",
- "address2": "いちご東池袋ビル9F",
- "company": "スライム株式会社",
- "division": "メタル部"
}, - "delivery_time_slot": "12",
- "delivery_date": "2019-04-05"
}
{- "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": [
- "TS001-I000001"
], - "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": {
- "box_delivery": true,
- "fragile_item": true
}, - "bundle_shipping_label": "string",
- "warehouse": "OPL",
- "items": [
- {
- "id": "TS001-I000004",
- "name": "勇者の盾",
- "code": "item-001",
- "quantity": 1,
- "unit_price": 1000,
- "price": 1000,
- "is_reduced_tax": true,
- "hs_code": "000000.000",
- "gift_wrapping_type": "NAVY",
- "cushioning_type": "BUBBLE_PACK",
- "backordered": false
}
], - "purpose": "SALE_OF_GOODS",
- "allocate_priority": 0,
- "sender": {
- "postcode": 1700013,
- "name": "string",
- "phone": "03-3333-3333",
- "prefecture": "東京都",
- "address1": "豊島区東池袋1-34-5",
- "address2": "いちご東池袋ビル9F",
- "company": "string",
- "division": "メタル部"
}, - "recipient": {
- "postcode": 1700013,
- "name": "string",
- "phone": "03-3333-3333",
- "prefecture": "東京都",
- "address1": "豊島区東池袋1-34-5",
- "address2": "いちご東池袋ビル9F",
- "company": "string",
- "division": "メタル部"
}
}
ステータスがピッキング中・ピッキング済み・梱包済みの出庫依頼の修正を依頼します。
データ取り込み後の修正となりますので、別途事務手数料+作業進捗状況による作業費用がかかります。
海外発送の場合は梱包済みのステータス以降は依頼ができません。
キャンセル依頼を出していただき、別途新規の出庫依頼を作成してください。
また、作業進捗状況によってはご依頼にお応えすることができない場合がございます。
ご了承の上ご利用ください。
id required | string Example: id=TS001-S000001 出庫ID指定 |
{ }
{- "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": [
- "TS001-I000001"
], - "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": {
- "box_delivery": true,
- "fragile_item": true
}, - "bundle_shipping_label": "string",
- "warehouse": "OPL",
- "items": [
- {
- "id": "TS001-I000004",
- "name": "勇者の盾",
- "code": "item-001",
- "quantity": 1,
- "unit_price": 1000,
- "price": 1000,
- "is_reduced_tax": true,
- "hs_code": "000000.000",
- "gift_wrapping_type": "NAVY",
- "cushioning_type": "BUBBLE_PACK",
- "backordered": false
}
], - "purpose": "SALE_OF_GOODS",
- "allocate_priority": 0,
- "sender": {
- "postcode": 1700013,
- "name": "string",
- "phone": "03-3333-3333",
- "prefecture": "東京都",
- "address1": "豊島区東池袋1-34-5",
- "address2": "いちご東池袋ビル9F",
- "company": "string",
- "division": "メタル部"
}, - "recipient": {
- "postcode": 1700013,
- "name": "string",
- "phone": "03-3333-3333",
- "prefecture": "東京都",
- "address1": "豊島区東池袋1-34-5",
- "address2": "いちご東池袋ビル9F",
- "company": "string",
- "division": "メタル部"
}
}
直近の出庫実績を取得します。
出庫情報と同じフォーマットのJSONが配列で取得できます。
date_before | string Example: date_before=20190320 指定日以前の最終出庫日の出庫実績 |
date_after | string Example: date_after=20190420 指定日以降の初回出庫日の出庫実績 |
{- "shipments": [
- {
- "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": [
- "TS001-I000001"
], - "fba_shipment_id": "FBA123456789",
- "shipping_email": "test@example.com",
- "delivery_note_type": "NOT_INCLUDE_PII",
- "price_on_delivery_note": true,
- "message": "お買上げありがとうございます。",
- "status": "shipped",
- "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": {
- "box_delivery": true,
- "fragile_item": true
}, - "bundle_shipping_label": null,
- "warehouse": "OPL",
- "shipment_return": true,
- "items": [
- {
- "id": "TS001-I000004",
- "name": "勇者の盾",
- "code": "item-001",
- "quantity": 1,
- "unit_price": 1000,
- "price": 1000,
- "is_reduced_tax": true,
- "hs_code": "000000.000",
- "gift_wrapping_type": "NAVY",
- "cushioning_type": "BUBBLE_PACK",
- "backordered": false
}
], - "assigned_temperature_zone": "frozen",
- "allocate_priority": 0,
- "shipped_at": "2025-02-01T18:00:00+09:00",
- "tracking_code": "123456789012",
- "tracking_codes": [
- "123456789012",
- "135791113170"
], - "delivery_service": "YAMATO-TAKKYUBIN",
- "package_quantity": 1,
- "packages": [
- {
- "size": "S"
}
], - "cases": {
- "item_id": 10,
- "details": [
- {
- "quantity_in_case": 10,
- "quantity": 2
}
]
}, - "international": true,
- "currency_code": "USD",
- "letter_of_attorney": false,
- "insurance": false,
- "purpose": "SALE_OF_GOODS",
- "duty_paid": true,
- "vat_number": "string",
- "eori_number": "string",
- "sender": {
- "postcode": 1700013,
- "name": "string",
- "phone": "03-3333-3333",
- "prefecture": "東京都",
- "address1": "豊島区東池袋1-34-5",
- "address2": "いちご東池袋ビル9F",
- "company": "string",
- "division": "メタル部"
}, - "recipient": {
- "postcode": 1700013,
- "name": "string",
- "phone": "03-3333-3333",
- "prefecture": "東京都",
- "address1": "豊島区東池袋1-34-5",
- "address2": "いちご東池袋ビル9F",
- "company": "string",
- "division": "メタル部"
}
}
]
}
指定年月日の出庫実績を取得します。
出庫情報と同じフォーマットのJSONが配列で取得できます。
year required | string Example: 2019 出庫年(YYYY) |
month required | string Example: 04 出庫月(MM) |
day | string Example: 02 出庫日(DD) |
{- "shipments": [
- {
- "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": [
- "TS001-I000001"
], - "fba_shipment_id": "FBA123456789",
- "shipping_email": "test@example.com",
- "delivery_note_type": "NOT_INCLUDE_PII",
- "price_on_delivery_note": true,
- "message": "お買上げありがとうございます。",
- "status": "shipped",
- "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": {
- "box_delivery": true,
- "fragile_item": true
}, - "bundle_shipping_label": null,
- "warehouse": "OPL",
- "shipment_return": true,
- "items": [
- {
- "id": "TS001-I000004",
- "name": "勇者の盾",
- "code": "item-001",
- "quantity": 1,
- "unit_price": 1000,
- "price": 1000,
- "is_reduced_tax": true,
- "hs_code": "000000.000",
- "gift_wrapping_type": "NAVY",
- "cushioning_type": "BUBBLE_PACK",
- "backordered": false
}
], - "assigned_temperature_zone": "frozen",
- "allocate_priority": 0,
- "shipped_at": "2025-02-01T18:00:00+09:00",
- "tracking_code": "123456789012",
- "tracking_codes": [
- "123456789012",
- "135791113170"
], - "delivery_service": "YAMATO-TAKKYUBIN",
- "package_quantity": 1,
- "packages": [
- {
- "size": "S"
}
], - "cases": {
- "item_id": 10,
- "details": [
- {
- "quantity_in_case": 10,
- "quantity": 2
}
]
}, - "international": true,
- "currency_code": "USD",
- "letter_of_attorney": false,
- "insurance": false,
- "purpose": "SALE_OF_GOODS",
- "duty_paid": true,
- "vat_number": "string",
- "eori_number": "string",
- "sender": {
- "postcode": 1700013,
- "name": "string",
- "phone": "03-3333-3333",
- "prefecture": "東京都",
- "address1": "豊島区東池袋1-34-5",
- "address2": "いちご東池袋ビル9F",
- "company": "string",
- "division": "メタル部"
}, - "recipient": {
- "postcode": 1700013,
- "name": "string",
- "phone": "03-3333-3333",
- "prefecture": "東京都",
- "address1": "豊島区東池袋1-34-5",
- "address2": "いちご東池袋ビル9F",
- "company": "string",
- "division": "メタル部"
}
}
]
}
{- "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"
}
]
}
指定商品の倉庫移動依頼をします。
発送元住所、発送先住所は指定された倉庫の住所となります。
通常出庫と同じ出庫依頼情報が作成され、同時に発送先倉庫での入庫依頼が作成されます。
warehouse required | string 移動元倉庫情報 |
required | object 移動先倉庫情報 |
required | Array of objects 移動商品リスト |
{- "warehouse": "BASE2",
- "destination": {
- "warehouse": "BASE3"
}, - "items": [
- {
- "code": "item-001",
- "quantity": 1,
- "name": "勇者の盾"
}
]
}
{- "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": [
- "TS001-I000001"
], - "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": {
- "box_delivery": true,
- "fragile_item": true
}, - "bundle_shipping_label": "string",
- "warehouse": "OPL",
- "items": [
- {
- "id": "TS001-I000004",
- "name": "勇者の盾",
- "code": "item-001",
- "quantity": 1,
- "unit_price": 1000,
- "price": 1000,
- "is_reduced_tax": true,
- "hs_code": "000000.000",
- "gift_wrapping_type": "NAVY",
- "cushioning_type": "BUBBLE_PACK",
- "backordered": false
}
], - "destination": {
- "warehouse": "BASE3",
- "warehousing": {
- "id": "TS001-W0001"
}
}, - "sender": {
- "name": "string",
- "company": "string",
- "postcode": 1700013,
- "phone": "03-3333-3333",
- "prefecture": "東京都",
- "address1": "豊島区東池袋1-34-5",
- "address2": "いちご東池袋ビル9F",
- "division": "メタル部"
}, - "recipient": {
- "name": "string",
- "company": "string",
- "postcode": 1700013,
- "phone": "03-3333-3333",
- "prefecture": "東京都",
- "address1": "豊島区東池袋1-34-5",
- "address2": "いちご東池袋ビル9F",
- "division": "メタル部"
}
}
ステータスによっては更新できません。
id required | string Example: id=TS001-S000001 出庫ID指定 |
required | object 移動先倉庫情報 |
required | Array of objects 移動商品リスト |
{- "destination": {
- "warehouse": "BASE3"
}, - "items": [
- {
- "code": "item-001",
- "quantity": 1,
- "name": "勇者の盾"
}
]
}
{- "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": [
- "TS001-I000001"
], - "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": {
- "box_delivery": true,
- "fragile_item": true
}, - "bundle_shipping_label": "string",
- "warehouse": "OPL",
- "items": [
- {
- "id": "TS001-I000004",
- "name": "勇者の盾",
- "code": "item-001",
- "quantity": 1,
- "unit_price": 1000,
- "price": 1000,
- "is_reduced_tax": true,
- "hs_code": "000000.000",
- "gift_wrapping_type": "NAVY",
- "cushioning_type": "BUBBLE_PACK",
- "backordered": false
}
], - "destination": {
- "warehouse": "BASE3",
- "warehousing": {
- "id": "TS001-W0001"
}
}, - "sender": {
- "name": "string",
- "company": "string",
- "postcode": 1700013,
- "phone": "03-3333-3333",
- "prefecture": "東京都",
- "address1": "豊島区東池袋1-34-5",
- "address2": "いちご東池袋ビル9F",
- "division": "メタル部"
}, - "recipient": {
- "name": "string",
- "company": "string",
- "postcode": 1700013,
- "phone": "03-3333-3333",
- "prefecture": "東京都",
- "address1": "豊島区東池袋1-34-5",
- "address2": "いちご東池袋ビル9F",
- "division": "メタル部"
}
}
ステータスがピッキング中になっている倉庫移動依頼の修正を依頼します。
データ取り込み後の修正となりますので、別途事務手数料+作業進捗状況による作業費用がかかります。
また、作業進捗状況によってはご依頼にお応えすることができない場合がございます。
ご了承の上ご利用ください。
id required | string Example: id=TS001-S000001 出庫ID指定 |
required | object 移動先倉庫情報 |
{- "destination": {
- "warehouse": "BASE3"
}
}
{- "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": [
- "TS001-I000001"
], - "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": {
- "box_delivery": true,
- "fragile_item": true
}, - "bundle_shipping_label": "string",
- "warehouse": "OPL",
- "items": [
- {
- "id": "TS001-I000004",
- "name": "勇者の盾",
- "code": "item-001",
- "quantity": 1,
- "unit_price": 1000,
- "price": 1000,
- "is_reduced_tax": true,
- "hs_code": "000000.000",
- "gift_wrapping_type": "NAVY",
- "cushioning_type": "BUBBLE_PACK",
- "backordered": false
}
], - "destination": {
- "warehouse": "BASE3",
- "warehousing": {
- "id": "TS001-W0001"
}
}, - "sender": {
- "name": "string",
- "company": "string",
- "postcode": 1700013,
- "phone": "03-3333-3333",
- "prefecture": "東京都",
- "address1": "豊島区東池袋1-34-5",
- "address2": "いちご東池袋ビル9F",
- "division": "メタル部"
}, - "recipient": {
- "name": "string",
- "company": "string",
- "postcode": 1700013,
- "phone": "03-3333-3333",
- "prefecture": "東京都",
- "address1": "豊島区東池袋1-34-5",
- "address2": "いちご東池袋ビル9F",
- "division": "メタル部"
}
}
ステータスがピッキング中になっている倉庫移動依頼のキャンセルを依頼します。
データ取り込み後のキャンセルとなりますので、別途事務手数料+作業進捗状況による作業費用がかかります。
また、作業進捗状況によってはご依頼にお応えすることができない場合がございます。
ご了承の上ご利用ください。
id required | string Example: id=TS001-S000001 出庫ID |
{ }
{- "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": [
- "TS001-I000001"
], - "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": {
- "box_delivery": true,
- "fragile_item": true
}, - "bundle_shipping_label": "string",
- "warehouse": "OPL",
- "items": [
- {
- "id": "TS001-I000004",
- "name": "勇者の盾",
- "code": "item-001",
- "quantity": 1,
- "unit_price": 1000,
- "price": 1000,
- "is_reduced_tax": true,
- "hs_code": "000000.000",
- "gift_wrapping_type": "NAVY",
- "cushioning_type": "BUBBLE_PACK",
- "backordered": false
}
], - "destination": {
- "warehouse": "BASE3",
- "warehousing": {
- "id": "TS001-W0001"
}
}, - "sender": {
- "name": "string",
- "company": "string",
- "postcode": 1700013,
- "phone": "03-3333-3333",
- "prefecture": "東京都",
- "address1": "豊島区東池袋1-34-5",
- "address2": "いちご東池袋ビル9F",
- "division": "メタル部"
}, - "recipient": {
- "name": "string",
- "company": "string",
- "postcode": 1700013,
- "phone": "03-3333-3333",
- "prefecture": "東京都",
- "address1": "豊島区東池袋1-34-5",
- "address2": "いちご東池袋ビル9F",
- "division": "メタル部"
}
}
対象の出庫依頼に含まれる全ての商品から引当が解除され入荷待ちに変更されます。
解除実行後は引当優先順位が高い入荷待ちの出庫依頼から引当処理が行われます。
ご了承の上ご利用ください。
id required | string Example: id=TS001-S000001 出庫ID |
{ }
{- "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": [
- "TS001-I000001"
], - "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": {
- "box_delivery": true,
- "fragile_item": true
}, - "bundle_shipping_label": "string",
- "warehouse": "OPL",
- "items": [
- {
- "id": "TS001-I000004",
- "name": "勇者の盾",
- "code": "item-001",
- "quantity": 1,
- "unit_price": 1000,
- "price": 1000,
- "is_reduced_tax": true,
- "hs_code": "000000.000",
- "gift_wrapping_type": "NAVY",
- "cushioning_type": "BUBBLE_PACK",
- "backordered": false
}
], - "purpose": "SALE_OF_GOODS",
- "allocate_priority": 0,
- "sender": {
- "postcode": 1700013,
- "name": "string",
- "phone": "03-3333-3333",
- "prefecture": "東京都",
- "address1": "豊島区東池袋1-34-5",
- "address2": "いちご東池袋ビル9F",
- "company": "string",
- "division": "メタル部"
}, - "recipient": {
- "postcode": 1700013,
- "name": "string",
- "phone": "03-3333-3333",
- "prefecture": "東京都",
- "address1": "豊島区東池袋1-34-5",
- "address2": "いちご東池袋ビル9F",
- "company": "string",
- "division": "メタル部"
}
}
出庫識別番号(identifier
)を指定して出庫依頼を操作します
オープンロジが発行する出庫IDが不明な場合にご利用ください。
依頼中の出庫依頼を取得します。
クエリパラメータで識別番号を指定した場合は、依頼中以外も取得します。
account_id required | string Example: TS001 アカウントコード |
identifier required | string Example: identifier=2015-00001 識別番号 カンマ( |
{- "shipments": [
- {
- "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": [
- "TS001-I000001"
], - "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": {
- "box_delivery": true,
- "fragile_item": true
}, - "bundle_shipping_label": null,
- "warehouse": "OPL",
- "shipment_return": true,
- "items": [
- {
- "id": "TS001-I000004",
- "name": "勇者の盾",
- "code": "item-001",
- "quantity": 1,
- "unit_price": 1000,
- "price": 1000,
- "is_reduced_tax": true,
- "hs_code": "000000.000",
- "gift_wrapping_type": "NAVY",
- "cushioning_type": "BUBBLE_PACK",
- "backordered": false
}
], - "assigned_temperature_zone": "frozen",
- "allocate_priority": 0,
- "shipped_at": "2025-02-01T18:00:00+09:00",
- "tracking_code": "123456789012",
- "tracking_codes": [
- "123456789012",
- "135791113170"
], - "delivery_service": "YAMATO-TAKKYUBIN",
- "package_quantity": 1,
- "packages": [
- {
- "size": "S"
}
], - "cases": {
- "item_id": 10,
- "details": [
- {
- "quantity_in_case": 10,
- "quantity": 2
}
]
}, - "international": true,
- "currency_code": "USD",
- "letter_of_attorney": false,
- "insurance": false,
- "purpose": "SALE_OF_GOODS",
- "duty_paid": true,
- "vat_number": "string",
- "eori_number": "string",
- "sender": {
- "postcode": 1700013,
- "name": "string",
- "phone": "03-3333-3333",
- "prefecture": "東京都",
- "address1": "豊島区東池袋1-34-5",
- "address2": "いちご東池袋ビル9F",
- "company": "string",
- "division": "メタル部"
}, - "recipient": {
- "postcode": 1700013,
- "name": "string",
- "phone": "03-3333-3333",
- "prefecture": "東京都",
- "address1": "豊島区東池袋1-34-5",
- "address2": "いちご東池袋ビル9F",
- "company": "string",
- "division": "メタル部"
}
}
]
}
出庫依頼を取得します。
account_id required | string Example: TS001 アカウントコード |
identifier required | string Example: 2015-00001 識別番号 |
{- "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": [
- "TS001-I000001"
], - "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": {
- "box_delivery": true,
- "fragile_item": true
}, - "bundle_shipping_label": null,
- "warehouse": "OPL",
- "shipment_return": true,
- "items": [
- {
- "id": "TS001-I000004",
- "name": "勇者の盾",
- "code": "item-001",
- "quantity": 1,
- "unit_price": 1000,
- "price": 1000,
- "is_reduced_tax": true,
- "hs_code": "000000.000",
- "gift_wrapping_type": "NAVY",
- "cushioning_type": "BUBBLE_PACK",
- "backordered": false
}
], - "assigned_temperature_zone": "frozen",
- "allocate_priority": 0,
- "shipped_at": "2025-02-01T18:00:00+09:00",
- "tracking_code": "123456789012",
- "tracking_codes": [
- "123456789012",
- "135791113170"
], - "delivery_service": "YAMATO-TAKKYUBIN",
- "package_quantity": 1,
- "packages": [
- {
- "size": "S"
}
], - "cases": {
- "item_id": 10,
- "details": [
- {
- "quantity_in_case": 10,
- "quantity": 2
}
]
}, - "international": true,
- "currency_code": "USD",
- "letter_of_attorney": false,
- "insurance": false,
- "purpose": "SALE_OF_GOODS",
- "duty_paid": true,
- "vat_number": "string",
- "eori_number": "string",
- "sender": {
- "postcode": 1700013,
- "name": "string",
- "phone": "03-3333-3333",
- "prefecture": "東京都",
- "address1": "豊島区東池袋1-34-5",
- "address2": "いちご東池袋ビル9F",
- "company": "string",
- "division": "メタル部"
}, - "recipient": {
- "postcode": 1700013,
- "name": "string",
- "phone": "03-3333-3333",
- "prefecture": "東京都",
- "address1": "豊島区東池袋1-34-5",
- "address2": "いちご東池袋ビル9F",
- "company": "string",
- "division": "メタル部"
}
}
ステータスによっては更新できません。
account_id required | string Example: TS001 アカウントコード |
identifier required | string Example: 2015-00001 識別番号 |
identifier required | string or null (識別番号) [ 1 .. 100 ] characters ユーザーが出庫依頼をユニークに識別するための符号です。 ユーザーが任意に指定します。 出庫依頼を作成する場合は、 |
order_no | string or null (注文番号) [ 1 .. 100 ] characters ECサイトなどの注文に紐づくユニークな固有の符号です。 同梱明細書の「注文番号」に印刷されます。 出庫依頼を作成する場合は、 |
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" 注文単位、もしくは商品単位で緩衝材指定します。緩衝材は有料オプションで別途料金が発生します。
|
cushioning_type | string or null (緩衝材種別) Enum: "BUBBLE_PACK" "BUBBLE_DOUBLE_PACK" 緩衝材単位を注文単位で利用する場合に指定します。 「注文単位」を指定した場合は、緩衝材種別を下記から指定してください。
|
gift_wrapping_unit | string or null (ギフトラッピング単位) Enum: "ORDER" "ITEM" 注文単位、もしくは商品単位でラッピングします。ギフトラッピングは有料オプションで別途料金が発生します。
|
gift_wrapping_type | string or null (ギフトラッピングタイプ) Enum: "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> (配送先連絡メールアドレス) お届け先へお荷物発送のお知らせメールを送信したい場合に指定します。 指定されたメールアドレス宛に「お荷物発送のお知らせ」メールをオープンロジドメインから自動送信します。
この項目が未指定または |
delivery_note_type | string or null (明細書の同梱設定) Enum: "NOT_INCLUDE_PII" "NONE" 明細書を同梱するかしないかを指定します。 値がない場合は、出庫設定の同梱明細書の同梱設定に従います。
|
price_on_delivery_note | boolean or null (明細書への金額印字指定) 明細書に金額を印字するかしないかを指定します。
|
message | string or null (明細書メッセージ) <= 500 characters 同梱明細書に記載するメッセージです。 ご依頼主マスタで設定している明細書メッセージを上書きする場合に利用します。 |
suspend | boolean (保留フラグ) Default: false
保留状態の出庫依頼は、保留解除しない限り出庫作業が開始されません。 ただし、保留状態の出庫依頼にも在庫は引き当てられます。 出庫作業を開始したくない場合に、出庫依頼時に |
shipping_date | string <date> (出庫希望日) 指定された日付以降に倉庫で出荷作業が行われます。倉庫の作業状況次第では指定日以降に出荷となる場合があります。 お届け希望日を指定したい場合は、 |
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" 配送会社を指示したい場合に指定します。 国内発送の場合に指定でき、指定すると別途料金が発生します。
|
delivery_time_slot | string or null (希望時間指定) Enum: "AM" "12" "14" "16" "18" "19" 国内発送の場合に、配達の時間帯を指示したい場合に指定します。
|
delivery_date | |
cash_on_delivery | boolean (代金引換指定) Default: false
|
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サイズの商品のみ、かつポスト便のサイズに収まった場合に、このパラメータの省略時には
|
warehouse | string or null (倉庫コード) 出庫する倉庫をコードで指定します。未指定または null を指定した場合は、標準倉庫から出庫されます。 |
required | Array of objects (配送商品リスト) 出庫したい商品を指定します。同梱物を指定する場合は、 |
international | boolean (海外発送指定) Default: false 海外発送する場合は、 |
delivery_service | string 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" 海外配送( Sagawa
Yamato
Japan Post
Fedex
DHL
|
currency_code | string (海外発送用通貨コード) 商品単価や合計金額で利用する通貨。
海外配送( 指定できる値は、通貨情報APIを参照してください。 |
insurance | boolean (海外発送用損害保証制度の加入希望) 海外配送( 損害保証制度の加入希望がある場合は |
backorder_if_unavailable | boolean (出庫単位の出庫予約フラグ) Default: false 在庫不足時、出庫予約として出庫依頼を作成できるようにします。商品単位の指定よりも、出庫単位の指定が優先されます。 |
purpose | string (輸出目的) Enum: "GIFT" "DOCUMENTS" "COMMERCIAL_SAMPLE" "SALE_OF_GOODS" "RETURNED_GOODS" "OTHERS" EMS/小形包装物 書留/DHL/Fedexの場合に指定します。 輸出目的が指す品目と実際の商品とが異なる場合には、通関手続きができない場合があります。 未指定の場合、【管理画面】 > 【設定】> 【配送情報】> 【配送設定】 > 「輸出目的設定」で選択した項目が適用されます。
|
allocate_priority | integer (引当優先順位) [ 0 .. 100 ] 出庫依頼に対して、出庫の商品単位で配送可在庫を確保する処理(引当)をオープンロジで行なっています。 数字が大きいほど、優先的に引当されます。 |
国内住所 (object) or 海外住所 (object) (発送元住所) 省略時は管理画面から登録してある情報が使われます。 | |
required | 国内住所 (object) or 海外住所 (object) (発送先住所) 発送先住所 (海外出庫の場合は |
{- "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
}
{- "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": [
- "TS001-I000001"
], - "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": {
- "box_delivery": true,
- "fragile_item": true
}, - "bundle_shipping_label": "string",
- "warehouse": "OPL",
- "items": [
- {
- "id": "TS001-I000004",
- "name": "勇者の盾",
- "code": "item-001",
- "quantity": 1,
- "unit_price": 1000,
- "price": 1000,
- "is_reduced_tax": true,
- "hs_code": "000000.000",
- "gift_wrapping_type": "NAVY",
- "cushioning_type": "BUBBLE_PACK",
- "backordered": false
}
], - "purpose": "SALE_OF_GOODS",
- "allocate_priority": 0,
- "sender": {
- "postcode": 1700013,
- "name": "string",
- "phone": "03-3333-3333",
- "prefecture": "東京都",
- "address1": "豊島区東池袋1-34-5",
- "address2": "いちご東池袋ビル9F",
- "company": "string",
- "division": "メタル部"
}, - "recipient": {
- "postcode": 1700013,
- "name": "string",
- "phone": "03-3333-3333",
- "prefecture": "東京都",
- "address1": "豊島区東池袋1-34-5",
- "address2": "いちご東池袋ビル9F",
- "company": "string",
- "division": "メタル部"
}
}
ステータスによっては削除できません。
account_id required | string Example: TS001 アカウントコード |
identifier required | string Example: 2015-00001 識別番号 |
{ }
{- "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": [
- "TS001-I000001"
], - "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": {
- "box_delivery": true,
- "fragile_item": true
}, - "bundle_shipping_label": "string",
- "warehouse": "OPL",
- "items": [
- {
- "id": "TS001-I000004",
- "name": "勇者の盾",
- "code": "item-001",
- "quantity": 1,
- "unit_price": 1000,
- "price": 1000,
- "is_reduced_tax": true,
- "hs_code": "000000.000",
- "gift_wrapping_type": "NAVY",
- "cushioning_type": "BUBBLE_PACK",
- "backordered": false
}
], - "purpose": "SALE_OF_GOODS",
- "allocate_priority": 0,
- "sender": {
- "postcode": 1700013,
- "name": "string",
- "phone": "03-3333-3333",
- "prefecture": "東京都",
- "address1": "豊島区東池袋1-34-5",
- "address2": "いちご東池袋ビル9F",
- "company": "string",
- "division": "メタル部"
}, - "recipient": {
- "postcode": 1700013,
- "name": "string",
- "phone": "03-3333-3333",
- "prefecture": "東京都",
- "address1": "豊島区東池袋1-34-5",
- "address2": "いちご東池袋ビル9F",
- "company": "string",
- "division": "メタル部"
}
}
ステータスがピッキング中・ピッキング済み・梱包済みの出庫依頼の修正を依頼します。
データ取り込み後の修正となりますので、別途事務手数料+作業進捗状況による作業費用がかかります。
海外発送の場合は梱包済みのステータス以降は依頼ができません。
キャンセル依頼を出していただき、別途新規の出庫依頼を作成してください。
また、作業進捗状況によってはご依頼にお応えすることができない場合がございます。
ご了承の上ご利用ください。
account_id required | string Example: TS001 アカウントコード |
identifier required | string Example: 2015-00001 識別番号 |
国内住所 (object) or 海外住所 (object) 発送先住所 (海外出庫の場合はregion_codeを指定する必要が有ります) | |
delivery_time_slot | string Enum: "AM" "12" "14" "16" "18" "19" 希望時間指定 (12はSAGAWAの場合のみ) |
delivery_date | string 配達希望日 (指定できる最短日付は配送会社によって変わります) |
{- "recipient": {
- "postcode": 1700013,
- "name": "open 太郎",
- "phone": "03-3333-3333",
- "prefecture": "東京都",
- "address1": "豊島区東池袋1-34-5",
- "address2": "いちご東池袋ビル9F",
- "company": "スライム株式会社",
- "division": "メタル部"
}, - "delivery_time_slot": "12",
- "delivery_date": "2019-04-05"
}
{- "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": [
- "TS001-I000001"
], - "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": {
- "box_delivery": true,
- "fragile_item": true
}, - "bundle_shipping_label": "string",
- "warehouse": "OPL",
- "items": [
- {
- "id": "TS001-I000004",
- "name": "勇者の盾",
- "code": "item-001",
- "quantity": 1,
- "unit_price": 1000,
- "price": 1000,
- "is_reduced_tax": true,
- "hs_code": "000000.000",
- "gift_wrapping_type": "NAVY",
- "cushioning_type": "BUBBLE_PACK",
- "backordered": false
}
], - "purpose": "SALE_OF_GOODS",
- "allocate_priority": 0,
- "sender": {
- "postcode": 1700013,
- "name": "string",
- "phone": "03-3333-3333",
- "prefecture": "東京都",
- "address1": "豊島区東池袋1-34-5",
- "address2": "いちご東池袋ビル9F",
- "company": "string",
- "division": "メタル部"
}, - "recipient": {
- "postcode": 1700013,
- "name": "string",
- "phone": "03-3333-3333",
- "prefecture": "東京都",
- "address1": "豊島区東池袋1-34-5",
- "address2": "いちご東池袋ビル9F",
- "company": "string",
- "division": "メタル部"
}
}
ステータスがピッキング中・ピッキング済み・梱包済みの出庫依頼の修正を依頼します。
データ取り込み後の修正となりますので、別途事務手数料+作業進捗状況による作業費用がかかります。
海外発送の場合は梱包済みのステータス以降は依頼ができません。
キャンセル依頼を出していただき、別途新規の出庫依頼を作成してください。
また、作業進捗状況によってはご依頼にお応えすることができない場合がございます。
ご了承の上ご利用ください。
account_id required | string Example: TS001 アカウントコード |
identifier required | string Example: 2015-00001 識別番号 |
{ }
{- "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": [
- "TS001-I000001"
], - "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": {
- "box_delivery": true,
- "fragile_item": true
}, - "bundle_shipping_label": "string",
- "warehouse": "OPL",
- "items": [
- {
- "id": "TS001-I000004",
- "name": "勇者の盾",
- "code": "item-001",
- "quantity": 1,
- "unit_price": 1000,
- "price": 1000,
- "is_reduced_tax": true,
- "hs_code": "000000.000",
- "gift_wrapping_type": "NAVY",
- "cushioning_type": "BUBBLE_PACK",
- "backordered": false
}
], - "purpose": "SALE_OF_GOODS",
- "allocate_priority": 0,
- "sender": {
- "postcode": 1700013,
- "name": "string",
- "phone": "03-3333-3333",
- "prefecture": "東京都",
- "address1": "豊島区東池袋1-34-5",
- "address2": "いちご東池袋ビル9F",
- "company": "string",
- "division": "メタル部"
}, - "recipient": {
- "postcode": 1700013,
- "name": "string",
- "phone": "03-3333-3333",
- "prefecture": "東京都",
- "address1": "豊島区東池袋1-34-5",
- "address2": "いちご東池袋ビル9F",
- "company": "string",
- "division": "メタル部"
}
}