Documentation Powered by ReDoc

OPENLOGI API (1.5.0)

Download OpenAPI specification:Download

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

オープンロジAPIを活用することで物流業務の自動化を行うことができるようになります。

CHANGELOG

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

利用方法

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

アクセストークンは以下URLのAPI設定画面より発行することができます。

https://app.openlogi.com/portal/tokens      (本番環境)
https://app-demo.openlogi.com/portal/tokens (デモ環境)

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

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

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

APIアクセス方法

オープンロジ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制限

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

それ以上の頻度で送信する必要がある場合は、弊社までお問い合わせください。

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

items

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

商品一覧

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

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

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

商品ID指定

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

stock
integer
Example: stock=1

在庫情報を含むかどうか

Responses

Response samples

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

商品登録

商品を登録します。

Request Body schema: application/json
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

セット商品の子商品リスト

tags
Array of strings

商品タグ

temperature_zone
string Nullable
Enum: "dry" "constant" "chilled" "frozen"

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

fifo
boolean Nullable

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

lot_limit_type
string Nullable
Enum: "expiry" "manufacture"

期限商品タイプ ※商品マスタ情報。期限管理を利用するお客様のみ使用可能

expiry_at_allocatable_days
integer Nullable

引当可能残期間（賞味期限） ※商品マスタ情報。期限管理を利用するお客様のみ使用可能

manufacture_date_allocatable_days
integer Nullable

引当可能残期間（製造年月日） ※商品マスタ情報。期限管理を利用するお客様のみ使用可能

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": "TS001-I000001",
  • "code": "item-002",
  • "name": "勇者の盾",
  • "price": "1000",
  • "is_reduced_tax": true,
  • "hs_code": "000000.000",
  • "barcode": "1234567890128",
  • "item_barcodes": [
    ],
  • "description": "玩具",
  • "international_info": {
    },
  • "child_items": [
    ],
  • "tags": [
    ],
  • "stock": {
    },
  • "stocks": [
    ],
  • "bundled_item": true,
  • "externalCode": "TEST1",
  • "hidden": true,
  • "temperature_zone": "frozen",
  • "fifo": true,
  • "lot_limit_type": "expiry",
  • "expiry_at_allocatable_days": 20,
  • "manufacture_date_allocatable_days": 20,
  • "expiry_at": "2021-04-05",
  • "manufacture_date": "2021-04-01",
  • "lot_allocatable_at": "2021-04-05",
  • "lot_allocatable_priority": 1
}

商品一括登録

商品を一括登録します。

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

Request Body schema: application/json
Array of objects

商品リスト

Responses

Request samples

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

Response samples

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

商品情報

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

path Parameters
id
required
string
Example: TS001-I000001

商品ID

query Parameters
stock
integer
Example: stock=1

在庫情報を含むかどうか

Responses

Response samples

Content type
application/json
{
  • "id": "TS001-I000001",
  • "code": "item-002",
  • "name": "勇者の盾",
  • "price": "1000",
  • "is_reduced_tax": true,
  • "hs_code": "000000.000",
  • "barcode": "1234567890128",
  • "item_barcodes": [
    ],
  • "description": "玩具",
  • "international_info": {
    },
  • "child_items": [
    ],
  • "tags": [
    ],
  • "stock": {
    },
  • "stocks": [
    ],
  • "bundled_item": true,
  • "externalCode": "TEST1",
  • "hidden": true,
  • "temperature_zone": "frozen",
  • "fifo": true,
  • "lot_limit_type": "expiry",
  • "expiry_at_allocatable_days": 20,
  • "manufacture_date_allocatable_days": 20,
  • "expiry_at": "2021-04-05",
  • "manufacture_date": "2021-04-01",
  • "lot_allocatable_at": "2021-04-05",
  • "lot_allocatable_priority": 1
}

商品更新

商品情報を更新します。

path Parameters
id
required
string
Example: TS001-I000001

商品ID

Request Body schema: application/json
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

セット商品の子商品リスト

tags
Array of strings

商品タグ

temperature_zone
string Nullable
Enum: "dry" "constant" "chilled" "frozen"

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

fifo
boolean Nullable

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

lot_limit_type
string Nullable
Enum: "expiry" "manufacture"

期限商品タイプ ※商品マスタ情報。期限管理を利用するお客様のみ使用可能

expiry_at_allocatable_days
integer Nullable

引当可能残期間（賞味期限） ※商品マスタ情報。期限管理を利用するお客様のみ使用可能

manufacture_date_allocatable_days
integer Nullable

引当可能残期間（製造年月日） ※商品マスタ情報。期限管理を利用するお客様のみ使用可能

bundled_item
boolean Nullable

同梱物

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": "TS001-I000001",
  • "code": "item-002",
  • "name": "勇者の盾",
  • "price": "1000",
  • "is_reduced_tax": true,
  • "hs_code": "000000.000",
  • "barcode": "1234567890128",
  • "item_barcodes": [
    ],
  • "description": "玩具",
  • "international_info": {
    },
  • "child_items": [
    ],
  • "tags": [
    ],
  • "stock": {
    },
  • "stocks": [
    ],
  • "bundled_item": true,
  • "externalCode": "TEST1",
  • "hidden": true,
  • "temperature_zone": "frozen",
  • "fifo": true,
  • "lot_limit_type": "expiry",
  • "expiry_at_allocatable_days": 20,
  • "manufacture_date_allocatable_days": 20,
  • "expiry_at": "2021-04-05",
  • "manufacture_date": "2021-04-01",
  • "lot_allocatable_at": "2021-04-05",
  • "lot_allocatable_priority": 1
}

商品削除

商品を削除します。

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

path Parameters
id
required
string
Example: TS001-I000001

商品ID

Request Body schema: application/json
any

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "TS001-I000001",
  • "code": "item-002",
  • "name": "勇者の盾",
  • "price": "1000",
  • "is_reduced_tax": true,
  • "hs_code": "000000.000",
  • "barcode": "1234567890128",
  • "item_barcodes": [
    ],
  • "description": "玩具",
  • "international_info": {
    },
  • "child_items": [
    ],
  • "tags": [
    ],
  • "stock": {
    },
  • "stocks": [
    ],
  • "bundled_item": true,
  • "externalCode": "TEST1",
  • "hidden": true,
  • "temperature_zone": "frozen",
  • "fifo": true,
  • "lot_limit_type": "expiry",
  • "expiry_at_allocatable_days": 20,
  • "manufacture_date_allocatable_days": 20,
  • "expiry_at": "2021-04-05",
  • "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 エンコードした値を指定してください。

path Parameters
id
required
string
Example: TS001-I000001

商品ID

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

Responses

Response samples

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

商品画像削除

商品画像を削除します。

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

path Parameters
id
required
string
Example: TS001-I000001

商品ID

image_id
string
Example: 1

画像ID

Responses

Response samples

Content type
application/json
{ }

商品一覧

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

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

path Parameters
account_id
required
string
Example: AB001

アカウントコード

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

商品識別番号

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

code
required
string
Example: code=DQ001,DQ002

商品コード

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

stock
integer
Example: stock=1

在庫情報を含むかどうか

Responses

Response samples

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

商品情報

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

path Parameters
account_id
required
string
Example: AB001

アカウントコード

code
required
string
Example: item-001

商品コード

query Parameters
stock
integer
Example: stock=1

在庫情報を含むかどうか

Responses

Response samples

Content type
application/json
{
  • "id": "TS001-I000001",
  • "code": "item-002",
  • "name": "勇者の盾",
  • "price": "1000",
  • "is_reduced_tax": true,
  • "hs_code": "000000.000",
  • "barcode": "1234567890128",
  • "item_barcodes": [
    ],
  • "description": "玩具",
  • "international_info": {
    },
  • "child_items": [
    ],
  • "tags": [
    ],
  • "stock": {
    },
  • "stocks": [
    ],
  • "bundled_item": true,
  • "externalCode": "TEST1",
  • "hidden": true,
  • "temperature_zone": "frozen",
  • "fifo": true,
  • "lot_limit_type": "expiry",
  • "expiry_at_allocatable_days": 20,
  • "manufacture_date_allocatable_days": 20,
  • "expiry_at": "2021-04-05",
  • "manufacture_date": "2021-04-01",
  • "lot_allocatable_at": "2021-04-05",
  • "lot_allocatable_priority": 1
}

商品更新

商品情報を更新します。

path Parameters
account_id
required
string
Example: AB001

アカウントコード

code
required
string
Example: item-001

商品コード

Request Body schema: application/json
code
required
string

商品コード

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

セット商品の子商品リスト

tags
Array of strings

商品タグ

temperature_zone
string Nullable
Enum: "dry" "constant" "chilled" "frozen"

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

fifo
boolean Nullable

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

lot_limit_type
string Nullable
Enum: "expiry" "manufacture"

期限商品タイプ ※商品マスタ情報。期限管理を利用するお客様のみ使用可能

expiry_at_allocatable_days
integer Nullable

引当可能残期間（賞味期限） ※商品マスタ情報。期限管理を利用するお客様のみ使用可能

manufacture_date_allocatable_days
integer Nullable

引当可能残期間（製造年月日） ※商品マスタ情報。期限管理を利用するお客様のみ使用可能

bundled_item
boolean Nullable

同梱物

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": "TS001-I000001",
  • "code": "item-002",
  • "name": "勇者の盾",
  • "price": "1000",
  • "is_reduced_tax": true,
  • "hs_code": "000000.000",
  • "barcode": "1234567890128",
  • "item_barcodes": [
    ],
  • "description": "玩具",
  • "international_info": {
    },
  • "child_items": [
    ],
  • "tags": [
    ],
  • "stock": {
    },
  • "stocks": [
    ],
  • "bundled_item": true,
  • "externalCode": "TEST1",
  • "hidden": true,
  • "temperature_zone": "frozen",
  • "fifo": true,
  • "lot_limit_type": "expiry",
  • "expiry_at_allocatable_days": 20,
  • "manufacture_date_allocatable_days": 20,
  • "expiry_at": "2021-04-05",
  • "manufacture_date": "2021-04-01",
  • "lot_allocatable_at": "2021-04-05",
  • "lot_allocatable_priority": 1
}

商品削除

商品を削除します。

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

path Parameters
account_id
required
string
Example: AB001

アカウントコード

code
required
string
Example: item-001

商品コード

Request Body schema: application/json
any

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "TS001-I000001",
  • "code": "item-002",
  • "name": "勇者の盾",
  • "price": "1000",
  • "is_reduced_tax": true,
  • "hs_code": "000000.000",
  • "barcode": "1234567890128",
  • "item_barcodes": [
    ],
  • "description": "玩具",
  • "international_info": {
    },
  • "child_items": [
    ],
  • "tags": [
    ],
  • "stock": {
    },
  • "stocks": [
    ],
  • "bundled_item": true,
  • "externalCode": "TEST1",
  • "hidden": true,
  • "temperature_zone": "frozen",
  • "fifo": true,
  • "lot_limit_type": "expiry",
  • "expiry_at_allocatable_days": 20,
  • "manufacture_date_allocatable_days": 20,
  • "expiry_at": "2021-04-05",
  • "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 エンコードした値を指定してください。

path Parameters
account_id
required
string
Example: AB001

アカウントコード

code
required
string
Example: item-001

商品コード

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

Responses

Response samples

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

商品画像削除

商品画像を削除します。

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

path Parameters
account_id
required
string
Example: AB001

アカウントコード

code
required
string
Example: item-001

商品コード

image_id
required
string
Example: 1

画像ID

Responses

Response samples

Content type
application/json
{ }

warehousings

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

入庫依頼一覧

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

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

Responses

Response samples

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

入庫依頼作成

入庫依頼を作成します。

実際の入庫処理をするには別途入庫明細書と入庫ラベルが必要になります。

オープンロジの入庫依頼中の画面より入庫明細書兼入庫ラベルを印刷し、 入庫明細書を同梱した上で入庫ラベルを箱に貼って倉庫宛に発送ください。

Request Body schema: application/json
inspection_type
required
string
Enum: "ID" "NAME" "CODE" "BARCODE" "LABEL"

検品タイプ（オープンロジ商品ID、商品名、商品コード、管理バーコード、オープンロジ商品ラベル）

required
Array of objects

入庫商品リスト

arrival_date
required
string

倉庫着予定日

arrival_date_confirmed
boolean

確定情報として登録

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

arrival_time_from
integer

倉庫着予定時間(いつから)

0 ~ 23の数値が指定可能です

arrival_time_to
integer

倉庫着予定時間(いつまで)

0 ~ 23の数値が指定可能です

sales_method
string
Enum: "INVENTORY" "RESERVATION" "OTHER"

販売方法

INVENTORY : 在庫販売

RESERVATION: 予約販売

OTHER : その他

shipping_scheduled_date
string

出庫予定日

販売方法が RESERVATION の場合、指定できます

transport_mode
string
Enum: "" "HOME_DELIVERY" "CHARTER" "CONTAINER"

配送方法

入庫する際の配送方法を指定できます

"" : 指定なし

HOME_DELIVERY : 宅配便

CHARTER : チャーター

CONTAINER : コンテナ

※入庫依頼作成時に、このパラメータが未指定の場合、HOME_DELIVERYとして登録されます。

identity_type
string
Enum: "ID_OR_LABEL" "SUPPLIER" "TRACKING_CODE" "VEHICLE_CODE" "CONTAINER"

入庫特定項目 ※入庫ラベルなし入庫を利用するお客様のみ使用可能

倉庫で入庫を特定する際のキーとなる項目を指定できます

許可された項目のみ指定可能です

ID_OR_LABEL : 入庫ラベル・ID

SUPPLIER : 発注先名。この値を指定し、identity_valuesを指定すると、倉庫側で発注先名を使用して入庫を特定します

TRACKING_CODE : お問い合わせ伝票番号。この値を指定し、tracking_codesを指定すると、倉庫側でお問い合わせ伝票番号を使用して入庫を特定します

VEHICLE_CODE : 車両番号。この値を指定し、vehicle_codeを指定すると、倉庫側で車両番号を使用して入庫を特定します

CONTAINER : コンテナID。この値を指定し、container_noを指定すると、倉庫側でコンテナIDを使用して入庫を特定します

※入庫依頼新規作成時に、このパラメータが未指定の場合、ID_OR_LABELとして登録されます。

identity_values
Array of strings

入庫特定情報 ※入庫ラベルなし入庫を利用するお客様のみ使用可能

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

入庫特定項目がID_OR_LABELの場合は指定できません

入庫特定項目がSUPPLIERの場合、このパラメータに発注先名を指定すると、倉庫側で発注先名を使用して入庫を特定します

tracking_codes
Array of strings

お問合せ伝票番号

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

vehicle_code
string

車両番号

商品を倉庫へ送る際のチャーターやコンテナを載せる車両の番号を指定します

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

vehicle_size
string
Enum: "UNDER_2T" "4T" "10T" "20FT" "40FT"

車両サイズ

車両やコンテナのサイズを指定できます

UNDER_2T: 2t以下

4T: 4t

10T: 10t

20FT: 20ft

40FT: 40ft

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

carrying_method
string
Enum: "PALETTE" "BARA"

積載方法

個口の積載方法を指定できます

PALETTE: パレット

BARA: バラ積み

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

container_no
string

コンテナID

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

driver_info
string

ドライバー情報

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

company_memo
string

入庫メモ

お客様用の入庫のメモです

identifier
string

入庫依頼識別子

Responses

Request samples

Content type
application/json
{
  • "inspection_type": "CODE",
  • "items": [
    ],
  • "arrival_date": "2019-04-22",
  • "arrival_date_confirmed": true,
  • "arrival_time_from": 10,
  • "arrival_time_to": 13,
  • "sales_method": "RESERVATION",
  • "shipping_scheduled_date": "2019-04-29",
  • "transport_mode": "",
  • "identity_type": "ID_OR_LABEL",
  • "identity_values": [
    ],
  • "tracking_codes": [
    ],
  • "vehicle_code": "string",
  • "vehicle_size": "UNDER_2T",
  • "carrying_method": "PALETTE",
  • "container_no": "string",
  • "driver_info": "string",
  • "company_memo": "string",
  • "identifier": "Identifier001"
}

Response samples

Content type
application/json
{
  • "id": "TS001-W0001",
  • "status": "waiting",
  • "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": "Identifier001",
  • "inspection_type": "CODE",
  • "transport_mode": "",
  • "identity_type": "ID_OR_LABEL",
  • "identity_values": [
    ],
  • "tracking_codes": [
    ],
  • "vehicle_code": "string",
  • "vehicle_size": "UNDER_2T",
  • "carrying_method": "PALETTE",
  • "container_no": "string",
  • "driver_info": "string",
  • "company_memo": "string",
  • "items": [
    ],
  • "shipment_return": false,
  • "warehouse_info": {
    },
  • "created_at": "2019-04-01T03:00:00.000Z"
}

入庫依頼情報

入庫情報を取得します。

path Parameters
id
required
string
Example: AB001-W0001

入庫ID

Responses

Response samples

Content type
application/json
{
  • "id": "TS001-W0001",
  • "status": "waiting",
  • "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": "Identifier001",
  • "inspection_type": "CODE",
  • "transport_mode": "",
  • "identity_type": "ID_OR_LABEL",
  • "identity_values": [
    ],
  • "tracking_codes": [
    ],
  • "vehicle_code": "string",
  • "vehicle_size": "UNDER_2T",
  • "carrying_method": "PALETTE",
  • "container_no": "string",
  • "driver_info": "string",
  • "company_memo": "string",
  • "items": [
    ],
  • "shipment_return": false,
  • "warehouse_info": {
    },
  • "created_at": "2019-04-01T03:00:00.000Z"
}

入庫依頼更新

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

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

path Parameters
id
required
string
Example: AB001-W0001

入庫ID

Request Body schema: application/json
inspection_type
required
string
Enum: "ID" "NAME" "CODE" "BARCODE" "LABEL"

検品タイプ（オープンロジ商品ID、商品名、商品コード、管理バーコード、オープンロジ商品ラベル）

required
Array of objects

入庫商品リスト

arrival_date
required
string

倉庫着予定日

arrival_date_confirmed
boolean

確定情報として登録

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

arrival_time_from
integer

倉庫着予定時間(いつから)

0 ~ 23の数値が指定可能です

arrival_time_to
integer

倉庫着予定時間(いつまで)

0 ~ 23の数値が指定可能です

sales_method
string
Enum: "INVENTORY" "RESERVATION" "OTHER"

販売方法

INVENTORY : 在庫販売

RESERVATION: 予約販売

OTHER : その他

shipping_scheduled_date
string

出庫予定日

販売方法が RESERVATION の場合、指定できます

transport_mode
string
Enum: "" "HOME_DELIVERY" "CHARTER" "CONTAINER"

配送方法

入庫する際の配送方法を指定できます

"" : 指定なし

HOME_DELIVERY : 宅配便

CHARTER : チャーター

CONTAINER : コンテナ

※入庫依頼作成時に、このパラメータが未指定の場合、HOME_DELIVERYとして登録されます。

identity_type
string
Enum: "ID_OR_LABEL" "SUPPLIER" "TRACKING_CODE" "VEHICLE_CODE" "CONTAINER"

入庫特定項目 ※入庫ラベルなし入庫を利用するお客様のみ使用可能

倉庫で入庫を特定する際のキーとなる項目を指定できます

許可された項目のみ指定可能です

ID_OR_LABEL : 入庫ラベル・ID

SUPPLIER : 発注先名。この値を指定し、identity_valuesを指定すると、倉庫側で発注先名を使用して入庫を特定します

TRACKING_CODE : お問い合わせ伝票番号。この値を指定し、tracking_codesを指定すると、倉庫側でお問い合わせ伝票番号を使用して入庫を特定します

VEHICLE_CODE : 車両番号。この値を指定し、vehicle_codeを指定すると、倉庫側で車両番号を使用して入庫を特定します

CONTAINER : コンテナID。この値を指定し、container_noを指定すると、倉庫側でコンテナIDを使用して入庫を特定します

※入庫依頼新規作成時に、このパラメータが未指定の場合、ID_OR_LABELとして登録されます。

identity_values
Array of strings

入庫特定情報 ※入庫ラベルなし入庫を利用するお客様のみ使用可能

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

入庫特定項目がID_OR_LABELの場合は指定できません

入庫特定項目がSUPPLIERの場合、このパラメータに発注先名を指定すると、倉庫側で発注先名を使用して入庫を特定します

tracking_codes
Array of strings

お問合せ伝票番号

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

vehicle_code
string

車両番号

商品を倉庫へ送る際のチャーターやコンテナを載せる車両の番号を指定します

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

vehicle_size
string
Enum: "UNDER_2T" "4T" "10T" "20FT" "40FT"

車両サイズ

車両やコンテナのサイズを指定できます

UNDER_2T: 2t以下

4T: 4t

10T: 10t

20FT: 20ft

40FT: 40ft

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

carrying_method
string
Enum: "PALETTE" "BARA"

積載方法

個口の積載方法を指定できます

PALETTE: パレット

BARA: バラ積み

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

container_no
string

コンテナID

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

driver_info
string

ドライバー情報

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

company_memo
string

入庫メモ

お客様用の入庫のメモです

identifier
string

入庫依頼識別子

Responses

Request samples

Content type
application/json
{
  • "inspection_type": "CODE",
  • "items": [
    ],
  • "arrival_date": "2019-04-22",
  • "arrival_date_confirmed": true,
  • "arrival_time_from": 10,
  • "arrival_time_to": 13,
  • "sales_method": "RESERVATION",
  • "shipping_scheduled_date": "2019-04-29",
  • "transport_mode": "",
  • "identity_type": "ID_OR_LABEL",
  • "identity_values": [
    ],
  • "tracking_codes": [
    ],
  • "vehicle_code": "string",
  • "vehicle_size": "UNDER_2T",
  • "carrying_method": "PALETTE",
  • "container_no": "string",
  • "driver_info": "string",
  • "company_memo": "string",
  • "identifier": "Identifier001"
}

Response samples

Content type
application/json
{
  • "id": "TS001-W0001",
  • "status": "waiting",
  • "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": "Identifier001",
  • "inspection_type": "CODE",
  • "transport_mode": "",
  • "identity_type": "ID_OR_LABEL",
  • "identity_values": [
    ],
  • "tracking_codes": [
    ],
  • "vehicle_code": "string",
  • "vehicle_size": "UNDER_2T",
  • "carrying_method": "PALETTE",
  • "container_no": "string",
  • "driver_info": "string",
  • "company_memo": "string",
  • "items": [
    ],
  • "shipment_return": false,
  • "warehouse_info": {
    },
  • "created_at": "2019-04-01T03:00:00.000Z"
}

入庫依頼削除

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

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

path Parameters
id
required
string
Example: AB001-W0001

入庫ID

Request Body schema: application/json
any

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "TS001-W0001",
  • "status": "waiting",
  • "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": "Identifier001",
  • "inspection_type": "CODE",
  • "transport_mode": "",
  • "identity_type": "ID_OR_LABEL",
  • "identity_values": [
    ],
  • "tracking_codes": [
    ],
  • "vehicle_code": "string",
  • "vehicle_size": "UNDER_2T",
  • "carrying_method": "PALETTE",
  • "container_no": "string",
  • "driver_info": "string",
  • "company_memo": "string",
  • "items": [
    ],
  • "shipment_return": false,
  • "warehouse_info": {
    },
  • "created_at": "2019-04-01T03:00:00.000Z"
}

直近の入庫実績

直近の入庫実績を取得します。

query Parameters
date_before
string
Example: date_before=20190101

指定日以前の最終入庫日の入庫実績(YYYYMMDD)

date_after
string
Example: date_after=20190401

指定日以降の初回入庫日の入庫実績(YYYYMMDD)

Responses

Response samples

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

指定日時の入庫実績

指定年月日の入庫実績を取得します。

path Parameters
year
string
Example: 2019

入庫年(YYYY)

month
string
Example: 04

入庫月(MM)

day
string
Example: 01

入庫日(DD)

Responses

Response samples

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

入庫ラベル取得

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

path Parameters
id
required
string
Example: AB001-W0001

入庫ID

Responses

shipments

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

出庫依頼一覧

依頼中の出庫依頼を取得します。

出庫IDまたは識別番号を指定した場合は、依頼中以外も取得します。

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

出庫ID指定

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

Responses

Response samples

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

出庫依頼作成

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

  • 出庫を特定するキーとして identifier が利用されます

  • identifier が指定されていない場合は order_no が identifier として利用されます

  • identifier と order_no のいずれかの指定が必須となります

Request Body schema: application/json
identifier
required
string Nullable

識別番号

order_no
string Nullable

注文番号 (同梱明細書の「注文番号」に印刷されます)

国内住所 (object) or 海外住所 (object)

発送元住所 (省略時は登録してある情報が使われます)

subtotal_amount
any Nullable

納品書 小計

delivery_charge
any Nullable

納品書 配送料

handling_charge
any Nullable

納品書 手数料

discount_amount
any Nullable

納品書 割引額

total_amount
any Nullable

納品書 合計

cushioning_unit
string Nullable
Enum: "ORDER" "ITEM"

緩衝材単位(注文単位、もしくは商品単位で緩衝材指定します。別途料金が発生します)

cushioning_type
string Nullable
Enum: "BUBBLE_PACK" "BUBBLE_DOUBLE_PACK"

緩衝材種別(プチプチ、プチプチ2重)

注文単位で緩衝材を利用する場合に指定することができます

gift_wrapping_unit
string Nullable
Enum: "ORDER" "ITEM"

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

gift_wrapping_type
string Nullable
Enum: "NAVY" "RED"

ギフトラッピングタイプ

注文単位でラッピングする場合に指定することができます

gift_sender_name
string Nullable

ギフト贈り主氏名

bundled_items
Array of strings Nullable

同梱物の商品ID or 商品コード (5つまで)

shipping_email
string Nullable

配送先連絡メール

delivery_note_type
string Nullable
Enum: "NOT_INCLUDE_PII" "NONE"

明細書の同梱設定

NOT_INCLUDE_PII : 住所非表示の明細書を同梱する

NONE : 同梱しない（明細書メッセージもクリアされます）

price_on_delivery_note
boolean Nullable

明細書への金額印字指定 (falseの場合には印字されません)

message
string Nullable

明細書メッセージ

suspend
boolean

保留フラグ

shipping_date
string

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

tax
string Nullable

税

total_with_normal_tax
any

総計通常税率 (1つ以上の軽減税率適用商品が含まれる場合に指定可能)

total_with_reduced_tax
any

総計軽減税率 (1つ以上の軽減税率適用商品が含まれる場合に指定可能)

required
国内住所 (object) or 海外住所 (object)

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

delivery_carrier
string Nullable
Enum: "YAMATO" "SAGAWA"

配送会社 (別途料金が発生します)

国内発送の場合に指定可能

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

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

国内発送の場合に指定可能

delivery_date
string Nullable

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

国内発送の場合に指定可能

cash_on_delivery
boolean

代金引換指定 (trueを指定したときだけ代金引換となります)

total_for_cash_on_delivery
any

代金引換総計 (代金引換の場合のみ指定可能)

tax_for_cash_on_delivery
any

代金引換消費税 (代金引換の場合のみ指定可能)

delivery_method
string Nullable
Enum: "POST_EXPRESS" "HOME_BOX"

配送便指定

POST_EXPRESS : ポスト便 (宅配便スピード)での配送 (SSサイズの商品で指定可能)

HOME_BOX : 宅配便 (段ボール梱包)での配送

SSサイズの商品のみの発送の場合に、このパラメータの省略時にはPOST_EXPRESSが設定されます

object Nullable

受取人からの希望

warehouse
string Nullable

倉庫コード

required
Array of objects

配送商品リスト

international
boolean

海外発送指定

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

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

Yamato

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

Japan Post

  • JAPANPOST-EMS EMS
  • JAPANPOST-EPACKET 小形包装物 書留
  • JAPANPOST-YU-PACKET 日本郵便 ゆうパケット

Fedex

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

DHL

  • DHL-EXPRESS DHL Express
currency_code
string

海外発送用通貨コード。海外発送時必須。 ※通貨情報参照

insurance
boolean

海外発送用損害保証制度の加入希望。

backorder_if_unavailable
boolean

在庫不足時、出庫予約としての登録許可。

purpose
string

海外発送用輸出目的。EMS/小形包装物 書留/DHL/Fedexの場合に指定可能

GIFT : 贈物

DOCUMENTS : 書類

COMMERCIAL_SAMPLE : 商品見本

SALE_OF_GOODS : 販売品

RETURNED_GOODS : 返送品

OTHERS : その他

allocate_priority
integer

引当優先順位

apply_rule
boolean

出庫ルール適用フラグ

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

Responses

Request samples

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

Response samples

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

出庫依頼一括作成

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

Request Body schema: application/json
required
Array of objects
apply_rule
boolean

出庫ルール適用フラグ

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

Responses

Request samples

Content type
application/json
Example
国内向け出庫依頼
国内向け出庫依頼
海外向け出庫依頼
{
  • "shipments": [
    ]
}

Response samples

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

出庫依頼

依頼中の出庫を取得します。

出庫IDまたは識別番号を指定した場合は、依頼中以外も取得します。

query Parameters
id
required
string
Example: id=TS001-S000001

出庫ID指定

Responses

Response samples

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

出庫依頼修正

依頼中の出庫依頼を更新します。 ステータスによっては更新できません。

query Parameters
id
required
string
Example: id=TS001-S000001

出庫ID指定

Request Body schema: application/json
identifier
required
string Nullable

識別番号

order_no
string Nullable

注文番号 (同梱明細書の「注文番号」に印刷されます)

国内住所 (object) or 海外住所 (object)

発送元住所 (省略時は登録してある情報が使われます)

subtotal_amount
any Nullable

納品書 小計

delivery_charge
any Nullable

納品書 配送料

handling_charge
any Nullable

納品書 手数料

discount_amount
any Nullable

納品書 割引額

total_amount
any Nullable

納品書 合計

cushioning_unit
string Nullable
Enum: "ORDER" "ITEM"

緩衝材単位(注文単位、もしくは商品単位で緩衝材指定します。別途料金が発生します)

cushioning_type
string Nullable
Enum: "BUBBLE_PACK" "BUBBLE_DOUBLE_PACK"

緩衝材種別(プチプチ、プチプチ2重)

注文単位で緩衝材を利用する場合に指定することができます

gift_wrapping_unit
string Nullable
Enum: "ORDER" "ITEM"

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

gift_wrapping_type
string Nullable
Enum: "NAVY" "RED"

ギフトラッピングタイプ

注文単位でラッピングする場合に指定することができます

gift_sender_name
string Nullable

ギフト贈り主氏名

bundled_items
Array of strings Nullable

同梱物の商品ID or 商品コード (5つまで)

shipping_email
string Nullable

配送先連絡メール

delivery_note_type
string Nullable
Enum: "NOT_INCLUDE_PII" "NONE"

明細書の同梱設定

NOT_INCLUDE_PII : 住所非表示の明細書を同梱する

NONE : 同梱しない（明細書メッセージもクリアされます）

price_on_delivery_note
boolean Nullable

明細書への金額印字指定 (falseの場合には印字されません)

message
string Nullable

明細書メッセージ

suspend
boolean

保留フラグ

shipping_date
string

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

tax
string Nullable

税

total_with_normal_tax
any

総計通常税率 (1つ以上の軽減税率適用商品が含まれる場合に指定可能)

total_with_reduced_tax
any

総計軽減税率 (1つ以上の軽減税率適用商品が含まれる場合に指定可能)

required
国内住所 (object) or 海外住所 (object)

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

delivery_carrier
string Nullable
Enum: "YAMATO" "SAGAWA"

配送会社 (別途料金が発生します)

国内発送の場合に指定可能

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

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

国内発送の場合に指定可能

delivery_date
string Nullable

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

国内発送の場合に指定可能

cash_on_delivery
boolean

代金引換指定 (trueを指定したときだけ代金引換となります)

total_for_cash_on_delivery
any

代金引換総計 (代金引換の場合のみ指定可能)

tax_for_cash_on_delivery
any

代金引換消費税 (代金引換の場合のみ指定可能)

delivery_method
string Nullable
Enum: "POST_EXPRESS" "HOME_BOX"

配送便指定

POST_EXPRESS : ポスト便 (宅配便スピード)での配送 (SSサイズの商品で指定可能)

HOME_BOX : 宅配便 (段ボール梱包)での配送

SSサイズの商品のみの発送の場合に、このパラメータの省略時にはPOST_EXPRESSが設定されます

object Nullable

受取人からの希望

warehouse
string Nullable

倉庫コード

required
Array of objects

配送商品リスト

international
boolean

海外発送指定

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

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

Yamato

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

Japan Post

  • JAPANPOST-EMS EMS
  • JAPANPOST-EPACKET 小形包装物 書留
  • JAPANPOST-YU-PACKET 日本郵便 ゆうパケット

Fedex

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

DHL

  • DHL-EXPRESS DHL Express
currency_code
string

海外発送用通貨コード。海外発送時必須。 ※通貨情報参照

insurance
boolean

海外発送用損害保証制度の加入希望。

backorder_if_unavailable
boolean

在庫不足時、出庫予約としての登録許可。

purpose
string

海外発送用輸出目的。EMS/小形包装物 書留/DHL/Fedexの場合に指定可能

GIFT : 贈物

DOCUMENTS : 書類

COMMERCIAL_SAMPLE : 商品見本

SALE_OF_GOODS : 販売品

RETURNED_GOODS : 返送品

OTHERS : その他

allocate_priority
integer

引当優先順位

Responses

Request samples

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

Response samples

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

出庫依頼削除

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

query Parameters
id
required
string
Example: id=TS001-S000001

出庫ID指定

Request Body schema: application/json
any

Responses

Request samples

Content type
application/json
{ }

Response samples

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

出庫依頼修正リクエスト

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

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

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

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

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

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

query Parameters
id
required
string
Example: id=TS001-S000001

出庫ID指定

Request Body schema: application/json
国内住所 (object) or 海外住所 (object)

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

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

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

delivery_date
string

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

Responses

Request samples

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

Response samples

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

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

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

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

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

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

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

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

query Parameters
id
required
string
Example: id=TS001-S000001

出庫ID指定

Request Body schema: application/json
any

Responses

Request samples

Content type
application/json
{ }

Response samples

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

出庫依頼一覧

依頼中の出庫依頼を取得します。

出庫IDまたは識別番号を指定した場合は、依頼中以外も取得します。

path Parameters
account_id
required
string
Example: TS001

アカウントコード

query Parameters
identifier
required
string
Example: identifier=2015-00001

識別番号

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

Responses

Response samples

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

出庫依頼

依頼中の出庫依頼を取得します。

出庫IDまたは識別番号を指定した場合は、依頼中以外も取得します。

path Parameters
account_id
required
string
Example: TS001

アカウントコード

identifier
required
string
Example: 2015-00001

識別番号

Responses

Response samples

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

出庫依頼修正

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

path Parameters
account_id
required
string
Example: TS001

アカウントコード

identifier
required
string
Example: 2015-00001

識別番号

Request Body schema: application/json
identifier
required
string Nullable

識別番号

order_no
string Nullable

注文番号 (同梱明細書の「注文番号」に印刷されます)

国内住所 (object) or 海外住所 (object)

発送元住所 (省略時は登録してある情報が使われます)

subtotal_amount
any Nullable

納品書 小計

delivery_charge
any Nullable

納品書 配送料

handling_charge
any Nullable

納品書 手数料

discount_amount
any Nullable

納品書 割引額

total_amount
any Nullable

納品書 合計

cushioning_unit
string Nullable
Enum: "ORDER" "ITEM"

緩衝材単位(注文単位、もしくは商品単位で緩衝材指定します。別途料金が発生します)

cushioning_type
string Nullable
Enum: "BUBBLE_PACK" "BUBBLE_DOUBLE_PACK"

緩衝材種別(プチプチ、プチプチ2重)

注文単位で緩衝材を利用する場合に指定することができます

gift_wrapping_unit
string Nullable
Enum: "ORDER" "ITEM"

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

gift_wrapping_type
string Nullable
Enum: "NAVY" "RED"

ギフトラッピングタイプ

注文単位でラッピングする場合に指定することができます

gift_sender_name
string Nullable

ギフト贈り主氏名

bundled_items
Array of strings Nullable

同梱物の商品ID or 商品コード (5つまで)

shipping_email
string Nullable

配送先連絡メール

delivery_note_type
string Nullable
Enum: "NOT_INCLUDE_PII" "NONE"

明細書の同梱設定

NOT_INCLUDE_PII : 住所非表示の明細書を同梱する

NONE : 同梱しない（明細書メッセージもクリアされます）

price_on_delivery_note
boolean Nullable

明細書への金額印字指定 (falseの場合には印字されません)

message
string Nullable

明細書メッセージ

suspend
boolean

保留フラグ

shipping_date
string

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

tax
string Nullable

税

total_with_normal_tax
any

総計通常税率 (1つ以上の軽減税率適用商品が含まれる場合に指定可能)

total_with_reduced_tax
any

総計軽減税率 (1つ以上の軽減税率適用商品が含まれる場合に指定可能)

required
国内住所 (object) or 海外住所 (object)

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

delivery_carrier
string Nullable
Enum: "YAMATO" "SAGAWA"

配送会社 (別途料金が発生します)

国内発送の場合に指定可能

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

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

国内発送の場合に指定可能

delivery_date
string Nullable

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

国内発送の場合に指定可能

cash_on_delivery
boolean

代金引換指定 (trueを指定したときだけ代金引換となります)

total_for_cash_on_delivery
any

代金引換総計 (代金引換の場合のみ指定可能)

tax_for_cash_on_delivery
any

代金引換消費税 (代金引換の場合のみ指定可能)

delivery_method
string Nullable
Enum: "POST_EXPRESS" "HOME_BOX"

配送便指定

POST_EXPRESS : ポスト便 (宅配便スピード)での配送 (SSサイズの商品で指定可能)

HOME_BOX : 宅配便 (段ボール梱包)での配送

SSサイズの商品のみの発送の場合に、このパラメータの省略時にはPOST_EXPRESSが設定されます

object Nullable

受取人からの希望

warehouse
string Nullable

倉庫コード

required
Array of objects

配送商品リスト

international
boolean

海外発送指定

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

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

Yamato

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

Japan Post

  • JAPANPOST-EMS EMS
  • JAPANPOST-EPACKET 小形包装物 書留
  • JAPANPOST-YU-PACKET 日本郵便 ゆうパケット

Fedex

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

DHL

  • DHL-EXPRESS DHL Express
currency_code
string

海外発送用通貨コード。海外発送時必須。 ※通貨情報参照

insurance
boolean

海外発送用損害保証制度の加入希望。

backorder_if_unavailable
boolean

在庫不足時、出庫予約としての登録許可。

purpose
string

海外発送用輸出目的。EMS/小形包装物 書留/DHL/Fedexの場合に指定可能

GIFT : 贈物

DOCUMENTS : 書類

COMMERCIAL_SAMPLE : 商品見本

SALE_OF_GOODS : 販売品

RETURNED_GOODS : 返送品

OTHERS : その他

allocate_priority
integer

引当優先順位

Responses

Request samples

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

Response samples

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

出庫依頼削除

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

path Parameters
account_id
required
string
Example: TS001

アカウントコード

identifier
required
string
Example: 2015-00001

識別番号

Request Body schema: application/json
any

Responses

Request samples

Content type
application/json
{ }

Response samples

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

出庫依頼修正リクエスト

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

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

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

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

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

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

path Parameters
account_id
required
string
Example: TS001

アカウントコード

identifier
required
string
Example: 2015-00001

識別番号

Request Body schema: application/json
国内住所 (object) or 海外住所 (object)

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

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

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

delivery_date
string

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

Responses

Request samples

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

Response samples

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

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

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

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

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

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

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

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

path Parameters
account_id
required
string
Example: TS001

アカウントコード

identifier
required
string
Example: 2015-00001

識別番号

Request Body schema: application/json
any

Responses

Request samples

Content type
application/json
{ }

Response samples

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

直近の出庫実績

直近の出庫実績を取得します。

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

query Parameters
date_before
string
Example: date_before=20190320

指定日以前の最終出庫日の出庫実績

date_after
string
Example: date_after=20190420

指定日以降の初回出庫日の出庫実績

Responses

Response samples

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

出庫実績

指定年月日の出庫実績を取得します。

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

path Parameters
year
required
string
Example: 2019

出庫年(YYYY)

month
required
string
Example: 04

出庫月(MM)

day
string
Example: 02

出庫日(DD)

Responses

Response samples

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

国コード情報

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

Responses

Response samples

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

通貨情報

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

Responses

Response samples

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

倉庫移動作成

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

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

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

Request Body schema: application/json
warehouse
required
string

移動元倉庫情報

required
object

移動先倉庫情報

required
Array of objects

移動商品リスト

Responses

Request samples

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

Response samples

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

倉庫移動更新

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

query Parameters
id
required
string
Example: id=TS001-S000001

出庫ID指定

Request Body schema: application/json
required
object

移動先倉庫情報

required
Array of objects

移動商品リスト

Responses

Request samples

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

Response samples

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

倉庫依頼修正リクエスト

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

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

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

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

query Parameters
id
required
string
Example: id=TS001-S000001

出庫ID指定

Request Body schema: application/json
required
object

移動先倉庫情報

Responses

Request samples

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

Response samples

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

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

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

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

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

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

query Parameters
id
required
string
Example: id=TS001-S000001

出庫ID

Request Body schema: application/json
any

Responses

Request samples

Content type
application/json
{ }

Response samples

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

出庫商品の引当解除

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

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

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

query Parameters
id
required
string
Example: id=TS001-S000001

出庫ID

Request Body schema: application/json
any

Responses

Request samples

Content type
application/json
{ }

Response samples

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