當前位置: 首頁>>編程示例 >>用法及示例精選 >>正文


PHP WHMCS UpdateQuote用法及代碼示例

更新現有引號

請求參數

參數 類型 說明 必需的
action string “UpdateQuote” Required
quoteid int 要更新的引號的 ID Required
subject string 引號的主題 Optional
stage string 引號的當前階段(“草稿”、“已交付”、“暫停”、“已接受”、“丟失”、“死亡”) Optional
validuntil string 引號的有效日期,直到本地化格式(例如 DD/MM/YYYY) Optional
datecreated string 以本地化格式創建引號的日期(例如 DD/MM/YYYY) Optional
lineitems array 一個 base64 編碼的序列化數組,包含以下鍵: Optional
lineitems[x][id] int 對於 $lineitems。現有訂單項的 ID。省略換行 Optional
lineitems[x][desc] string 對於 $lineitems。行項目的說明 Optional
lineitems[x][qty] int 對於 $lineitems。引號的行項目的數量 Optional
lineitems[x][up] float 對於 $lineitems。行項目的單價 Optional
lineitems[x][discount] float 對於 $lineitems。為行項目提供的折扣數量 Optional
lineitems[x][taxable] bool 對於 $lineitems。行項目是否應納稅 Optional
userid int 如果引號是針對現有客戶的,則引號所針對的客戶 ID Optional
firstname string 如果沒有 $userid,則引用的客戶的名字 Optional
lastname string 如果沒有 $userid,則引用的客戶的姓氏 Optional
companyname string 如果沒有 $userid,則引號所針對的客戶公司 Optional
email string 如果沒有 $userid,引號所針對的客戶的電子郵件地址 Optional
address1 string 如果沒有 $userid,則引用的客戶地址 1 Optional
address2 string 如果沒有 $userid,則引用的客戶地址 2 Optional
city string 如果沒有 $userid,則引號所針對的客戶所在城市 Optional
state string 如果沒有 $userid,則引用的客戶端狀態 Optional
country string 如果沒有 $userid,則引號所針對的客戶所在的國家/地區 Optional
phonenumber string 客戶的電話號碼(無國家代碼),如果沒有 $userid 則引號。本地格式,例如 4035551234 Optional
tax_id string 客戶的稅號 Optional
currency int 如果沒有 $userid,則引號的貨幣 id Optional
proposal string 向最終用戶顯示的提案文本 Optional
customernotes string 顯示給最終用戶的引號注釋 Optional
adminnotes string 引號單上的注釋僅向員工顯示 Optional

響應參數

參數 類型 說明
result string 操作結果:成功或錯誤

示例請求 (CURL)

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://www.example.com/includes/api.php');
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS,
    http_build_query(
        array(
            'action' => 'UpdateQuote',
            // See https://developers.whmcs.com/api/authentication
            'username' => 'IDENTIFIER_OR_ADMIN_USERNAME',
            'password' => 'SECRET_OR_HASHED_PASSWORD',
            'subject' => 'Test Quote Subject',
            'stage' => 'Draft',
            'lineitems' => base64_encode(serialize(array(array("id"=>1,"desc"=>"Test Description 1","qty"=>1,"up"=>"10.00","discount"=>"10.00",
"taxable"=>true),array("desc"=>"Test Description 2","qty"=>4,"up"=>"15.00","discount"=>"0.00",
"taxable"=>false)))),
            'responsetype' => 'json',
        )
    )
);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$response = curl_exec($ch);
curl_close($ch);

示例請求(本地 API)

$command = 'UpdateQuote';
$postData = array(
    'subject' => 'Test Quote Subject',
    'stage' => 'Draft',
    'lineitems' => base64_encode(serialize(array(array("id"=>1,"desc"=>"Test Description 1","qty"=>1,"up"=>"10.00","discount"=>"10.00",
"taxable"=>true),array("desc"=>"Test Description 2","qty"=>4,"up"=>"15.00","discount"=>"0.00",
"taxable"=>false)))),
);
$adminUsername = 'ADMIN_USERNAME'; // Optional for WHMCS 7.2 and later

$results = localAPI($command, $postData, $adminUsername);
print_r($results);

示例響應 JSON

{
    "result": "success"
}

錯誤響應

可能的錯誤條件響應包括:

  • 未找到引號 ID
  • 無效階段

相關用法


注:本文由純淨天空篩選整理自whmcs.com大神的英文原創作品 UpdateQuote。非經特殊聲明,原始代碼版權歸原作者所有,本譯文未經允許或授權,請勿轉載或複製。