Added: new response fields in Orders API

Peardian · Peardian · commit 82e1c425d477 · 2014-05-09T15:08:45.000-04:00
diff --git a/includes/classes/AmazonOrder.php b/includes/classes/AmazonOrder.php
@@ -219,6 +219,18 @@ protected function parseXML($xml){
         if (isset($xml->ShipServiceLevelCategory)){
             $d['ShipServiceLevelCategory'] = (string)$xml->ShipServiceLevelCategory;
         }
+        if (isset($xml->CbaDisplayableShippingLabel)){
+            $d['CbaDisplayableShippingLabel'] = (string)$xml->CbaDisplayableShippingLabel;
+        }
+        if (isset($xml->ShippedByAmazonTFM)){
+            $d['ShippedByAmazonTFM'] = (string)$xml->ShippedByAmazonTFM;
+        }
+        if (isset($xml->TFMShipmentStatus)){
+            $d['TFMShipmentStatus'] = (string)$xml->TFMShipmentStatus;
+        }
+        if (isset($xml->OrderType)){
+            $d['OrderType'] = (string)$xml->OrderType;
+        }
         if (isset($xml->EarliestShipDate)){
             $d['EarliestShipDate'] = (string)$xml->EarliestShipDate;
         }
@@ -592,6 +604,78 @@ public function getShipServiceLevelCategory(){
         }
     }
     
+    /**
+     * Returns the customized Checkout by Amazon (CBA) label of the Order.
+     * 
+     * This method will return <b>FALSE</b> if the CBA label category has not been set yet.
+     * @return string|boolean single value, or <b>FALSE</b> if label not set yet
+     */
+    public function getCbaDisplayableShippingLabel(){
+        if (isset($this->data['CbaDisplayableShippingLabel'])){
+            return $this->data['CbaDisplayableShippingLabel'];
+        } else {
+            return false;
+        }
+    }
+    
+    /**
+     * Returns an indication of whether or not the Order was shipped with the Amazon TFM service.
+     * 
+     * This method will return <b>FALSE</b> if the status has not been set yet.
+     * @return string|boolean single value, or <b>FALSE</b> if value not set yet
+     */
+    public function getShippedByAmazonTfm(){
+        if (isset($this->data['ShippedByAmazonTFM'])){
+            return $this->data['ShippedByAmazonTFM'];
+        } else {
+            return false;
+        }
+    }
+    
+    /**
+     * Returns the status of an Order shipped using Amazon TFM.
+     * 
+     * This method will return <b>FALSE</b> if the status has not been set yet.
+     * Valid values for the status are...
+     * <ul>
+     * <li>PendingPickUp</li>
+     * <li>LabelCanceled</li>
+     * <li>PickedUp</li>
+     * <li>AtDestinationFC</li>
+     * <li>Delivered</li>
+     * <li>RejectedByBuyer</li>
+     * <li>Undeliverable</li>
+     * <li>ReturnedToSeller</li>
+     * </ul>
+     * @return string|boolean single value, or <b>FALSE</b> if status not set yet
+     */
+    public function getTfmShipmentStatus(){
+        if (isset($this->data['TFMShipmentStatus'])){
+            return $this->data['TFMShipmentStatus'];
+        } else {
+            return false;
+        }
+    }
+    
+    /**
+     * Returns the type of the order.
+     * 
+     * This method will return <b>FALSE</b> if the type has not been set yet.
+     * Valid values for the type are...
+     * <ul>
+     * <li>StandardOrder</li>
+     * <li>Preorder</li>
+     * </ul>
+     * @return string|boolean single value, or <b>FALSE</b> if order type not set yet
+     */
+    public function getOrderType(){
+        if (isset($this->data['OrderType'])){
+            return $this->data['OrderType'];
+        } else {
+            return false;
+        }
+    }
+    
     /**
      * Returns the timestamp of the earliest shipping date.
      * 
diff --git a/includes/classes/AmazonOrderItemList.php b/includes/classes/AmazonOrderItemList.php
@@ -253,6 +253,35 @@ protected function parseXML($xml){
                     $i++;
                 }
             }
+            if (isset($item->InvoiceData)){
+                if (isset($item->InvoiceData->InvoiceRequirement)){
+                    $this->itemList[$n]['InvoiceData']['InvoiceRequirement'] = (string)$item->InvoiceData->InvoiceRequirement;
+                }
+                if (isset($item->InvoiceData->BuyerSelectedInvoiceCategory)){
+                    $this->itemList[$n]['InvoiceData']['BuyerSelectedInvoiceCategory'] = (string)$item->InvoiceData->BuyerSelectedInvoiceCategory;
+                }
+                if (isset($item->InvoiceData->InvoiceTitle)){
+                    $this->itemList[$n]['InvoiceData']['InvoiceTitle'] = (string)$item->InvoiceData->InvoiceTitle;
+                }
+                if (isset($item->InvoiceData->InvoiceInformation)){
+                    $this->itemList[$n]['InvoiceData']['InvoiceInformation'] = (string)$item->InvoiceData->InvoiceInformation;
+                }
+            }
+            if (isset($item->ConditionId)){
+                $this->itemList[$n]['ConditionId'] = (string)$item->ConditionId;
+            }
+            if (isset($item->ConditionSubtypeId)){
+                $this->itemList[$n]['ConditionSubtypeId'] = (string)$item->ConditionSubtypeId;
+            }
+            if (isset($item->ConditionNote)){
+                $this->itemList[$n]['ConditionNote'] = (string)$item->ConditionNote;
+            }
+            if (isset($item->ScheduledDeliveryStartDate)){
+                $this->itemList[$n]['ScheduledDeliveryStartDate'] = (string)$item->ScheduledDeliveryStartDate;
+            }
+            if (isset($item->ScheduledDeliveryEndDate)){
+                $this->itemList[$n]['ScheduledDeliveryEndDate'] = (string)$item->ScheduledDeliveryEndDate;
+            }
             $this->index++;
         }
             
@@ -608,7 +637,7 @@ public function getPromotionDiscount($i = 0, $only = false){
     }
     
     /**
-     * Returns specified promotion ID for specified item.
+     * Returns specified promotion ID for the specified item.
      * 
      * This method will return the entire list of Promotion IDs if <i>$j</i> is not set.
      * @param int $i [optional] <p>List index to retrieve the value from. Defaults to 0.</p>
@@ -625,7 +654,129 @@ public function getPromotionIds($i = 0, $j = null){
         } else {
             return false;
         }
-        
+    }
+    
+    /**
+     * Returns invoice data for the specified item.
+     * 
+     * This method will return <b>FALSE</b> if the list has not yet been filled.
+     * The array for invoice data may have the following fields:
+     * <ul>
+     * <li><b>InvoiceRequirement</b> - invoice requirement information</li>
+     * <li><b>BuyerSelectedInvoiceCategory</b> - invoice category information selected by the buyer</li>
+     * <li><b>InvoiceTitle</b> - the title of the invoice as specified by the buyer</li>
+     * <li><b>InvoiceInformation</b> - additional invoice information</li>
+     * </ul>
+     * @param int $i [optional] <p>List index to retrieve the value from. Defaults to 0.</p>
+     * @return array|boolean array, or <b>FALSE</b> if incorrect index
+     */
+    public function getInvoiceData($i = 0){
+        if (isset($this->itemList[$i]['InvoiceData'])){
+            return $this->itemList[$i]['InvoiceData'];
+        } else {
+            return false;
+        }
+    }
+    
+    /**
+     * Returns the condition for the specified item.
+     * 
+     * This method will return <b>FALSE</b> if the list has not yet been filled.
+     * Possible values for the condition ID are...
+     * <ul>
+     * <li>New</li>
+     * <li>Used</li>
+     * <li>Collectible</li>
+     * <li>Refurbished</li>
+     * <li>Preorder</li>
+     * <li>Club</li>
+     * </ul>
+     * @param int $i [optional] <p>List index to retrieve the value from. Defaults to 0.</p>
+     * @return string|boolean single value, or <b>FALSE</b> if incorrect index
+     */
+    public function getConditionId($i = 0){
+        if (isset($this->itemList[$i]['ConditionId'])){
+            return $this->itemList[$i]['ConditionId'];
+        } else {
+            return false;
+        }
+    }
+    
+    /**
+     * Returns the subcondition for the specified item.
+     * 
+     * This method will return <b>FALSE</b> if the list has not yet been filled.
+     * Possible values for the subcondition ID are...
+     * <ul>
+     * <li>New</li>
+     * <li>Mint</li>
+     * <li>Very Good</li>
+     * <li>Good</li>
+     * <li>Acceptable</li>
+     * <li>Poor</li>
+     * <li>Club</li>
+     * <li>OEM</li>
+     * <li>Warranty</li>
+     * <li>Refurbished Warranty</li>
+     * <li>Refurbished</li>
+     * <li>Open Box</li>
+     * <li>Any</li>
+     * <li>Other</li>
+     * </ul>
+     * @param int $i [optional] <p>List index to retrieve the value from. Defaults to 0.</p>
+     * @return string|boolean single value, or <b>FALSE</b> if incorrect index
+     */
+    public function getConditionSubtypeId($i = 0){
+        if (isset($this->itemList[$i]['ConditionSubtypeId'])){
+            return $this->itemList[$i]['ConditionSubtypeId'];
+        } else {
+            return false;
+        }
+    }
+    
+    /**
+     * Returns the condition description for the specified item.
+     * 
+     * This method will return <b>FALSE</b> if the list has not yet been filled.
+     * @param int $i [optional] <p>List index to retrieve the value from. Defaults to 0.</p>
+     * @return string|boolean single value, or <b>FALSE</b> if incorrect index
+     */
+    public function getConditionNote($i = 0){
+        if (isset($this->itemList[$i]['ConditionNote'])){
+            return $this->itemList[$i]['ConditionNote'];
+        } else {
+            return false;
+        }
+    }
+    
+    /**
+     * Returns the earliest date in the scheduled delivery window for the specified item.
+     * 
+     * This method will return <b>FALSE</b> if the list has not yet been filled.
+     * @param int $i [optional] <p>List index to retrieve the value from. Defaults to 0.</p>
+     * @return string|boolean single value, or <b>FALSE</b> if incorrect index
+     */
+    public function getScheduledDeliveryStartDate($i = 0){
+        if (isset($this->itemList[$i]['ScheduledDeliveryStartDate'])){
+            return $this->itemList[$i]['ScheduledDeliveryStartDate'];
+        } else {
+            return false;
+        }
+    }
+    
+    /**
+     * Returns the latest date in the scheduled delivery window for the specified item.
+     * 
+     * This method will return <b>FALSE</b> if the list has not yet been filled.
+     * @param int $i [optional] <p>List index to retrieve the value from. Defaults to 0.</p>
+     * @return string|boolean single value, or <b>FALSE</b> if incorrect index
+     */
+    public function getScheduledDeliveryEndDate($i = 0){
+        if (isset($this->itemList[$i]['ScheduledDeliveryEndDate'])){
+            return $this->itemList[$i]['ScheduledDeliveryEndDate'];
+        } else {
+            return false;
+        }
     }
     
     /**
