If first time to visit BUYFY, please look through this introduction.
> > About API

About API

このページではBUYFY APIを利用して、新規注文を送信したり、注文情報を取得する方法を説明します。APIを利用するとプログラムを利用してお客様のウェブサイトとBUYFYの輸入代行システムを連携できます。ご要望に応じたカスタマイズしたプログラムの制作をご希望の場合はこちらからお問い合わせください。

APIの利用開始方法

APIを利用開始するにはまずユーザー設定でAPIをオンに設定してください。APIをオンにすると自動的にAPIシークレットが作成されます。APIシークレットはAPIの利用にユーザーを判別する文字列ですので、他人に知られないように管理をしてください。APIを一度オフにしてから再度オンにするとAPIシークレットをリセットできます。さらにセキュリティを高めるには必要に応じてサーバーのIPアドレスを設定してください。

共通のリクエストパラメータ

以下のリクエストパラメータは全てのオペレーションに共通して必要です。リクエストはPOSTまたはGETにて送信してください。

パラメータ 説明 必須
secret 会員登録後に『アカウント』>『ユーザー設定』で取得してください。 はい
response jsonまたはxmlを指定してください。デフォルト値はjsonです。 いいえ

注文の作成(create_order)

概要

注文を作成するためのオペレーションです。注文の作成には新規注文と追加注文があります。リクエストの方法は同じですが、追加注文の際には注文IDを指定してください。注文の作成を行う前にこちらの方法でデフォルトプランを設定してください。

リクエストURL

リクエストパラメータ

パラメータ 説明 必須
odrid 追加注文の際に追加する注文の注文IDを数値で指定してください。新規注文の場合は指定する必要はありません。 いいえ
odrno 利用者が独自に指定できる注文管理番号です。BUYFYのシステムとは関係ありません。 いいえ
gname お届け先住所の名前です。通常は英語で指定してください。 はい
fname お届け先住所の苗字です。通常は英語で指定してください。 はい
company お届け先住所の会社名です。 いいえ
country お届け先住所の国を2桁のカントリーコードで指定してください。指定可能なカントリーコードはこちらをご確認ください。 はい
zip お届け先住所の郵便番号を指定してください。 はい
state お届け先住所の都道府県・州を指定してください。 はい
city お届け先住所の市町村を指定してください。 はい
address お届け先住所の住所・通り名・番地を指定してください。 はい
bldg お届け先住所の建物名や部屋番号を指定してください。 いいえ
phone お届け先住所の電話番号を指定してください。 いいえ
itmno 利用者が独自に設定する商品の管理番号です。BUYFYのシステムとは関係ありません。 いいえ
code 商品コードを指定してください。商品コードについてはこちらをご確認ください。 いいえ
title 商品名を指定してください。 いいえ
url 商品販売ページのURLを指定してください。 はい
img 商品画像のURLを指定してください。 いいえ
seller ショッピングプラットフォームの場合は出品者名を指定してください。 いいえ
option オプションがある場合は指定してください。複数のオプションを指定する場合は『/』で区切ってください。 いいえ
qty 申込数量を整数で指定してください。 はい
price 商品単価を現地通貨単位の不動点少数で指定してください。 はい

レスポンスサンプル

{
  "response": {
    "status": "success"
  }
}

注文の更新(update_order)

概要

注文を更新するためのオペレーションです。更新する内容は注文ステータス毎に異なります。このオペレーションを利用して支払いの実行(事前にデポジット入金が必要)や国際発送依頼ができます。

リクエストURL

リクエストパラメータ

パラメータ 説明 必須
odrid 注文情報を更新する注文IDを指定してください。 はい
cancel 注文をキャンセルする場合に『cancel=1』を指定してください。注文のキャンセルが可能なのは『確認中』または『1次決済』のステータスにあり、入金のない注文に限ります。 いいえ

レスポンスサンプル

{
  "response": {
    "status": "success",
    "order": {
      "st": 4
    }
  }
}

注文情報の修正(modify_order)

概要

注文情報を修正するためのオペレーションです。修正が可能なのは注文管理番号およびお届け先住所となります。指定したパラメータの値のみが上書きされます。

リクエストURL

リクエストパラメータ

パラメータ 説明 必須
odrid 注文情報を修正する注文IDを指定してください。 はい
odrno 利用者が独自に指定できる注文管理番号です。BUYFYのシステムとは関係ありません。 いいえ
gname お届け先住所の名前です。通常は英語で指定してください。 いいえ
fname お届け先住所の苗字です。通常は英語で指定してください。 いいえ
company お届け先住所の会社名です。 いいえ
country お届け先住所の国を2桁のカントリーコードで指定してください。指定可能なカントリーコードはこちらをご確認ください。 いいえ
zip お届け先住所の郵便番号を指定してください。 いいえ
state お届け先住所の都道府県・州を指定してください。 いいえ
city お届け先住所の市町村を指定してください。 いいえ
address お届け先住所の住所・通り名・番地を指定してください。 いいえ
bldg お届け先住所の建物名や部屋番号を指定してください。 いいえ
phone お届け先住所の電話番号を指定してください。 いいえ

レスポンスサンプル

{
  "response": {
    "status": "success"
  }
}

注文一覧の取得(get_orderlist)

概要

注文ステータスを指定して注文一覧を取得するためのオペレーションです。

リクエストURL

リクエストパラメータ

パラメータ 説明 必須
odrst 注文一覧を取得する注文ステータスを指定してください。指定しない場合は進行中注文を取得します。指定可能な注文ステータスはこちらをご確認ください。 いいえ

レスポンスサンプル

{
  "response": {
    "status": "success",
    "odrnum": 2,
    "orders": {
      "order": [
        {
          "id": "24552",
          "no": "DDD",
          "status": "CHECKING",
          "service": "ODR"
        },
        {
          "id": "24551",
          "no": "",
          "status": "1STBILL",
          "service": "ODR"
        }
      ]
    }
  }
}

注文詳細の取得(get_order)

概要

注文IDを指定して注文詳細を取得するためのオペレーションです。

リクエストURL

リクエストパラメータ

パラメータ 説明 必須
odrid 注文情報を取得する注文IDを指定してください。 はい

レスポンスサンプル

{
  "response": {
    "status": "success",
    "order": {
      "id": 24652,
      "no": "32222-3344",
      "status": "SHIPPED",
      "service": "ODR",
      "paycurrency": "JPY",
      "area": [
        "us"
      ],
      "bill": {
        "item": 12300,
        "commission": 650,
        "adjustbill1": 0,
        "adjustbill2": 0,
        "shipintl": 3450,
        "shiplocal": 352,
        "insurance": 0,
        "storagefee": 0,
        "fwdcommission": 0,
        "adjustdeposit": 0,
        "custom": 0,
        "tax": 0
      },
      "delivery": {
        "gname": "Taro",
        "fname": "Yamada",
        "company": "",
        "country": "jp",
        "zip": "1233456",
        "state": "Tokyo",
        "city": "Chiyoda-ku",
        "address": "3-2-1, Chiyoda",
        "bldg": "",
        "phone": "81312345678"
      },
      "items": {
        "item": [
          {
            "id": "108331",
            "status": "SHIPPED",
            "no": "37892d983",
            "title": "",
            "seller": "",
            "url": "http://ebay.com/test/item",
            "applyqty": 0,
            "qty": 1,
            "price": 99.20
          }
        ]
      },
      "shippings": {
        "shipping": [
          {
            "weightunit": "LBS",
            "weight": "3.0",
            "sizeunit": "INCH",
            "width": "12",
            "depth": "8",
            "height": "5",
            "payonarrival": "1",
            "trackno": "3445677888",
            "trackurl": "https://www.fedex.com/fedextrack/?cntry_code=jp&tab=1&tracknums=&clienttype=wtrk"
          }
        ]
      },
      "messages": {
        "message": [
          {
            "type": "OUTGOING",
            "title": "",
            "text": "test",
            "datetime": "2018-10-07 14:06:46"
          },
          {
            "type": "OUTGOING",
            "title": "test",
            "text": "test",
            "files": {
              "file": [
                "http://buyfy.jp/dbimg/message/5083c268598ba_importsquare_1538798348814895.png"
              ]
            },
            "datetime": "2018-10-06 12:59:18"
          }
        ]
      }
    }
  }
}

メッセージの送信(send_message)

概要

代行会社にメッセージを送信するためのオペレーションです。

リクエストURL

リクエストパラメータ

パラメータ 説明 必須
odrid メッセージを送信する注文IDを指定してください。 はい
subject メッセージのタイトルです。100字以内で指定してください。指定しない場合は『無題メッセージ』となります。 いいえ
body メッセージの本文です。1000文字以内で指定してください。 はい

レスポンスサンプル

{
  "response": {
    "status": "success"
  }
}
Instruction
If you are first time to visit, please read this
About BUYFY
Things to consider on importing goods
About Private Import
Member registration is free of charge
Member Registration
Sign in from here if you already became a member
Sign In
Calculate approx shipping fees by weight and size
Calculate Shipping Fees
Exchange Rate
1GBP = 1.2837USD
1EUR = 1.1419USD
1CNY = 0.1441USD
1HKD = 0.1277USD
1JPY = 0.0089USD
Updated on Nov 19th, 2018
Currency exchange fees will be added to the applied rate for agency service. You can check the applied rate of each agency on this page.