コンテンツにスキップ

確定API version3 仕様書#

システム概要#

機能一覧#

売上データの取得・修正

  • 未確定売上データの取得
  • 未確定件数取得（プログラム指定）
  • 未確定件数取得（広告主指定）
  • 売上データの修正処理(単品商品)
  • 売上データの修正処理(複数商品)

売上データの確定・キャンセル

  • 売上データの確定処理
  • 売上データのキャンセル処理

確定データの取得・取消

  • 当日確定データの取得
  • 当日確定件数取得（プログラム指定）
  • 当日確定件数取得（広告主指定）
  • 確定済みデータの取得
  • 当日確定データの取消処理

共通の仕様#

  • API からの返却値は text/json 形式となります。
  • 当APIは日本標準時 (UTC+9) で動作しています。当日・前日などの表記については日本標準時が基準となります。
  • プログラム終了後も API 認証キーが有効であれば API を利用することができます。
  • JSON データで送信するときは特に記載がなければ数値型・文字列型のどちらでリクエストしても問題ありません。

v2からの変更点#

  1. データ取得件数のlimit機能の追加しました。(v2は全て1万件固定でlimit指定できません)
  2. 未確定売上データ取得で注文単位の金額から商品ごと詳細の注文金額に修正しています。
  3. 未確定売上データ取得でorder_idによる検索機能を追加しました。
  4. 指定プログラムの未確定件数の取得機能を追加しました。
  5. 広告主配下全プログラムの未確定件数の取得機能を追加しました。
  6. 当日確定売上取得データにキャンセル理由を追加しました。
  7. 指定プログラムの当日確定件数の取得機能を追加しました。
  8. 広告主配下全プログラムの当日確定件数の取得機能を追加しました。

エンドポイント#

リスト取得系のエンドポイント

①https://ecsales-api.a8.net/v3

Note

${PROGRAM_ID}はA8.netより発行されているプログラムIDを設定してください。
${SP_ID}はA8.netより発行されている広告主IDを設定してください。

リスト取得（GET）
未確定リスト取得 上記エンドポイント/ins/${PROGRAM_ID}/unsealed
未確定件数取得（指定プログラム情報取得） 上記エンドポイント/ins/${PROGRAM_ID}/unsealed/count
未確定件数取得（広告主配下の全プログラム情報取得） 上記エンドポイント/sp/${SP_ID}/unsealed/count
当日確定リスト取得 上記エンドポイント/ins/${PROGRAM_ID}/sealed/today
当日確定リスト取得（指定プログラム情報取得） 上記エンドポイント/ins/${PROGRAM_ID}/sealed/today/count
当日確定リスト取得（広告主配下の全プログラム情報取得） 上記エンドポイント/sp/${SP_ID}/sealed/today/count
昨日以前確定リスト取得 上記エンドポイント/ins/${PROGRAM_ID}/sealed

確定・取消系処理系のエンドポイント

②https://ecsales-api.a8.net/v3/ins/${PROGRAM_ID}/order/${ORDER_ID}

Note

${ORDER_ID}はA8.net より発行される売上データのユニークキーを設定してください。

処理（POST）
売上修正処理 上記エンドポイント/modify
売上確定処理 上記エンドポイント/decide
売上キャンセル処理 上記エンドポイント/cancel
当日確定取消処理 上記エンドポイント/revival

その他注意事項#

  • 本資料で申し上げる「売上データ」とは、成果が未確定の状態のものを指します。
  • 本資料で申し上げる「確定データ」とは、「売上データ」が成果として認められ確定されたものと、成果として認められずキャンセルしたものを指します。
  • 日本標準時 (UTC+9) で 23:30 ~ 翌 01:00 前後は売上データの日次処理が行われるため、確定APIが利用できない場合があります。
  • 同一の API 認証キーから 1 分間に 100 回以上のアクセスがあった場合、A8.net より API の使用用途について問い合わせさせていただく場合があります。
  • 登録したIP以外からのアクセスは認証エラーとなります。

未確定売上データの取得/unsealed#

  • GET処理となります。
  • 未確定売上データを一覧で取得します。確定済みの売上データは含まれません。
  • 最大値10,000 件となります。10,000 件を超える未確定データがある場合には、データ取得開始位置パラメータを変更してください。

リクエストパラメータ#

パラメータ 設定値 形式 必須 備考
PROGRAM_ID プログラムID URL 必須 A8.net より発行されたプログラムID ..../v3/ins/の後ろに設定します。
api_key API認証キー GET 必須 A8.net より発行されるプログラムID に紐づく確定 API 認証キー
date 売上発生日 GET 任意 yyyyMMdd。指定なし：全件取得
order_id オーダーID GET 任意 A8.net より発行される売上データのユニークキー
order_no 注文番号 GET 任意 申込1件毎に御社システムが発行する注文（申込）番号を設定。
offset データ取得開始位置 GET 任意 デフォルト: 0　任意の位置からデータを取得できます。例10001件目から先を取得。
limit データ取得件数指定 GET 任意 デフォルト: 10000　10000件以内の件数を指定できます。

レスポンスフィールド#

フィールド 設定値 型 備考
status_code ステータスコード 数値 別途ステータスコード一覧を参照
message メッセージ 文字列
results 取得したリスト 配列
sales_ymd 売上発生日 文字列 yyyy/MM/dd HH:MI:SS 形式
as_id メディアID 文字列 A8.netで管理しているメディアID
order_id オーダーID 文字列 A8.net より発行される売上データのユニークキー
order_no 注文番号 文字列 申込1件毎に御社システムが発行している注文（申込）番号
decide_flg 確定フラグ 数値 0=未確定, 1=確定
order_count 注文個数 数値 注文個数（合計）
order_money 注文金額 数値 注文金額（合計）
pay_money 成功報酬額 数値 成功報酬額（合計）
website_name メディアの主サイト名 文字列
items 商品リスト 配列
code 商品コード 文字列 御社システム側で発行している商品を識別するコード
price 商品単価 数値
reward_fair_money 報酬対象売上額 数値 商品毎の報酬対象売上額
pay_money 成功報酬額 数値 商品毎の成功報酬額
quantity 商品個数 数値

サンプルコード#

リクエスト

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
#!/bin/bash
PROGRAM_ID="s00008100201001"
API_KEY="abcdefghijklmnopqrstuvwxyz1234567890"

DATE=`date ‐d '1 day ago' +%Y%m%d`
ORDER_NO=
OFFSET=
LIMIT= 3000

curl
"https://ecsales-api.a8.net/v3/ins/${PROGRAM_ID}/unsealed?api_key=${API_KEY}&date=${DATE}&order_no=${ORDER_NO}&offset=${OFFSET}&limit=${LIMIT}"

Note

リクエストサンプルコード解説ポイント
・ins/の後にプログラムIDの値を設定します。null及び省略は不可となります。
・api_keyはnull及び省略不可ですので必ず入れてください。
・例では現在日の前日をYYYYMMMDD形式にしてdateパラメータとして設定しています。nullや省略した場合は全件検索となります。
・例ではorder_idは省略しています。
・例ではorder_noはnull値が入っていますので、省略時と同じ全件検索となります。
・例ではoffsetはnull値が入っていますので、省略時と同じくデータを1件目から取得します。
・例ではlimitは3000が入っていますので、1件目から3000件分のデータを取得します。
・URLのプログラムIDの後にunsealedを指定します。

レスポンス結果

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
{
    "status_code": 10000,
    "message": "処理が成功しました。",
    "results": [
        {
            "sales_ymd": "2021/12/28 07:20:05",
            "as_id": "a00000000000",
            "order_id": "150728157995",
            "order_no": "so8100201001‐20211228‐001",
            "decide_flg": 0,
            "order_count": 3,
            "order_money": 300,
            "pay_money": 427,
            "website_name":"テストサイト",
            "items": [
                {
                    "code": "si1‐8100201001‐20211228‐001A",
                    "price": 100,
                    "reward_fair_money": 100,
                    "pay_money": 142,
                    "quantity": 1
                }
                {
                    "code": "si1‐8100201001‐20211228‐001B",
                    "price": 100,
                    "reward_fair_money": 200,
                    "pay_money": 285,
                    "quantity": 2
                }
            ]
        }
    ]
}

未確定件数取得（プログラム指定）/unsealed/count#

  • GET処理となります。
  • 指定したプログラム情報の未確定件数を取得します。確定済みの売上データは含まれません。

リクエストパラメータ#

パラメータ 設定値 形式 必須 備考
PROGRAM_ID プログラムID URL 必須 A8.net より発行されたプログラムID ..../v3/ins/の後ろに設定します。
api_key API認証キー GET 必須 A8.net より発行されるプログラムID に紐づく確定 API 認証キー

レスポンスフィールド#

フィールド 設定値 型 備考
status_code ステータスコード 数値 別途ステータスコード一覧を参照
message メッセージ 文字列
results 取得したリスト 配列
ins_id プログラムID 文字列
count 未確定件数 数値 プログラムIDの未確定件数

サンプルコード#

リクエスト

1
2
3
4
5
6
#!/bin/bash
PROGRAM_ID="s00008100201001"
API_KEY="abcdefghijklmnopqrstuvwxyz1234567890"

curl
"https://ecsales-api.a8.net/v3/ins/${PROGRAM_ID}/unsealed/count?api_key=${API_KEY}"

Note

リクエストサンプルコード解説ポイント
・ins/の後にプログラムIDの値を設定します。null及び省略は不可となります。
・api_keyはnull及び省略不可ですので必ず入れてください。
・URLのプログラムIDの後にunsealed/countを指定します。

レスポンス結果

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
{
    "status_code": 10000,
    "message": "処理が成功しました。",
    "results": [
        {
            "ins_id":"s00008100201001",
            "count":15
        }
    ]
}

未確定件数取得（広告主指定）/unsealed/count#

  • GET処理となります。
  • 広告主配下のプログラム情報毎の未確定件数の一覧を取得します。確定済みの売上データは含まれません。

リクエストパラメータ#

パラメータ 設定値 形式 必須 備考
SP_ID 広告主ID URL 必須 A8.net より発行された広告主ID ..../v3[/sp/の後ろに設定します。
api_key API認証キー JSON 必須 A8.net より発行されるプログラムID に紐づく確定 API 認証キー

レスポンスフィールド#

フィールド 設定値 型 備考
status_code ステータスコード 数値 別途ステータスコード一覧を参照
message メッセージ 文字列
results 取得したリスト 配列
ins_id プログラムID 文字列
count 未確定件数 数値 プログラムIDの未確定件数

レスポンスフィールド#

フィールド 設定値 型 備考
status_code ステータスコード 数値 別途ステータスコード一覧を参照
message メッセージ 文字列

サンプルコード#

リクエスト

1
2
3
4
5
6
#!/bin/bash
SP_ID="s00008100201"
API_KEY="abcdefghijklmnopqrstuvwxyz1234567890"

curl
"https://ecsales-api.a8.net/v3/sp/${SP_ID}/unsealed/count?api_key=${API_KEY}"

Note

リクエストサンプルコード解説ポイント
・sp/の後に広告主IDの値を設定します。null及び省略は不可となります。
・api_keyはnull及び省略不可ですので必ず入れてください。
・URLのプログラムIDの後にunsealed/countを指定します。

レスポンス結果

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
    "status_code": 10000,
    "message": "処理が成功しました。",
    "results": [
        {
            "ins_id":"s00008100201001",
            "count":15
        }
        {
            "ins_id":"s00008100201002",
            "count":14
        }
    ]
}

売上データの修正処理(単一商品)/modify#

  • JSONデータを使用したPOST処理となります。
  • 未確定売上データ1件の売上内容を修正します。
  • 対象の売上に対して異なる種類の商品が複数ある場合は「売上修正(複数商品)」を参照してください。

リクエストパラメータ#

パラメータ 設定値 形式 必須 備考
PROGRAM_ID プログラムID URL 必須 A8.net より発行されたプログラムID
api_key API認証キー JSON 必須 A8.net より発行されるプログラムID に紐づく確定 API 認証キー
order_id オーダーID URL 必須 A8.net より発行される売上データのユニークキー
price 単価 JSON 任意 price か quantity のどちらかは必須
quantity 商品個数 JSON 任意 price か quantity のどちらかは必須
reason_code 修正理由コード JSON 必須 1: 品切れのため
2: 返品のため
3: 追加発注のため
4: 注文金額の変更
5: 単価の変更のため
6: その他

レスポンスフィールド#

フィールド 設定値 型 備考
status_code ステータスコード 数値 別途ステータスコード一覧を参照
message メッセージ 文字列

サンプルコード#

リクエスト

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
#!/bin/bash
PROGRAM_ID="s00008100201001"
API_KEY="abcdefghijklmnopqrstuvwxyz1234567890"
ORDER_ID=150729160161
PRICE=100
QUANTITY=2
REASON=1
JSONREQ="{\"api_key\":\"${API_KEY}\", \"price\":\"${PRICE}\", \"quantity\": \"${QUANTITY}\",\"reason_code\":\"${REASON}\"}"

curl ‐X POST ‐H "Content‐type: application/json" ‐d "${JSONREQ}" "https://ecsales ‐api.a8.net/v3/ins/${PROGRAM_ID}/order/${ORDER_ID}/modify"

Note

リクエストサンプルコード解説ポイント
・ins/の後にプログラムIDの値を設定します。null及び省略は不可となります。
・api_keyはnull及び省略不可ですので必ず入れてください。
・order_idはnull及び省略不可ですので必ず入れてください。
・priceは変更したくない場合は省略してください。null値はエラーとなります。省略する場合はquantityは必ず入れてください。
・quantityは変更したくない場合は省略してください。null値はエラーとなります。省略する場合はpriceは必ず入れてください。
・reason_codeはnull及び省略不可ですので必ず入れてください。
・URL末尾はmodifyになります。

レスポンス結果

1
2
3
4
{
    "status_code": 10000,
    "message": "処理が成功しました。",
}

売上データの修正処理(複数商品)　/modify#

  • JSONデータを使用したPOST処理となります。
  • 未確定売上データ1件に対して商品が複数ある場合の売上内容を修正します。

リクエストパラメータ#

パラメータ 設定値 形式 必須 備考
PROGRAM_ID プログラムID URL 必須 A8.net より発行されたプログラムID
api_key API認証キー JSON 必須 A8.net より発行されるプログラムID に紐づく確定 API 認証キー
order_id オーダーID URL 必須 A8.net より発行される売上データのユニークキー
items 商品リスト JSON 必須 下記パラメータを配列として格納した注文詳細リスト
code 商品コード JSON 必須 御社システムで発行している商品を判別するためのコード
price 単価 JSON 任意 price か quantity のどちらかは必須
quantity 商品個数 JSON 任意 price か quantity のどちらかは必須
reason_code 修正理由コード JSON 必須 1: 品切れのため
2: 返品のため
3: 追加発注のため
4: 注文金額の変更
5: 単価の変更のため
6: その他

レスポンスフィールド#

フィールド 設定値 型 備考
status_code ステータスコード 数値 別途ステータスコード一覧を参照
message メッセージ 文字列

サンプルコード#

リクエスト

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
#!/bin/bash
PROGRAM_ID="s00008100201001"
API_KEY="abcdefghijklmnopqrstuvwxyz1234567890"
ORDER_ID=150729160161
ITEM_CODE=si1‐8100201001‐20211229‐001
PRICE_1=100
QUANTITY_1=2
REASON_1=1
ITEM_CODE=si1‐8100201001‐20211229‐002
PRICE_2=150
QUANTITY_2=0
REASON_2=2

JSONREQ="{\"api_key\":\"${API_KEY}\", \"items\":[
{\"code\": \"${ITEM_CODE_1}\”,\”price\":\"${PRICE_1}\”, \"quantity\":\"${QUANTITY_1}\”, \"reason_code\":\"${REASON_1}\”},
{\"code\": \"${ITEM_CODE_2}\”,\”price\":\"${PRICE_2}\”, \"quantity\":\"${QUANTITY_2}\”, \"reason_code\":\"${REASON_2}\”}
]}"

curl ‐X POST ‐H "Content‐type: application/json" ‐d "${JSONREQ}" "https://ecsales‐api.a8.net/v3/ins/${PROGRAM_ID}/order/${ORDER_ID}/modify"

Note

リクエストサンプルコード解説ポイント
・ins/の後にプログラムIDの値を設定します。null及び省略は不可となります。
・api_keyはnull及び省略不可ですので必ず入れてください。
・order_idはnull及び省略不可ですので必ず入れてください。
・priceは変更したくない場合は省略してください。null値はエラーとなります。省略する場合はquantityは必ず入れてください。
・quantityは変更したくない場合は省略してください。null値はエラーとなります。省略する場合はpriceは必ず入れてください。
・reason_codeはnull及び省略不可ですので必ず入れてください。
・URL末尾はmodifyになります。

レスポンス結果

1
2
3
4
{
    "status_code": 10000,
    "message": "処理が成功しました。",
}

売上データの確定処理/decide#

  • JSONデータを使用したPOST処理となります。
  • 未確定売上データ1件を確定します。

リクエストパラメータ#

パラメータ 設定値 形式 必須 備考
PROGRAM_ID プログラムID URL 必須 A8.net より発行されたプログラムID
api_key API認証キー JSON 必須 A8.net より発行されるプログラムID に紐づく確定 API 認証キー
order_id オーダーID URL 必須 A8.net より発行される売上データのユニークキー

レスポンスフィールド#

フィールド 設定値 型 備考
status_code ステータスコード 数値 別途ステータスコード一覧を参照
message メッセージ 文字列

サンプルコード#

リクエスト

1
2
3
4
5
6
7
#!/bin/bash
PROGRAM_ID="s00008100201001"
API_KEY="abcdefghijklmnopqrstuvwxyz1234567890"
ORDER_ID=150729160161
JSONREQ="{\"api_key\":\"${API_KEY}\"}"

curl ‐X POST ‐H "Content‐type: application/json" ‐d "${JSONREQ}" "https://ecsales‐api.a8.net/v3/ins/${PROGRAM_ID}/order/${ORDER_ID}/decide"

Note

リクエストサンプルコード解説ポイント
・ins/の後にプログラムIDの値を設定します。null及び省略は不可となります。
・api_keyはnull及び省略不可ですので必ず入れてください。
・order_idはnull及び省略不可ですので必ず入れてください。
・URL末尾はdecideになります。

レスポンス結果

1
2
3
4
{
    "status_code": 10000,
    "message": "処理が成功しました。",
}

売上データのキャンセル処理/cancel#

  • JSONデータを使用したPOST処理となります。
  • 未確定売上データ1件をキャンセルします。

リクエストパラメータ#

パラメータ 設定値 形式 必須 備考
PROGRAM_ID プログラムID URL 必須 A8.net より発行されたプログラムID
api_key API認証キー JSON 必須 A8.net より発行されるプログラムID に紐づく確定 API 認証キー
order_id オーダーID URL 必須 A8.net より発行される売上データのユニークキー
reason_code 修正理由コード JSON 必須 1: 品切れのため
2: 返品のため
3: 追加発注のため
4: 注文金額の変更
5: 単価の変更のため
6: その他

レスポンスフィールド#

フィールド 設定値 型 備考
status_code ステータスコード 数値 別途ステータスコード一覧を参照
message メッセージ 文字列

サンプルコード#

リクエスト

1
2
3
4
5
6
7
8
#!/bin/bash
PROGRAM_ID="s00008100201001"
API_KEY="abcdefghijklmnopqrstuvwxyz1234567890"
ORDER_ID=150729160161
REASON=1
JSONREQ="{\"api_key\":\"${API_KEY}\", \"reason_code\":\"${REASON}\"}"

curl ‐X POST ‐H "Content‐type: application/json" ‐d "${JSONREQ}" "https://ecsales‐api.a8.net/v3/ins/${PROGRAM_ID}/order/${ORDER_ID}/cancel"

Note

リクエストサンプルコード解説ポイント
・ins/の後にプログラムIDの値を設定します。null及び省略は不可となります。
・api_keyはnull及び省略不可ですので必ず入れてください。
・order_idはnull及び省略不可ですので必ず入れてください。
・reason_codeはnull及び省略不可ですので必ず入れてください。
・URL末尾はcancelになります。

レスポンス結果

1
2
3
4
{
    "status_code": 10000,
    "message": "処理が成功しました。",
}

当日確定データの取得/sealed/today#

  • GET処理となります。
  • 当日に確定またはキャンセルした売上データを一覧で取得します。
  • 1度に取得できる確定データは 10,000 件となります。10,000 件を超える確定データがある場合には、データ取得開始位置パラメータを変更してください。

リクエストパラメータ#

パラメータ 設定値 形式 必須 備考
PROGRAM_ID プログラムID URL 必須 A8.net より発行されたプログラムID ..../v3/ins/の後ろに設定します。
api_key API認証キー GET 必須 A8.net より発行されるプログラムID に紐づく確定 API 認証キー
order_id オーダーID GET 任意 A8.net より発行される売上データのユニークキー
order_no 注文番号 GET 任意 申込1件毎に御社システムが発行する注文（申込）番号を設定。
offset データ取得開始位置 GET 任意 デフォルト: 0　任意の位置からデータを取得できます。例10001件目から先を取得。
limit データ取得件数指定 GET 任意 デフォルト: 10000　10000件以内の件数を指定できます。

レスポンスフィールド#

フィールド 設定値 型 備考
status_code ステータスコード 数値 別途ステータスコード一覧を参照
message メッセージ 文字列
results 取得したリスト 配列
deide_ymd 確定日 文字列 yyyy/MM/dd HH:MI:SS 形式
sales_ymd 売上発生日 文字列 yyyy/MM/dd HH:MI:SS 形式
as_id メディアID 文字列 A8.netで管理しているメディアID
order_id オーダーID 文字列 A8.net より発行される売上データのユニークキー
order_no 注文番号 文字列 申込1件毎に御社システムが発行している注文（申込）番号
decide_flg 確定フラグ 数値 0=未確定, 1=確定
del_flg キャンセルフラグ 数値 1 : キャンセル = 2 : 金額修正 = 0 : 支払確定
del_reason キャンセル理由 数値 1: 品切れのため
2: 返品のため
3: 空注文のため
4: 偽注文のため
5: 二重注文のため
6: その他
order_count 注文件数 数値
order_money 注文金額 数値
pay_money 成果報酬額 数値
website_name メディアの主サイト名 文字列
items 商品リスト 配列
code 商品コード 文字列 御社システム側で発行している商品を識別するコード
price 商品単価 数値
quantity 商品個数 数値

サンプルコード#

リクエスト

1
2
3
4
5
6
7
8
#!/bin/bash
PROGRAM_ID="s00008100201001"
API_KEY="abcdefghijklmnopqrstuvwxyz1234567890"
ORDER_NO=
OFFSET=
LIMIT= 3000
curl
"https://ecsales-api.a8.net/v3/ins/${PROGRAM_ID}/sealed/today?api_key=${API_KEY}&order_no=${ORDER_NO}&offset=${OFFSET}&limit=${LIMIT}"

Note

リクエストサンプルコード解説ポイント
・ins/の後にプログラムIDの値を設定します。null及び省略は不可となります。
・api_keyはnull及び省略不可ですので必ず入れてください。
・例ではorder_idは省略しています。
・例ではorder_noはnull値が入っていますので、省略時と同じ全件検索となります。
・例ではoffsetはnull値が入っていますので、省略時と同じくデータを1件目から取得します。
・URLのプログラムIDの後にsealed/todayを指定します。

レスポンス結果

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
{                                   
    "status_code": 10000,                               
    "message": "処理が成功しました。",                                
    "results": [                                
        {                           
            "deide_ymd": "2021/12/29 09:24:25",                     
            "sales_ymd": "2021/12/28 07:20:05",                     
            "as_id": "a00000000000",                        
            "order_id": "150728157995",                     
            "order_no": "so8100201001‐20211228‐001",                        
            "decide_flg": 1,                        
            "del_flg":2,                        
            "del_reason":2,                     
            "order_count": 5,                       
            "order_money": 350,                     
            "pay_money": 35,                        
            "website_name":"テストサイト",                        
            "items": [                      
                {                   
                "code": "si1‐8100201001‐20211228‐001",                  
                "price": 50,                    
                "quantity": 3                   
                },                  
                {                   
                "code": "si1‐8100201001‐20211228‐002",                  
                "price": 100,                   
                "quantity": 2                   
                }                   
            ]                       
        }                           
    ]                               
}

当日確定件数取得（プログラム指定）/sealed/today/count#

  • GET処理となります。
  • 指定したプログラム情報毎の当日中に承認作業まで完了した売上件数を取得します。確定済データが対象となります。

リクエストパラメータ#

パラメータ 設定値 形式 必須 備考
PROGRAM_ID プログラムID URL 必須 A8.net より発行されたプログラムID ..../v3/ins/の後ろに設定します。
api_key API認証キー GET 必須 A8.net より発行されるプログラムID に紐づく確定 API 認証キー

レスポンスフィールド#

フィールド 設定値 型 備考
status_code ステータスコード 数値 別途ステータスコード一覧を参照
message メッセージ 文字列
results 取得したリスト 配列
ins_id プログラムID 文字列
count 当日確定件数 数値 該当プログラムの当日確定された件数

サンプルコード#

リクエスト

1
2
3
4
5
6
#!/bin/bash
PROGRAM_ID="s00008100201001"
API_KEY="abcdefghijklmnopqrstuvwxyz1234567890"

curl
"https://ecsales-api.a8.net/v3/ins/${PROGRAM_ID}/sealed/today/count?api_key=${API_KEY}"

Note

リクエストサンプルコード解説ポイント
・ins/の後にプログラムIDの値を設定します。null及び省略は不可となります。
・api_keyはnull及び省略不可ですので必ず入れてください。
・URLのプログラムIDの後にunsealed/countを指定します。

レスポンス結果

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
{                       
    "status_code": 10000,                   
    "message": "処理が成功しました。",                    
    "results": [                    
        {               
            "ins_id":"s00008100201001",         
            "count":15          
        }               
    ]                   
}

当日確定件数取得（広告主指定）　/sealed/today/count#

  • GET処理となります。
  • 広告主配下のプログラム情報毎の当日中に承認作業まで完了した売上件数を取得します。確定済みの売上データが対象です。

リクエストパラメータ#

パラメータ 設定値 形式 必須 備考
SP_ID 広告主ID URL 必須 A8.net より発行された広告主ID ..../v3/sp/の後ろに設定します。
api_key API認証キー GET 必須 A8.net より発行されるプログラムID に紐づく確定 API 認証キー

レスポンスフィールド#

フィールド 設定値 型 備考
status_code ステータスコード 数値 別途ステータスコード一覧を参照
message メッセージ 文字列
results 取得したリスト 配列
ins_id プログラムID 文字列
count 当日確定件数 数値 該当プログラムの当日確定された件数

サンプルコード#

リクエスト

1
2
3
4
5
6
#!/bin/bash
SP_ID="s00008100201"
API_KEY="abcdefghijklmnopqrstuvwxyz1234567890"

curl
"https://ecsales-api.a8.net/v3/sp/${SP_ID}/sealed/today/count?api_key=${API_KEY}"

Note

リクエストサンプルコード解説ポイント
・sp/の後に広告主IDの値を設定します。null及び省略は不可となります。
・api_keyはnull及び省略不可ですので必ず入れてください。
・URLのプログラムIDの後にunsealed/countを指定します。

レスポンス結果

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{                       
    "status_code": 10000,                   
    "message": "処理が成功しました。",                    
    "results": [                    
        {               
            "ins_id":"s00008100201001",         
            "count":15          
        }               
        {               
            "ins_id":"s00008100201002",         
            "count":14          
        }
    ]           
}

確定済みデータの取得/sealed#

  • GET処理となります。
  • 前日(指定日)以前に確定またはキャンセルした確定データを一覧で取得します。
  • 91日以上前に確定またはキャンセルした確定データは取得できません。
  • 指定日なしの場合、昨日以前に該当するすべてのデータを取得します。
  • 1度に取得できる確定データは 10,000 件となります。10,000 件を超える確定データがある場合には、データ取得開始位置パラメータを変更してください。

リクエストパラメータ#

パラメータ 設定値 形式 必須 備考
PROGRAM_ID プログラムID URL 必須 A8.net より発行されたプログラムID ..../v3/ins/の後ろに設定します。
api_key API認証キー GET 必須 A8.net より発行されるプログラムID に紐づく確定 API 認証キー
date 確定日 GET 任意 yyyyMMdd。指定なし：全件取得
order_id オーダーID GET 任意 A8.net より発行される売上データのユニークキー
order_no 注文番号 GET 任意 申込1件毎に御社システムが発行する注文（申込）番号を設定。
offset データ取得開始位置 GET 任意 デフォルト: 0　任意の位置からデータを取得できます。例10001件目から先を取得。
limit データ取得件数指定 GET 任意 デフォルト: 10000　10000件以内の件数を指定できます。

レスポンスフィールド#

　
フィールド 設定値 型 備考
status_code ステータスコード 数値 別途ステータスコード一覧を参照
message メッセージ 文字列
results 取得したリスト 配列
deide_ymd 確定日 文字列 yyyy/MM/dd 形式
sales_ymd 売上発生日 文字列 yyyy/MM/dd 形式
as_id メディアID 文字列 A8.netで管理しているメディアID
order_id オーダーID 文字列 A8.net より発行される売上データのユニークキー
order_no 注文番号 文字列 申込1件毎に御社システムが発行している注文（申込）番号
decide_flg 確定フラグ 数値 0=未確定, 1=確定
order_count 注文件数 数値
order_money 注文金額 数値
pay_money 成果報酬額 数値
website_name メディアの主サイト名 文字列

サンプルコード#

リクエスト

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
#!/bin/bash
PROGRAM_ID="s00008100201001"
API_KEY="abcdefghijklmnopqrstuvwxyz1234567890"
ORDER_ID=
ORDER_NO=
DATE=`date ‐d '1 day ago' +%Y%m%d`
OFFSET=
LIMIT= 3000

curl
"https://ecsales-api.a8.net/v3/ins/${PROGRAM_ID}/sealed?api_key=${API_KEY}&order_id=${ORDER_ID}&date=${DATE}&offset=${OFFSET}&limit=${LIMIT}"

Note

リクエストサンプルコード解説ポイント
・ins/の後にプログラムIDの値を設定します。null及び省略は不可となります。
・api_keyはnull及び省略不可ですので必ず入れてください。
・例ではorder_idはnull値が入っていますので、省略時と同じ全件検索となります。
・例ではorder_noは省略しています。
・例では現在日の前日をYYYYMMMDD形式にしてdateパラメータとして設定しています。nullや省略した場合は全件検索となります。
・例ではoffsetはnull値が入っていますので、省略時と同じくデータを1件目から取得します。
・例ではlimitは3000が入っていますので、1件目から3000件分のデータを取得します。
・URLのプログラムIDの後にsealedを指定します。

レスポンス結果

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
{                               
    "status_code": 10000,                           
    "message": "処理が成功しました。",                            
    "results": [                            
        {                       
            "deide_ymd": "2021/12/29",                  
            "sales_ymd": "2021/12/28",                  
            "as_id": "a00000000000",                    
            "order_id": "150728157995",                 
            "order_no": "so8100201001‐20211228‐001",                    
            "decide_flg": 1,                    
            "order_count": 1,                   
            "order_money": 100,                 
            "pay_money": 10,                    
            "website_name":"テストサイト"                 
        }                       
    ]                           
}

当日確定データの取消処理/revival#

  • JSONデータを使用したPOST処理となります。
  • 当日中に確定またはキャンセルした売上データ1件の確定ステータスを未確定に戻します。
  • 前日以前に確定したデータは取消・変更できません。

リクエストパラメータ#

パラメータ 設定値 形式 必須 備考
PROGRAM_ID プログラムID URL 必須 A8.net より発行されたプログラムID
api_key API認証キー JSON 必須 A8.net より発行されるプログラムID に紐づく確定 API 認証キー
order_id オーダーID URL 必須 A8.net より発行される売上データのユニークキー

レスポンスフィールド#

フィールド 設定値 型 備考
status_code ステータスコード 数値 別途ステータスコード一覧を参照
message メッセージ 文字列

サンプルコード#

リクエスト

1
2
3
4
5
6
7
#!/bin/bash
PROGRAM_ID="s00008100201001"
API_KEY="abcdefghijklmnopqrstuvwxyz1234567890"
ORDER_ID=150729160161
JSONREQ="{\"api_key\":\"${API_KEY}\"}"

curl ‐X POST ‐H "Content‐type: application/json" ‐d "${JSONREQ}" "https://ecsales‐api.a8.net/v3/ins/${PROGRAM_ID}/order/${ORDER_ID}/revival"

Note

リクエストサンプルコード解説ポイント
・ins/の後にプログラムIDの値を設定します。null及び省略は不可となります。
・api_keyはnull及び省略不可ですので必ず入れてください。
・order_idはnull及び省略不可ですので必ず入れてください。
・URL末尾はrevivalになります。

レスポンス結果

1
2
3
4
{                   
    "status_code": 10000,               
    "message": "処理が成功しました。",                
}

ステータスコード一覧#

  • レスポンスフィールドの status_code および message の一覧です。

ステータスコード

コード 内容
10000 処理が成功しました。
10001 プログラム ID の桁数は 15 桁にしてください。
10002 オーダーID の桁数は 12 桁にしてください。
10003 広告主IDの桁数は12桁にしてください。
10004 認証に失敗しました。
10007 該当するオーダーID がありません。 10018 処理中にエラーが発生しました。
10018 処理中にエラーが発生しました。
10023 リクエスト JSON の型式が不正です。
10024 リクエスト URL が不正です。
20000 注文番号は 50 桁以内にしてください。
20001 日時は YYYYMMDD もしくは YYYYMM の形で指定してください。
20002 データ取得開始位置は数値を指定してください。
20003 データ取得件数指定は数値を指定してください。
20004 データ取得開始位置が不正です。正しい値を指定してください。
20005 データ取得件数指定が不正です。正しい値を指定してください。
30102 指定されたオーダーID は確定済みです。
30103 指定されたオーダーID は承認待ち状態です。
30105 データの整合性にエラーがあります。
30106 データの整合性にエラーがあります。
30107 データの整合性にエラーがあります。
30108 データの整合性にエラーがあります。
30109 データの整合性にエラーがあります。
30110 データの整合性にエラーがあります。
30111 データの整合性にエラーがあります。
30112 データの整合性にエラーがあります。
30113 データの整合性にエラーがあります。
30114 データの整合性にエラーがあります。
30115 データの整合性にエラーがあります。
30117 データの整合性にエラーがあります。
30118 DB 更新処理時に異常が発生しました。
30119 キャンセル理由コードを指定してください。
30120 キャンセル理由コードが不正です。
30121 売上金額が0の時はキャンセルを行ってください。
30301 DB 更新処理時に異常が発生しました。
30311 商品リストが抽出できません。
30312 商品リストが配列型ではありません。
30313 商品コードを指定してください。
30314 商品コードが不正です。
30315 商品単価または商品個数を指定してください。
30316 商品単価または商品個数が不正です。
30317 修正理由コードを指定してください。
30318 修正理由コードが不正です。
30322 該当する商品コードがありません。
30323 指定されたオーダーID は確定済みです。
30324 指定されたオーダーID は商品が複数存在します。
30325 1オーダー内で総商品売上金額が 20 億を超えることはできません。
30326 １オーダー内で総商品個数が1万を超えることはできません。
30327 キャンセル個数(修正後の商品個数 - 注文時の商品個数)が1万以上になっています。
9,999以下になるよう商品個数を修正してください。
30328 売上金額または商品個数が不正です。
30401 DB 更新処理時に異常が発生しました。
30411 指定されたオーダーID は未確定です。 30413 指定されたオーダーID は承認待ち状態です
30413 指定されたオーダーID は承認待ち状態です