Back to top

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

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

利用方法

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

アクセストークンはAPI設定画面より利用するクライアント名を登録することで発行することができます。

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

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

APIアクセス方法

オープンロジAPIを提供するホストは以下のURLになります。

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

アクセスする際には指定のリクエストヘッダーを付与する必要があります。

Key Description
X-Api-Version 利用するAPIのバージョン (1.3 / 1.4)
Authorization API設定画面 にて取得したBearer Token

例)

X-Api-Version: 1.4
Authorization: Bearer wz2FvCW3NRm4GZgLC7GMlW3XbM2qIIbuCDv8RZ8F

商品 

商品登録 

商品登録
/api/items

商品を登録します。

Request Format

Key Type Description
code string (unique,required) 商品コード
name string (unique) 商品名
price number 商品価格
barcode string 管理バーコード
description string 品名
international_info (international_info) 海外発送情報
child_items [child_items] セット商品として登録する場合の子商品リスト

international_info

Key Type Description
invoice_summary string 品名(英語)
origin string 原産国(国連LOCODE)

child_items

  • セット商品の登録には子商品の id または codeいずれかの指定が必須です
Key Type Description
id string (required) 商品ID
code string (required) 商品コード
quantity number (required) 数量
  • Request  新規データ
  • Headers
    Content-Type: application/json
    Body
    {
        "code": "DQ003",
        "name": "世界樹の葉",
        "description": "薬草",
        "international_info": {
            "invoice_summary": "MAGICAL LEAF",
            "origin": "JP",
        }
    }
  • Response  201
  • Headers
    Content-Type: application/json
    Body
    {
        "id": "AB001-I000003",
        "code": "DQ003",
        "name": "世界樹の葉",
        "description": "薬草",
        "international_info": {
            "invoice_summary": "MAGICAL LEAF",
            "origin": "JP",
        }
    }
  • Request  商品名もしくは商品コードが重複
  • Headers
    Content-Type: application/json
    Body
    {
      "code": "DQ004",
      "name": "世界樹の葉"
    }
  • Response  409
  • Headers
    Content-Type: application/json
    Body
    {
      "error": "validation_failed",
      "error_description": "Validation failed",
      "errors": {
        "name": [
          "Already exist"
        ]
      }
    }
  • Request  セット商品新規データ
  • Headers
    Content-Type: application/json
    Body
    {
      "code": "DQSET001",
      "name": "やくそうセット",
      "description": "薬草",
      "child_items": [
        {
          "code": "DQ001",
          "quantity": 1
        },
        {
          "code": "DQ002",
          "quantity": 2
        }
      ]
    }
  • Response  201
  • Headers
    Content-Type: application/json
    Body
    {
        "id": "AB001-S000001",
        "code": "DQSET001",
        "name": "やくそうセット",
        "description": "薬草",
        "child_items": [
            {
                "id": "AB001-I000001",
                "code": "DQ001",
                "quantity": 1
            },
            {
                "id": "AB001-I000002",
                "code": "DQ002",
                "quantity": 2
            },
        ]
    }

一括商品登録 

一括商品登録
/api/items/bulk

商品を一括登録します。

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

Request Format

Key Type Description
items [item] 商品リスト
  • Request  複数商品の登録
  • Headers
    Content-Type: application/json
    Body
    {
      "items": [
        {
          "code": "DQ003",
          "name": "世界樹の葉"
        },
        {
          "code": "DQ004",
          "name": "時の砂"
        }
      ]
    }
  • Response  202
  • Headers
    Content-Type: application/json
    Body
    {
      "items": [
        {
          "id": "AB001-I000003",
          "code": "DQ003",
          "name": "世界樹の葉"
        },
        {
          "id": "AB001-I000004",
          "code": "DQ004",
          "name": "時の砂"
        }
      ]
    }
  • Request  複数セット商品の登録
  • Headers
    Content-Type: application/json
    Body
    {
      "items": [
        {
          "code": "DQSET001",
          "name": "やくそうセット1",
          "child_items": [
            {
              "code": "DQ001",
              "quantity": 1
            },
            {
              "code": "DQ002",
              "quantity": 2
            }
          ]
        },
        {
          "code": "DQSET002",
          "name": "やくそうセット2",
          "child_items": [
            {
              "code": "DQ001",
              "quantity": 1
            },
            {
              "code": "DQ003",
              "quantity": 3
            }
          ]
        }
      ]
    }
  • Response  200
  • Headers
    Content-Type: application/json
    Body
    {
      "items": [
        {
          "id": "AB001-S000001",
          "code": "DQSET001",
          "name": "やくそうセット1",
          "child_items": [
            {
              "id": "AB001-I000001",
              "code": "DQ001",
              "quantity": 1
            },
            {
              "id": "AB001-I000002",
              "code": "DQ002",
              "quantity": 2
            }
          ]
        },
        {
          "id": "AB001-S000002",
          "code": "DQSET002",
          "name": "やくそうセット2",
          "child_items": [
            {
              "id": "AB001-I000001",
              "code": "DQ001",
              "quantity": 1
            },
            {
              "id": "AB001-I000003",
              "code": "DQ003",
              "quantity": 3
            }
          ]
        }
      ]
    }

商品画像登録 

商品画像登録
/api/items/{id}/images
/api/items/{account_id}/{code}/images

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

Request Format

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

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

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

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

  • Parameters
  • id
    string (required) Example: AB001-I000002

    商品ID

    account_id
    string (required) Example: AB001

    アカウントID

    code
    string (required) Example: DQ001

    商品コード

  • Request  商品画像の登録
  • Headers
    Content-Type: multipart/form-data
    Body
    ------sample
    Content-Disposition: form-data; name="file"; filename="DQ003.jpg"
    Content-Type: image/jpeg
    ------sample--
  • Response  200
  • Headers
    Content-Type: application/json
    Body
    {
      "id": 1234
    }

商品一覧 

商品一覧
/api/items{?id,stock}
/api/items/{account_id}{?identifier,code,stock}

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

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

  • Parameters
  • id
    string (required) Example: AB001-I000001,AB001-I000003

    商品IDのカンマ区切り文字列

    identifier
    string (required) Example: 123456-098765,12345678,AB12345

    商品識別番号のカンマ区切り文字列

    code
    string (required) Example: DQ001,DQ002

    商品コードのカンマ区切り文字列

    stock
    number (optional) Example: 1

    在庫情報を含む

  • Response  200
  • Headers
    Content-Type: application/json
    Body
    {
        "items": [
            {
                "id": "AB001-I000001",
                "code": "DQ001",
                "name": "やくそう",
                "stock": {
                    "available": 2,
                    "shipping": 1,
                    "quantity": 3,
                    "size": "60",
                    "weight": 700
                }
            },
            {
                "id": "AB001-I000002",
                "code": "DQ002",
                "name": "キメラのつばさ"
            },
            {
                "id": "AB001-S000001",
                "code": "DQSET001",
                "name": "やくそうセット1",
                "child_items": [
                    {
                        "id": "AB001-I000001",
                        "code": "DQ001",
                        "quantity": 1
                    },
                    {
                        "id": "AB001-I000002",
                        "code": "DQ002",
                        "quantity": 2
                    },
                ]
            },
        ]
    }

商品情報 

商品情報
/api/items/{id}{?stock}
/api/items/{account_id}/{code}{?stock}

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

Response Format

Key Type Description
id string 商品ID
code string 商品コード
name string 商品名
stock (stock) 在庫情報(入庫実績が無ければ存在しない)
stocks (stocks) 倉庫別在庫情報(入庫実績が無ければ存在しない)

stock

Key Type Description
available number 在庫数
shipping number 出庫依頼数
quantity number 実在庫数
size enum サイズ (SS,S,60,80,100,120,140)
weight number 重さ(g)

stocks

Key Type Description
warehouse string 倉庫コード
available number 在庫数
shipping number 出庫依頼数
quantity number 実在庫数
  • Parameters
  • id
    string (required) Example: AB001-I000002

    商品ID

    account_id
    string (required) Example: AB001

    アカウントID

    code
    string (required) Example: DQ001

    商品コード

    stock
    number (optional) Example: 1

    在庫情報を含む

  • Response  200
  • Headers
    Content-Type: application/json
    Body
    {
        "id": "AB001-I000001",
        "code": "DQ001",
        "name": "やくそう",
        "stock": {
            "available": 2,
            "shipping": 1,
            "quantity": 3,
            "size": "60",
            "weight": 700
        },
        "stocks": [
            {
                "warehouse_base_code": "NBT",
                "available": 2,
                "shipping": 1,
                "quantity": 3,
            }
        ]
    }

商品更新 

商品更新
/api/items/{id}
/api/items/{account_id}/{code}

商品情報を更新します。

Request Format

Key Type Description
code string 商品コード
name string (required) 商品名
price string 商品価格
barcode string 管理バーコード
international_info (international_info) 海外発送情報
child_items [child_items] セットの商品
  • Parameters
  • id
    string (required) Example: AB001-I000002

    商品ID

    account_id
    string (required) Example: AB001

    アカウントID

    code
    string (required) Example: DQ001

    商品コード

  • Request  名前の変更
  • Body
    {
      "name": "すごいやくそう"
    }
  • Response  200
  • Headers
    Content-Type: application/json
    Body
    {
      "id": "AB001-I000001",
      "code": "DQ001",
      "name": "すごいやくそう"
    }
  • Request  セット商品の更新
  • Body
    {
      "name": "すごいやくそうセット",
      "child_items": [
        {
          "code": "DQ003",
          "quantity": 3
        }
      ]
    }
  • Response  200
  • Headers
    Content-Type: application/json
    Body
    {
        "id": "AB001-S000001",
        "code": "DQSET001",
        "name": "すごいやくそうセット"
        "child_items": {
            {
                "id": "AB001-I000003",
                "code": "DQ003",
                "quantity": 3
            }
        }
    }

商品削除 

商品削除
/api/items/{id}
/api/items/{account_id}/{code}

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

  • Parameters
  • id
    string (required) Example: AB001-I000002

    商品ID

    account_id
    string (required) Example: AB001

    アカウントID

    code
    string (required) Example: DQ001

    商品コード

  • Response  200
  • Headers
    Content-Type: application/json
    Body
    {
      "id": "AB001-I000001",
      "code": "DQ001",
      "name": "すごいやくそう"
    }
  • Response  404
  • Headers
    Content-Type: application/json
    Body
    {
      "error": "not_found",
      "error_description": "Not found"
    }

商品画像削除 

商品画像削除
/api/items/{id}/images/{image_id}
/api/items/{account_id}/{code}/images/{image_id}

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

  • Parameters
  • id
    string (required) Example: AB001-I000002

    商品ID

    account_id
    string (required) Example: AB001

    アカウントID

    code
    string (required) Example: DQ001

    商品コード

    image_id
    string (required) Example: ab001001

    画像ID

  • Response  200
  • Headers
    Content-Type: application/json
    Body
    {}
  • Response  404
  • Headers
    Content-Type: application/json
    Body
    {
      "error": "not_found",
      "error_description": "Not found"
    }

入庫 

入庫依頼 

入庫依頼
/api/warehousings

入庫依頼を作成します。

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

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

Request Format

Key Type Description
inspection_type enum (NAME,CODE,BARCODE,LABEL,IMAGE) (required) 検品タイプ
items [item] (required) 入庫商品リスト
arrival_date date 倉庫着予定日
tracking_codes [tracking_code] お問合せ伝票番号
memo string 入庫明細書の備考欄
warehouse string 倉庫コード(省略時はデフォルトの倉庫になります)

item

Key Type Description
code string (required) 商品コード
quantity number (required) 数量
  • Request  入庫依頼
  • Headers
    Content-Type: application/json
    Body
    {
      "inspection_type": "CODE",
      "items": [
        {
          "code": "DQ001",
          "quantity": 20
        },
        {
          "code": "DQ002",
          "quantity": 2
        }
      ],
      "arrival_date": "2015-01-02",
      "tracking_codes": [
        "TrackingCode001",
        "TrackingCode002"
      ],
      "memo": "やくそうは2袋に10束ずつ入っていますが、葉っぱ1枚を商品1点としてカウントしてください。"
    }
  • Response  201
  • Headers
    Content-Type: application/json
    Body
    {
      "id": "AB001-W0001",
      "status": "waiting",
      "created_at": "2015-01-01T12:00:00+09:00",
      "arrival_date": "2015-01-02",
      "inspection_type": "CODE",
      "memo": "やくそうは2袋に10束ずつ入っていますが、葉っぱ1枚を商品1点としてカウントしてください。",
      "tracking_codes": [
        "TrackingCode001",
        "TrackingCode002"
      ],
      "items": [
        {
          "id": 1,
          "code": "DQ001",
          "name": "やくそう",
          "quantity": 20
        },
        {
          "id": 2,
          "code": "DQ002",
          "name": "つばさ",
          "quantity": 2
        }
      ]
    }

入庫依頼一覧 

入庫依頼一覧
/api/warehousings

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

Response Format

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

  • Response  200
  • Headers
    Content-Type: application/json
    Body
    {
      "warehousings": [
        {
          "id": "AB001-W0001",
          "status": "waiting",
          "created_at": "2015-01-01T12:00:00+09:00",
          "arrival_date": "2015-01-02",
          "inspection_type": "CODE",
          "memo": "やくそうは2袋に10束ずつ入っていますが、葉っぱ1枚を商品1点としてカウントしてください。",
          "tracking_codes": [
            "TrackingCode001",
            "TrackingCode002"
          ],
          "items": [
            {
              "id": "AB001-I00001",
              "code": "DQ001",
              "name": "やくそう",
              "quantity": 20
            },
            {
              "id": "AB001-I00002",
              "code": "DQ002",
              "name": "キメラのつばさ",
              "quantity": 2
            }
          ]
        }
      ]
    }

直近の入庫実績 

直近の入庫実績
/api/warehousings/stocked{?date_before,date_after}

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

Response Format

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

  • Parameters
  • date_before
    string (optional) Example: 20150101

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

    date_after
    string (optional) Example: 20150101

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

  • Response  200
  • Headers
    Content-Type: application/json
    Body
    {
      "warehousings": [
        {
          "id": "AB001-W0001",
          "status": "stocked",
          "created_at": "2015-01-01T12:00:00+09:00",
          "stocked_at": "2015-01-02T12:00:00+09:00",
          "arrival_date": "2015-01-02",
          "inspection_type": "CODE",
          "memo": "やくそうは2袋に10束ずつ入っていますが、葉っぱ1枚を商品1点としてカウントしてください。",
          "tracking_codes": [
            "TrackingCode001",
            "TrackingCode002"
          ],
          "items": [
            {
              "id": "AB001-I00001",
              "code": "DQ001",
              "name": "やくそう",
              "quantity": 20,
              "recieved": 20
            },
            {
              "id": "AB001-I00002",
              "code": "DQ002",
              "name": "キメラのつばさ",
              "quantity": 2,
              "recieved": 1
            }
          ]
        }
      ]
    }

入庫実績 

過去の入庫実績
/api/warehousings/stocked/{year}/{month}/{day}

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

Response Format

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

  • Parameters
  • year
    string (required) 

    入庫年(YYYY)

    month
    string (required) 

    入庫月(MM)

    day
    string (optional) 

    入庫日(DD)

  • Response  200
  • Headers
    Content-Type: application/json
    Body
    {
      "warehousings": [
        {
          "id": "AB001-W0001",
          "status": "stocked",
          "created_at": "2015-01-01T12:00:00+09:00",
          "stocked_at": "2015-01-02T12:00:00+09:00",
          "arrival_date": "2015-01-02",
          "inspection_type": "CODE",
          "memo": "やくそうは2袋に10束ずつ入っていますが、葉っぱ1枚を商品1点としてカウントしてください。",
          "tracking_codes": [
            "TrackingCode001",
            "TrackingCode002"
          ],
          "items": [
            {
              "id": "AB001-I00001",
              "code": "DQ001",
              "name": "やくそう",
              "quantity": 20,
              "recieved": 20
            },
            {
              "id": "AB001-I00002",
              "code": "DQ002",
              "name": "キメラのつばさ",
              "quantity": 2,
              "recieved": 1
            }
          ]
        }
      ]
    }

入庫情報 

入庫情報
/api/warehousings/{id}

入庫情報を取得します。

Response Format

Key Type Description
id string 入庫ID
status string 入庫ステータス (waiting, received, checking, stocked)
inspection_type enum 検品タイプ
arrival_date date 倉庫着予定日
tracking_codes [tracking_code] お問合せ伝票番号
memo string 入庫明細書の備考欄
items [item] 入庫商品リスト
shipment_return boolean 返品フラグ

item

Key Type Description
id string 商品ID
code string 商品コード
name string 商品名
quantity number 入庫依頼数
received number 入庫実数
  • Parameters
  • id
    string (required) Example: AB001-W0001

    入庫ID

  • Response  200
  • Headers
    Content-Type: application/json
    Body
    {
      "id": "AB001-W0001",
      "status": "waiting",
      "created_at": "2015-01-01T12:00:00+09:00",
      "arrival_date": "2015-01-02",
      "inspection_type": "CODE",
      "memo": "やくそうは2袋に10束ずつ入っていますが、葉っぱ1枚を商品1点としてカウントしてください。",
      "tracking_codes": [
        "TrackingCode001",
        "TrackingCode002"
      ],
      "items": [
        {
          "id": "AB001-I00001",
          "code": "DQ001",
          "name": "やくそう",
          "quantity": 20
        },
        {
          "id": "AB001-I00002",
          "code": "DQ002",
          "name": "つばさ",
          "quantity": 2
        }
      ]
    }

入庫依頼更新 

入庫情報更新
/api/warehousings/{id}

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

Request Format

inspection_type、items、arrival_date、memo、tracking_codesのいずれかひとつは必須です。

Key Type Description
inspection_type enum (NAME,CODE,BARCODE,LABEL,IMAGE) 検品タイプ
items [item] 入庫商品リスト
arrival_date date 倉庫着予定日
memo string 入庫明細書の備考欄
tracking_codes [tracking_code] お問合せ伝票番号
  • Response  200
  • Headers
    Content-Type: application/json
    Body
    {
        "id": "AB001-W0001",
        "status": "waiting",
        "created_at": "2015-01-01T12:00:00+09:00",
        "arrival_date": "2015-01-02",
        "inspection_type": "LABEL",
        "memo": "やくそうは2袋に10束ずつ入っていますが、葉っぱ1枚を商品1点としてカウントしてください。",
        "tracking_codes": [
            "TrackingCode001",
            "TrackingCode002"
        ],
        "items": [
            {
                "id": "AB001-I00001",
                "code": "DQ001",
                "name": "やくそう",
                "quantity": 20,
            },
            {
                "id": "AB001-I00002",
                "code": "DQ002",
                "name": "つばさ",
                "quantity": 2,
            }
        ]
    }

入庫依頼削除 

入庫依頼削除
/api/warehousings/{id}

入庫依頼をキャンセルします。 ステータスによってはキャンセルできません。

  • Parameters
  • id
    string (required) Example: AB001-W0001

    入庫ID

  • Response  200
  • Headers
    Content-Type: application/json
    Body
    {
        "id": "AB001-W0001",
        "status": "waiting",
        "created_at": "2015-01-01T12:00:00+09:00",
        "arrival_date": "2015-01-02",
        "inspection_type": "CODE",
        "memo": "やくそうは2袋に10束ずつ入っていますが、葉っぱ1枚を商品1点としてカウントしてください。",
        "tracking_codes": [
            "TrackingCode001",
            "TrackingCode002"
        ],
        "items": [
            {
                "id": "AB001-I00001",
                "code": "DQ001",
                "name": "やくそう",
                "quantity": 20,
            },
            {
                "id": "AB001-I00002",
                "code": "DQ002",
                "name": "つばさ",
                "quantity": 2,
            }
        ]
    }

出庫 

出庫依頼 

出庫依頼
/api/shipments

出庫依頼をします。

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

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

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

  • 特定する値として order_no とは別の値を利用したい場合は identifier を直接指定してください

Request Format

Key Type Description
identifier string (required,unique) 識別番号
order_no string (optional) 注文番号 (同梱明細書の「注文番号」に印刷されます)
recipient (address) (required) 発送先住所
sender (address) (optional) 発送元住所 (省略時は登録してある情報が使われます)
subtotal_amount number 納品書 小計
delivery_charge number 納品書 配送料
handling_charge number 納品書 手数料
discount_amount number 納品書 割引額
total_amount number 納品書 合計
ignore_miscalculation boolean 金額の整合性を検証しない場合に指定 (省略時は検証します)
delivery_method enum (POST,POST_EXPRESS,HOME_BOX) 配送便指定 (SSサイズの商品のみの発送で省略時はPOST_EXPRESS。指定する値の説明は下記参照)
delivery_carrier enum (YAMATO,SAGAWA) 配送会社 (別途料金が発生します)
delivery_time_slot enum (AM,12,14,16,18,19) 希望時間指定 (12はSAGAWAの場合のみ)
delivery_date date 配達希望日 (指定できる最短日付は配送会社によって変わります)
shipping_date date 発送希望日 (配送会社へ引き渡す日付で、配達希望日とは異なります)
delivery_options (delivery_options) 受取人からの希望
delivery_note_type enum (NORMAL,NONE) 明細書の同梱設定 (NONEを指定すると同梱しません。明細メッセージもクリアされます)
gift_wrapping_unit enum (ORDER,ITEM) ギフトラッピング単位 (注文単位、もしくは商品単位でラッピングします。別途料金が発生します)
gift_wrapping_type enum (NAVY,RED,PINK, BROWN,WHITE) ギフトラッピングタイプ (注文単位でラッピングする場合に指定)
gift_sender_name string ギフト贈り主氏名
cushioning_unit enum (ORDER,ITEM) 緩衝材単位(注文単位、もしくは商品単位で緩衝材指定します。別途料金が発生します)
cushioning_type enum (BUBBLE_PACK,BUBBLE_DOUBLE_PACK,AIR_PACK) 緩衝材種別(プチプチ、プチプチ2重、エアーピロー) 商品単位の場合はitemsで個別に指定
bundled_items array 同梱物の商品ID or 商品コード (5つまで)
cash_on_delivery boolean 代引き指定
shipping_email string 配送先連絡メール
message string 明細メッセージ
label_note string 品名(配送設定でデフォルト品名未設定の場合必須)
items [item] (1つ以上) 配送商品リスト
international boolean 海外発送指定
delivery_service string (required) 海外発送用配送サービス。海外発送時必須。(EMSのみ)
currency_code string (required) 海外発送用通貨コード。海外発送時必須。 ※通貨情報参照
insurance boolean 海外発送用損害保証制度の加入希望。
warehouse string 倉庫コード。更新時指定不可(省略時はデフォルトの倉庫になります)

address

Key Type Description
postcode string (required) 郵便番号
prefecture string (required) 都道府県
address1 string (required) 住所
address2 string マンション・ビル名
name string (required) 氏名
company string 会社
division string 部署
phone string (required) 電話番号

address(海外)

Key Type Description
region_code string (required) 国コード。※国コード情報
postcode string (required) 郵便番号
city string (required) 都市名
address string (required) 住所
name string (required) 氏名
phone string (required) 電話番号

delivery_options

Key Type Description
box_delivery boolean 不在時宅配ボックス
fragile_item boolean 割れ物注意

item

Key Type Description
code string (required) 商品コード
quantity number (required) 数量
name string 納品書 商品名
unit_price number 納品書 単価
price number 納品書 金額
gift_wrapping_type enum (NAVY,RED,PINK, BROWN,WHITE) ギフトラッピングタイプ (商品単位でラッピングする場合に指定)
cushioning_type enum (BUBBLE_PACK,BUBBLE_DOUBLE_PACK) 緩衝材種別(プチプチ、プチプチ2重)
backorder_if_unavailable boolean 在庫不足時、出庫予約としての登録許可

delivery_methodの指定値

enum Description
POST ポスト便での配送 (SSサイズの商品で指定可能)
POST_EXPRESS ポスト便 (宅配便スピード)での配送 (SSサイズの商品で指定可能)
HOME_BOX 宅配便 (段ボール梱包)での配送
  • Request  出庫依頼
  • Headers
    Content-Type: application/json
    Body
    {
      "identifier": "2015-00001",
      "recipient": {
        "postcode": "111-0002",
        "prefecture": "東京都",
        "address1": "渋谷区渋谷1-1-1",
        "address2": "ラダトーム101",
        "name": "山田 太郎",
        "company": "スライム株式会社",
        "division": "メタル部",
        "phone": "03-3333-3333"
      },
      "sender": {
        "postcode": "111-0003",
        "prefecture": "千葉県",
        "address1": "浦安市舞浜1-1-1",
        "address2": "シンデレラ城101",
        "name": "ミッキー マウス",
        "company": "オリエンタル株式会社",
        "division": "ランド事業部",
        "phone": "03-3333-4444"
      },
      "subtotal_amount": 1500,
      "delivery_charge": 550,
      "handling_charge": 0,
      "discount_amount": 0,
      "total_amount": 2050,
      "delivery_method": "HOME_BOX",
      "delivery_carrier": "YAMATO",
      "delivery_time_slot": "AM",
      "delivery_date": "2015-01-01",
      "gift_wrapping_unit": "ORDER",
      "gift_wrapping_type": "NAVY",
      "gift_sender_name": "ブルー トー",
      "bundled_items": [
        "DQ008",
        "DQ009"
      ],
      "label_note": "CD",
      "items": [
        {
          "code": "DQ001",
          "quantity": 1,
          "unit_price": 400,
          "price": 400
        },
        {
          "code": "DQ002",
          "quantity": 2,
          "name": "つばさ",
          "unit_price": 550,
          "price": 1100
        }
      ]
    }
  • Response  201
  • Headers
    Content-Type: application/json
    Body
    {
      "id": "AB001-S000001",
      "identifier": "2015-00001",
      "created_at": "2015-01-01T12:00:00+09:00",
      "recipient": {
        "postcode": "111-0002",
        "prefecture": "東京都",
        "address1": "渋谷区渋谷1-1-1",
        "address2": "ラダトーム101",
        "name": "山田 太郎",
        "company": "スライム株式会社",
        "division": "メタル部",
        "phone": "03-3333-3333"
      },
      "sender": {
        "postcode": "111-0003",
        "prefecture": "千葉県",
        "address1": "浦安市舞浜1-1-1",
        "address2": "シンデレラ城101",
        "name": "ミッキー マウス",
        "company": "オリエンタル株式会社",
        "division": "ランド事業部",
        "phone": "03-3333-4444"
      },
      "subtotal_amount": 1500,
      "delivery_charge": 550,
      "handling_charge": 0,
      "discount_amount": 0,
      "total_amount": 2050,
      "delivery_method": "HOME_BOX",
      "delivery_carrier": "YAMATO",
      "delivery_time_slot": "AM",
      "delivery_date": "2015-01-01",
      "gift_wrapping_unit": "ORDER",
      "gift_wrapping_type": "NAVY",
      "gift_sender_name": "ブルー トー",
      "bundled_items": [
        "AB001-I000008",
        "AB001-I000009"
      ],
      "status": "waiting",
      "label_note": "CD",
      "items": [
        {
          "code": "DQ001",
          "quantity": 1,
          "unit_price": 400,
          "price": 400
        },
        {
          "code": "DQ002",
          "quantity": 2,
          "name": "つばさ",
          "unit_price": 550,
          "price": 1100
        }
      ]
    }

一括出庫依頼 

一括出庫依頼
/api/shipments/bulk

一括で出庫依頼をします。

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

Request Format

Key Type Description
sender (address) 発送元住所
subtotal_amount number 納品書 小計
delivery_charge number 納品書 配送料
handling_charge number 納品書 手数料
discount_amount number 納品書 割引額
total_amount number 納品書 合計
shipments [shipment] 配送先リスト
  • Request  複数の出庫依頼
  • Headers
    Content-Type: application/json
    Body
    [
      {
        "identifier": "2015-00001",
        "recipient": {
          "postcode": "111-0002",
          "prefecture": "東京都",
          "address1": "渋谷区渋谷1-1-1",
          "address2": "ラダトーム101",
          "name": "ロト 太郎",
          "company": "スライム株式会社",
          "division": "メタル部",
          "phone": "03-3333-3333"
        },
        "sender": {
          "postcode": "111-0003",
          "prefecture": "千葉県",
          "address1": "浦安市舞浜1-1-1",
          "address2": "シンデレラ城101",
          "name": "ミッキー マウス",
          "company": "オリエンタル株式会社",
          "division": "ランド事業部",
          "phone": "03-3333-4444"
        },
        "subtotal_amount": 1500,
        "delivery_charge": 550,
        "handling_charge": 0,
        "discount_amount": 0,
        "total_amount": 2050,
        "delivery_method": "HOME_BOX",
        "delivery_carrier": "YAMATO",
        "delivery_time_slot": "AM",
        "delivery_date": "2015-01-01",
        "gift_wrapping_unit": "ORDER",
        "gift_wrapping_type": "NAVY",
        "gift_sender_name": "ブルー トー",
        "label_note": "CD",
        "items": [
          {
            "code": "DQ001",
            "quantity": 1,
            "unit_price": 400,
            "price": 400
          },
          {
            "code": "DQ002",
            "quantity": 2,
            "name": "つばさ",
            "unit_price": 550,
            "price": 1100
          }
        ]
      },
      {
        "identifier": "2015-00002",
        "recipient": {
          "postcode": "111-0002",
          "prefecture": "東京都",
          "address1": "渋谷区渋谷1-1-1",
          "address2": "ラダトーム102",
          "name": "ロト 花子",
          "company": "スライム株式会社",
          "division": "メタル部",
          "phone": "03-3333-3333"
        },
        "sender": {
          "postcode": "111-0003",
          "prefecture": "千葉県",
          "address1": "浦安市舞浜1-1-1",
          "address2": "シンデレラ城101",
          "name": "ミッキー マウス",
          "company": "オリエンタル株式会社",
          "division": "ランド事業部",
          "phone": "03-3333-4444"
        },
        "subtotal_amount": 400,
        "delivery_charge": 550,
        "handling_charge": 0,
        "discount_amount": 0,
        "total_amount": 950,
        "label_note": "CD",
        "items": [
          {
            "code": "DQ001",
            "quantity": 1,
            "unit_price": 400,
            "price": 400
          }
        ]
      }
    ]
  • Request  複数の出庫依頼-送り主共通
  • Headers
    Content-Type: application/json
    Body
    {
      "sender": {
        "postcode": "111-0003",
        "prefecture": "千葉県",
        "address1": "浦安市舞浜1-1-1",
        "address2": "シンデレラ城101",
        "name": "ミッキー マウス",
        "company": "オリエンタル株式会社",
        "division": "ランド事業部",
        "phone": "03-3333-4444"
      },
      "subtotal_amount": 400,
      "delivery_charge": 550,
      "handling_charge": 0,
      "discount_amount": 0,
      "total_amount": 950,
      "items": [
        {
          "code": "DQ001",
          "quantity": 1,
          "unit_price": 400,
          "price": 400
        }
      ],
      "shipments": [
        {
          "identifier": "2015-00001",
          "recipient": {
            "postcode": "111-0002",
            "prefecture": "東京都",
            "address1": "渋谷区渋谷1-1-1",
            "address2": "ラダトーム101",
            "name": "ロト 太郎",
            "company": "スライム株式会社",
            "division": "メタル部",
            "phone": "03-3333-3333"
          }
        },
        {
          "identifier": "2015-00002",
          "recipient": {
            "postcode": "111-0002",
            "prefecture": "東京都",
            "address1": "渋谷区渋谷1-1-1",
            "address2": "ラダトーム102",
            "name": "ロト 花子",
            "company": "スライム株式会社",
            "division": "メタル部",
            "phone": "03-3333-3333"
          }
        }
      ]
    }
  • Response  202
  • Headers
    Content-Type: application/json
    Body
    {
      "job": 1234
    }

出庫更新 

出庫更新
/api/shipments/{id}
/api/shipments/{account_id}/{identifier}

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

Request Format

出庫依頼と同じフォーマットのJSONを送信することで更新できます。

  • Parameters
  • id
    string (required) Example: AB001-S000001

    出庫ID

    account_id
    string (required) Example: AB001

    アカウントID

    identifier
    string (required) Example: 2015-00001

    識別番号

  • Request  出庫更新
  • Headers
    Content-Type: application/json
    Body
    {
      "identifier": "2015-00001",
      "recipient": {
        "postcode": "111-0002",
        "prefecture": "東京都",
        "address1": "渋谷区渋谷1-1-1",
        "address2": "ラダトーム101",
        "name": "山田 太郎",
        "company": "スライム株式会社",
        "division": "メタル部",
        "phone": "03-3333-3333"
      },
      "sender": {
        "postcode": "111-0003",
        "prefecture": "千葉県",
        "address1": "浦安市舞浜1-1-1",
        "address2": "シンデレラ城101",
        "name": "ミッキー マウス",
        "company": "オリエンタル株式会社",
        "division": "ランド事業部",
        "phone": "03-3333-4444"
      },
      "subtotal_amount": 2200,
      "delivery_charge": 550,
      "handling_charge": 0,
      "discount_amount": 0,
      "total_amount": 2750,
      "delivery_method": "HOME_BOX",
      "delivery_carrier": "YAMATO",
      "delivery_time_slot": "AM",
      "delivery_date": "2015-01-01",
      "gift_wrapping_unit": "ORDER",
      "gift_wrapping_type": "NAVY",
      "gift_sender_name": "ブルー トー",
      "bundled_items": [],
      "items": [
        {
          "code": "DQ002",
          "quantity": 4,
          "name": "つばさ",
          "unit_price": 550,
          "price": 2200
        }
      ]
    }
  • Response  200
  • Headers
    Content-Type: application/json
    Body
    {
      "id": "AB001-S000001",
      "identifier": "2015-00001",
      "created_at": "2015-01-01T12:00:00+09:00",
      "recipient": {
        "postcode": "111-0002",
        "prefecture": "東京都",
        "address1": "渋谷区渋谷1-1-1",
        "address2": "ラダトーム101",
        "name": "山田 太郎",
        "company": "スライム株式会社",
        "division": "メタル部",
        "phone": "03-3333-3333"
      },
      "sender": {
        "postcode": "111-0003",
        "prefecture": "千葉県",
        "address1": "浦安市舞浜1-1-1",
        "address2": "シンデレラ城101",
        "name": "ミッキー マウス",
        "company": "オリエンタル株式会社",
        "division": "ランド事業部",
        "phone": "03-3333-4444"
      },
      "subtotal_amount": 2200,
      "delivery_charge": 550,
      "handling_charge": 0,
      "discount_amount": 0,
      "total_amount": 2750,
      "delivery_method": "HOME_BOX",
      "delivery_carrier": "YAMATO",
      "delivery_time_slot": "AM",
      "delivery_date": "2015-01-01",
      "gift_wrapping_unit": "ORDER",
      "gift_wrapping_type": "NAVY",
      "gift_sender_name": "ブルー トー",
      "bundled_items": null,
      "status": "waiting",
      "label_note": "CD",
      "items": [
        {
          "code": "DQ002",
          "quantity": 4,
          "name": "つばさ",
          "unit_price": 550,
          "price": 2200
        }
      ]
    }

出庫修正依頼 

出庫修正依頼
/api/shipments/{id}/modify
/api/shipments/{account_id}/{identifier}/modify

ステータスがピッキング中・ピッキング済み・梱包済みの出庫依頼の修正を依頼します。 データ取り込み後の修正となりますので、別途事務手数料+作業進捗状況による作業費用がかかります。 海外発送の場合は梱包済みのステータス以降は依頼ができません。キャンセル依頼を出していただき、別途新規の出庫依頼を作成してください。 また、作業進捗状況によってはご依頼にお応えすることができない場合がございます。 ご了承の上ご利用ください。

Request Format

出庫依頼のうち、発送先住所、希望時間帯、配達希望日のみが指定可能です。

Key Type Description
recipient (address) (required) 発送先住所
delivery_time_slot enum (AM,12,14,16,18,19) 希望時間指定 (12はSAGAWAの場合のみ)
delivery_date date 配達希望日 (指定できる最短日付は配送会社によって変わります)
  • Parameters
  • id
    string (required) Example: AB001-S000001

    出庫ID

    account_id
    string (required) Example: AB001

    アカウントID

    identifier
    string (required) Example: 2015-00001

    識別番号

  • Request  出庫修正依頼
  • Headers
    Content-Type: application/json
    Body
    {
        "recipient": {
            "postcode": "111-0002",
            "prefecture": "東京都",
            "address1": "渋谷区渋谷1-1-1",
            "address2": "ラダトーム101",
            "name": "山田 太郎",
            "company": "スライム株式会社",
            "division": "メタル部",
            "phone": "03-3333-3333"
        },
    }
  • Response  200
  • Headers
    Content-Type: application/json
    Body
    {
      "id": "AB001-S000001",
      "identifier": "2015-00001",
      "created_at": "2015-01-01T12:00:00+09:00",
      "recipient": {
        "postcode": "111-0002",
        "prefecture": "東京都",
        "address1": "渋谷区渋谷1-1-1",
        "address2": "ラダトーム101",
        "name": "山田 太郎",
        "company": "スライム株式会社",
        "division": "メタル部",
        "phone": "03-3333-3333"
      },
      "sender": {
        "postcode": "111-0003",
        "prefecture": "千葉県",
        "address1": "浦安市舞浜1-1-1",
        "address2": "シンデレラ城101",
        "name": "ミッキー マウス",
        "company": "オリエンタル株式会社",
        "division": "ランド事業部",
        "phone": "03-3333-4444"
      },
      "subtotal_amount": 2200,
      "delivery_charge": 550,
      "handling_charge": 0,
      "discount_amount": 0,
      "total_amount": 2750,
      "delivery_method": "HOME_BOX",
      "delivery_carrier": "YAMATO",
      "delivery_time_slot": "AM",
      "delivery_date": "2015-01-01",
      "gift_wrapping_unit": "ORDER",
      "gift_wrapping_type": "NAVY",
      "gift_sender_name": "ブルー トー",
      "bundled_items": null,
      "status": "modify_request",
      "label_note": "CD",
      "items": [
        {
          "code": "DQ002",
          "quantity": 4,
          "name": "つばさ",
          "unit_price": 550,
          "price": 2200
        }
      ]
    }

出庫キャンセル依頼 

出庫キャンセル依頼
/api/shipments/{id}/cancel
/api/shipments/{account_id}/{identifier}/cancel

ステータスがピッキング中になっている出庫依頼のキャンセルを依頼します。 データ取り込み後のキャンセルとなりますので、別途事務手数料+作業進捗状況による作業費用がかかります。 また、作業進捗状況によってはご依頼にお応えすることができない場合がございます。 ご了承の上ご利用ください。

Request Format

  • Parameters
  • id
    string (required) Example: AB001-S000001

    出庫ID

    account_id
    string (required) Example: AB001

    アカウントID

    identifier
    string (required) Example: 2015-00001

    識別番号

  • Response  200
  • Headers
    Content-Type: application/json
    Body
    {
      "id": "AB001-S000001",
      "identifier": "2015-00001",
      "created_at": "2015-01-01T12:00:00+09:00",
      "recipient": {
        "postcode": "111-0002",
        "prefecture": "東京都",
        "address1": "渋谷区渋谷1-1-1",
        "address2": "ラダトーム101",
        "name": "山田 太郎",
        "company": "スライム株式会社",
        "division": "メタル部",
        "phone": "03-3333-3333"
      },
      "sender": {
        "postcode": "111-0003",
        "prefecture": "千葉県",
        "address1": "浦安市舞浜1-1-1",
        "address2": "シンデレラ城101",
        "name": "ミッキー マウス",
        "company": "オリエンタル株式会社",
        "division": "ランド事業部",
        "phone": "03-3333-4444"
      },
      "subtotal_amount": 2200,
      "delivery_charge": 550,
      "handling_charge": 0,
      "discount_amount": 0,
      "total_amount": 2750,
      "delivery_method": "HOME_BOX",
      "delivery_carrier": "YAMATO",
      "delivery_time_slot": "AM",
      "delivery_date": "2015-01-01",
      "gift_wrapping_unit": "ORDER",
      "gift_wrapping_type": "NAVY",
      "gift_sender_name": "ブルー トー",
      "bundled_items": null,
      "status": "cancel_request",
      "label_note": "CD",
      "items": [
        {
          "code": "DQ002",
          "quantity": 4,
          "name": "つばさ",
          "unit_price": 550,
          "price": 2200
        }
      ]
    }

出庫依頼一覧 

出庫依頼一覧
/api/shipments{?id}
/api/shipments/{account_id}{?identifier}

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

Response Format

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

  • Parameters
  • id
    string (required) Example: AB001-S000001,AB001-S000002

    出庫IDのカンマ区切り文字列

    account_id
    string (required) Example: AB001

    アカウントID

    identifier
    string (required) Example: 2015-00001,2015-00002

    識別番号のカンマ区切り文字列

  • Response  200
  • Headers
    Content-Type: application/json
    Body
    {
      "shipments": [
        {
          "id": "AB001-S000001",
          "identifier": "2015-00001",
          "created_at": "2015-01-01T12:00:00+09:00",
          "recipient": {
            "postcode": "111-0002",
            "prefecture": "東京都",
            "address1": "渋谷区渋谷1-1-1",
            "address2": "ラダトーム101",
            "name": "ロト 太郎",
            "company": "スライム株式会社",
            "division": "メタル部",
            "phone": "03-3333-3333"
          },
          "sender": {
            "postcode": "111-0003",
            "prefecture": "千葉県",
            "address1": "浦安市舞浜1-1-1",
            "address2": "シンデレラ城101",
            "name": "ミッキー マウス",
            "company": "オリエンタル株式会社",
            "division": "ランド事業部",
            "phone": "03-3333-4444"
          },
          "subtotal_amount": 1500,
          "delivery_charge": 550,
          "handling_charge": 0,
          "discount_amount": 0,
          "total_amount": 2050,
          "delivery_method": "HOME_BOX",
          "delivery_carrier": "",
          "delivery_time_slot": "AM",
          "status": "waiting",
          "label_note": "CD",
          "items": [
            {
              "code": "DQ001",
              "quantity": 1,
              "unit_price": 400,
              "price": 400,
              "allocated_at": "2015-01-01T13:00:00+09:00"
            },
            {
              "code": "DQ002",
              "quantity": 2,
              "name": "つばさ",
              "unit_price": 550,
              "price": 1100,
              "allocated_at": "2015-01-01T13:00:00+09:00"
            }
          ]
        }
      ]
    }

直近の出庫実績 

直近の出庫実績
/api/shipments/shipped{?date_before,date_after}

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

Response Format

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

  • Parameters
  • date_before
    string (optional) Example: 20150101

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

    date_after
    string (optional) Example: 20150102

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

  • Response  200
  • Headers
    Content-Type: application/json
    Body
    {
      "shipments": [
        {
          "id": "AB001-S000001",
          "identifier": "2015-00001",
          "created_at": "2015-01-01T12:00:00+09:00",
          "recipient": {
            "postcode": "111-0002",
            "prefecture": "東京都",
            "address1": "渋谷区渋谷1-1-1",
            "address2": "ラダトーム101",
            "name": "ロト 太郎",
            "company": "スライム株式会社",
            "division": "メタル部",
            "phone": "03-3333-3333"
          },
          "sender": {
            "postcode": "111-0003",
            "prefecture": "千葉県",
            "address1": "浦安市舞浜1-1-1",
            "address2": "シンデレラ城101",
            "name": "ミッキー マウス",
            "company": "オリエンタル株式会社",
            "division": "ランド事業部",
            "phone": "03-3333-4444"
          },
          "subtotal_amount": 1500,
          "delivery_charge": 550,
          "handling_charge": 0,
          "discount_amount": 0,
          "total_amount": 2050,
          "delivery_method": "HOME_BOX",
          "delivery_carrier": "",
          "delivery_time_slot": "AM",
          "delivery_date": "2015-01-01",
          "status": "shipped",
          "shipped_at": "2015-01-01T15:00:00+09:00",
          "tracking_code": "123456789000",
          "tracking_codes": [
            "123456789000"
          ],
          "package_quantity": 1,
          "label_note": "CD",
          "items": [
            {
              "code": "DQ001",
              "quantity": 1,
              "unit_price": 400,
              "price": 400,
              "allocated_at": "2015-01-01T13:00:00+09:00"
            },
            {
              "code": "DQ002",
              "quantity": 2,
              "name": "つばさ",
              "unit_price": 550,
              "price": 1100,
              "allocated_at": "2015-01-01T13:00:00+09:00"
            }
          ]
        }
      ]
    }

出庫実績 

出庫実績
/api/shipments/shipped/{year}/{month}/{day}

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

Response Format

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

  • Parameters
  • year
    string (required) 

    出庫年(YYYY)

    month
    string (required) 

    出庫月(MM)

    day
    string (optional) 

    出庫日(DD)

  • Response  200
  • Headers
    Content-Type: application/json
    Body
    {
        "shipments": [
            {
                "id": "AB001-S000001",
                "identifier": "2015-00001",
                "created_at": "2015-01-01T12:00:00+09:00",
                "recipient": {
                    "postcode": "111-0002",
                    "prefecture": "東京都",
                    "address1": "渋谷区渋谷1-1-1",
                    "address2": "ラダトーム101",
                    "name": "ロト 太郎",
                    "company": "スライム株式会社",
                    "division": "メタル部",
                    "phone": "03-3333-3333"
                },
                "sender": {
                    "postcode": "111-0003",
                    "prefecture": "千葉県",
                    "address1": "浦安市舞浜1-1-1",
                    "address2": "シンデレラ城101",
                    "name": "ミッキー マウス",
                    "company": "オリエンタル株式会社",
                    "division": "ランド事業部",
                    "phone": "03-3333-4444"
                },
                "subtotal_amount": 1500,
                "delivery_charge": 550,
                "handling_charge": 0,
                "discount_amount": 0,
                "total_amount": 2050,
                "delivery_method": "HOME_BOX",
                "delivery_carrier": "",
                "delivery_time_slot": "AM",
                "status": "shipped",
                "shipped_at": "2015-01-01T15:00:00+09:00",
                "tracking_code": "123456789000",
                "tracking_codes": ["123456789000"],
                "package_quantity": 1,
                "packages": [
                    {
                        "size": "60",
                    },
                ]
                "label_note": "CD",
                "items": [
                    {
                        "code": "DQ001",
                        "quantity": 1,
                        "unit_price": 400,
                        "price": 400,
                        "allocated_at": "2015-01-01T13:00:00+09:00"
                    },
                    {
                        "code": "DQ002",
                        "quantity": 2,
                        "name": "つばさ",
                        "unit_price": 550,
                        "price": 1100,
                        "allocated_at": "2015-01-01T13:00:00+09:00"
                    }
                ]
            }
        ]
    }

出庫情報 

出庫情報
/api/shipments/{id}
/api/shipments/{account_id}/{identifier}

出庫情報を取得します。

Response Format

Key Type Description
id string 出庫ID
identifier string 識別番号
order_no string 注文番号
recipient (address) 発送先住所
sender (address) 発送元住所
subtotal_amount number 納品書 小計
delivery_charge number 納品書 配送料
handling_charge number 納品書 手数料
discount_amount number 納品書 割引額
total_amount number 納品書 合計
delivery_method enum 配送便
delivery_carrier enum 配送会社
delivery_time_slot enum 配送希望時間帯
delivery_date date 配送希望日
delivery_options (delivery_options) 受取人からの希望
gift_wrapping_unit enum ギフトラッピング単位
gift_wrapping_type enum ギフトラッピングタイプ
gift_sender_name string ギフト贈り主氏名
bundled_items array 同梱物の商品ID
cash_on_delivery boolean 代引き指定
shipping_email string 配送先連絡メール
message string 明細メッセージ
label_note string 品名
items [item] 配送商品リスト
status enum (backordered, waiting, picking, picked, packed, modify_request, cancel_request, suspended, shipped) ステータス
shipment_return boolean 返品フラグ
shipped_at datetime 発送日時
tracking_code string 伝票番号(追跡番号)略式
tracking_codes [string] 伝票番号(追跡番号)
package_quantity number 個口数
packages [package] 個口実績情報詳細

address

Key Type Description
postcode string 郵便番号
prefecture string 都道府県
address1 string 住所1
address2 string 住所2
name string 氏名
company string 会社
division string 部署
phone string 電話番号

delivery_options

Key Type Description
box_delivery boolean 不在時宅配ボックス
fragile_item boolean 割れ物注意

item

Key Type Description
code string 商品コード
quantity number 数量
name string 納品書 商品名
unit_price number 納品書 単価
price number 納品書 金額
allocated_at datetime 在庫割り当て日時

package

Key Type Description
size string 個口サイズ
weight number 重量(海外発送のみ)
tracking_code string 伝票番号(海外発送のみ)
  • Parameters
  • id
    string (required) Example: AB001-S000001

    出庫ID

    account_id
    string (required) Example: AB001

    アカウントID

    identifier
    string (required) Example: 2015-00001

    識別番号

  • Response  200
  • Headers
    Content-Type: application/json
    Body
    {
        "id": "AB001-S000001",
        "identifier": "2015-00001",
        "created_at": "2015-01-01T12:00:00+09:00",
        "recipient": {
            "postcode": "111-0002",
            "prefecture": "東京都",
            "address1": "渋谷区渋谷1-1-1",
            "address2": "ラダトーム101",
            "name": "山田 太郎",
            "company": "スライム株式会社",
            "division": "メタル部",
            "phone": "03-3333-3333"
        },
        "sender": {
            "postcode": "111-0003",
            "prefecture": "千葉県",
            "address1": "浦安市舞浜1-1-1",
            "address2": "シンデレラ城101",
            "name": "ミッキー マウス",
            "company": "オリエンタル株式会社",
            "division": "ランド事業部",
            "phone": "03-3333-4444"
        },
        "subtotal_amount": 1500,
        "delivery_charge": 550,
        "handling_charge": 0,
        "discount_amount": 0,
        "total_amount": 2050,
        "delivery_method": "HOME_BOX",
        "delivery_carrier": "YAMATO",
        "delivery_time_slot": "AM",
        "status": "shipped",
        "shipped_at": "2015-01-01T15:00:00+09:00",
        "tracking_code": "123456789000",
        "tracking_codes": ["123456789000"],
        "package_quantity": 1,
        "packages": [
            {
                "size": "60",
            },
        ],
        "label_note": "CD",
        "items": [
            {
                "code": "DQ001",
                "quantity": 1,
                "unit_price": 400,
                "price": 400,
                "allocated_at": "2015-01-01T13:00:00+09:00"
            },
            {
                "code": "DQ002",
                "quantity": 2,
                "name": "つばさ",
                "unit_price": 550,
                "price": 1100,
                "allocated_at": "2015-01-01T13:00:00+09:00"
            }
        ]
    }

国コード情報 

国コード一覧取得
/api/shipments/international/regions/ems

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

  • Response  200
  • Headers
    Content-Type: application/json
    Body
    {
      "regions": [
        {
          "code": "AU",
          "name": "オーストラリア"
        },
        {
          "code": "BB",
          "name": "バルバドス"
        },
        {
          "code": "FR",
          "name": "フランス"
        },
        {
          "code": "FR-CORSICA",
          "name": "コルシカ"
        },
        {
          "code": "GB",
          "name": "英国(イギリス)"
        },
        {
          "code": "GB-GUERNSEY",
          "name": "ガーンジー"
        },
        {
          "code": "GB-JERSEY",
          "name": "ジャージー"
        },
        {
          "code": "GB-MAN",
          "name": "マン島"
        },
        {
          "code": "US",
          "name": "米国(アメリカ合衆国)"
        },
        {
          "code": "US-HAWAII",
          "name": "ハワイ"
        }
      ]
    }

通貨情報 

通貨コード一覧取得
/api/shipments/international/currencies

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

  • Response  200
  • Headers
    Content-Type: application/json
    Body
    {
      "currencies": [
        {
          "code": "JPY",
          "name": "日本円"
        },
        {
          "code": "USD",
          "name": "ドル"
        },
        {
          "code": "CNY",
          "name": "人民元"
        },
        {
          "code": "EUR",
          "name": "ユーロ"
        },
        {
          "code": "GBP",
          "name": "ポンド"
        }
      ]
    }

出庫依頼削除 

出庫依頼削除
/api/shipments/{id}
/api/shipments/{account_id}/{identifier}

出庫依頼をキャンセルします。 ステータスによってはキャンセルできません。

  • Parameters
  • id
    string (required) Example: AB001-S000001

    出庫ID

    account_id
    string (required) Example: AB001

    アカウントID

    identifier
    string (required) Example: 2015-00001

    識別番号

  • Response  200
  • Headers
    Content-Type: application/json
    Body
    {
      "id": "AB001-S000001",
      "identifier": "2015-00001",
      "created_at": "2015-01-01T12:00:00+09:00",
      "recipient": {
        "postcode": "111-0002",
        "prefecture": "東京都",
        "address1": "渋谷区渋谷1-1-1",
        "address2": "ラダトーム101",
        "name": "山田 太郎",
        "company": "スライム株式会社",
        "division": "メタル部",
        "phone": "03-3333-3333"
      },
      "sender": {
        "postcode": "111-0003",
        "prefecture": "千葉県",
        "address1": "浦安市舞浜1-1-1",
        "address2": "シンデレラ城101",
        "name": "ミッキー マウス",
        "company": "オリエンタル株式会社",
        "division": "ランド事業部",
        "phone": "03-3333-4444"
      },
      "subtotal_amount": 1500,
      "delivery_charge": 550,
      "handling_charge": 0,
      "discount_amount": 0,
      "total_amount": 2050,
      "delivery_method": "HOME_BOX",
      "delivery_carrier": "YAMATO",
      "delivery_time_slot": "AM",
      "status": "waiting",
      "label_note": "CD",
      "items": [
        {
          "code": "DQ001",
          "quantity": 1,
          "unit_price": 400,
          "price": 400
        },
        {
          "code": "DQ002",
          "quantity": 2,
          "name": "つばさ",
          "unit_price": 550,
          "price": 1100
        }
      ]
    }

倉庫移動 

倉庫移動依頼
/api/shipments/transfer

指定商品の倉庫移動依頼をします。発送元住所、発送先住所は指定された倉庫の住所となります。 通常出庫と同じ出庫依頼情報が作成され、同時に発送先倉庫での入庫依頼が作成されます。

Request Format

Key Type Description
warehouse string 移動元倉庫コード
destination (destination) 移動先倉庫情報
items [item] (1つ以上) 移動商品リスト

destination

Key Type Description
warehouse string 移動先倉庫コード

item

Key Type Description
code string (required) 商品コード
quantity number (required) 数量
name string 商品名
  • Request  倉庫移動依頼
  • Headers
    Content-Type: application/json
    Body
    {
        "warehouse": "NBT",
        "destination": {
            "warehouse": "NBZ"
        },
        "items": [
            {
                "code": "DQ001",
                "quantity": 1,
            },
        ]
    }
  • Response  201
  • Headers
    Content-Type: application/json
    Body
    {
        "id": "AB001-S000001",
        "created_at": "2015-01-01T12:00:00+09:00",
        "recipient": {
            "postcode": "3540041",
            "prefecture": "埼玉県",
            "address1": "入間郡三芳町藤久保123",
            "address2": "",
            "name": "オープンロジ (AB001-W0025)",
            "company": "",
            "division": "",
            "phone": "03-3333-3333"
        },
        "sender": {
            "postcode": "3590013",
            "prefecture": "埼玉県",
            "address1": "所沢市城456    ",
            "address2": "",
            "name": "NB所沢",
            "company": "",
            "division": "",
            "phone": "04-2933-7788"
        },
        "status": "waiting",
        "items": [
            {
                "code": "DQ001",
                "quantity": 1,
            }
        ],
        "warehouse": "NBT",
        "destination": {
            "warehouse": "NBZ"
        }
    }

倉庫移動更新 

倉庫移動更新
/api/shipments/transfer/{id}

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

Request Format

Key Type Description
destination (destination) 移動先倉庫情報
items [item] (1つ以上) 移動商品リスト
  • Parameters
  • id
    string (required) Example: AB001-S000001

    出庫ID

  • Request  倉庫移動更新
  • Headers
    Content-Type: application/json
    Body
    {
        "destination": {
            "warehouse": "NBZ"
        },
        "items": [
            {
                "code": "DQ001",
                "quantity": 5,
            },
        ]
    }
  • Response  200
  • Headers
    Content-Type: application/json
    Body
    {
        "id": "AB001-S000001",
        "created_at": "2015-01-01T12:00:00+09:00",
        "recipient": {
            "postcode": "3540041",
            "prefecture": "埼玉県",
            "address1": "入間郡三芳町藤久保123",
            "address2": "",
            "name": "オープンロジ (AB001-W0025)",
            "company": "",
            "division": "",
            "phone": "03-3333-3333"
        },
        "sender": {
            "postcode": "3590013",
            "prefecture": "埼玉県",
            "address1": "所沢市城456",
            "address2": "",
            "name": "NB所沢",
            "company": "",
            "division": "",
            "phone": "04-2933-7788"
        },
        "status": "waiting",
        "items": [
            {
                "code": "DQ001",
                "quantity": 5,
            }
        ],
        "warehouse": "NBT",
        "destination": {
            "warehouse": "NBZ"
        }
    }

倉庫移動修正依頼 

倉庫移動修正依頼
/api/shipments/transfer/{id}/modify

ステータスがピッキング中になっている倉庫移動依頼の修正を依頼します。 データ取り込み後の修正となりますので、別途事務手数料+作業進捗状況による作業費用がかかります。 また、作業進捗状況によってはご依頼にお応えすることができない場合がございます。 ご了承の上ご利用ください。

Request Format

倉庫移動更新のうち、移動先倉庫情報のみが指定可能です。

Key Type Description
destination (destination) 移動先倉庫情報
  • Parameters
  • id
    string (required) Example: AB001-S000001

    出庫ID

  • Request  倉庫移動修正依頼
  • Headers
    Content-Type: application/json
    Body
    {
        "destination": {
            "warehouse": "NBZ"
        },
    }
  • Response  200
  • Headers
    Content-Type: application/json
    Body
    {
        "id": "AB001-S000001",
        "created_at": "2015-01-01T12:00:00+09:00",
        "recipient": {
            "postcode": "3540041",
            "prefecture": "埼玉県",
            "address1": "入間郡三芳町藤久保123",
            "address2": "",
            "name": "オープンロジ (AB001-W0025)",
            "company": "",
            "division": "",
            "phone": "03-3333-3333"
        },
        "sender": {
            "postcode": "3590013",
            "prefecture": "埼玉県",
            "address1": "所沢市城456",
            "address2": "",
            "name": "NB所沢",
            "company": "",
            "division": "",
            "phone": "04-2933-7788"
        },
        "status": "waiting",
        "items": [
            {
                "code": "DQ001",
                "quantity": 5,
            }
        ],
        "warehouse": "NBT",
        "destination": {
            "warehouse": "NBZ"
        }
    }

倉庫移動キャンセル依頼 

倉庫移動キャンセル依頼
/api/shipments/transfer/{id}/cancel

ステータスがピッキング中になっている倉庫移動依頼のキャンセルを依頼します。 データ取り込み後のキャンセルとなりますので、別途事務手数料+作業進捗状況による作業費用がかかります。 また、作業進捗状況によってはご依頼にお応えすることができない場合がございます。 ご了承の上ご利用ください。

Request Format

  • Parameters
  • id
    string (required) Example: AB001-S000001

    出庫ID

  • Response  200
  • Headers
    Content-Type: application/json
    Body
    {
        "id": "AB001-S000001",
        "created_at": "2015-01-01T12:00:00+09:00",
        "recipient": {
            "postcode": "3540041",
            "prefecture": "埼玉県",
            "address1": "入間郡三芳町藤久保123",
            "address2": "",
            "name": "オープンロジ (AB001-W0025)",
            "company": "",
            "division": "",
            "phone": "03-3333-3333"
        },
        "sender": {
            "postcode": "3590013",
            "prefecture": "埼玉県",
            "address1": "所沢市城456",
            "address2": "",
            "name": "NB所沢",
            "company": "",
            "division": "",
            "phone": "04-2933-7788"
        },
        "status": "waiting",
        "items": [
            {
                "code": "DQ001",
                "quantity": 5,
            }
        ],
        "warehouse": "NBT",
        "destination": {
            "warehouse": "NBZ"
        }
    }

Generated by aglio on 10 Aug 2018