YSAPI_ORDER (注文に関するAPI)

  1. new：コンストラクタ

  2. orderCount：注文ステータス別件数参照

  3. orderList：注文検索API

  4. orderInfo：注文詳細API

  5. orderStatusChange：注文ステータス変更API

  6. orderPayStatusChange：入金ステータス変更API

  7. orderShipStatusChange：出荷ステータス変更API

  8. orderChange：注文内容変更API

  9. orderChangeHistory：注文操作履歴一覧API

  10. orderSplit：注文分割API

  11. orderItemAdd：注文ライン追加API

  12. orderPayNumber：支払番号発行API

  13. orderCouponCancel：クーポンキャンセルAPI

  14. YSAPI_ORDER_LIST_REQUEST：orderList検索条件モデル

  15. YSAPI_ORDER_LIST_RESPONSE：orderList取得情報モデル

  16. YSAPI_ORDER_INFO_RESPONSE：orderInfo取得情報モデル

  17. YSAPI_ORDER_CHANGE_REQUEST：orderChange更新情報モデル

  18. YSAPI_ORDER_CHANGE_HISTORY_RESPONSE：orderChangeHistory取得情報モデル

  19. YSAPI_ORDER_SPLIT_REQUEST：orderSplit更新情報モデル

  20. YSAPI_ORDER_SPLIT_ITEM：orderSplit分割商品情報モデル

  21. YASPI_ORDER_ITEM_ADD_REQUEST：orderItemAdd加情報モデル

  22. YSAPI_ORDER_ITEM_OPTION：orderItemAdd商品オプション情報モデル

    23. __construct($auth,$seller_id="")

    注文に関するAPIクラスの新規インスタンスを作成します。$api = new YSAPI_ORDER($auth,'seller_id');

    IN/OUT   説明 必須 備考
    in $auth YSAPI_AUTHオブジェクト ※  
    $seller_id ストアアカウントを指定します ※  
    out YSAPI_SELLING YSAPI_SELLINGオブジェクト    

    orderCount()

    注文ステータス別件数参照API$xml = $api->orderCount();

    IN/OUT   説明 必須 備考
    in なし      
    out $xml 実行結果(XMLデータ)    

    orderList($cond, $field="", $start=1, $results=10, $sort="+order_time")

    注文検索API$xml = $api->orderList($cond);

    IN/OUT   説明 必須 備考
    in $cond 検索条件 (YSAPI_ORDER_LIST_REQUEST) ※  
    $field 取得フィールド (string)   省略時は全フィールド
    $start 取得開始件数 (int)   デフォルト : 1
    $results 最大取得件数 (int)   デフォルト : 10
    ※上限値はありません
    $sort ソート順 (string)   デフォルト : +order_time
    昇順:+
    降順:-
    ※指定可能なキー名に関してはYahoo!Developperを参照
    out $xml 実行結果(XMLデータ)    

    orderInfo($orderId, $field="")

    注文詳細API$xml = $api->orderInfo('XXXXXXXXXX');

    IN/OUT   説明 必須 備考
    in $orderId 注文ID (string) ※  
    $field レスポンスに含めるfiledをカンマ区切りにします。(string)   省略時は全フィールド
    ※指定可能なフィールドに関してはYahoo!Developperを参照
    out $xml 実行結果(XMLデータ)    

    orderStatusChange($OrderId, $IsPointFix, $OrderStatus, $CancelReason="", $OperationUser="")

    注文ステータス変更API$xml = $api->orderStatusChange("XXXXXXXXXX", false);

    IN/OUT   説明 必須 備考
    in $OrderId 注文ID (string) ※  
    $IsPointFix ポイント確定要否 (bool) ※ true : ポイント確定します。
    false : ポイント確定しません。
    ※注文ステータスを「完了」に変更する際は、必ずポイント確定要否をtrueに指定してください。
    $OrderStatus 注文ステータス (int) ※ 1 : 予約中
    2 : 処理中
    3 : 保留
    4 : キャンセル
    5 : 完了
    ※注文ステータスを「キャンセル」にするとシステムが自動で注文キャンセルメールを購入者に送信します。
    $CancelReason キャンセル理由 (int) △ 注文ステータスに4を指定した場合必須。
    ■注文者都合
    100:キャンセル
    110:返品
    120:未入金
    130:住所不明
    140:受け取り拒否
    150連絡不通
    160重複注文
    170決済審査不可
    180その他
    ■ストア都合
    200:決済方法都合
    210:欠品
    220:販売中止
    230:その他
    ※nullや指定がない場合は「210」が選択されます
    $OperationUser 更新者名(ビジネスID登録氏名) (string)   ※120文字まで入力可
    out $xml 実行結果(XMLデータ)    

    orderPayStatusChange($OrderId, $PayStatus, $PayDate=null, $OperationUser="")

    入金ステータス変更API $xml = $api->orderPayStatusChange("XXXXXXXXXX", 1);

    IN/OUT   説明 必須 備考
    in $OrderId 注文ID (string) ※  
    $PayStatus 入金ステータス (int) ※ 0 : 入金待ち
    1 : 入金済み
    $PayDate 入金日 (date string)   デフォルト : null
    $OperationUser 更新者名(ビジネスID登録氏名) (string)   ※120文字まで入力可
    out $xml 実行結果(XMLデータ)    

    orderShipStatusChange($OrderId, $IsPointFix, $ShipStatus, $ShipMethod=null, $ShipNotes=null, $ShipInvoiceNumber1=null, $ShipInvoiceNumber2=null, $ShipUrl=null, $ShipDate=null, $ArrivalDate=null, $OperationUser="")

    出荷ステータス変更API$xml = $api->orderShipStatusChange("XXXXXXXXXX",true,1);

    IN/OUT   説明 必須 備考
    in $OrderId 注文ID (string) ※  
    $IsPointFix ポイント確定要否 (bool) ※ true : ポイント確定します。
    false : ポイント確定しません。
    ※注文ステータスを「完了」に変更する際は、必ずポイント確定要否をtrueに指定してください。
    $ShipStatus 出荷ステータス (int) ※ 0 : 出荷不可
    1 : 出荷可
    2 : 出荷処理中
    3 : 出荷完了
    4 : 着荷完了
    $ShipMethod 配送方法 (string)   配送方法：postage1-14,16のどれか1つ（postage15は欠番）ストアクリエイターProの配送設定順
    $ShipNotes 配送メモ (string)   ※最大半角500文字
    $ShipInvoiceNumber1 配送伝票番号1 (string)    
    $ShipInvoiceNumber2 配送伝票番号2 (string)    
    $ShipUrl 配送会社URL (string)   最大半角100文字。&などが含まれる場合はCDATAとする必要があります。
    $ShipDate 出荷日 (date string)    
    $ArrivalDate 着荷日 (date string)    
    $OperationUser 更新者名(ビジネスID登録氏名) (string)   ※120文字まで入力可
    out $xml 実行結果(XMLデータ)    

    orderChange($OrderId, $info, $OperationUser="")

    注文内容変更API$xml = $api->orderChange($info);

    IN/OUT   説明 必須 備考
    in $OrderId 注文ID (string) ※  
    in $info 変更内容 (ORDER_CHANGE_REQUEST) ※  
    $OperationUser 更新者名(ビジネスID登録氏名) (string)   ※120文字まで入力可
    out $xml 実行結果(XMLデータ)    

    orderChangeHistory($orderId)

    注文操作履歴一覧API$xml = $api->orderChangeHistory("XXXXXXXXXX");

    IN/OUT   説明 必須 備考
    in $OrderId 注文ID (string) ※  
    out $xml 実行結果(XMLデータ)    

    orderSplit($OrderId,$OperationUser,$SplitId,$info)

    注文内容変更API$xml = $api->orderSplit("XXXXXXXXXX","○○",1,$info);

    IN/OUT   説明 必須 備考
    in $OrderId 注文ID (string) ※  
    $OperationUser 更新者名(ビジネスID登録氏名) (string) ※ ※120文字まで入力可
    $SplitId 分割ID (int) ※ ※1か2です。
    $info 注文分割情報 (YSAPI_ORDER_SPLIT_REQUEST) ※  
    out $xml 実行結果(XMLデータ)    

    orderItemAdd($OrderId, $IsQuotation, $Lines, $OperationUser="")

    注文内容変更API$xml = $api->orderItemAdd("XXXXXXXXXX",true,$Lines);

    IN/OUT   説明 必須 備考
    in $OrderId 注文ID (string) ※  
    $IsQuotation 商品情報の引用 (bool) ※ true : 商品情報を商品データベースから引用 / false : 手動登録
    /Req/Order/Item/IsQuotation の指定がなければこちらの設定が全商品に適応されます。
    $Lines 追加する商品の配列 ( array() YASPI_ORDER_ITEM_ADD_REQUEST ) ※  
    $OperationUser 更新者名(ビジネスID登録氏名) (string)   ※120文字まで入力可
    out $xml 実行結果(XMLデータ)    

    orderPayNumber($OrderId, $OperationUser="")

    支払番号発行API$xml = $api->orderPayNumber("XXXXXXXXXX");

    IN/OUT   説明 必須 備考
    in $OrderId 注文ID (string) ※  
    $OperationUser 更新者名(ビジネスID登録氏名) (string)   ※120文字まで入力可
    out $xml 実行結果(XMLデータ)    

    orderCouponCancel($OrderId, $OperationUser="")

    クーポンキャンセルAPI$xml = $api->orderCouponCancel("XXXXXXXXXX");

    IN/OUT   説明 必須 備考
    in $OrderId 注文ID (string) ※  
    $OperationUser 更新者名(ビジネスID登録氏名) (string)   ※120文字まで入力可
    out $xml 実行結果(XMLデータ)    

    YSAPI_ORDER_LIST_REQUEST

    orderList検索条件モデル

    プロパティ名 内容 TYPE 備考
    OrderId 注文ID（商品URL） String 50 ^[a-zA-Z0-9-]+$
    ※OrderID、 OrderTime いずれか必須です。
    DeviceType デバイス情報 String 1 どのカートから入ってきたかで定義します。
    1 : PC
    2 : ガラケー
    3 : スマートフォン
    4 : タブレット
    IsActive 注文有効フラグ bool 有効な注文として扱うか判定するフラグです。
    フラグが立っていなければ表示もされません。
    false : 無効注文
    true : 有効注文
    IsSeen 閲覧済みフラグ bool false : 未閲覧
    true : 閲覧済
    IsSplit 分割フラグ bool false : 未分割
    true : 分割済
    IsRoyalty 課金フラグ bool 課金対象かどうかを判定します。例えばテスト注文の場合はfalseを指定します。
    false : 課金対象外
    true : 課金対象
    IsRoyaltyFix 課金確定フラグ bool 課金が確定しているかどうかの判定です。
    false : 課金未確定
    true : 課金確定済
    IsAffiliate アフィリエイトフラグ bool アフィリエイト経由の注文かどうかの判定です。
    false : 非アフィリエイト経由注文
    true : アフィリエイト経由注文
    OrderTime 注文日時 date string 注文確定ボタン押下した日時です。
    Y-M-D H:i:s
    ※OrderID、 OrderTime いずれか必須です。
    OrderTimeFrom 注文日時（From） date string 注文日時のレンジ検索時に指定します。
    Y-M-D H:i:s
    ※OrderIDを指定しない場合、OrderTime、OrderTimeFrom、OrderTimeTo いずれか必須です。
    OrderTimeTo 注文日時（To） date string 注文日時のレンジ検索時に指定します。
    Y-M-D H:i:s
    ※OrderIDを指定しない場合、OrderTime、OrderTimeFrom、OrderTimeTo いずれか必須です。
    ReleaseDateFrom 発売日（From） date string >発売日の期間開始日。特定の日付のみ指定する場合は期間終了日と同じ日を指定します。
    期間開始日のみ指定時は指定日以降全てが対象となります。
    Y-M-D
    ReleaseDateTo 発売日（To） date string 発売日の期間終了日。特定の日付のみ指定する場合は開始日と同じ日を指定します。
    期間終了日のみ指定時は指定日以前全てが対象となります。
    Y-M-D
    Suspect 悪戯フラグ String 1 いたずら対象、非対象、解除済みを判定するフラグです。
    0 : 非悪戯注文
    1 : 悪戯注文
    2 : 悪戯解除済注文
    ※複数マッチはカンマ区切りで指定します。
    OrderStatus 注文ステータス String 1 注文情報の状態を表すステータスです。
    新規注文は注文ステータス「処理中」かつ閲覧済みフラグ「false」で表現されます。
    新規予約は注文ステータス「予約中」かつ閲覧済みフラグ「false」で表現されます。
    1 : 予約中
    2 : 処理中
    3 : 保留
    4 : キャンセル
    5 : 完了
    ※複数マッチはカンマ区切りで指定します。
    ※注文ステータスのリクエストは以下の組み合わせとなります。
    　・『新規予約の検索』　⇒「IsSeen: false 、かつOrderStatus: 1」
    　・『新規注文の検索』　⇒「IsSeen: false 、かつOrderStatus: 2」
    　・『予約の検索』　　　⇒「IsSeen: true 、 かつOrderStatus: 1」
    　・『処理中の検索』　　⇒「IsSeen: true 、 かつOrderStatus: 2」
    　・『保留の検索』　　　⇒「OrderStatus: 3」
    　・『キャンセルの検索』⇒「OrderStatus: 4」
    　・『完了の検索』　　　⇒「OrderStatus: 5」
    　・『処理中と新規注文の検索』　⇒「OrderStatus: 2」
    StoreStatus ストアステータス String 2 ストアが独自に設定可能なステータスです。
    （ステータス名はストアクリエイターProで管理します。）
    数値
    PrintSlipFlag 注文伝票出力有無 bool false : 注文伝票未出力
    true : 注文伝票出力済み
    PrintDeliveryFlag 納品書出力有無 bool false : 納品書未出力
    true : 納品書出力済み
    PrintBillFlag 請求書出力有無 bool false : 請求書未出力
    true : 請求書出力済み
    BuyerCommentsFlag バイヤーコメント有無 bool ご要望欄入力がされている/されていないを表すフラグです
    false : バイヤーコメントなし
    true : バイヤーコメントあり
    PayStatus 入金ステータス String 1 受注、支払時に支払方法毎に注文PFで設定です。
    0 : 未入金
    1 : 入金済
    SettleStatus 決済ステータス String 1 1 : 決済申込
    2 : 支払待ち
    3 : 支払完了
    4 : 入金待ち
    5 : 決済完了
    6 : キャンセル
    7 : 返金
    8 : 有効期限切れ
    9 : 決済申込中
    10 : オーソリエラー
    11 : 売上取消
    12 : Suicaアドレスエラー
    ※複数マッチはカンマ区切りで指定します。
    PayType 支払い分類 String 1 0 : 後払い
    1 : 前払い
    ※複数マッチはカンマ区切りで指定します。
    PayMethod 支払い方法 String 11 payment_決済ID
    payment_a1：クレジットカード決済
    payment_a6：コンビニ決済（セブンイレブン）
    payment_a7：コンビニ決済（その他）
    payment_a8：モバイルSuica決済
    payment_a9：ドコモケータイ払い
    payment_a10：auかんたん決済
    payment_a11：ソフトバンクまとめて支払い
    payment_a15：ペイジー
    payment_a16：Yahoo!マネー/預金払い
    payment_b[1-6]：銀行振込（名称はストアの自由設定）
    payment_c1：ゆうちょ銀行（前払い）
    payment_c2：ゆうちょ銀行（後払い）
    payment_c3：現金書留
    payment_d1：商品代引
    payment_e[1-15]：ストアの自由なお支払い方法名
    payment_z1：ポイント全額払い
    NeedBillSlip 請求書有無 bool キーなし : カートに設定なし
    false : 請求書不要
    true : 請求書必要
    NeedDetailedSlip 明細書有無 bool 伝票画面上では、「納品書」表記です。
    帳票出力でも「納品書」出力で、「明細書」が出力可能です。
    キーなし : カートに設定なし
    false : 明細書不要
    true : 明細書必要
    NeedReceipt 領収書有無 bool キーなし : カートに設定なし
    false : 領袖書不要
    true : 領袖書必要
    BillFirstName ご請求先名前 String 297 297byte(最大)
    BillFirstNameKana ご請求先名前カナ String 297 297byte(最大)
    BillLastName ご請求先名字 String 297 297byte(最大)
    BillLastNameKana ご請求先名字カナ String 297 297byte(最大)
    BillZipCode ご請求先郵便番号 String 10 10byte(最大)
    BillPrefecture ご請求先都道府県 String 12 ご請求先都道府県
    海外の場合「その他」が入ります。
    12byte(最大)
    BillPhoneNumber ご請求先電話番号 String 14 14byte(最大)
    BillMailAddress ご請求先メールアドレス String 99 バイヤーの入力したメールアドレスです。
    Wallet利用の場合でかつ追加メールアドレス欄に入力がある場合は追加メールアドレスを入れます。
    99byte(最大)
    ShipStatus 出荷ステータス String 1 支払方法によって「出荷不可」か「出荷可」とします。注文受付時に判定します。カートからの値はNullです。
    0 : 出荷不可
    1 : 出荷可
    2 : 出荷処理中
    3 : 出荷完了
    4 : 着荷完了
    ShipMethod 配送方法 String 9 お届け方法番号：postage1-14,16のどれか1つ（postage15は欠番）
    ストアクリエイターProの配送設定順。
    ShipRequestDateFrom 配送希望日（From） date string 配送希望日の期間開始日。特定の日付のみ指定する場合は期間終了日と同じ日を指定します。
    期間開始日のみ指定時は指定日以降全てが対象となります。
    Y-M-D
    ShipRequestDateTo 配送希望日（To） date string 配送希望日の期間終了日。特定の日付のみ指定する場合は開始日と同じ日を指定します。
    期間終了日のみ指定時は指定日以前全てが対象となります。
    Y-M-D
    ShipRequestDateNo 配送希望日無し String 1 配送希望日無しの条件を指定します。
    0 : 配送希望日無しを含みます。
    1 : 配送希望日無しを含みません。
    2 : 配送希望無しのみ
    ShipInvoiceNumber 配送伝票番号 String 30 配送伝票番号1/2の両方に対して検索を行います。
    ArriveType きょうつく、あすつく String 1 0 : 通常
    1 : きょうつく注文
    2 : あすつく注文
    ※複数マッチはカンマ区切りで指定します。
    ShipDate 出荷日 date string 注文管理ツールで入力された出荷日です。
    Y-M-D
    ShipDateFrom 出荷日（From） date string 出荷日のレンジ検索時に指定します。
    Y-M-D
    ShipDateTo 出荷日（To） date string 出荷日のレンジ検索時に指定します。
    Y-M-D
    NeedGiftWrap ギフト包装有無 bool キーなし : カートに設定なし
    false : ギフト包装無し
    true : ギフト包装有り
    NeedGiftWrapMessage ギフトメッセージ有無 bool false : ギフトメッセージ無し
    true : ギフトメッセージ有り
    NeedGiftWrapPaper のし有無 bool false : のし無し
    true : のし有り
    キーなし : カートに設定なし
    ShipFirstName お届け先名前 String 297 297byte(最大)
    ShipFirstNameKana お届け先名前カナ String 297 297byte(最大)
    ShipLastName お届け先名字 String 297 297byte(最大)
    ShipLastNameKana お届け先名字カナ String 297 297byte(最大)
    ShipZipCode お届け先郵便番号 String 10 10byte(最大)
    ShipPrefecture お届け先都道府県 String 12 ご請求先都道府県
    海外の場合「その他」が入ります。
    12byte(最大)
    ShipPhoneNumber お届け先電話番号 String 14 14byte(最大)
    IsGetPointFixAll 全付与ポイント確定有無 bool 全Lineの付与ポイントの確定処理が完了したかどうかを示します。
    false : 未確定
    true : 確定済
    ItemId 商品コード String 255 商品コードを指定します。ストアアカウントは含みません。
    255byte(最大)
    Title 商品名 String 255 商品名を指定します。
    255byte(最大)
    SubCode 商品サブコード String 99 商品にサブコードが存在している場合に指定します。
    99byte(最大)
    GetPointFixDateFrom 付与ポイント確定日（From） date string 付与ポイント確定日の期間開始日。特定の日付のみ指定する場合は期間終了日と同じ日を指定します。
    期間開始日のみ指定時は指定日以降全てが対象となります。
    Y-M-D
    GetPointFixDateTo 付与ポイント確定日（To） date string 付与ポイント確定日の期間開始日。特定の日付のみ指定する場合は期間終了日と同じ日を指定します。
    期間開始日のみ指定時は指定日以降全てが対象となります。
    Y-M-D
    IsLogin Yahoo! JAPAN IDログイン有無 bool false : ゲスト
    true : ログイン
    SellerType セラー種別 String 1 1 : セラー
    2 : セラー（個人出店者）
    ※複数マッチはカンマ区切りで指定します。
    IsPayManagement 代金支払い管理注文 bool false : 非代金支払い管理
    true : 代金支払い管理
    ExistMultiReleaseDate 複数発売日あり bool false : 発売日1つ以下
    true : 2つ以上
    ReadOnlyMode 読み取り専用 String 1 0：読み書き可能のみ（初期値）
    1：読み取り専用のみ（キャンセル受付注文のみ）
    2：両方含む

    YSAPI_ORDER_LIST_RESPONSE

    orderList取得情報モデル

    ファンクション名 説明
    __construct($xml) orderListで取得したXMLからorderList取得情報モデルの新規インスタンスを作成します。

    $xml = $api->orderList($cond);
    $orders = array();
    foreach ($xml->Search->OrderInfo as $order) {
    　$orders[] = new YSAPI_ORDER_LIST_RESPONSE($order);
    }

    プロパティ名 内容 TYPE 備考
    OrderId 注文ID String 50 ^[a-zA-Z0-9-]+$
    Version バージョン String 2 カートや注文PF、購入データIFが変わったときにバージョンをあげます。
    OriginalOrderId 受注時注文ID String 50 受注処理した際の注文IDです。
    ex）注文Aを注文B、注文Cに分割
    　　注文Cを注文D、注文Eに分割
    　　注文A、B、C、D、Eすべての受注時注文IDはA
    ^[a-zA-Z0-9-]+$
    ParentOrderId 分割元注文ID String 50 注文分割した際の分割元注文IDです。
    （一番元となる受注時注文IDとは違う場合があります）
    ex）注文Aを注文B、注文Cに分割
    　　注文Cを注文D、注文Eに分割
    　　注文B、Cの分割元注文IDはA
    　　注文D、Eの分割元注文IDはC
    ^[a-zA-Z0-9-]+$
    DeviceType デバイス情報 String 1 どのカートから入ってきたかで定義します。
    1 : PC
    2 : ガラケー
    3 : スマートフォン
    4 : タブレット
    IsSeen 閲覧済みフラグ bool false : 未閲覧
    true : 閲覧済
    IsSplit 分割フラグ bool false : 未分割
    true : 分割済
    IsRoyalty 課金フラグ bool 課金対象かどうかを判定します。例えばテスト注文の場合はfalseを指定します。
    false : 課金対象外
    true : 課金対象
    IsSeller 管理者注文フラグ bool セラーが登録Yahoo!IDで行った注文です。注文管理で表示します。
    false : 非管理者注文
    true : 管理者注文
    IsAffiliate アフィリエイトフラグ bool アフィリエイト経由の注文かどうかの判定です。
    false : 非アフィリエイト経由注文
    true : アフィリエイト経由注文
    IsRatingB2s 評価フラグ（Buyer⇒Seller） bool 購入者がストア評価を実施済みかどうかの判定です。
    false : 未評価
    true : 評価済
    OrderTime 注文日時 date string 注文確定ボタン押下時
    落札時（＝操作日時）
    （例）2012-04-19T16:10:40
    ExistMultiReleaseDate 複数発売日あり bool 発売日が1つも設定されていない場合も「0」です。
    false : 発売日1つのみ
    true : 発売日複数有り
    ReleaseDate 注文（最長）発売日 date string 検索APIの取得項目のみで指定可能です。
    注文の（最長）発売日がセットされます。
    LastUpdateTime 最終更新日時 date string 注文情報の最終更新日時です。
    Suspect 悪戯フラグ String 1 いたずら対象、非対象、解除済みを判定するフラグです。
    0 : 非悪戯注文
    1 : 悪戯注文
    2 : 悪戯解除済注文
    OrderStatus 注文ステータス String 1 注文情報の状態を表すステータスです。
    新規注文は注文ステータス「処理中」かつ閲覧済みフラグ「false」で表現されます。
    新規予約は注文ステータス「予約中」かつ閲覧済みフラグ「false」で表現されます。
    1 : 予約中
    2 : 処理中
    3 : 保留
    4 : キャンセル
    5 : 完了
    StoreStatus ストアステータス String 2 ストアが独自に設定可能なステータスです。
    （ステータス名はストアクリエイターProで管理します。）
    数値
    RoyaltyFixTime 課金確定日時 date string  
    PrintSlipFlag 注文伝票出力有無 bool false : 注文伝票未出力
    true : 注文伝票出力済み
    PrintDeliveryFlag 納品書出力有無 bool false : 納品書未出力
    true : 納品書出力済み
    PrintBillFlag 請求書出力有無 bool false : 請求書未出力
    true : 請求書出力済み
    PayStatus 入金ステータス String 1 受注、支払時に支払方法毎に注文PFで設定です。
    0 : 未入金
    1 : 入金済
    SettleStatus 決済ステータス String 1 1 : 決済申込
    2 : 支払待ち
    3 : 支払完了
    4 : 入金待ち
    5 : 決済完了
    6 : キャンセル
    7 : 返金
    8 : 有効期限切れ
    9 : 決済申込中
    10 : オーソリエラー
    11 : 売上取消
    12 : Suicaアドレスエラー
    PayType 支払い分類 String 1 0 : 後払い
    1 : 前払い
    PayMethod 支払い方法 String 11 payment_決済ID
    payment_a1：クレジットカード決済
    payment_a6：コンビニ決済（セブンイレブン）
    payment_a7：コンビニ決済（その他）
    payment_a8：モバイルSuica決済
    payment_a9：ドコモケータイ払い
    payment_a10：auかんたん決済
    payment_a11：ソフトバンクまとめて支払い
    payment_a15：ペイジー
    payment_a16：Yahoo!マネー/預金払い
    payment_b[1-6]：銀行振込（名称はストアの自由設定）
    payment_c1：ゆうちょ銀行（前払い）
    payment_c2：ゆうちょ銀行（後払い）
    payment_c3：現金書留
    payment_d1：商品代引
    payment_e[1-15]：ストアの自由なお支払い方法名
    payment_z1：ポイント全額払い
    PayDate 入金日 date string 注文管理ツールで入力された入金日です。
    UseWallet ウォレット利用有無 bool 支払にWalletを利用した注文フラグです。
    ※Wallet利用の範囲を定義する必要があります。
    false : Wallet利用無し
    true : Wallet利用有り
    NeedBillSlip 請求書有無 bool キーなし : カートに設定なし
    false : 請求書不要
    true : 請求書必要
    NeedDetailedSlip 明細書有無 bool 伝票画面上では、「納品書」表記です。
    帳票出力でも「納品書」出力で、「明細書」が出力可能です。
    キーなし : カートに設定なし
    false : 明細書不要
    true : 明細書必要
    NeedReceipt 領収書有無 bool キーなし : カートに設定なし
    false : 領袖書不要
    true : 領袖書必要
    BillFirstName ご請求先名前 String 297 297byte(最大)
    BillFirstNameKana ご請求先名前カナ String 297 297byte(最大)
    BillLastName ご請求先名字 String 297 297byte(最大)
    BillLastNameKana ご請求先名字カナ String 297 297byte(最大)
    BillPrefecture ご請求先都道府県 String 12 ご請求先都道府県
    海外の場合「その他」が入ります。
    12byte(最大)
    ShipStatus 出荷ステータス String 1 支払方法によって「出荷不可」か「出荷可」とします。注文受付時に判定します。
    0 : 出荷不可
    1 : 出荷可
    2 : 出荷処理中
    3 : 出荷完了
    4 : 着荷完了
    ShipMethod 配送方法 String 9 お届け方法番号：postage1-14,16のどれか1つ（postage15は欠番）
    ストアクリエイターProの配送設定順。
    ShipRequestDate 配送希望日 date string  
    ShipRequestTime 配送希望時間 string 13 12:00～14:00など
    ShipNotes 配送メモ string 500 注文管理ツールで入力された出荷の配送希望メモ入力内容です。
    ShipInvoiceNumber1 配送伝票番号1 string 30 注文管理ツールでセラーが入力、アップロードした配送会社の配送伝票番号。注文管理ツールの画面上は1と2があります。
    ShipInvoiceNumber2 配送伝票番号2 string 30 注文管理ツールでセラーが入力、アップロードした配送会社の配送伝票番号。注文管理ツールの画面上は1と2があります。
    ArriveType きょうつく、あすつく String 1 0 : 通常
    1 : きょうつく注文
    2 : あすつく注文
    ShipDate 出荷日 date string 注文管理ツールで入力された出荷日です。
    Y-M-D
    NeedGiftWrap ギフト包装有無 bool キーなし : カートに設定なし
    false : ギフト包装無し
    true : ギフト包装有り
    NeedGiftWrapMessage ギフトメッセージ有無 bool false : ギフトメッセージ無し
    true : ギフトメッセージ有り
    NeedGiftWrapPaper のし有無 bool false : のし無し
    true : のし有り
    キーなし : カートに設定なし
    ShipFirstName お届け先名前 String 297 297byte(最大)
    ShipFirstNameKana お届け先名前カナ String 297 297byte(最大)
    ShipLastName お届け先名字 String 297 297byte(最大)
    ShipLastNameKana お届け先名字カナ String 297 297byte(最大)
    ShipZipCode お届け先郵便番号 String 10 10byte(最大)
    ShipPrefecture お届け先都道府県 String 12 ご請求先都道府県
    海外の場合「その他」が入ります。
    12byte(最大)
    PayCharge 手数料 String 10 セラーが設定した手数料（代引き手数料など）、Yahoo!決済の決済手数料は別です。
    ShipCharge 送料 String 10 送料無料クーポン値引き後の金額
    GiftWrapCharge ギフト包装料 String 10  
    Discount 値引き String 10  
    UsePoint 利用ポイント数 String 10  
    TotalPrice 合計金額 String 10 小計 - 利用ポイント + ギフト包装料 + 手数料 - 値引き + 送料
    RefundTotalPrice 返金合計金額 String 10 注文キャンセル後取得可能
    UsePointType 利用ポイント種別 String 1 Y : Yahoo!ポイント
    T : Tポイント
    IsGetPointFixAll 全付与ポイント確定有無 bool 全Lineの付与ポイントが確定処理を完了したかどうかを示します。
    false : 未確定
    true : 確定済
    IsLogin Yahoo! JAPAN IDログイン有無 bool false : ゲスト
    true : ログイン
    PayNo 支払番号 String 20  
    PayNoIssueDate 支払番号発行日時 date string  
    SellerType セラー種別 String 1 1 : セラー
    2 : セラー（個人出店者）
    IsPayManagement 代金支払い管理注文 bool false : 非代金支払い管理
    true : 代金支払い管理
    ShipUrl 配送会社URL String 100  
    ShipMethodName 配送方法名 String 150  
    ArrivalDate 着荷日 date string  
    TotalMallCouponDiscount モールクーポン値引き額 String 10  
    IsReadOnly 読み取り専用 String 1 1：読み取り専用（キャンセル受付注文）
    0：読み書き可能

    YSAPI_ORDER_INFO_RESPONSE

    orderInfo取得情報モデル

    ファンクション名 説明
    __construct($xml) orderInfoで取得したXMLからorderInfo取得情報モデルの新規インスタンスを作成します。

    $xml = $api->orderInfo("XXXXXXXXXX");
    $info = new YSAPI_ORDER_INFO_RESPONSE($xml);

    プロパティ名 内容 TYPE 備考
    OrderId 注文ID（商品URL） String 50 ^[a-zA-Z0-9-]+$
    ※OrderID、 OrderTime いずれか必須です。
    Version バージョン String 2 ショッピングカートや、注文APIのIF仕様のバージョンです。
    OriginalOrderId 受注時注文ID String 50 受注処理した際の注文IDです。
    ex）注文Aを注文B、注文Cに分割
    　　注文Cを注文D、注文Eに分割
    　　注文A、B、C、D、Eすべての受注時注文IDはA
    ^[a-zA-Z0-9-]+$
    ParentOrderId 分割元注文ID String 50 注文分割した際の分割元注文IDです。
    （一番元となる受注時注文IDとは違う場合があります）
    ex）注文Aを注文B、注文Cに分割
    　　注文Cを注文D、注文Eに分割
    　　注文B、Cの分割元注文IDはA
    　　注文D、Eの分割元注文IDはC
    ^[a-zA-Z0-9-]+$
    DeviceType デバイス情報 String 1 1 : PC
    2 : MB
    3 : スマートフォン
    4 : タブレット
    MobileCarrierName 携帯キャリア名 String 8 携帯キャリアの種別です。
    8byte（最大）
    IsSeen 閲覧済みフラグ bool false : 未閲覧
    true : 閲覧済
    IsSplit 分割フラグ bool false : 未分割
    true : 分割済
    CancelReason キャンセル理由 String 3 ■注文者都合
    100:キャンセル
    110:返品
    120:未入金
    130:住所不明
    140:受け取り拒否
    150:連絡不通
    160:重複注文
    170:決済審査不可
    180:その他
    300:間違えて注文した
    310:ポイントを利用し忘れた
    320:クーポンを利用し忘れた
    330:他で安い価格をみつけた
    340:送料が高かった
    350:お届け先を変更したい
    360:配送方法を変更したい
    370:お支払い方法を変更したい
    380:クレジットカードが利用できなかった

    ■ストア都合
    200:決済方法都合
    210:欠品
    220:販売中止
    230:その他

    ■その他
    0：キャンセル理由該当なしシステムキャンセル

    空欄：キャンセルではない注文
    CancelReasonDetail キャンセル理由詳細 String 200 キャンセル理由がストア都合キャンセル「その他（230）」の場合、
    ストアが入力した理由が表記されます。キャンセル理由230以外は空欄となります。
    200文字（最大）
    IsRoyalty ロイヤルティフラグ bool 課金していいかどうかの判定です。 （テスト注文かどうかの判定となります。）
    false : ロイヤルティ対象外
    true : ロイヤルティ対象
    IsRoyaltyFix ロイヤルティ確定フラグ bool 課金が確定しているかどうかの判定です。
    false : ロイヤルティ未確定
    true : ロイヤルティ確定済
    IsSeller 管理者注文フラグ bool ストア自身が自分の店舗で購入テストをおこなう際に設定されます。
    false : 非管理者注文
    true : 管理者注文
    IsAffiliate アフィリエイトフラグ bool アフィリエイト経由の注文かどうかの判定です。
    false : 非アフィリエイト経由注文
    true : アフィリエイト経由注文
    IsRatingB2s 評価フラグ（Buyer⇒Seller） bool 購入者がストア評価を実施済みかどうかの判定です。
    false : 未評価
    true : 評価済
    NeedSnl SNLオプトイン bool ストアニュースレターのオプトインフラグです。
    false：ストアニュースレター不要
    true：ストアニュースレター必要
    OrderTime 注文日時 date string 注文が行われた日時（ショッピングカートにて注文確定ボタンを押下した日時）です。
    （例）2012-04-19T16:10:40（日本標準時）
    LastUpdateTime 最終更新日時 date string 注文情報の最終更新日時です。
    LastUpdateTime 最終更新日時 date string 注文情報の最終更新日時です。
    Suspect いたずらフラグ String 1 いたずら注文の疑いがある注文を判定する情報です。
    0 : 非いたずら注文
    1 : いたずら注文
    2 : いたずら解除済注文
    SuspectMessage いたずらメッセージ String 99 いたずら注文として判定された際のメッセージです。
    99byte（最大）
    OrderStatus 注文ステータス String 1 1 : 予約中
    2 : 処理中
    3 : 保留
    4 : キャンセル
    5 : 完了

    ※閲覧済みフラグとセットで閲覧していない予約中を「新規予約」、閲覧していない処理中を「新規注文」として扱います。
    StoreStatus ストアステータス String 2 ストアが独自に注文情報に設定可能なステータスです。(数値)
    RoyaltyFixTime ロイヤルティ確定日時 date string 課金確定した日時です。
    SendConfirmTime 注文確認メール送信時刻 date string 受注が新規に入った際に送られる注文確認メールの送信日時です。
    SendPayTime 支払完了メール送信時刻 date string 決済時に送られるメール送信日時です。
    PrintSlipTime 注文伝票出力時刻 date string 注文伝票を出力した日時です。
    PrintDeliveryTime 納品書出力時刻 date string 納品書を出力した日時です。
    PrintBillTime 請求書出力時刻 date string 請求書を出力した日時です。
    BuyerComments バイヤーコメント String 99 ご要望欄入力内容です。（お届け情報入力フォームのメッセージフィールドを参考）
    750byte（最大）
    SellerComments セラーコメント String 99 ストアがカートに表示しているコメント文字列です。
    750byte（最大）
    Notes ストア内メモ String 40000 注文管理ツールでストアが入力した時のストア内メモです。
    40000byte（最大）
    OperationUser 更新者 String 60 更新作業を行ったYahoo!JAPANビジネスIDの登録氏名です。
    バッチ等ユーザ操作以外の更新時は“system”となります。
    60byte（最大）
    Referer 参照元URL（リファラー） String 500 ドメイン、検索キーワード等を網羅したリファラー情報です。
    500byte（最大）
    EntryPoint 入力ポイント String 1000 購入者が対象ストアにどこから入ったか、入ったストアページのURLです。
    1000byte（最大）
    HistoryId 履歴ID String 3 注文の更新履歴を管理するIDです。(数値)
    UsageId クーポン利用ID String 10 ※「UsageId」は1注文につき1つ必ず発行されるユニークのIDで、その注文で利用したクーポン情報と紐付いています。
    ただしクーポンIDを扱っているものではありません。
    UseCouponData 使用したクーポン情報 String 10000 その注文で利用したクーポンIDを扱っておりクーポン情報の詳細情報を取得します。
    ※クーポン種別によらずクーポンを利用した注文であれば常にデータが入ります。
    ※\A、\Bは文字列です。
    ※UseCouponDataを分割する際は、\A,\Bを利用して分割する必要があります。
    ※クーポン種別（値引きタイプ）：1: 定額, 2: 定率, 3: 送料無料

    クーポンID\Aクーポン名\Aクーポン種別\Aクーポンカテゴリ\A利用枚数\BクーポンID\Aクーポン名\Aクーポン種別\Aクーポンカテゴリ\A利用枚数
    10000byte（最大）

    TotalCouponDiscount クーポン合計値引き額 String 15 1つの注文に紐づくすべての商品のストアクーポンで値引きされる金額の内、送料以外の値引き合計値となります。
    ※Item.CouponDiscountの合計値と一致します。
    ※TotalCouponDiscountはストアクーポン利用の場合注文時に計算された値が入るのに対してDetail.Discountは注文後にストアクリエイターPro上で値引き欄に入力した値が入ります。
    ShippingCouponFlg 送料無料クーポン利用有無 String 1 送料無料クーポン利用有無です。
    0 : なし
    1 : あり
    ShippingCouponDiscount 送料無料クーポンを適用したときの送料の値引き額 String 10 送料無料クーポンを適用したときの送料の値引き額です。ストアクーポンで値引きされる金額の内、送料のみの値引き合計値となります。
    CampaignPoints 後付与ポイント内訳 String 100 カンマ区切りで後付与ポイント内訳が並びます
    例)100,200,300,400
    IsMultiShip 複数配送注文フラグ bool ※本フィールドは、一部ストア限定機能です
    false : 複数配送注文でない
    true : 複数配送注文）
    MultiShipId 複数配送注文ID String 42 複数配送注文を識別するID
    ※本フィールドは、一部ストア限定機能です
    IsReadOnly 読み取り専用 String 1 0：読み書き可能
    1：読み取り専用（キャンセル受付注文）
    Pay->*** (請求情報)
    PayStatus 入金ステータス String 1 受注、支払時に支払方法毎に設定されます。
    0 : 入金待ち
    1 : 入金済み
    SettleStatus 決済ステータス String 1 1 : 決済申込
    2 : 支払待ち
    3 : 支払完了
    4 : 入金待ち
    5 : 決済完了
    6 : キャンセル
    7 : 返金
    8 : 有効期限切れ
    9 : 決済申込中
    10 : オーソリエラー
    11 : 売上取消
    12 : Suicaアドレスエラー
    PayType 支払い分類 String 1 お支払方法分類です。
    前払い、後払いを判定します。
    0 : 後払い
    1 : 前払い
    PayKind 支払い種別 String 1 お支払い方法の種別です。
    0 : カード
    1 : ネットバンキング
    2 : キャリア決済
    3 : 振込
    4 : 代引
    5 : コンビニ
    6 : 電子マネー
    7 : その他
    PayMethod 支払い方法 String 11 payment_決済ID
    payment_a1：クレジットカード決済
    payment_a6：コンビニ決済（セブンイレブン）
    payment_a7：コンビニ決済（その他）
    payment_a8：モバイルSuica決済
    payment_a9：ドコモケータイ払い
    payment_a10：auかんたん決済
    payment_a11：ソフトバンクまとめて支払い
    payment_a15：ペイジー
    payment_a16：Yahoo!マネー/預金払い
    payment_b[1-6]：銀行振込（名称はストアの自由設定）
    payment_c1：ゆうちょ銀行（前払い）
    payment_c2：ゆうちょ銀行（後払い）
    payment_c3：現金書留
    payment_d1：商品代引
    payment_e[1-15]：ストアの自由なお支払い方法名
    payment_z1：ポイント全額払い
    PayMethodName 支払い方法名称 String 150 お支払方法と別に,Yahoo!決済名称、銀行振込の銀行名、ゆうちょ、などの名称を持ちます。
    SellerHandlingCharge ストア負担決済手数料 String 6 ストア負担の決済手数料です。(数値)
    PayActionTime 支払い日時 date string 購入履歴詳細画面　支払更新日時です。
    PayDate 入金日 date string 注文管理ツールで入力された入金日です。
    PayNotes 入金処理備考 String 1000 注文管理ツールで入力された入金の備考欄の内容です。
    1000byte（最大）
    SettleId 決済ID String 38 決済IDです。
    （英数字ASCII文字）
    英数字ASCII文字
    英文字は小文字
    CardBrand カード種別 String 297 クレジットカードの場合のカードブランド名（VISA等）です。
    ※Yahoo!ウォレット登録のクレジットカード決済時のみ表示します。
    CardNumber クレジットカード番号 String 496 独自加盟店契約のストアのみ利用可能です。暗号化された文字列情報が取得できます。
    CardNumberLast4 カード番号下４けた String 4 クレジットカード下4けたです。（\d{4}）
    CardExpireYear カード有効期限（年） String 4 独自加盟店契約のストアのみ利用可能です。暗号化された文字列情報が取得できます。（YYYY）
    CardExpireMonth カード有効期限（月） String 4 独自加盟店契約のストアのみ利用可能です。暗号化された文字列情報が取得できます。（MM）
    CardPayType カード支払い区分 String 1 1 : 一括払い
    2 : ボーナス一括払い
    3 : リボ払い
    4 : 分割払い
    ※注文完了段階ではありません。
    CardHolderName カード名義人姓名（独自カード用） String 594 独自加盟店契約のストアのみ利用可能です。暗号化された文字列情報が取得できます。
    CardPayCount カード支払回数 String 3 CardPayTypeが分割払いの際の支払い回数です。(数値)
    CardBirthDay カード生年月日 String 8 独自加盟店契約のストアのみ利用可能です。暗号化された文字列情報が取得できます。
    UseYahooCard Yahoo! JAPAN JCBカード利用有無 bool 支払にYahoo! JAPAN JCBカードを利用した注文フラグです。
    ※「Yahoo! JAPANカード」を判定するフラグではありません。
    　また、「Yahoo! JAPANカード」を判定するフラグを返すAPIの提供はありません。
    false : Yahoo! JAPAN JCBカード利用無し
    true : Yahoo! JAPAN JCBカード利用有り
    UseWallet ウォレット利用有無 bool 支払にYahoo!ウォレット登録のクレジットカードを利用した注文フラグです。
    false : Wallet利用無し
    true : Wallet利用有り
    NeedBillSlip 請求書有無 bool 購入者が入力した注文時の請求書希望の有無です。
    キーなし : カートに設定なし
    false : 請求書不要
    true : 請求書必要
    NeedDetailedSlip 明細書有無 bool 購入者が入力した注文時の希望明細書の有無です。
    伝票画面上では、「納品書」表記します。
    帳票出力でも「納品書」出力で、「明細書」が出力可能です。
    キーなし : カートに設定なし
    false : 明細書不要
    true : 明細書必要
    NeedReceipt 領収書有無 bool 購入者が入力した注文時の領収書の有無です。
    キーなし : カートに設定なし
    false : 領袖書不要
    true : 領袖書必要
    AgeConfirmField 年齢確認フィールド名 String 30 年齢確認フィールドにストアが設定したフィールド名です。
    （お届け情報入力フォーム設定のチェックボックスの名前欄を参考）
    AgeConfirmValue 年齢確認入力値 String 3 年齢確認フィールド数値入力がある場合です。
    （カートの年齢確認入力欄を参考）
    AgeConfirmCheck 年齢確認チェック有無 bool 年齢確認チェックボックスがある場合です。
    false : チェック無し
    true : チェック有り
    BillAddressFrom ご請求先住所引用元 String 4 ラジオボタンチェック値です。
    P : UDB自宅住所
    B : UDB勤務先住所
    ship : お届け先と同じ
    O1:その他1
    O2:その他2
    O3:その他3
    O4:その他4
    O : その他で入力
    BillFirstName ご請求先名前 String 297 297byte（最大）
    BillFirstNameKana ご請求先名前カナ String 297 297byte（最大）
    BillLastName ご請求先名字 String 297 297byte（最大）
    BillLastNameKana ご請求先名字カナ String 297 297byte（最大）
    BillZipCode ご請求先郵便番号 String 10 10byte(最大)
    BillPrefecture ご請求先都道府県 String 12 ご請求先都道府県
    海外の場合「その他」が入ります。
    12byte(最大)
    BillPrefectureKana ご請求先都道府県フリガナ String 18 18byte(最大)
    BillCity ご請求先市区郡 String 297 297byte(最大)
    BillCityKana ご請求先市区郡フリガナ String 297 297byte(最大)
    BillAddress1 ご請求先住所1 String 297 297byte(最大)
    BillAddress1Kana ご請求先住所1フリガナ String 297 297byte(最大)
    BillAddress2 ご請求先住所2 String 297 297byte(最大)
    BillAddress2Kana ご請求先住所2フリガナ String 297 297byte(最大)
    BillPhoneNumber ご請求先電話番号 String 14 14byte(最大)
    BillEmgPhoneNumber ご請求先電話番号（緊急） String 14 14byte(最大)
    BillMailAddress ご請求先メールアドレス String 99 購入者の入力したメールアドレスです。Wallet利用の場合でかつ追加メールアドレス欄に入力がある場合は追加メールアドレスを入れます。
    BillSection1Field ご請求先所属1フィールド名 String 297 297byte（最大）
    BillSection1Value ご請求先所属1入力情報 String 297 297byte（最大）
    BillSection2Field ご請求先所属2フィールド名 String 297 297byte（最大）
    BillSection2Value ご請求先所属2入力情報 String 297 297byte（最大）
    PayNo 支払番号 String 20  
    PayNoIssueDate 支払番号発行日時 date string  
    ConfirmNumber 確認番号 String 20  
    PaymentTerm 支払期限日時 date string コンビニ決済、モバイルSuica決済、ペイジー決済での支払い期限です。
    Ship->*** (配送情報)
    ShipStatus 出荷ステータス String 1 支払方法によって「出荷不可」か「出荷可」とします。注文受付時に判定します。
    0 : 出荷不可
    1 : 出荷可
    2 : 出荷処理中
    3 : 出荷完了
    4 : 着荷完了
    ShipMethod 配送方法 String 9 お届け方法番号：postage1-14,16のどれか1つ（postage15は欠番）
    ストアクリエイターProの配送設定順。
    ShipMethodName 配送方法名 String 150 ヤマト運輸など、お届け方法名称です。
    Keyと名称のセットはストア登録内容になります。
    ShipRequestDate 配送希望日 date string  
    ShipRequestTime 配送希望時間 string 13 12:00～14:00など
    ShipNotes 配送メモ string 500 注文管理ツールで入力された出荷の配送希望メモ入力内容です。
    ShipInvoiceNumber1 配送伝票番号1 string 30 ストアがツールやAPIで設定した、配送会社の配送伝票番号情報です。
    ShipInvoiceNumber2 配送伝票番号2 string 30 ストアがツールやAPIで設定した、配送会社の配送伝票番号情報です。
    ShipUrl 配送会社URL String 100 ストアがツールやAPIで設定した、配送会社の追跡URLです。
    ArriveType きょうつく、あすつく String 1 きょうつく注文、あすつく注文の場合設定します。
    0 : 通常
    1 : きょうつく注文
    2 : あすつく注文
    ShipDate 出荷日 date string ツールやAPIで入力された出荷日です。
    ArrivalDate 着荷日 date string ツールやAPIで入力された着荷日です。
    NeedGiftWrap ギフト包装有無 bool キーなし : カートに設定なし
    false : ギフト包装無し
    true : ギフト包装有り
    GiftWrapType ギフト包装種類 String 30  
    GiftWrapMessage ギフトメッセージ String 297 297byte（最大）
    NeedGiftWrapPaper のし有無 bool false : のし無し
    true : のし有り
    キーなし : カートに設定なし
    GiftWrapPaperType のし種類 String 30  
    GiftWrapName 名入れ String 297 名入れ（メッセージ）
    297byte（最大）
    Option1Field オプションフィールドキー情報（フィールド名） String 150 オプションフィールドフィールド名
    Option1Type オプションフィールドキー情報（設定） String 1 キー無し
    0 : テキストボックス（全角10文字まで）
    1 : テキストボックス（全角50文字まで）
    2 : テキストボックス（全角250文字まで）
    3 : プルダウン
    4 : ラジオボタン
    5 : チェックボックス
    Option1Value オプションフィールド入力内容 String 1500 1500byte（最大）
    Option2Field オプションフィールドキー情報（フィールド名） String 150 オプションフィールドフィールド名
    Option2Type オプションフィールドキー情報（設定） String 1 キー無し
    0 : テキストボックス（全角10文字まで）
    1 : テキストボックス（全角50文字まで）
    2 : テキストボックス（全角250文字まで）
    3 : プルダウン
    4 : ラジオボタン
    5 : チェックボックス
    Option2Value オプションフィールド入力内容 String 1500 1500byte（最大）
    ShipFirstName お届け先名前 String 297 297byte(最大)
    ShipFirstNameKana お届け先名前カナ String 297 297byte(最大)
    ShipLastName お届け先名字 String 297 297byte(最大)
    ShipLastNameKana お届け先名字カナ String 297 297byte(最大)
    ShipZipCode お届け先郵便番号 String 10 10byte(最大)
    ShipPrefecture お届け先市区郡 String 12 ご請求先都道府県
    海外の場合「その他」が入ります。
    12byte(最大)
    ShipPrefectureKana お届け先市区郡カナ String 18  
    ShipCity お届け先市区郡 String 297  
    ShipCityKana お届け先市区郡カナ String 297  
    ShipAddress1 お届け先住所1 String 297  
    ShipAddress1Kana お届け先住所1カナ String 297  
    ShipAddress2 お届け先住所2 String 297  
    ShipAddress2Kana お届け先住所2カナ String 297  
    ShipPhoneNumber お届け先電話番号 String 14 14byte(最大)
    ShipEmgPhoneNumber お届け先緊急連絡先 String 14 14byte(最大)
    ShipSection1Field お届け先所属1フィールド名 String 297 297byte（最大）
    ShipSection1Value お届け先所属1入力情報 String 297 297byte（最大）
    ShipSection2Field お届け先所属2フィールド名 String 297 297byte（最大）
    ShipSection2Value お届け先所属2入力情報 String 297 297byte（最大）
    Detai->*** (明細情報)
    PayCharge 手数料 String 10 セラーが設定した手数料（代引き手数料など）、Yahoo!決済の決済手数料は別です。
    ShipCharge 送料 String 10 送料無料クーポン値引き後の金額
    GiftWrapCharge ギフト包装料 String 10  
    Discount 値引き String 10  
    Adjustments 調整額 String 10 ※マイナスの値も許容、その場合は -(10byte) が許容最大
    SettleAmount 決済金額 String 15 合計金額
    ※合計金額(TotalPrice)と同じ値になります。
    UsePoint 利用ポイント数 String 10  
    TotalPrice 合計金額 String 10 小計 - 利用ポイント + ギフト包装料 + 手数料 - 値引き + 送料
    SettlePayAmount 入金金額 String 15 分割後注文には引き継ぎません。
    元注文で確認させます。
    TaxRatio 消費税率 String 3 注文ごとの消費税率です。
    IsGetPointFixAll 全付与ポイント確定有無 bool 全Lineの付与ポイントが確定処理を完了したかどうかを示します。
    false : 未確定
    true : 確定済
    TotalMallCouponDiscount モールクーポン値引き額 String 15 モールクーポンで値引きされる額の合計値を示します。
    Item[]->*** (商品情報)
    LineId 商品ラインID String 2  
    ItemId 商品ID String 228  
    Title 商品名 String 225  
    SubCode 商品サブコード String 99 商品サブコードが設定されている場合のみです。
    SubCodeOption 商品サブコードオプション String 150 商品サブコードオプションが設定されている場合のみです。
    key&value両方
    ItemOption[] 商品オプション Array 商品オプションが設定されている場合のみです。
    ※ItemOptionはInscriptionとあわせて20個までです。
    [Index,Name(オプション項目名 84byte),Value(オプション値 84byte)]の配列
    Inscription[] インスクリプション Array 商品にインスクリプションが設定されている場合のみです。
    ※InscriptionはItemOptionとあわせて20個までです。
    [Index,Name(インスク 84byte),Value(値 84byte)]の配列
    IsUsed 中古フラグ bool false :　中古ではない
    true :　中古
    ImageId 商品画像ID String 160  
    IsTaxable 課税対象 bool false : 課税非対象
    true : 課税対象
    Jan JANコード String 14  
    ProductId 製品コード String 9 品番/型番
    CategoryId プロダクトカテゴリID String 12  
    AffiliateRatio アフィリエイト料率 String 9 ストア負担料率 5.5%、Yahoo!JAPAN負担料率 1%とした場合、5.5_1.0となります。
    （数値）_（数値）
    ストア負担料率_Yahoo!JAPAN負担料率
    2つの数値をアンダースコアつなぎ
    数値部分は 0.0～70.0
    UnitPrice 商品単価 String 10 商品ごとの単価（ストアクーポン値引き後の金額）
    ※値引き後の値となります
    Quantity 数量 String 3 商品ごとの数量です。
    PointAvailQuantity ポイント対象数量 String 3 ポイント付与対象数量
    ReleaseDate 発売日 date string 発売日の入力がある場合のみです。
    発売日＞注文日の場合、予約注文として扱います。
    HaveReview 商品レビュー有無フラグ bool false : レビュー無し
    true : レビュー有り
    PointFspCode 商品別ポイントコード String 5 10001～10015、20001～20010
    PointRatioY 付与ポイント倍率（Yahoo!JAPAN負担） String 2 付与ポイントのYahoo!JAPAN負担倍率。
    Yahoo!JAPANの負担が10倍であれば10が入ります。
    PointRatioSeller 付与ポイント倍率（ストア負担） String 2 付与ポイントのストア負担倍率です。
    ストアが5倍負担であれば5が入ります。
    UnitGetPoint 単位付与ポイント数 String 10 商品1数量の付与ポイント数×数量でLine毎のポイント数
    ポイント倍率をかけた値が入ります。
    IsGetPointFix 付与ポイント確定フラグ bool false : 未確定
    true : 確定済
    GetPointFixDate 付与ポイント確定日 date string 注文日14日後、予約注文は発売日の14日後をセットします。
    CouponData ストアクーポン String 800 ストアクーポンは全ラインに適用されます。
    ※\A、\Bは文字列です。
    ※クーポン種別（クーポンタイプ）：1: 単体商品指定,2: 複数商品指定,3: ストア対象

    クーポンID\Aクーポン名\Aクーポン種別\Aクーポンカテゴリ\A利用枚数\BクーポンID\Aクーポン名\Aクーポン種別\Aクーポンカテゴリ\A利用枚数

    CouponDiscount クーポンの値引き額 String 10  
    CouponUseNum クーポン適用枚数 String 3  
    OriginalPrice 値引き前の単価 String 10  
    OriginalNum ライン分割前の数量 String 3  
    LeadTimeText 発送日テキスト String 50 発送日情報設定とストア休業日出荷設定に基づく発送目安文言
    ※2017/8/9より利用可能
    LeadTimeStart 発送日スタート Date String 発送日情報設定とストア休業日出荷設定に基づく発送日スタート日時
    ※2017/8/9より利用可能
    LeadTimeEnd 発送日エンド Date String 発送日情報設定とストア休業日出荷設定に基づく発送日エンド日時
    ※2017/8/9より利用可能
    Seller->*** (セラー情報)
    SellerId セラーID String 128  
    Buyer->*** (バイヤー情報)
    IsLogin Yahoo! JAPAN IDログイン有無 bool false : ゲスト
    true : ログイン
    FspLicenseCode FSPライセンスコード String 4 スタークラブについての詳細は下記ページをご覧ください。
    http://starclub.yahoo.co.jp/
    ■スタークラブの項目
    「?」 : ゲスト
    「ERR」 : 取得エラー
    「1000」 : ランク外
    「1100」 : レギュラー
    「1200」 : ブロンズ
    「1300」 : シルバー
    「1400」 : ゴールド
    「1500」 : プラチナ
    ■ストアスタンプラリー項目
    項目なし : ゲスト
    「ERR」 : 取得エラー
    「2000」 : なし
    「2100」 : ブロンズ
    「2200」 : シルバー
    「2300」 : ゴールド
    「2400」 : プラチナ
    「2500」 : ダイヤモンド
    FspLicenseName FSPライセンス名 String 15 スタークラブについての詳細は下記ページをご覧ください。
    http://starclub.yahoo.co.jp/
    ■スタークラブの項目
    「?」 : ゲスト
    「ERR」 : 取得エラー
    「ランク外」 : ランク外
    「レギュラー」 : レギュラー
    「ブロンズ」 : ブロンズ
    「シルバー」 : シルバー
    「ゴールド」 : ゴールド
    「プラチナ」 : プラチナ
    ■ストアスタンプラリー項目
    項目なし : ゲスト
    「ERR」 : 取得エラー
    「なし」 : なし
    「ブロンズ」 : ブロンズ
    「シルバー」 : シルバー
    「ゴールド」 : ゴールド
    「プラチナ」 : プラチナ
    「ダイヤモン」 : ダイヤモンド
    GuestAuthId ゲストユニークキー（vwoidc） String 20 ゲスト注文の場合のみです。

    YSAPI_ORDER_CHANGE_REQUEST

    orderChange更新情報モデル

    ファンクション名 説明
    __construct() orderChange更新情報モデルの初期化。

    $order = new YSAPI_ORDER_CHANGE_REQUEST();
    $order->IsSeen = false;
    $result = $api->orderChange("XXXXXXXXXX", $order);

    プロパティ名 内容 TYPE 備考
    IsSeen 閲覧済みフラグ bool false : 未閲覧
    true : 閲覧済
    Suspect 悪戯フラグ String 1 いたずら対象、非対象、解除済みを判定するフラグです。
    0 : 非悪戯注文
    1 : 悪戯注文
    2 : 悪戯解除済注文
    PayType 支払い分類 String 1 お支払方法分類です。
    前払い、後払いを判定します。
    0 : 後払い
    1 : 前払い
    PayKind 支払い種別 String 1 お支払い方法の種別です。
    0 : カード
    1 : ネットバンキング
    2 : キャリア決済
    3 : 振込
    4 : 代引
    5 : コンビニ
    6 : 電子マネー
    7 : その他
    PayMethod 支払い方法 String 11 payment_決済ID
    payment_a1：クレジットカード決済
    payment_a6：コンビニ決済（セブンイレブン）
    payment_a7：コンビニ決済（その他）
    payment_a8：モバイルSuica決済
    payment_a9：ドコモケータイ払い
    payment_a10：auかんたん決済
    payment_a11：ソフトバンクまとめて支払い
    payment_a15：ペイジー
    payment_a16：Yahoo!マネー/預金払い
    payment_b[1-6]：銀行振込（名称はストアの自由設定）
    payment_c1：ゆうちょ銀行（前払い）
    payment_c2：ゆうちょ銀行（後払い）
    payment_c3：現金書留
    payment_d1：商品代引
    payment_e[1-15]：ストアの自由なお支払い方法名
    payment_z1：ポイント全額払い
    PayMethodName 支払い方法名称 String 150 お支払方法と別に,Yahoo!決済名称、銀行振込の銀行名、ゆうちょ、などの名称を持ちます。
    StoreStatus ストアステータス String 2 ストアが独自に注文情報に設定可能なステータスです。(数値)
    PrintSlipTime 注文伝票出力時刻 date string 注文伝票を出力した日時です。
    PrintDeliveryTime 納品書出力時刻 date string 納品書を出力した日時です。
    PrintBillTime 請求書出力時刻 date string 請求書を出力した日時です。
    BuyerComments バイヤーコメント String 99 ご要望欄入力内容です。（お届け情報入力フォームのメッセージフィールドを参考）
    750byte（最大）
    SellerComments セラーコメント String 99 ストアがカートに表示しているコメント文字列です。
    750byte（最大）
    Notes ストア内メモ String 40000 注文管理ツールでストアが入力した時のストア内メモです。
    40000byte（最大）
    RefundStatus 返金ステータス String 1 返金の要不要や返金の状態を表す区分です。
    0：不要
    1：必要
    2：返金済み
    APIで更新できるのは1：必要から2：返金済みへの更新のみ。
    PayDate 入金日 date string 注文管理ツールで入力された入金日です。
    PayNotes 入金処理備考 String 1000 注文管理ツールで入力された入金の備考欄の内容です。
    1000byte（最大）
    PayManageLimitDate 代金支払い管理注文期限日時 date string  
    NeedBillSlip 請求書有無 bool キーなし : カートに設定なし
    false : 請求書不要
    true : 請求書必要
    NeedDetailedSlip 明細書有無 bool 伝票画面上では、「納品書」表記です。
    帳票出力でも「納品書」出力で、「明細書」が出力可能です。
    キーなし : カートに設定なし
    false : 明細書不要
    true : 明細書必要
    NeedReceipt 領収書有無 bool キーなし : カートに設定なし
    false : 領袖書不要
    true : 領袖書必要
    BillFirstName ご請求先名前 String 297 297byte(最大)
    BillFirstNameKana ご請求先名前カナ String 297 297byte(最大)
    BillLastName ご請求先名字 String 297 297byte(最大)
    BillLastNameKana ご請求先名字カナ String 297 297byte(最大)
    BillZipCode ご請求先郵便番号 String 10 10byte(最大)
    BillPrefecture ご請求先都道府県 String 12 ご請求先都道府県
    海外の場合「その他」が入ります。
    12byte(最大)
    BillPrefectureKana ご請求先都道府県フリガナ String 18 18byte(最大)
    BillCity ご請求先市区郡 String 297 297byte(最大)
    BillCityKana ご請求先市区郡フリガナ String 297 297byte(最大)
    BillAddressFrom ご請求先住所引用元 String 4 ラジオボタンチェック値です。
    P : UDB自宅住所
    B : UDB勤務先住所
    ship : お届け先と同じ
    O1:その他1
    O2:その他2
    O3:その他3
    O4:その他4
    O : その他で入力
    BillAddress1 ご請求先住所1 String 297 297byte(最大)
    BillAddress1Kana ご請求先住所1フリガナ String 297 297byte(最大)
    BillAddress2 ご請求先住所2 String 297 297byte(最大)
    BillAddress2Kana ご請求先住所2フリガナ String 297 297byte(最大)
    BillPhoneNumber ご請求先電話番号 String 14 14byte(最大)
    BillEmgPhoneNumber ご請求先電話番号（緊急） String 14 14byte(最大)
    BillMailAddress ご請求先メールアドレス String 99 購入者の入力したメールアドレスです。Wallet利用の場合でかつ追加メールアドレス欄に入力がある場合は追加メールアドレスを入れます。
    BillSection1Field ご請求先所属1フィールド名 String 297 297byte（最大）
    BillSection1Value ご請求先所属1入力情報 String 297 297byte（最大）
    BillSection2Field ご請求先所属2フィールド名 String 297 297byte（最大）
    BillSection2Value ご請求先所属2入力情報 String 297 297byte（最大）
    ShipMethod 配送方法 String 9 お届け方法番号：postage1-14,16のどれか1つ（postage15は欠番）
    ストアクリエイターProの配送設定順。
    ShipMethodName 配送方法名 String 150 ヤマト運輸など、お届け方法名称です。
    Keyと名称のセットはストア登録内容になります。
    ShipRequestDate 配送希望日 date string  
    ShipRequestTime 配送希望時間 string 13 12:00～14:00など
    ShipNotes 配送メモ string 500 注文管理ツールで入力された出荷の配送希望メモ入力内容です。
    ShipInvoiceNumber1 配送伝票番号1 string 30 ストアがツールやAPIで設定した、配送会社の配送伝票番号情報です。
    ShipInvoiceNumber2 配送伝票番号2 string 30 ストアがツールやAPIで設定した、配送会社の配送伝票番号情報です。
    ShipUrl 配送会社URL String 100 ストアがツールやAPIで設定した、配送会社の追跡URLです。
    ArriveType きょうつく、あすつく String 1 きょうつく注文、あすつく注文の場合設定します。
    0 : 通常
    1 : きょうつく注文
    2 : あすつく注文
    ShipDate 出荷日 date string ツールやAPIで入力された出荷日です。
    ArrivalDate 着荷日 date string ツールやAPIで入力された着荷日です。
    NeedGiftWrap ギフト包装有無 bool キーなし : カートに設定なし
    false : ギフト包装無し
    true : ギフト包装有り
    GiftWrapType ギフト包装種類 String 30  
    GiftWrapMessage ギフトメッセージ String 297 297byte（最大）
    NeedGiftWrapPaper のし有無 bool false : のし無し
    true : のし有り
    キーなし : カートに設定なし
    GiftWrapPaperType のし種類 String 30  
    GiftWrapName 名入れ String 297 名入れ（メッセージ）
    297byte（最大）
    ShipFirstName お届け先名前 String 297 297byte(最大)
    ShipFirstNameKana お届け先名前カナ String 297 297byte(最大)
    ShipLastName お届け先名字 String 297 297byte(最大)
    ShipLastNameKana お届け先名字カナ String 297 297byte(最大)
    ShipZipCode お届け先郵便番号 String 10 10byte(最大)
    ShipPrefecture お届け先市区郡 String 12 ご請求先都道府県
    海外の場合「その他」が入ります。
    12byte(最大)
    ShipPrefectureKana お届け先市区郡カナ String 18  
    ShipCity お届け先市区郡 String 297  
    ShipCityKana お届け先市区郡カナ String 297  
    ShipAddress1 お届け先住所1 String 297  
    ShipAddress1Kana お届け先住所1カナ String 297  
    ShipAddress2 お届け先住所2 String 297  
    ShipAddress2Kana お届け先住所2カナ String 297  
    ShipPhoneNumber お届け先電話番号 String 14 14byte(最大)
    ShipEmgPhoneNumber お届け先緊急連絡先 String 14 14byte(最大)
    ShipSection1Field お届け先所属1フィールド名 String 297 297byte（最大）
    ShipSection1Value お届け先所属1入力情報 String 297 297byte（最大）
    ShipSection2Field お届け先所属2フィールド名 String 297 297byte（最大）
    ShipSection2Value お届け先所属2入力情報 String 297 297byte（最大）
    PayCharge 手数料 String 10 セラーが設定した手数料（代引き手数料など）、Yahoo!決済の決済手数料は別です。
    ShipCharge 送料 String 10 送料無料クーポン値引き後の金額
    GiftWrapCharge ギフト包装料 String 10  
    Discount 値引き String 10  
    Adjustments 調整額 String 10 ※マイナスの値も許容、その場合は -(10byte) が許容最大
    Item[]->*** (商品情報)
    LineId 商品ラインID String 2  
    Quantity 数量 String 3 商品ごとの数量です。
    ReleaseDate 発売日 date string 発売日の入力がある場合のみです。
    発売日＞注文日の場合、予約注文として扱います。

    YSAPI_ORDER_CHANGE_HISTORY_RESPONSE

    orderChangeHistory取得情報モデル

    ファンクション名 説明
    __construct($xml) orderChangeHistoryで取得したXMLからorderChangeHistoryの新規インスタンスを作成します。

    $xml = $api->orderChangeHistory("XXXXXXXXXX");
    $histories = array();
    foreach ($xml->History as $history) {
    　$histories[] = new YSAPI_ORDER_CHANGE_HISTORY_RESPONSE($history);
    }

    プロパティ名 内容 TYPE 備考
    HistoryId 履歴ID String  
    UpdateTime 更新日時 Date String  
    UpdatePerson 更新者 String （以下のいずれかが入ります）
    Yahoo! JAPAN ビジネスIDに紐づく作業者氏名
    Yahoo! JAPAN ビジネスID
    Yahoo! JAPAN ID
    system
    ※システム更新については自動連動などによる更新内容なども含みます。
    Change->***
    Field 変更フィールド String  
    Value 変更内容 String ※個人情報に関してのValueは空です。
    Change->Item->***
    LineId ラインID String  
    Field 変更フィールド String  
    Value 変更内容 String ※個人情報に関してのValueは空です。

    YSAPI_ORDER_SPLIT_REQUEST

    orderSplit更新情報モデル

    ファンクション名 説明
    __construct() orderSplit更新情報モデルの初期化。

    $order= new YSAPI_ORDER_SPLIT_REQUEST();
    $result = $api->orderSplit("XXXXXXXXXX", "", 1, $order);

    プロパティ名 内容 TYPE 備考
    PayCharge 手数料 int  
    ShipCharge 送料 int  
    GiftWrapCharge ギフト包装料 int  
    Discount 値引き int  
    UsePoint 利用ポイント int  
    Item 商品 array( YSAPI_ORDER_SPLIT_ITEM )  

    YSAPI_ORDER_SPLIT_ITEM

    orderSplit分割商品情報モデル

    ファンクション名 説明
    __construct() orderSplit分割商品情報モデルの初期化。

    $item= new YSAPI_ORDER_SPLIT_ITEM();

    プロパティ名 内容 TYPE 備考
    LineId 商品ラインID int  
    Quantity 数量 int  

    YASPI_ORDER_ITEM_ADD_REQUEST

    orderItemAdd加情報モデル

    ファンクション名 説明
    __construct() orderItemAdd加情報モデルの初期化。

    $item= new YASPI_ORDER_ITEM_ADD_REQUEST();

    プロパティ名 内容 TYPE 備考
    LineId 商品ラインID int ※必須
    ラインIDは1注文に紐づく商品数を連番（初期値1）で振ったものです。追加する商品に対してラインIDの最大数+1を指定してください。
    ItemId 商品ID String ※必須
    Title 商品名 String ※IsQuotationがfalse（商品データベースからの引用なし）の場合必須です。
    IsQuotation 商品情報の引用 bool true:商品情報を商品データベースから引用
    false:手動登録
    ※こちらの設定がある場合、/Req/Target/IsQuotation よりも優先されます。
    SubCode 商品サブコード String  
    ItemOption 商品オプション array( YSAPI_ORDER_ITEM_OPTION )  
    Inscription インスクリプション array( YSAPI_ORDER_ITEM_OPTION )  
    UnitPrice 商品単価（税抜き） int ※IsQuotationがfalse（商品データベースからの引用なし）の場合必須です。
    Quantity 数量 int ※必須

    YSAPI_ORDER_ITEM_OPTION

    orderItemAdd商品オプション情報モデル

    ファンクション名 説明
    __construct() orderItemAdd商品オプション情報モデルの初期化。

    $item= new YSAPI_ORDER_ITEM_OPTION();

    プロパティ名 内容 TYPE 備考
    Index 商品オプション・インスクリプションの表示順 int ※必須
    Name 商品オプション・インスクリプションの項目名 String ※必須
    Value 商品オプション・インスクリプションの値 String ※必須

2017/10/19