動作概要
MakeShopの注文情報をREST形式のAPIを通じて取得・操作することができます。 注文データの取得- 次の3つの方法で注文情報を取得できます。
- 前回取得時からの差分注文
- 注文番号を指定することによる指定注文
- 期間を指定する指定期間注文
- 注文番号を指定して、注文をキャンセルすることができます。
- 注文番号を指定して、配送ステータスを変更することができます。
- MakeShopで、注文内容が修正時、入金状態・配送状態等の注文ステータス変更時、受注時等、予め設定したタイミングで任意のURLに更新通知を送ることができます。
ご利用前の準備
注文APIをご利用いただくには、ショップ管理画面で注文APIの利用設定を行ってください。
認証コードは、[発行]ボタンを押下すると発行されます。以降[変更]ボタンを押下する度に、新しい認証コードが発行されます。
- ※認証コードを発行、もしくは変更した場合は、必ず[保存]ボタンを押下してください。
API仕様
注文データ取得APIは、メイクショップ上の注文情報を外部から取得するインターフェースです。使用すると、最後に取得した日時以降の注文情報をXMLで出力します。 注文日時、注文番号を指定することで対象注文を選択可能です。 APIのご利用には、メイクショップ管理画面で発行した認証キーが必要です。
リクエストURL
https://www.makeshop.jp/api/orderinfo/index.html
https://www.makeshop.jp/api/orderinfo/index.html?cmd=status&shopid=test&token=61efa02bde9d3eb5714560b233596e42&service=testsystem&ordernum=PB13818933178731403&status=0&result=test&deliveryid=0
- 最大100件まで出力されます。対象データが100件以上ある場合は、条件を指定することで、出力件数を調整してください。
リクエストパラメータ（共通）
注文APIで利用する共通パラメータ一覧です。| No | 項目名 | 必須 | 説明 |
|---|---|---|---|
| 1 | shopid | ○ | ご契約のショップIDを指定します。 12文字以内の半角英数で指定してください。 |
| 2 | token | ○ | ショップ管理画面で表示される認証コードを指定します。 32文字以内の半角英数で指定してください。 |
| 3 | service | APIへ接続するシステムの名称を16文字以内の半角英数で指定します。 任意の文字列で指定してください。 サービスのご利用形態により、MakeShopより指定させていただく場合がございます。 |
エラーメッセージ一覧（共通）
注文APIで共通のエラーメッセージを記載します。| ID | コード | 判定条件 | メッセージ | 備考 |
|---|---|---|---|---|
| A-1 | 400 | 実行コマンドが未入力 | 実行コマンドが指定されていません。 | |
| A-2 | 400 | 実行コマンドが下記以外の指定だったとき ・許可されている実行コマンド get status deliver |
コマンド「●●」は定義されていません。 | |
| A-3 | 400 | ショップIDが未入力 | ショップIDが指定されていません。 | |
| A-4 | 400 | 認証コードが未入力 | 認証コードが指定されていません。 | |
| A-6 | 500 | データベースに接続できない | データベースとの接続を確立できませんでした。時間をおいてから再度お試しください。 | |
| A-7 | 401 | 指定したショップIDが存在しない | ショップIDまたは認証コードが間違っています。 | |
| A-8 | 401 | システム上のショップ情報が取得できない | ショップIDまたは認証コードが間違っています。 | |
| A-10 | 400 | 実行コマンドが下記以外の指定だったとき ・許可されている実行コマンド get status deliver |
[認証コード｜実行コマンド｜ショップID｜サービスコード]が指定されていません。 | |
| A-11 | 401 | 指定したショップIDが存在しない | ショップIDまたは認証コードが間違っています。 | |
| A-12 | 903 | 対象の注文がなかったとき | 注文は存在しません。 | 引数などの書式に問題はないが、検索結果が0件の場合に出力されるエラー。 |
| A-13 | 903 | 対象の注文がなかったとき | 注文番号「●●」の注文は存在しません。 | 引数などの書式に問題はないが、検索結果が0件の場合に出力されるエラー。 書式も正しい注文番号を指定した場合に出力される。 |
注文データ取得API
注文データを取得します。 追加パラメータ一覧| No | 項目名 | 必須 | 説明 |
|---|---|---|---|
| 1 | cmd | ○ | APIの動作を指定します。 get：注文データ取得 |
| 2 | ordernum | 注文番号を26文字以内の半角英数で指定します。 | |
| 3 | start | 注文日時を範囲で取得する場合に指定してください。 yyyymmddhhmmss |
|
| 4 | end | 注文日時を範囲で取得する場合に指定してください。 yyyymmddhhmmss |
|
| 5 | canceled | キャンセル注文を出力する場合は指定します。 指定しない場合は、0として判定されます。 0：取得しない 1：取得する |
- 注文番号、注文日時を指定しない場合は、最後に取得した注文日時以降の注文が出力されます。
ご利用例
2013/12/20 10:00:00～2013/12/21 09:59:59の注文を取得します。https://www.makeshop.jp/api/orderinfo/index.html?cmd=get&shopid=test&token=61efa02bde9d3eb5714560b233596e42&start=20131220100000&end=20131221095959
エラーメッセージ一覧
| ID | コード | 判定条件 | メッセージ |
|---|---|---|---|
| B-1 | 403 | 注文情報参照が「許可しない」になっている。 | ショップ設定により操作が禁止されています。 |
| B-2 | 406 | キャンセルデータ取得用の引数が、空か0か1以外 | キャンセルデータ取得フラグの値が間違っています。 |
| B-3 | 406 | 開始～終了指定の引数がyyyymmddhhiiss以外で指定されたとき | [開始日｜終了日]の指定が間違っています。 日付はyyyymmddhhmmssの形で指定してください。 |
| B-4 | 406 | 終了日が開始日より過去の指定だったとき | 終了日は開始日以降の日付を指定してください。 |
| B-5 | 406 | 注文番号が未入力、または19桁以外の桁数だったとき | 注文番号が間違っています。 |
注文データ取得API データフォーマットの返り値
| No | 項目名 | 使用回数 | 説明 | プロパティ | 必須 | 桁数 | フォーマット/例 | 備考 |
|---|---|---|---|---|---|---|---|---|
| 1 | orders | 1 | 注文群 | – | ||||
| 2 | order | n | 注文 | – | 複数記載可 | |||
| 3 | ordernum | 1 | 注文番号 | ○ | 19 | P154650696673492905 | ||
| 4 | status | 1 | 状態 | ○ | 1 | 注文の判別に利用 0：キャンセル 1：通常 99：仮注文（※1） |
||
| 5 | repeatsalenum | 1 | 定期購入回数 | – | 1 | 定期購入時に表示 半角数字0埋めなし |
||
| 6 | date | 1 | 注文日 | ○ | 19 | YYYY-MM-DD 00:00:00 | ||
| 7 | paymethod | 1 | 支払方法 | type | ○ | 2 | Amazon Pay | 任意設定した決済名称が返却される。 ※typeについては入金完了とする決済別ステータス一覧を参照 |
| 8 | payment_status | 1 | 入金状況 | 1 | 0 | 0：未入金 1：入金完了 ※決済方法と入金完了とするステータスについては入金完了とする決済別ステータス一覧を参照 |
||
| 9 | ordermemo | 1 | 詳細注文情報内メモ | – | 2018/01/19 後払い.com -> 銀行振込 主管理者 | |||
| 10 | orderdetail | 1 | 注文詳細 | – | ||||
| 11 | commodities | 注文明細群 | – | |||||
| 12 | commodity | n | 注文明細 | – | ||||
| 13 | name | 1 | 商品名 | ○ | 255 | 素敵なパジャマM（メンズ） | ||
| 14 | brandcode | 1 | システム商品コード | ○ | 12 | 2001000003 | ||
| 15 | orgcode | 1 | 独自商品コード | 50 | 値がない場合は閉じタグのみ。<orgcode /> |
|||
| 16 | orgoptioncode | 1 | 独自オプションコード | 20 | ||||
| 17 | option | 1 | オプション情報 | オプション詳細開始のタグ | ||||
| 18 | jancode | JANコード | 16 | |||||
| 19 | dcrate | 割引率 | 2 | 0 | 0から99までのパーセンテージで返却 | |||
| 20 | price | 1 | 販売価格 | ○ | 10 | 4800 | ||
| 21 | amount | 1 | 注文個数 | ○ | 10 | 1 | ||
| 22 | point | n | 各種ポイント付与率 | type, name |
10 | 付与ポイント（type：name） shop：ショップポイント gmo：GMOポイント yahoo：yahoo!ポイント |
||
| 23 | consumption_tax_rate | 1 | 消費税率 | ○ | 2 | 8 | 購入商品の消費税率を半角数値で出力する。 | |
| 24 | nameoption | n | 名入れオプション | |||||
| 25 | label1 | 1 | 名入れ項目名1 | |||||
| 26 | comment1 | 1 | 名入れ入力内容1 | |||||
| 27 | label2 | 1 | 名入れ項目名2 | |||||
| 28 | comment2 | 1 | 名入れ入力内容2 | |||||
| 29 | label3 | 1 | 名入れ項目名3 | |||||
| 30 | comment3 | 1 | 名入れ入力内容3 | |||||
| 31 | label4 | 1 | 名入れ項目名4 | |||||
| 32 | comment4 | 1 | 名入れ入力内容4 | |||||
| 33 | label5 | 1 | 名入れ項目名5 | |||||
| 34 | comment5 | 1 | 名入れ入力内容5 | |||||
| 35 | label6 | 1 | 名入れ項目名6 | |||||
| 36 | comment6 | 1 | 名入れ入力内容6 | |||||
| 37 | label7 | 1 | 名入れ項目名7 | |||||
| 38 | comment7 | 1 | 名入れ入力内容7 | |||||
| 39 | label8 | 1 | 名入れ項目名8 | |||||
| 40 | comment8 | 1 | 名入れ入力内容8 | |||||
| 41 | label9 | 1 | 名入れ項目名9 | |||||
| 42 | comment9 | 1 | 名入れ入力内容9 | |||||
| 43 | label10 | 1 | 名入れ項目名10 | |||||
| 44 | comment10 | 1 | 名入れ入力内容10 | |||||
| 45 | amount | 1 | 数量 | |||||
| 46 | couponname | 1 | クーポン名 | 100 | 1万円以上で500円引き | クーポンが利用された場合、出力される。 | ||
| 47 | couponcode | 1 | クーポンコード | 20 | j6jze4t9n8gzmghxnk40 | クーポンが利用された場合、出力される。 | ||
| 48 | coupon | 1 | クーポン割引額 | 10 | -500 | クーポンが利用された場合、出力される。 | ||
| 49 | bulk | 1 | まとめ買い割引額 | 10 | -500 | まとめ買い割引対象商品が購入された場合、出力される。 ※まとめ買い割引対象商品を購入すれば割引額が0円でも項目を出力する。 |
||
| 50 | carriage | 1 | 送料 | 10 | 950 | |||
| 51 | commission | 1 | 決済手数料 | name | 10 | 840 | ※決済手数料が1円以上の場合、出力される（決済手数料0円、もしくは未設定時は出力されない）。 | |
| 52 | point | 1 | 10 | 500 | 会員グループの設定でポイント付与（率と額）が設定されている場合に表示される。 | |||
| 53 | dcprice | 1 | 10 | -300 | 会員グループの設定で現金割引（率と額）が設定されている場合に表示される。 | |||
| 54 | usepoint | n | 利用ポイント | type, name |
11 | -500 | 発行ポイント（type：name） shop：ショップポイント gmo：GMOポイント yahoo：Tポイント |
|
| 55 | correction | 1 | 修正額 | 10 | ||||
| 56 | sumprice | 1 | 合計金額 | ○ | 10 | |||
| 57 | price_per_tax_rate_list | n | 税率毎の合計金額群 | 税率毎の合計金額値の登録がある場合に出力。 | ||||
| 58 | price_per_tax_rate tax_rate | 1 | 各税率の合計金額値 | 税率毎の合計金額値を出力。 | ||||
| 59 | buyer | 1 | 注文者情報群 | – | ||||
| 60 | id | 1 | 注文者ID | ○ | 18 | 151021000001 | ||
| 61 | office_name | 1 | 会社名 | 60 | GMOメイクショップ株式会社 | 法人名入力オプション利用時に出力。 | ||
| 62 | office_name_kana | 1 | 会社名（フリガナ） | 60 | ジーエムオーメイクショップ | 法人名入力オプション利用時に出力。 | ||
| 63 | department | 1 | 部署名 | 60 | 法人営業部 | 法人名入力オプション利用時に出力。 | ||
| 64 | name | 1 | 名前 | ○ | 40 | 佐々木小次郎 | ||
| 65 | kana | 1 | フリガナ | ○ | 40 | ササキコジロウ | ||
| 66 | tel | 1 | 電話番号 | ○ | 30 | 決済画面内の電話番号 | ||
| 67 | tel2 | 1 | 電話番号2 | 30 | 決済画面内の緊急時連絡先 | |||
| 68 | 1 | メールアドレス | ○ | 100 | mail@example.com | Eメールアドレス形式 | ||
| 69 | zip | 1 | 郵便番号 | ○ | 8 | 000-0000 | CDATA | |
| 70 | address | 1 | 住所 | 200 | ||||
| 71 | membergroup | 1 | 会員グループ群 | – | ||||
| 72 | id | 1 | 会員グループコード | 4 | 2 | |||
| 73 | name | 1 | 会員グループ名 | 40 | プレミアム会員 | |||
| 74 | deliveries | 1 | 配送先群 | id | – | |||
| 75 | delivery | n | 配送先 | – | ||||
| 76 | office_name | 1 | 会社名 | 60 | GMOソリューションパートナー株式会社 | 法人名入力オプション利用時に出力。 | ||
| 77 | office_name_kana | 1 | 会社名（フリガナ） | 60 | ジーエムオーソリューションパートナー | 法人名入力オプション利用時に出力。 | ||
| 78 | department | 1 | 部署名 | 60 | 事業推進部 | 法人名入力オプション利用時に出力。 | ||
| 79 | name | 1 | 名前 | ○ | 40 | 宮本武蔵 | ||
| 80 | kana | 1 | フリガナ | ○ | 40 | ミヤモトムサシ | ||
| 81 | tel | 1 | 電話番号 | ○ | 30 | |||
| 82 | zip | 1 | 郵便番号 | ○ | 8 | 000-0000 | ||
| 83 | area | 1 | 都道府県 | ○ | 6 | 東京都 | ||
| 84 | address | 1 | 住所 | ○ | 150 | |||
| 85 | deliverydate | 1 | 配送希望日 | 10 | YYYY-MM-DD | |||
| 86 | deliverytime | 1 | 配送希望時間 | 11 | 00:00-00:00 | |||
| 87 | commodities | 1 | 明細群 | – | ||||
| 88 | commodity | n | 明細 | – | ||||
| 89 | name | 1 | 商品名 | ○ | 255 | |||
| 90 | option | 1 | オプション名 | 商品のオプションをテキストで出力する。 | ||||
| 91 | brandcode | 1 | システム商品コード | 12 | ||||
| 92 | orgcode | 1 | 独自商品コード | 50 | ||||
| 93 | orgoptioncode | 1 | 独自オプションコード | 20 | ||||
| 94 | price | 1 | 販売価格 | ○ | 10 | |||
| 95 | point | 1 | ポイント | 10 | ||||
| 96 | amount | 1 | 注文個数 | ○ | 10 | |||
| 97 | consumption_tax_rate | 1 | 消費税率 | ○ | 2 | 8 | 購入商品の消費税率を半角数値で出力する | |
| 98 | nameoption | n | 名入れオプション | |||||
| 99 | label1 | 1 | 名入れ項目名1 | |||||
| 100 | comment1 | 1 | 名入れ入力内容1 | |||||
| 101 | label2 | 1 | 名入れ項目名2 | |||||
| 102 | comment2 | 1 | 名入れ入力内容2 | |||||
| 103 | label3 | 1 | 名入れ項目名3 | |||||
| 104 | comment3 | 1 | 名入れ入力内容3 | |||||
| 105 | label4 | 1 | 名入れ項目名4 | |||||
| 106 | comment4 | 1 | 名入れ入力内容4 | |||||
| 107 | label5 | 1 | 名入れ項目名5 | |||||
| 108 | comment5 | 1 | 名入れ入力内容5 | |||||
| 109 | label6 | 1 | 名入れ項目名6 | |||||
| 110 | comment6 | 1 | 名入れ入力内容6 | |||||
| 111 | label7 | 1 | 名入れ項目名7 | |||||
| 112 | comment7 | 1 | 名入れ入力内容7 | |||||
| 113 | label8 | 1 | 名入れ項目名8 | |||||
| 114 | comment8 | 1 | 名入れ入力内容8 | |||||
| 115 | label9 | 1 | 名入れ項目名9 | |||||
| 116 | comment9 | 1 | 名入れ入力内容9 | |||||
| 117 | label10 | 1 | 名入れ項目名10 | |||||
| 118 | comment10 | 1 | 名入れ入力内容10 | |||||
| 119 | amount | 1 | 数量 | |||||
| 120 | delivery_id | △ | 2 | 通常配送の場合のみ固定値1を出力する。 複数配送の場合はお届け先ごとに01,02,03・・・を出力する。 |
||||
| 121 | delivery_status | 1 | 配送ステータス | ○ | 1 | 0 | 0：未配送 1：配送完了 2：返送 3：キャンセル |
|
| 122 | scheduled_shipping_date | 1 | 出荷予定日 | 19 | YYYY-MM-DD | |||
| 123 | shipping_date | 1 | 配送完了日時 | 19 | YYYY-MM-DD 00:00:00 | |||
| 124 | delivery_order | 1 | 出荷指示 | ○ | 1 | 0 | 0：未指示 1：出荷指示済み 2：出荷準備中 |
|
| 125 | carrier | 1 | 配送業者コード | 3 | 1 | 配送業者コードは配送業者コード一覧を参照 | ||
| 126 | daliverynum | 1 | 配送伝票番号 | 20 | ||||
| 127 | carriage | 1 | 配送方法 | name, price |
○ | 10 | name：配送方法名称（ショップ様任意設定項目） price：配送料 |
|
| 128 | notes | 1 | 配送備考項目群 | △ | – | 複数配送の場合のみ出力される | ||
| 129 | note | n | 配送備考情報項目 | num, title |
△ | 複数配送の場合のみ出力される num：1～（自動採番） title：設問項目名（ショップ様任意設定項目） |
||
| 130 | notes | 1 | 記載事項情報項目群 | ○ | – | |||
| 131 | note | n | 記載事項情報項目 | num, title |
num：1～（自動採番） title：設問項目名（ショップ様任意設定項目） |
|||
| 132 | combined_paymethod | 1 | 併用の支払方法 | type | 2 | Yahoo!ショッピングカード決済 | paymethodの値がY2の決済の場合、併用される決済の名称が返却される。 | |
| 133 | combined_price | 1 | 併用の支払での金額 | 10 | Yahoo!ショッピングカード決済 | ※typeについては入金完了とする決済別ステータス一覧を参照 |
※1 仮注文について
- 3Dセキュアのクレジットカードをはじめとした外部の決済システムを利用する決済方法の場合、注文データのステータスが
99（仮注文）として登録され、決済が正常完了すると、1（通常）に変更されます。
- 外部の決済システムでのユーザーの離脱等で決済が正常完了しなかった場合、仮注文として登録された注文はバッチ処理で自動的に削除されます。
- ただし一定の条件下で
99（仮注文）のまま、削除されないケースが有り得ます（下記図表のcase5の場合）。 99（仮注文）のまま一定期間存在する可能性がある決済方法は、後述する入金完了とする決済別ステータス一覧の仮注文として残る可能性で、有と記載のあるものです。
仮注文動作の説明図（case1～case5）
在庫連携システム用注文確認メール書式
| No | 項目名 | 使用回数 | 説明 | プロパティ | 必須 | 桁数 | フォーマット/例 | 備考 |
|---|---|---|---|---|---|---|---|---|
| 1 | order | n | 注文 | – | 複数記載可 | |||
| 2 | ordernum | 1 | 注文番号 | ○ | 19 | P154650696673492905 | ||
| 3 | date | 1 | 注文日 | ○ | 19 | YYYY-MM-DD 00:00:00 | ||
| 4 | paymethod | 1 | 支払方法 | type | ○ | 2 | 決済方法 | |
| 5 | bankaccount | |||||||
| 6 | store | |||||||
| 7 | id | |||||||
| 8 | url | |||||||
| 9 | name | |||||||
| 10 | mail@example.com | |||||||
| 11 | orderdetail | 1 | 注文詳細 | – | ||||
| 12 | commodities | 注文明細群 | – | |||||
| 13 | commodity | n | 注文明細 | – | ||||
| 14 | name | 1 | 商品名 | ○ | 255 | |||
| 15 | brandcode | 1 | システム商品コード | ○ | 12 | 2001000003 | ||
| 16 | orgcode | 1 | 独自商品コード | 50 | 値がない場合は閉じタグのみ。<orgcode /> |
|||
| 17 | orgoptioncode | 1 | 独自オプションコード | 20 | ||||
| 18 | option | 1 | オプション情報 | オプション詳細開始のタグ | ||||
| 19 | jancode | JANコード | 16 | |||||
| 20 | dcrate | 割引率 | 2 | 0-99 | ||||
| 21 | price | 1 | 販売価格 | ○ | 10 | |||
| 22 | amount | 1 | 注文個数 | ○ | 10 | |||
| 23 | point | n | 各種ポイント付与率 | type, name |
10 | 付与ポイント（type：name） shop：ショップポイント gmo：GMOポイント yahoo：yahoo!ポイント |
||
| 24 | consumption_tax_rate | 1 | 消費税率 | ○ | 2 | 8 | 購入商品の消費税率を半角数値で出力する。 | |
| 25 | nameoption | n | 名入れオプション | |||||
| 26 | label | 1 | 名入れ項目名1 | |||||
| 27 | comment1 | 1 | 名入れ入力内容1 | |||||
| 28 | label2 | 1 | 名入れ項目名2 | |||||
| 29 | comment2 | 1 | 名入れ入力内容2 | |||||
| 30 | label3 | 1 | 名入れ項目名3 | |||||
| 31 | comment3 | 1 | 名入れ入力内容3 | |||||
| 32 | label4 | 1 | 名入れ項目名4 | |||||
| 33 | comment4 | 1 | 名入れ入力内容4 | |||||
| 34 | label5 | 1 | 名入れ項目名5 | |||||
| 35 | comment5 | 1 | 名入れ入力内容5 | |||||
| 36 | label6 | 1 | 名入れ項目名6 | |||||
| 37 | comment6 | 1 | 名入れ入力内容6 | |||||
| 38 | label7 | 1 | 名入れ項目名7 | |||||
| 39 | comment7 | 1 | 名入れ入力内容7 | |||||
| 40 | label8 | 1 | 名入れ項目名8 | |||||
| 41 | comment8 | 1 | 名入れ入力内容8 | |||||
| 42 | label9 | 1 | 名入れ項目名9 | |||||
| 43 | comment9 | 1 | 名入れ入力内容9 | |||||
| 44 | label10 | 1 | 名入れ項目名10 | |||||
| 45 | comment10 | 1 | 名入れ入力内容10 | |||||
| 46 | amount | 1 | 数量 | |||||
| 47 | couponname | 1 | クーポン名 | 100 | 1万円以上で500円引き | クーポンが利用された場合、出力される。 | ||
| 48 | couponcode | 1 | クーポンコード | 20 | j6jze4t9n8gzmghxnk40 | クーポンが利用された場合、出力される。 | ||
| 49 | coupon | 1 | クーポン割引額 | 10 | -500 | クーポンが利用された場合、出力される。 | ||
| 50 | bulk | 1 | まとめ買い割引額 | 10 | -500 | まとめ買い割引対象商品が購入された場合、出力される。 ※まとめ買い割引対象商品を購入すれば割引額が0円でも項目を出力する。 |
||
| 51 | carriage | 1 | 送料 | 10 | ||||
| 52 | commission | 1 | 決済手数料 | name | 10 | ※決済手数料が1円以上の場合、出力される（決済手数料0円、もしくは未設定時は出力されない）。 | ||
| 53 | point | 1 | 10 | 500 | 会員グループの設定でポイント付与（率と額）が設定されている場合に表示される。 | |||
| 54 | dcprice | 1 | 10 | -300 | 会員グループの設定で現金割引（率と額）が設定されている場合に表示される。 | |||
| 55 | usepoint | n | 利用ポイント | type, name |
10 | -500 | 発行ポイント（type：name） shop：ショップポイント gmo：GMOポイント yahoo：yahoo!ポイント |
|
| 56 | sumprice | 1 | 合計金額 | ○ | 10 | |||
| 57 | price_per_tax_rate_list | n | 税率毎の合計金額群 | 税率毎の合計金額値の登録がある場合に出力。 | ||||
| 58 | price_per_tax_rate tax_rate | 1 | 各税率の合計金額値 | 税率毎の合計金額値を出力。 | ||||
| 59 | buyer | 1 | 注文者情報群 | – | ||||
| 60 | id | 1 | 注文者ID | ○ | 18 | 151021000001 | ||
| 61 | office_name | 1 | 会社名 | 60 | 法人名入力オプション利用時 | |||
| 62 | office_name_kana | 1 | 会社名（フリガナ） | 60 | 法人名入力オプション利用時 | |||
| 63 | department | 1 | 部署名 | 60 | 法人名入力オプション利用時 | |||
| 64 | name | 1 | 名前 | ○ | 40 | |||
| 65 | kana | 1 | フリガナ | ○ | 40 | |||
| 66 | tel | 1 | 電話番号 | ○ | 30 | |||
| 67 | tel2 | 1 | 電話番号2 | 30 | ||||
| 68 | 1 | メールアドレス | ○ | 100 | mail@example.com | Eメールアドレス形式 | ||
| 69 | zip | 1 | 郵便番号 | ○ | 8 | 000-0000 | CDATA | |
| 70 | address | 1 | 住所 | 200 | ||||
| 71 | membergroup | 1 | 会員グループ群 | – | ||||
| 72 | id | 1 | 会員グループコード | 4 | 2 | |||
| 73 | name | 1 | 会員グループ名 | 40 | プレミアム会員 | |||
| 74 | deliveries | 1 | 配送先群 | – | ||||
| 75 | delivery | n | 配送先 | id | – | |||
| 76 | office_name | 1 | 会社名 | 60 | 法人名入力オプション利用時 | |||
| 77 | office_name_kana | 1 | 会社名（フリガナ） | 60 | 法人名入力オプション利用時 | |||
| 78 | department | 1 | 部署名 | 60 | 法人名入力オプション利用時 | |||
| 79 | name | 1 | 名前 | ○ | 40 | |||
| 80 | kana | 1 | フリガナ | ○ | 40 | |||
| 81 | tel | 1 | 電話番号 | ○ | 30 | |||
| 82 | zip | 1 | 郵便番号 | ○ | 8 | 000-0000 | ||
| 83 | area | 1 | 都道府県 | ○ | 6 | 東京都 | ||
| 84 | address | 1 | 住所 | ○ | 150 | |||
| 85 | deliverydate | 1 | 配送希望日 | 10 | YYYY-MM-DD | |||
| 86 | deliverytime | 1 | 配送希望時間 | 11 | 00:00-00:00 | |||
| 87 | commodities | 1 | 明細群 | – | ||||
| 88 | commodity | n | 明細 | – | ||||
| 89 | name | 1 | 商品名 | ○ | 255 | |||
| 90 | option | 1 | オプション名 | 商品のオプションをテキストで出力する。 | ||||
| 91 | brandcode | 1 | システム商品コード | 12 | ||||
| 92 | orgcode | 1 | 独自商品コード | 50 | ||||
| 93 | orgoptioncode | 1 | 独自オプションコード | 20 | ||||
| 94 | price | 1 | 販売価格 | ○ | 10 | |||
| 95 | point | 1 | ポイント | 10 | ||||
| 96 | amount | 1 | 注文個数 | ○ | 10 | |||
| 97 | consumption_tax_rate | 1 | 消費税率 | ○ | 2 | 8 | 購入商品の消費税率を半角数値で出力する。 | |
| 98 | nameoption | n | 名入れオプション | |||||
| 99 | label1 | 1 | 名入れ項目名1 | |||||
| 100 | comment1 | 1 | 名入れ入力内容1 | |||||
| 101 | label2 | 1 | 名入れ項目名2 | |||||
| 102 | comment2 | 1 | 名入れ入力内容2 | |||||
| 103 | label3 | 1 | 名入れ項目名3 | |||||
| 104 | comment3 | 1 | 名入れ入力内容3 | |||||
| 105 | label4 | 1 | 名入れ項目名4 | |||||
| 106 | comment4 | 1 | 名入れ入力内容4 | |||||
| 107 | label5 | 1 | 名入れ項目名5 | |||||
| 108 | comment5 | 1 | 名入れ入力内容5 | |||||
| 109 | label6 | 1 | 名入れ項目名6 | |||||
| 110 | comment6 | 1 | 名入れ入力内容6 | |||||
| 111 | label7 | 1 | 名入れ項目名7 | |||||
| 112 | comment7 | 1 | 名入れ入力内容7 | |||||
| 113 | label8 | 1 | 名入れ項目名8 | |||||
| 114 | comment8 | 1 | 名入れ入力内容8 | |||||
| 115 | label9 | 1 | 名入れ項目名9 | |||||
| 116 | comment9 | 1 | 名入れ入力内容9 | |||||
| 117 | label10 | 1 | 名入れ項目名10 | |||||
| 118 | comment10 | 1 | 名入れ入力内容10 | |||||
| 119 | amount | 1 | 数量 | |||||
| 120 | delivery_id | △ | 2 | 通常配送の場合のみ固定値1を出力する。 複数配送の場合はお届け先ごとに01,02…を出力する。 |
||||
| 121 | carriage | 1 | 配送方法 | name, price |
○ | 10 | name：配送方法名称（ショップ様任意設定項目） price：配送料 |
|
| 122 | notes | 1 | 配送備考項目群 | △ | – | 複数配送の場合のみ出力される。 | ||
| 123 | note | n | 配送備考情報項目 | num, title |
△ | 複数配送の場合のみ出力される。 num：1～（自動採番） title：設問項目名（ショップ様任意設定項目） |
||
| 124 | notes | 1 | 記載事項情報項目群 | ○ | – | |||
| 125 | note | n | 記載事項情報項目 | num, title |
○ | num：1～（自動採番） title：設問項目名（ショップ様任意設定項目） |
||
| 126 | mailtext | 1 | 購入者宛メール | ○ | ||||
| 127 | from | 1 | 購入者宛メール送信者 | ○ | 100 | Eメールアドレス形式 | ショップ管理者メール | |
| 128 | to | 1 | 購入者宛メール宛先 | ○ | 100 | Eメールアドレス形式 | 注文者メール | |
| 129 | to | 1 | 購入者宛メールCC | 100 | Eメールアドレス形式 | – | ||
| 130 | subject | 1 | 購入者宛メール件名 | ○ | 【注文番号】注文がはいりました。 | XMLメールの件名 | ||
| 131 | body | 1 | 購入者宛メール本文 | ○ | CDATA形式 | 送信された注文メール本文 | ||
| 132 | combined_paymethod | 1 | 併用の支払方法 | type | 2 | Yahoo!ショッピングカード決済 | paymethodの値がY2の決済の場合、併用される決済の名称が返却される。 | |
| 133 | combined_price | 1 | 併用の支払での金額 | 10 | Yahoo!ショッピングカード決済 | ※typeについては入金完了とする決済別ステータス一覧を参照 |
入金完了とする決済別ステータス一覧
| 記号 | 決済方法 | ステータス | 仮注文 として 残る 可能性 |
備考 |
|---|---|---|---|---|
| B | 銀行振り込み | 入金完了 | ||
| P | ゆうちょ銀行 | 入金完了 | ||
| R | 代金引換 | 入金完了 | ||
| N | NP後払い | 入金完了 | ||
| A | 後払い.COM | 入金完了 | ||
| C | クレジットカード（イプシロン） | 決済完了 | 有 | 即時決済 |
| T | クレジットカード（ペイジェント） | 決済完了 | 即時決済 | |
| Y | クレジットカード（ペイメントゲートウェイ） | 決済完了 | 有 | 即時決済 |
| 〃 | 〃 | 売上報告済 | 有 | 定期購入 |
| G | クレジットカード（イーコンテクスト） | 決済完了 | 有 | 即時決済 |
| E | 楽天銀行 | 決済完了 | 即時決済 | |
| I | Bitcash | 決済完了 | 即時決済 | |
| H | ちょコム | 決済完了 | 即時決済 | |
| V | ネットバンク | 決済完了 | 有 | 即時決済 |
| Z | コンビニ決済（イプシロン） | 入金完了 | ||
| F | コンビニ決済（ペイメントゲートウェイ） | 決済完了 | ||
| J | コンビニ他現金（イーコンテクスト） | 決済完了 | ||
| K | 価格.com安心支払い | 決済完了 | ||
| L | PayPal | 決済完了 | 有 | 即時決済 |
| O | Yahoo!ウォレット | 決済完了 | 有 | |
| Q | キャリア決済（イプシロン） | 決済完了 | 有 | |
| S | ショッピングクレジット | 売上登録依頼済み | ||
| M | 後払い決済（Paid） | 確定 | ||
| X | 決済不要 | 受注時 | ※ | |
| W | ウェブマネー（未使用） | – | ||
| D | Do-Link（未使用） | – | ||
| U | キャリア決済（ペイメントゲートウェイ） | 決済完了 | ||
| A1 | フレッツ・まとめて支払い（ペイメントゲートウェイ） | 決済完了 | 2016年3月をもって終了 | |
| B1 | GMO後払い | – | 有 | |
| C1 | Paidy | 請求確定 | 有 | |
| D1 | Amazon Pay | 決済完了 | ||
| E1 | NP掛け払い（旧FREX B2B後払い） | 入金完了 | ||
| F1 | リクルートかんたん支払い | 決済完了 | ||
| G1 | 楽天ペイ | 決済完了 | 有 | |
| H1 | ZEUSクレジット | 決済完了 | 有 | |
| I1 | クレジットカード（クロネコwebコレクト） | 決済完了 | 有 | |
| J1 | コンビニ決済（クロネコwebコレクト） | 決済完了 | 有 | |
| K1 | クロネコ代金後払い | 決済完了 | 有 | |
| L1 | atone | 決済完了 | 有 | |
| M1 | 銀行振込（バーチャル口座）(イプシロン) | 入金完了 | ||
| N1 | LINE Pay | 決済完了 | ||
| O1 | PayPay | 決済完了 | ||
| P1 | クロネコペイ | 決済完了 | 有 | |
| Y1 | Yahoo!ショッピングカード決済 | 決済完了 | ||
| Y2 | Yahoo!ショッピングPayPay残高払い | 決済完了 | 決済方法の併用が可能。 | |
| Y9 | Yahoo!ショッピング（全額ポイント） | 決済完了 |
- ※即時決済のものは注文確定時に入金完了（決済完了）のステータスとなります
注文状態変更API
注文をキャンセルに変更します。 以下のキャンセル操作には対応していません。- 在庫戻し
- ポイント還元
| No | 項目名 | 必須 | 説明 |
|---|---|---|---|
| 1 | cmd | ○ | APIの動作を指定します。 status：注文ステータス変更 |
| 2 | ordernum | ○ | 注文番号を26文字以内の半角英数で指定します。 必須項目です |
| 3 | deliveryid | ○ | 配送先が1つの場合は0を指定します。 複数ある場合は1以降の連番を半角数字で指定します。 |
| 4 | status | ○ | キャンセルへ変更します。 0：注文キャンセル |
| 5 | result | キャンセル理由を入力します。 入力値は、管理画面のメモ欄に追加されます。 キャンセル理由 ＋（API） 改行 ＋ 既存のメモ欄EUC-JPでURLエンコードしてください。 |
ご利用例
注文番号PB13818933178731403 の注文を『テスト』という理由でキャンセルします。
https://www.makeshop.jp/api/orderinfo/index.html?cmd=status&shopid=test&token=61efa02bde9d3eb5714560b233596e42&service=testsystem&ordernum=PB13818933178731403&status=0&result=%a5%c6%a5%b9%a5%c8&deliveryid=0
エラーメッセージ一覧
| ID | コード | 判定条件 | メッセージ |
|---|---|---|---|
| C-1 | 403 | 注文情報変更設定が「許可しない」または「状態変更のみ許可」になっているとき。 | ショップ設定により操作が禁止されています。 |
| C-2 | 403 | 注文情報変更設定が「許可しない」の設定になっている。 | ショップ設定により操作が禁止されています。 |
| C-3 | 406 | 注文番号が未入力、または19桁以外の桁数だったとき | 注文番号が間違っています。 |
| C-4 | 406 | 配送IDが数値で1～2桁以外だったとき | 配送IDは数値で指定してください。 |
| C-5 | 406 | キャンセル以外の指定があったとき。（0：キャンセルなので0以外の値がきたとき） | 注文状態は0で指定してください。 |
| C-6 | 409 | 既にキャンセル済み、または配送完了の注文だったとき | 注文番号「注文番号が入ります」の注文は既に[キャンセル｜キャンセル取消]されています。 |
| C-7 | 504 | 通常配送：通常配送にも関わらず、配送先IDの指定が0以外 複数配送：配送先の指定が正しくない（パラメータ：deliveryidに不備） |
指定された注文番号「注文番号が入ります」、配送ID「●●」の配送先は存在しません。 |
| C-8 | 指定なし | ステータスが処理中の場合 | 処理中です |
配送状態変更API
配送ステータスを変更します。 追加パラメータ一覧| No | 項目名 | 必須 | 説明 |
|---|---|---|---|
| 1 | cmd | ○ | APIの動作を指定します。 deliver：配送状態変更 |
| 2 | ordernum | ○ | 注文番号を26文字以内の半角英数で指定します。 必須項目です |
| 3 | deliveryid | ○ | 配送先が1つの場合は0を指定します。 複数ある場合は1以降の連番を半角数字で指定します。 |
| 4 | status | ○ | 配送ステータスを変更します。 1：配送指示済 2：配送準備中 3：配送完了 9：返送 |
| 5 | carrier | 配送伝票業者を配送業者コードで指定します (次の配送業者コードを参照）文字列null入力で値を削除します。 |
|
| 6 | deliverynum | 配送伝票番号を入力しますnull入力で値を削除します。 |
|
| 7 | send_mail | ○ | 固定値で1を指定します。 |
| 8 | result | キャンセル理由を入力します。入力値は、管理画面のメモ欄に追加されます。 キャンセル理由 ＋（API）[改行] ＋ 既存のメモ欄 EUC-JPでURLエンコードしてください。 |
ご利用例
注文番号PB13818933178731403 の複数配送先お届け先2に対し、配送業者 メール便 配送伝票番号 123456789012 、『テスト』という理由で配送完了にします。
https://www.makeshop.jp/api/orderinfo/index.html?cmd=deliver&shopid=test&token=61efa02bde9d3eb5714560b233596e42&service=testsystem&ordernum=PB13818933178731403&deliveryid=2&status=3&carrier=001&deliverynum=123456789012&send_mail=1&result=%a5%c6%a5%b9%a5%c8
配送状態変更APIのパラメータ carrier で指定可能な配送業者コード一覧
| 配送業者コード | 配送伝票業者 |
|---|---|
| 001 | ゆうパック |
| 002 | クロネコヤマト |
| 003 | 佐川急便 |
| 004 | 国際スピード郵便(USPS) |
| 006 | 西濃運輸 |
| 007 | 福山通運 |
| 008 | EMS国際スピード郵便 |
| 009 | ゆうパック代金引換小包 |
| 010 | ゆうパック書留 |
| 011 | レターパック500 |
| 012 | 翌朝10時郵便 |
| 013 | 名鉄運輸 |
| 014 | OCS 国際エクスプレス |
| 015 | 普通郵便 |
| 016 | 普通郵便代引き |
| 017 | トナミ運輸 |
| 018 | トールエクスプレスジャパン |
| 019 | エコ配 |
| 020 | レターパック350 |
| 021 | セイノースーパーエクスプレス |
| 022 | 新潟運輸 |
| 023 | DHL |
| 024 | 第一貨物 |
| 025 | ゆうパケット |
| 026 | ポスパケット |
| 027 | クリックポスト |
| 028 | スマートレター |
| 029 | 宅急便コンパクト |
| 030 | ネコポス |
| 031 | クロネコDM便 |
レスポンス仕様
注文状態変更のリクエストを行うと、以下のレスポンスが返却されます。| No | 項目名 | 項目名2 | 説明 |
|---|---|---|---|
| 1 | response | ||
| 2 | ordernum | 注文番号 半角英数26文字 | |
| 3 | code | レスポンスコード 半角数値3ケタ | |
| 4 | message | エラーメッセージ |
- 文字コードUTF-8のXMLで出力されます。
- レスポンスコードとエラーメッセージは、エラーメッセージ一覧をご参照ください。
エラーメッセージ一覧
| ID | コード | 判定条件 | メッセージ |
|---|---|---|---|
| D-1 | 406 | 注文番号が未入力、または19桁以外の桁数だったとき | 注文番号が間違っています。 |
| D-2 | 406 | 配送IDが数値で1～2桁以外だったとき | 配送IDは数値で指定してください。 |
| D-3 | 406 | 配送ステータスが以下の値以外で指定されたとき 1：配送指示済 2：配送準備中 3：配送完了 9：返送 |
・serviceがelogitwmsの場合配送状態は0～3または9で指定してください。 ・それ以外 配送状態は3または9で指定してください。 |
| D-4 | 406 | 配送完了メール送付が1以外の指定だったとき ・配送完了メール送付有無（現在は1しか許可していない） 0：送らない 1：送る |
配送完了メールは1で表示してください。 |
| D-5 | 400 | 実行コマンドが下記以外の時 ・実行コマンド get update deliver |
[認証コード｜実行コマンド｜ショップID｜サービスコード]が指定されていません。 |
| D-6 | 409 | 配送ステータス変更指示が下記のいずれかの場合 1：配送指示済み 2：配送準備中 3：配送済み 該当注文の配送ステータスが未処理以外で変更できなかったとき |
注文番号「注文番号が入ります」、配送ID「●●」の配送は[配送完了｜返送｜出荷準備中｜出荷指示済み]のため変更できません。 |
| E-1 | 409 | 通常配送時：配送ステータス変更を下記で指定したが、 9：返送 該当注文の配送ステータスが配送完了になっていたとき |
注文番号「注文番号が入ります」、配送ID「●●」の配送は[配送完了｜返送｜出荷準備中｜出荷指示済み]のため変更できません。 |
| E-2 | 400 | 配送ステータスの変更指示が下記以外だったとき 1：配送指示済み 2：配送準備中 3：配送済み 9：返送 |
[認証コード｜実行コマンド｜ショップID｜サービスコード]が指定されていません。 |
| E-3 | 400 | 複数配送時：配送ステータス変更を下記で指定したが、 9：返送 該当注文の配送ステータスが配送完了になっていたとき |
返送可能なステータスではありません。 |
| E-4 | 504 | 配送ステータス変更できる注文番号が存在しなかったとき。 | 指定された注文番号「●●」、配送ID「●●」の配送先は存在しません。 |
| E-5 | 504 | 通常配送なのに、配送先IDが0以外の指定 | 指定された注文番号「●●」、配送ID「●●」の配送先は存在しません。 |
| E-6 | 406 | イプシロンステータス連連携失敗 | イプシロンステータス連携に失敗しました。イプシロン管理画面でご確認お願いします。 |
| E-7 | 400 | 配送済（配送完了）処理に失敗 | 未入金または未決済のため配送処理ができません。 |
更新通知機能
設定したタイミングで指定したURLに更新通知を送信します。
以下の操作を行った場合に更新通知が送信されます。
以下の操作では、更新通知は送信されません。
- 数量を変更する
- 配送料・代引き手数料を変更する
- 合計金額を変更する
- 利用ポイントを変更する
- 注文を分割する
- 伝票番号一括ステータス変更機能を利用して変更する
更新通知で利用できる変数
更新通知では、以下の変数がご利用いただけます。| 変数名 | 変換文字列 |
|---|---|
| [SHOPID] | ショップIDを出力します。 |
| [ORDERNUM] | 操作対象の注文番号を出力します。 |
| [CMD] | 通知するタイミングに応じて、以下の文字列を送信します 受注時 … 0 注文内容修正時 … 1 注文キャンセル時 … 2 入金完了時 … 3 配送完了時 … 4 |
ご利用例
以下のURLを管理画面の「更新通知APIのURL」に設定しておくと、設定した操作を行った際に[SHOPID] [ORDERNUM] [CMD]を置換して、指定したURLをコールします。
https://www.makeshop.jp/sample?shopid=[SHOPID]&order=[ORDERNUM]&cmd=[CMD]
- ※更新通知に対しては、特にレスポンスを行う必要はありませんが、テキストデータとして
404を返していただくと、管理画面に設定された認証コードを削除します。
配送指示機能
配送指示機能とは、倉庫管理システム（以下WMS）とのシステム連携でご利用いただく機能です。管理画面で配送指示を送ると、WMS側で配送指示済みの注文を検知し、出荷を行います。配送が完了した場合、WMS側から配送完了にステータスを変更することで、MakeShop管理画面上で状況を確認することができます。
配送指示機能は、以下の設定になっている場合ご利用いただけます。
配送指示操作
MakeShop管理画面に配送指示済みの項目が表示されます。
イレギュラー操作
配送指示後、MakeShop側で注文内容の修正を行った場合、倉庫管理システムとデータ差異が発生する可能性があります。
配送指示後に注文内容を修正した場合、画面上にアイコンを表示し、以降の注文内容修正で更新通知を送信しなくなります。
注文API仕様説明書.pptx
別紙「3-1.注文データ取得API」データフォーマット.xlsx