* GET /orders//notes * * @since 2.1 * @param array $routes * @return array */ public function register_routes( $routes ) { # GET|POST /orders $routes[ $this->base ] = array( array( array( $this, 'get_orders' ), WC_API_Server::READABLE ), array( array( $this, 'create_order' ), WC_API_Server::CREATABLE | WC_API_Server::ACCEPT_DATA ), ); # GET /orders/count $routes[ $this->base . '/count'] = array( array( array( $this, 'get_orders_count' ), WC_API_Server::READABLE ), ); # GET|PUT|DELETE /orders/ $routes[ $this->base . '/(?P\d+)' ] = array( array( array( $this, 'get_order' ), WC_API_Server::READABLE ), array( array( $this, 'edit_order' ), WC_API_Server::EDITABLE | WC_API_Server::ACCEPT_DATA ), array( array( $this, 'delete_order' ), WC_API_Server::DELETABLE ), ); # GET|POST /orders//notes $routes[ $this->base . '/(?P\d+)/notes' ] = array( array( array( $this, 'get_order_notes' ), WC_API_Server::READABLE ), array( array( $this, 'create_order_note' ), WC_API_SERVER::CREATABLE | WC_API_Server::ACCEPT_DATA ), ); # GET|PUT|DELETE /orders//notes/ $routes[ $this->base . '/(?P\d+)/notes/(?P\d+)' ] = array( array( array( $this, 'get_order_note' ), WC_API_Server::READABLE ), array( array( $this, 'edit_order_note' ), WC_API_SERVER::EDITABLE | WC_API_Server::ACCEPT_DATA ), array( array( $this, 'delete_order_note' ), WC_API_SERVER::DELETABLE ), ); # GET|POST /orders//refunds $routes[ $this->base . '/(?P\d+)/refunds' ] = array( array( array( $this, 'get_order_refunds' ), WC_API_Server::READABLE ), array( array( $this, 'create_order_refund' ), WC_API_SERVER::CREATABLE | WC_API_Server::ACCEPT_DATA ), ); # GET|PUT|DELETE /orders//refunds/ $routes[ $this->base . '/(?P\d+)/refunds/(?P\d+)' ] = array( array( array( $this, 'get_order_refund' ), WC_API_Server::READABLE ), array( array( $this, 'edit_order_refund' ), WC_API_SERVER::EDITABLE | WC_API_Server::ACCEPT_DATA ), array( array( $this, 'delete_order_refund' ), WC_API_SERVER::DELETABLE ), ); return $routes; } /** * Get all orders * * @since 2.1 * @param string $fields * @param array $filter * @param string $status * @param int $page * @return array */ public function get_orders( $fields = null, $filter = array(), $status = null, $page = 1 ) { if ( ! empty( $status ) ) $filter['status'] = $status; $filter['page'] = $page; $query = $this->query_orders( $filter ); $orders = array(); foreach( $query->posts as $order_id ) { if ( ! $this->is_readable( $order_id ) ) continue; $orders[] = current( $this->get_order( $order_id, $fields ) ); } $this->server->add_pagination_headers( $query ); return array( 'orders' => $orders ); } /** * Get the order for the given ID * * @since 2.1 * @param int $id the order ID * @param array $fields * @return array */ public function get_order( $id, $fields = null ) { // ensure order ID is valid & user has permission to read $id = $this->validate_request( $id, 'shop_order', 'read' ); if ( is_wp_error( $id ) ) return $id; $order = wc_get_order( $id ); $order_post = get_post( $id ); $order_data = array( 'id' => $order->id, 'order_number' => $order->get_order_number(), 'created_at' => $this->server->format_datetime( $order_post->post_date_gmt ), 'updated_at' => $this->server->format_datetime( $order_post->post_modified_gmt ), 'completed_at' => $this->server->format_datetime( $order->completed_date, true ), 'status' => $order->get_status(), 'currency' => $order->get_order_currency(), 'total' => wc_format_decimal( $order->get_total(), 2 ), 'subtotal' => wc_format_decimal( $order->get_subtotal( $order ), 2 ), 'total_line_items_quantity' => $order->get_item_count(), 'total_tax' => wc_format_decimal( $order->get_total_tax(), 2 ), 'total_shipping' => wc_format_decimal( $order->get_total_shipping(), 2 ), 'cart_tax' => wc_format_decimal( $order->get_cart_tax(), 2 ), 'shipping_tax' => wc_format_decimal( $order->get_shipping_tax(), 2 ), 'total_discount' => wc_format_decimal( $order->get_total_discount(), 2 ), 'cart_discount' => wc_format_decimal( $order->get_cart_discount(), 2 ), 'order_discount' => wc_format_decimal( $order->get_order_discount(), 2 ), 'shipping_methods' => $order->get_shipping_method(), 'payment_details' => array( 'method_id' => $order->payment_method, 'method_title' => $order->payment_method_title, 'paid' => isset( $order->paid_date ), ), 'billing_address' => array( 'first_name' => $order->billing_first_name, 'last_name' => $order->billing_last_name, 'company' => $order->billing_company, 'address_1' => $order->billing_address_1, 'address_2' => $order->billing_address_2, 'city' => $order->billing_city, 'state' => $order->billing_state, 'postcode' => $order->billing_postcode, 'country' => $order->billing_country, 'email' => $order->billing_email, 'phone' => $order->billing_phone, ), 'shipping_address' => array( 'first_name' => $order->shipping_first_name, 'last_name' => $order->shipping_last_name, 'company' => $order->shipping_company, 'address_1' => $order->shipping_address_1, 'address_2' => $order->shipping_address_2, 'city' => $order->shipping_city, 'state' => $order->shipping_state, 'postcode' => $order->shipping_postcode, 'country' => $order->shipping_country, ), 'note' => $order->customer_note, 'customer_ip' => $order->customer_ip_address, 'customer_user_agent' => $order->customer_user_agent, 'customer_id' => $order->customer_user, 'view_order_url' => $order->get_view_order_url(), 'line_items' => array(), 'shipping_lines' => array(), 'tax_lines' => array(), 'fee_lines' => array(), 'coupon_lines' => array(), ); // add line items foreach( $order->get_items() as $item_id => $item ) { $product = $order->get_product_from_item( $item ); $meta = new WC_Order_Item_Meta( $item['item_meta'], $product ); $item_meta = array(); foreach ( $meta->get_formatted() as $meta_key => $formatted_meta ) { $item_meta[] = array( 'key' => $meta_key, 'label' => $formatted_meta['label'], 'value' => $formatted_meta['value'], ); } $order_data['line_items'][] = array( 'id' => $item_id, 'subtotal' => wc_format_decimal( $order->get_line_subtotal( $item ), 2 ), 'subtotal_tax' => wc_format_decimal( $item['line_subtotal_tax'], 2 ), 'total' => wc_format_decimal( $order->get_line_total( $item ), 2 ), 'total_tax' => wc_format_decimal( $order->get_line_tax( $item ), 2 ), 'price' => wc_format_decimal( $order->get_item_total( $item ), 2 ), 'quantity' => (int) $item['qty'], 'tax_class' => ( ! empty( $item['tax_class'] ) ) ? $item['tax_class'] : null, 'name' => $item['name'], 'product_id' => ( isset( $product->variation_id ) ) ? $product->variation_id : $product->id, 'sku' => is_object( $product ) ? $product->get_sku() : null, 'meta' => $item_meta, ); } // add shipping foreach ( $order->get_shipping_methods() as $shipping_item_id => $shipping_item ) { $order_data['shipping_lines'][] = array( 'id' => $shipping_item_id, 'method_id' => $shipping_item['method_id'], 'method_title' => $shipping_item['name'], 'total' => wc_format_decimal( $shipping_item['cost'], 2 ), ); } // add taxes foreach ( $order->get_tax_totals() as $tax_code => $tax ) { $order_data['tax_lines'][] = array( 'id' => $tax->id, 'rate_id' => $tax->rate_id, 'code' => $tax_code, 'title' => $tax->label, 'total' => wc_format_decimal( $tax->amount, 2 ), 'compound' => (bool) $tax->is_compound, ); } // add fees foreach ( $order->get_fees() as $fee_item_id => $fee_item ) { $order_data['fee_lines'][] = array( 'id' => $fee_item_id, 'title' => $fee_item['name'], 'tax_class' => ( ! empty( $fee_item['tax_class'] ) ) ? $fee_item['tax_class'] : null, 'total' => wc_format_decimal( $order->get_line_total( $fee_item ), 2 ), 'total_tax' => wc_format_decimal( $order->get_line_tax( $fee_item ), 2 ), ); } // add coupons foreach ( $order->get_items( 'coupon' ) as $coupon_item_id => $coupon_item ) { $order_data['coupon_lines'][] = array( 'id' => $coupon_item_id, 'code' => $coupon_item['name'], 'amount' => wc_format_decimal( $coupon_item['discount_amount'], 2 ), ); } return array( 'order' => apply_filters( 'woocommerce_api_order_response', $order_data, $order, $fields, $this->server ) ); } /** * Get the total number of orders * * @since 2.1 * @param string $status * @param array $filter * @return array */ public function get_orders_count( $status = null, $filter = array() ) { if ( ! empty( $status ) ) $filter['status'] = $status; $query = $this->query_orders( $filter ); if ( ! current_user_can( 'read_private_shop_orders' ) ) return new WP_Error( 'woocommerce_api_user_cannot_read_orders_count', __( 'You do not have permission to read the orders count', 'woocommerce' ), array( 'status' => 401 ) ); return array( 'count' => (int) $query->found_posts ); } /** * Create an order * * @since 2.2 * @param array $data raw order data * @return array */ public function create_order( $data ) { $data = isset( $data['order'] ) ? $data['order'] : array(); try { // permission check if ( ! current_user_can( 'publish_shop_orders' ) ) { throw new WC_API_Exception( 'woocommerce_api_user_cannot_create_order', __( 'You do not have permission to create orders', 'woocommerce' ), 401 ); } $data = apply_filters( 'woocommerce_api_create_order_data', $data, $this ); // default order args, note that status is checked for validity in wc_create_order() $default_order_args = array( 'status' => isset( $data['status'] ) ? $data['status'] : '', 'customer_note' => isset( $data['customer_note'] ) ? $data['customer_note'] : null, ); // if creating order for existing customer if ( ! empty( $data['customer_id'] ) ) { // make sure customer exists if ( false === get_user_by( 'id', $data['customer_id'] ) ) { throw new WC_API_Exception( 'woocommerce_api_invalid_customer_id', __( 'Customer ID is invalid', 'woocommerce' ), 400 ); } $default_order_args['customer_id'] = $data['customer_id']; } // create the pending order $order = wc_create_order( $default_order_args ); if ( is_wp_error( $order ) ) { throw new WC_API_Exception( 'woocommerce_api_cannot_create_order', sprintf( __( 'Cannot create order: %s', 'woocommerce' ), implode( ', ', $order->get_error_messages() ) ), 400 ); } // billing/shipping addresses $this->set_order_addresses( $order, $data ); $lines = array( 'line_item' => 'line_items', 'shipping' => 'shipping_lines', 'fee' => 'fee_lines', 'coupon' => 'coupon_lines', ); foreach ( $lines as $line_type => $line ) { if ( isset( $data[ $line ] ) && is_array( $data[ $line ] ) ) { $set_item = "set_{$line_type}"; foreach ( $data[ $line ] as $item ) { $this->$set_item( $order, $item, 'create' ); } } } // calculate totals and set them $order->calculate_totals(); // payment method (and payment_complete() if `paid` == true) if ( isset( $data['payment_details'] ) && is_array( $data['payment_details'] ) ) { // method ID & title are required if ( empty( $data['payment_details']['method_id'] ) || empty( $data['payment_details']['method_title'] ) ) { throw new WC_API_Exception( 'woocommerce_invalid_payment_details', __( 'Payment method ID and title are required', 'woocommerce' ), 400 ); } update_post_meta( $order->id, '_payment_method', $data['payment_details']['method_id'] ); update_post_meta( $order->id, '_payment_method_title', $data['payment_details']['method_title'] ); // mark as paid if set if ( isset( $data['payment_details']['paid'] ) && 'true' === $data['payment_details']['paid'] ) { $order->payment_complete( isset( $data['payment_details']['transaction_id'] ) ? $data['payment_details']['transaction_id'] : '' ); } } // set order currency if ( isset( $data['currency'] ) ) { if ( ! array_key_exists( $data['currency'], get_woocommerce_currencies() ) ) { throw new WC_API_Exception( 'woocommerce_invalid_order_currency', __( 'Provided order currency is invalid', 'woocommerce'), 400 ); } update_post_meta( $order->id, '_order_currency', $data['currency'] ); } // set order number if ( isset( $data['order_number'] ) ) { update_post_meta( $order->id, '_order_number', $data['order_number'] ); } // TODO: should we allow clients to set meta? // HTTP 201 Created $this->server->send_status( 201 ); wc_delete_shop_order_transients( $order->id ); do_action( 'woocommerce_api_create_order', $order->id, $this ); return $this->get_order( $order->id ); } catch ( WC_API_Exception $e ) { return new WP_Error( $e->getErrorCode(), $e->getMessage(), array( 'status' => $e->getCode() ) ); } } /** * Edit an order * * @since 2.2 * @param int $id the order ID * @param array $data * @return array */ public function edit_order( $id, $data ) { $data = isset( $data['order'] ) ? $data['order'] : array(); try { $update_totals = false; $id = $this->validate_request( $id, 'shop_order', 'edit' ); if ( is_wp_error( $id ) ) { return $id; } $data = apply_filters( 'woocommerce_api_edit_order_data', $data, $id, $this ); $order = wc_get_order( $id ); $order_args = array( 'order_id' => $order->id ); // customer note if ( isset( $data['customer_note'] ) ) { $order_args['customer_note'] = $data['customer_note']; } // order status if ( ! empty( $data['status'] ) ) { $order->update_status( $data['status'], isset( $data['status_note'] ) ? $data['status_note'] : '' ); } // customer ID if ( isset( $data['customer_id'] ) && $data['customer_id'] != $order->get_user_id() ) { // make sure customer exists if ( false === get_user_by( 'id', $data['customer_id'] ) ) { throw new WC_API_Exception( 'woocommerce_api_invalid_customer_id', __( 'Customer ID is invalid', 'woocommerce' ), 400 ); } update_post_meta( $order->id, '_customer_user', $data['customer_id'] ); } // billing/shipping address $this->set_order_addresses( $order, $data ); $lines = array( 'line_item' => 'line_items', 'shipping' => 'shipping_lines', 'fee' => 'fee_lines', 'coupon' => 'coupon_lines', ); foreach ( $lines as $line_type => $line ) { if ( isset( $data[ $line ] ) && is_array( $data[ $line ] ) ) { $update_totals = true; foreach ( $data[ $line ] as $item ) { // item ID is always required if ( ! array_key_exists( 'id', $item ) ) { throw new WC_API_Exception( 'woocommerce_invalid_item_id', __( 'Order item ID is required', 'woocommerce' ), 400 ); } // create item if ( is_null( $item['id'] ) ) { $this->set_item( $order, $line_type, $item, 'create' ); } elseif ( $this->item_is_null( $item, $line_type ) ) { // delete item wc_delete_order_item( $item['id'] ); } else { // update item $this->set_item( $order, $line_type, $item, 'update' ); } } } } // payment method (and payment_complete() if `paid` == true and order needs payment) if ( isset( $data['payment_details'] ) && is_array( $data['payment_details'] ) ) { // method ID if ( isset( $data['payment_details']['method_id'] ) ) { update_post_meta( $order->id, '_payment_method', $data['payment_details']['method_id'] ); } // method title if ( isset( $data['payment_details']['method_title'] ) ) { update_post_meta( $order->id, '_payment_method_title', $data['payment_details']['method_title'] ); } // mark as paid if set if ( $order->needs_payment() && isset( $data['payment_details']['paid'] ) && 'true' === $data['payment_details']['paid'] ) { $order->payment_complete( isset( $data['payment_details']['transaction_id'] ) ? $data['payment_details']['transaction_id'] : '' ); } } // set order currency if ( isset( $data['currency'] ) ) { if ( ! array_key_exists( $data['currency'], get_woocommerce_currencies() ) ) { throw new WC_API_Exception( 'woocommerce_invalid_order_currency', __( 'Provided order currency is invalid', 'woocommerce' ), 400 ); } update_post_meta( $order->id, '_order_currency', $data['currency'] ); } // set order number if ( isset( $data['order_number'] ) ) { update_post_meta( $order->id, '_order_number', $data['order_number'] ); } // if items have changed, recalculate order totals if ( $update_totals ) { $order->calculate_totals(); } // update the order post to set customer note/modified date wc_update_order( $order_args ); wc_delete_shop_order_transients( $order->id ); do_action( 'woocommerce_api_edit_order', $order->id, $this ); return $this->get_order( $id ); } catch ( WC_API_Exception $e ) { return new WP_Error( $e->getErrorCode(), $e->getMessage(), array( 'status' => $e->getCode() ) ); } } /** * Delete an order * * @param int $id the order ID * @param bool $force true to permanently delete order, false to move to trash * @return array */ public function delete_order( $id, $force = false ) { $id = $this->validate_request( $id, 'shop_order', 'delete' ); if ( is_wp_error( $id ) ) { return $id; } wc_delete_shop_order_transients( $id ); do_action( 'woocommerce_api_delete_order', $id, $this ); return $this->delete( $id, 'order', ( 'true' === $force ) ); } /** * Helper method to get order post objects * * @since 2.1 * @param array $args request arguments for filtering query * @return WP_Query */ private function query_orders( $args ) { // set base query arguments $query_args = array( 'fields' => 'ids', 'post_type' => 'shop_order', 'post_status' => array_keys( wc_get_order_statuses() ) ); // add status argument if ( ! empty( $args['status'] ) ) { $statuses = 'wc-' . str_replace( ',', ',wc-', $args['status'] ); $statuses = explode( ',', $statuses ); $query_args['post_status'] = $statuses; unset( $args['status'] ); } $query_args = $this->merge_query_args( $query_args, $args ); return new WP_Query( $query_args ); } /** * Helper method to set/update the billing & shipping addresses for * an order * * @since 2.1 * @param \WC_Order $order * @param array $data */ private function set_order_addresses( $order, $data ) { $address_fields = array( 'first_name', 'last_name', 'company', 'email', 'phone', 'address_1', 'address_2', 'city', 'state', 'postcode', 'country', ); $billing_address = $shipping_address = array(); // billing address if ( isset( $data['billing_address'] ) && is_array( $data['billing_address'] ) ) { foreach ( $address_fields as $field ) { if ( isset( $data['billing_address'][ $field ] ) ) { $billing_address[ $field ] = wc_clean( $data['billing_address'][ $field ] ); } } unset( $address_fields['email'] ); unset( $address_fields['phone'] ); } // shipping address if ( isset( $data['shipping_address'] ) && is_array( $data['shipping_address'] ) ) { foreach ( $address_fields as $field ) { if ( isset( $data['shipping_address'][ $field ] ) ) { $shipping_address[ $field ] = wc_clean( $data['shipping_address'][ $field ] ); } } } $order->set_address( $billing_address, 'billing' ); $order->set_address( $shipping_address, 'shipping' ); // update user meta if ( $order->get_user_id() ) { foreach( $billing_address as $key => $value ) { update_user_meta( $order->get_user_id(), 'billing_' . $key, $value ); } foreach( $shipping_address as $key => $value ) { update_user_meta( $order->get_user_id(), 'shipping_' . $key, $value ); } } } /** * Helper method to check if the resource ID associated with the provided item is null * * Items can be deleted by setting the resource ID to null * * @since 2.2 * @param array $item item provided in the request body * @return bool true if the item resource ID is null, false otherwise */ private function item_is_null( $item ) { $keys = array( 'product_id', 'method_id', 'title', 'code' ); foreach ( $keys as $key ) { if ( array_key_exists( $key, $item ) && is_null( $item[ $key ] ) ) { return true; } } return false; } /** * Wrapper method to create/update order items * * When updating, the item ID provided is checked to ensure it is associated * with the order. * * @since 2.2 * @param \WC_Order $order order * @param string $item_type * @param array $item item provided in the request body * @param string $action either 'create' or 'update' * @throws WC_API_Exception if item ID is not associated with order */ private function set_item( $order, $item_type, $item, $action ) { global $wpdb; $set_method = "set_{$item_type}"; // verify provided line item ID is associated with order if ( 'update' === $action ) { $result = $wpdb->get_row( $wpdb->prepare( "SELECT * FROM {$wpdb->prefix}woocommerce_order_items WHERE order_item_id = %d AND order_id = %d", absint( $item['id'] ), absint( $order->id ) ) ); if ( is_null( $result ) ) { throw new WC_API_Exception( 'woocommerce_invalid_item_id', __( 'Order item ID provided is not associated with order', 'woocommerce' ), 400 ); } } $this->$set_method( $order, $item, $action ); } /** * Create or update a line item * * @since 2.2 * @param \WC_Order $order * @param array $item line item data * @param string $action 'create' to add line item or 'update' to update it * @throws WC_API_Exception invalid data, server error */ private function set_line_item( $order, $item, $action ) { $creating = ( 'create' === $action ); // product is always required if ( ! isset( $item['product_id'] ) ) { throw new WC_API_Exception( 'woocommerce_api_invalid_product_id', __( 'Product ID is required', 'woocommerce' ), 400 ); } // when updating, ensure product ID provided matches if ( 'update' === $action ) { $item_product_id = wc_get_order_item_meta( $item['id'], '_product_id' ); $item_variation_id = wc_get_order_item_meta( $item['id'], '_variation_id' ); if ( $item['product_id'] != $item_product_id && $item['product_id'] != $item_variation_id ) { throw new WC_API_Exception( 'woocommerce_api_invalid_product_id', __( 'Product ID provided does not match this line item', 'woocommerce' ), 400 ); } } $product = wc_get_product( $item['product_id'] ); // must be a valid WC_Product if ( ! is_object( $product ) ) { throw new WC_API_Exception( 'woocommerce_api_invalid_product', __( 'Product is invalid', 'woocommerce' ), 400 ); } // quantity must be positive float if ( isset( $item['quantity'] ) && floatval( $item['quantity'] ) <= 0 ) { throw new WC_API_Exception( 'woocommerce_api_invalid_product_quantity', __( 'Product quantity must be a positive float', 'woocommerce' ), 400 ); } // quantity is required when creating if ( $creating && ! isset( $item['quantity'] ) ) { throw new WC_API_Exception( 'woocommerce_api_invalid_product_quantity', __( 'Product quantity is required', 'woocommerce' ), 400 ); } $item_args = array(); // quantity if ( isset( $item['quantity'] ) ) { $item_args['qty'] = $item['quantity']; } // variations must each have a key & value if ( isset( $item['variations'] ) && is_array( $item['variations'] ) ) { foreach ( $item['variations'] as $key => $value ) { if ( ! $key || ! $value ) { throw new WC_API_Exception( 'woocommerce_api_invalid_product_variation', __( 'The product variation is invalid', 'woocommerce' ), 400 ); } } $item_args['variation'] = $item['variations']; } // total if ( isset( $item['total'] ) ) { $item_args['totals']['line_total'] = floatval( $item['total'] ); } // total tax if ( isset( $item['total_tax'] ) ) { $item_args['totals']['line_tax'] = floatval( $item['total_tax'] ); } // subtotal if ( isset( $item['subtotal'] ) ) { $item_args['totals']['line_subtotal'] = floatval( $item['subtotal'] ); } // subtotal tax if ( isset( $item['subtotal_tax'] ) ) { $item_args['totals']['line_subtotal_tax'] = floatval( $item['subtotal_tax'] ); } if ( $creating ) { $item_id = $order->add_product( $product, $item_args['qty'], $item_args ); if ( ! $item_id ) { throw new WC_API_Exception( 'woocommerce_cannot_create_line_item', __( 'Cannot create line item, try again', 'woocommerce' ), 500 ); } } else { $item_id = $order->update_product( $item['id'], $product, $item_args ); if ( ! $item_id ) { throw new WC_API_Exception( 'woocommerce_cannot_update_line_item', __( 'Cannot update line item, try again', 'woocommerce' ), 500 ); } } } /** * Create or update an order shipping method * * @since 2.2 * @param \WC_Order $order * @param array $shipping item data * @param string $action 'create' to add shipping or 'update' to update it * @throws WC_API_Exception invalid data, server error */ private function set_shipping( $order, $shipping, $action ) { // total must be a positive float if ( isset( $shipping['total'] ) && floatval( $shipping['total'] ) < 0 ) { throw new WC_API_Exception( 'woocommerce_invalid_shipping_total', __( 'Shipping total must be a positive amount', 'woocommerce' ), 400 ); } if ( 'create' === $action ) { // method ID is required if ( ! isset( $shipping['method_id'] ) ) { throw new WC_API_Exception( 'woocommerce_invalid_shipping_item', __( 'Shipping method ID is required', 'woocommerce' ), 400 ); } $rate = new WC_Shipping_Rate( $shipping['method_id'], isset( $shipping['method_title'] ) ? $shipping['method_title'] : '', isset( $shipping['total'] ) ? floatval( $shipping['total'] ) : 0, array(), $shipping['method_id'] ); $shipping_id = $order->add_shipping( $rate ); if ( ! $shipping_id ) { throw new WC_API_Exception( 'woocommerce_cannot_create_shipping', __( 'Cannot create shipping method, try again', 'woocommerce' ), 500 ); } } else { $shipping_args = array(); if ( isset( $shipping['method_id'] ) ) { $shipping_args['method_id'] = $shipping['method_id']; } if ( isset( $shipping['method_title'] ) ) { $shipping_args['method_title'] = $shipping['method_title']; } if ( isset( $shipping['total'] ) ) { $shipping_args['cost'] = floatval( $shipping['total'] ); } $shipping_id = $order->update_shipping( $shipping['id'], $shipping_args ); if ( ! $shipping_id ) { throw new WC_API_Exception( 'woocommerce_cannot_update_shipping', __( 'Cannot update shipping method, try again', 'woocommerce' ), 500 ); } } } /** * Create or update an order fee * * @since 2.2 * @param \WC_Order $order * @param array $fee item data * @param string $action 'create' to add fee or 'update' to update it * @throws WC_API_Exception invalid data, server error */ private function set_fee( $order, $fee, $action ) { if ( 'create' === $action ) { // fee title is required if ( ! isset( $fee['title'] ) ) { throw new WC_API_Exception( 'woocommerce_invalid_fee_item', __( 'Fee title is required', 'woocommerce' ), 400 ); } $order_fee = new stdClass(); $order_fee->id = sanitize_title( $fee['title'] ); $order_fee->name = $fee['title']; $order_fee->amount = isset( $fee['total'] ) ? floatval( $fee['total'] ) : 0; // if taxable, tax class and total are required if ( isset( $fee['taxable'] ) && $fee['taxable'] ) { if ( empty( $fee['tax_class'] ) ) { throw new WC_API_Exception( 'woocommerce_invalid_fee_item', __( 'Fee tax class is required when fee is taxable', 'woocommerce' ), 400 ); } $order_fee->taxable = true; $order_fee->tax_class = $fee['tax_class']; $order_fee->tax = isset( $fee['total_tax'] ) ? floatval( $fee['total_tax'] ) : 0; } $fee_id = $order->add_fee( $order_fee ); if ( ! $fee_id ) { throw new WC_API_Exception( 'woocommerce_cannot_create_fee', __( 'Cannot create fee, try again', 'woocommerce' ), 500 ); } } else { $fee_args = array(); if ( isset( $fee['title'] ) ) { $fee_args['name'] = $fee['title']; } if ( isset( $fee['tax_class'] ) ) { $fee_args['tax_class'] = $fee['tax_class']; } if ( isset( $fee['total'] ) ) { $fee_args['line_total'] = floatval( $fee['total'] ); } if ( isset( $fee['total_tax'] ) ) { $fee_args['line_tax'] = floatval( $fee['total_tax'] ); } $fee_id = $order->update_fee( $fee['id'], $fee_args ); if ( ! $fee_id ) { throw new WC_API_Exception( 'woocommerce_cannot_update_fee', __( 'Cannot update fee, try again', 'woocommerce' ), 500 ); } } } /** * Create or update an order coupon * * @since 2.2 * @param \WC_Order $order * @param array $coupon item data * @param string $action 'create' to add coupon or 'update' to update it * @throws WC_API_Exception invalid data, server error */ private function set_coupon( $order, $coupon, $action ) { // coupon amount must be positive float if ( isset( $coupon['amount'] ) && floatval( $coupon['amount'] ) < 0 ) { throw new WC_API_Exception( 'woocommerce_invalid_coupon_total', __( 'Coupon discount total must be a positive amount', 'woocommerce' ), 400 ); } if ( 'create' === $action ) { // coupon code is required if ( empty( $coupon['code'] ) ) { throw new WC_API_Exception( 'woocommerce_invalid_coupon_coupon', __( 'Coupon code is required', 'woocommerce' ), 400 ); } $coupon_id = $order->add_coupon( $coupon['code'], isset( $coupon['amount'] ) ? floatval( $coupon['amount'] ) : 0 ); if ( ! $coupon_id ) { throw new WC_API_Exception( 'woocommerce_cannot_create_order_coupon', __( 'Cannot create coupon, try again', 'woocommerce' ), 500 ); } } else { $coupon_args = array(); if ( isset( $coupon['code'] ) ) { $coupon_args['code'] = $coupon['code']; } if ( isset( $coupon['amount'] ) ) { $coupon_args['discount_amount'] = floatval( $coupon['amount'] ); } $coupon_id = $order->update_coupon( $coupon['id'], $coupon_args ); if ( ! $coupon_id ) { throw new WC_API_Exception( 'woocommerce_cannot_update_order_coupon', __( 'Cannot update coupon, try again', 'woocommerce' ), 500 ); } } } /** * Get the admin order notes for an order * * @since 2.1 * @param string $order_id order ID * @param string|null $fields fields to include in response * @return array */ public function get_order_notes( $order_id, $fields = null ) { // ensure ID is valid order ID $order_id = $this->validate_request( $order_id, 'shop_order', 'read' ); if ( is_wp_error( $order_id ) ) { return $order_id; } $args = array( 'post_id' => $order_id, 'approve' => 'approve', 'type' => 'order_note' ); remove_filter( 'comments_clauses', array( 'WC_Comments', 'exclude_order_comments' ), 10, 1 ); $notes = get_comments( $args ); add_filter( 'comments_clauses', array( 'WC_Comments', 'exclude_order_comments' ), 10, 1 ); $order_notes = array(); foreach ( $notes as $note ) { $order_notes[] = current( $this->get_order_note( $order_id, $note->comment_ID ) ); } return array( 'order_notes' => apply_filters( 'woocommerce_api_order_notes_response', $order_notes, $order_id, $fields, $notes, $this->server ) ); } /** * Get an order note for the given order ID and ID * * @since 2.2 * @param string $order_id order ID * @param string $id order note ID * @param string|null $fields fields to limit response to * @return array */ public function get_order_note( $order_id, $id, $fields = null ) { // validate order ID $order_id = $this->validate_request( $order_id, 'shop_order', 'read' ); if ( is_wp_error( $order_id ) ) { return $order_id; } $id = absint( $id ); if ( empty( $id ) ) { return new WP_Error( 'woocommerce_api_invalid_order_note_id', __( 'Invalid order note ID', 'woocommerce' ), array( 'status' => 400 ) ); } $note = get_comment( $id ); if ( is_null( $note ) ) { return new WP_Error( 'woocommerce_api_invalid_order_note_id', __( 'An order note with the provided ID could not be found', 'woocommerce' ), array( 'status' => 404 ) ); } $order_note = array( 'id' => $note->comment_ID, 'created_at' => $this->server->format_datetime( $note->comment_date_gmt ), 'note' => $note->comment_content, 'customer_note' => get_comment_meta( $note->comment_ID, 'is_customer_note', true ) ? true : false, ); return array( 'order_note' => apply_filters( 'woocommerce_api_order_note_response', $order_note, $id, $fields, $note, $order_id, $this ) ); } /** * Create a new order note for the given order * * @since 2.2 * @param string $order_id order ID * @param array $data raw request data * @return WP_Error|array error or created note response data */ public function create_order_note( $order_id, $data ) { $data = isset( $data['order_note'] ) ? $data['order_note'] : array(); // permission check if ( ! current_user_can( 'publish_shop_orders' ) ) { return new WP_Error( 'woocommerce_api_user_cannot_create_order_note', __( 'You do not have permission to create order notes', 'woocommerce' ), array( 'status' => 401 ) ); } $order_id = absint( $order_id ); if ( empty( $order_id ) ) { return new WP_Error( 'woocommerce_api_invalid_order_id', __( 'Order ID is invalid', 'woocommerce' ), array( 'status' => 400 ) ); } $order = wc_get_order( $order_id ); $data = apply_filters( 'woocommerce_api_create_order_note_data', $data, $order_id, $this ); // note content is required if ( ! isset( $data['note'] ) ) { return new WP_Error( 'woocommerce_api_invalid_order_note', __( 'Order note is required', 'woocommerce' ), array( 'status' => 400 ) ); } $is_customer_note = ( isset( $data['customer_note'] ) && true === $data['customer_note'] ); // create the note $note_id = $order->add_order_note( $data['note'], $is_customer_note ); if ( ! $note_id ) { return new WP_Error( 'woocommerce_api_cannot_create_order_note', __( 'Cannot create order note, please try again', 'woocommerce' ), array( 'status' => 500 ) ); } // HTTP 201 Created $this->server->send_status( 201 ); do_action( 'woocommerce_api_create_order_note', $note_id, $order_id, $this ); return $this->get_order_note( $order->id, $note_id ); } /** * Edit the order note * * @since 2.2 * @param string $order_id order ID * @param string $id note ID * @param array $data parsed request data * @return WP_Error|array error or edited note response data */ public function edit_order_note( $order_id, $id, $data ) { $data = isset( $data['order_note'] ) ? $data['order_note'] : array(); // validate order ID $order_id = $this->validate_request( $order_id, 'shop_order', 'edit' ); if ( is_wp_error( $order_id ) ) { return $order_id; } $order = wc_get_order( $order_id ); // validate note ID $id = absint( $id ); if ( empty( $id ) ) { return new WP_Error( 'woocommerce_api_invalid_order_note_id', __( 'Invalid order note ID', 'woocommerce' ), array( 'status' => 400 ) ); } // ensure note ID is valid $note = get_comment( $id ); if ( is_null( $note) ) { return new WP_Error( 'woocommerce_api_invalid_order_note_id', __( 'An order note with the provided ID could not be found', 'woocommerce' ), array( 'status' => 404 ) ); } // ensure note ID is associated with given order if ( $note->comment_post_ID != $order->id ) { return new WP_Error( 'woocommerce_api_invalid_order_note_id', __( 'The order note ID provided is not associated with the order', 'woocommerce' ), array( 'status' => 400 ) ); } $data = apply_filters( 'woocommerce_api_edit_order_note_data', $data, $note->comment_ID, $order->id, $this ); // note content if ( isset( $data['note'] ) ) { wp_update_comment( array( 'comment_ID' => $note->comment_ID, 'comment_content' => $data['note'], ) ); } // customer note if ( isset( $data['customer_note'] ) ) { update_comment_meta( $note->comment_ID, 'is_customer_note', true === $data['customer_note'] ); } do_action( 'woocommerce_api_edit_order_note', $note->comment_ID, $order->id, $this ); return $this->get_order_note( $order->id, $note->comment_ID ); } /** * Delete order note * * @since 2.2 * @param string $order_id order ID * @param string $id note ID * @return WP_Error|array error or deleted message */ public function delete_order_note( $order_id, $id ) { $order_id = $this->validate_request( $order_id, 'shop_order', 'delete' ); if ( is_wp_error( $order_id ) ) { return $order_id; } // validate note ID $id = absint( $id ); if ( empty( $id ) ) { return new WP_Error( 'woocommerce_api_invalid_order_note_id', __( 'Invalid order note ID', 'woocommerce' ), array( 'status' => 400 ) ); } // ensure note ID is valid $note = get_comment( $id ); if ( is_null( $note) ) { return new WP_Error( 'woocommerce_api_invalid_order_note_id', __( 'An order note with the provided ID could not be found', 'woocommerce' ), array( 'status' => 404 ) ); } // ensure note ID is associated with given order if ( $note->comment_post_ID != $order_id ) { return new WP_Error( 'woocommerce_api_invalid_order_note_id', __( 'The order note ID provided is not associated with the order', 'woocommerce' ), array( 'status' => 400 ) ); } // force delete since trashed order notes could not be managed through comments list table $result = wp_delete_comment( $note->comment_ID, true ); if ( $result ) { do_action( 'woocommerce_api_delete_order_note', $note->comment_ID, $order_id, $this ); return array( 'message' => __( 'Permanently deleted order note', 'woocommerce' ) ); } else { return new WP_Error( 'woocommerce_api_cannot_delete_order_note', __( 'This order note cannot be deleted', 'woocommerce' ), array( 'status' => 500 ) ); } } /** * Get the order refunds for an order * * @since 2.2 * @param string $order_id order ID * @param string|null $fields fields to include in response * @return array */ public function get_order_refunds( $order_id, $fields = null ) { // Ensure ID is valid order ID $order_id = $this->validate_request( $order_id, 'shop_order', 'read' ); if ( is_wp_error( $order_id ) ) { return $order_id; } $refund_items = get_posts( array( 'post_type' => 'shop_order_refund', 'post_parent' => $order_id, 'posts_per_page' => -1, 'post_status' => 'any', 'fields' => 'ids' ) ); $order_refunds = array(); foreach ( $refund_items as $refund_id ) { $order_refunds[] = current( $this->get_order_refund( $order_id, $refund_id ) ); } return array( 'order_refunds' => apply_filters( 'woocommerce_api_order_refunds_response', $order_refunds, $order_id, $fields, $refund_items, $this ) ); } /** * Get an order refund for the given order ID and ID * * @since 2.2 * @param string $order_id order ID * @param int $refund order refund ID * @param string|null $fields fields to limit response to * @return array */ public function get_order_refund( $order_id, $id, $fields = null ) { // Validate order ID $order_id = $this->validate_request( $order_id, 'shop_order', 'read' ); if ( is_wp_error( $order_id ) ) { return $order_id; } $id = absint( $id ); if ( empty( $id ) ) { return new WP_Error( 'woocommerce_api_invalid_order_refund_id', __( 'Invalid order refund ID', 'woocommerce' ), array( 'status' => 400 ) ); } $order = wc_get_order( $id ); $refund = wc_get_order( $id ); if ( ! $refund ) { return new WP_Error( 'woocommerce_api_invalid_order_refund_id', __( 'An order refund with the provided ID could not be found', 'woocommerce' ), array( 'status' => 404 ) ); } $line_items = array(); // Add line items foreach ( $refund->get_items( 'line_item' ) as $item_id => $item ) { $product = $order->get_product_from_item( $item ); $meta = new WC_Order_Item_Meta( $item['item_meta'], $product ); $item_meta = array(); foreach ( $meta->get_formatted() as $meta_key => $formatted_meta ) { $item_meta[] = array( 'key' => $meta_key, 'label' => $formatted_meta['label'], 'value' => $formatted_meta['value'], ); } $line_items[] = array( 'id' => $item_id, 'subtotal' => wc_format_decimal( $order->get_line_subtotal( $item ), 2 ), 'subtotal_tax' => wc_format_decimal( $item['line_subtotal_tax'], 2 ), 'total' => wc_format_decimal( $order->get_line_total( $item ), 2 ), 'total_tax' => wc_format_decimal( $order->get_line_tax( $item ), 2 ), 'price' => wc_format_decimal( $order->get_item_total( $item ), 2 ), 'quantity' => (int) $item['qty'], 'tax_class' => ( ! empty( $item['tax_class'] ) ) ? $item['tax_class'] : null, 'name' => $item['name'], 'product_id' => ( isset( $product->variation_id ) ) ? $product->variation_id : $product->id, 'sku' => is_object( $product ) ? $product->get_sku() : null, 'meta' => $item_meta, ); } $order_refund = array( 'id' => $refund->id, 'date' => $this->server->format_datetime( $refund->date ), 'amount' => wc_format_decimal( $refund->get_refund_amount(), 2 ), 'reason' => $refund->get_refund_reason(), 'line_items' => $line_items ); return array( 'order_refund' => apply_filters( 'woocommerce_api_order_refund_response', $order_refund, $id, $fields, $refund, $order_id, $this ) ); } /** * Create a new order refund for the given order * * @since 2.2 * @param string $order_id order ID * @param array $data raw request data * @param bool $api_refund do refund using a payment gateway API * @return WP_Error|array error or created refund response data */ public function create_order_refund( $order_id, $data, $api_refund = true ) { $data = isset( $data['order_refund'] ) ? $data['order_refund'] : array(); // Permission check if ( ! current_user_can( 'publish_shop_orders' ) ) { return new WP_Error( 'woocommerce_api_user_cannot_create_order_refund', __( 'You do not have permission to create order refunds', 'woocommerce' ), array( 'status' => 401 ) ); } $order_id = absint( $order_id ); if ( empty( $order_id ) ) { return new WP_Error( 'woocommerce_api_invalid_order_id', __( 'Order ID is invalid', 'woocommerce' ), array( 'status' => 400 ) ); } $data = apply_filters( 'woocommerce_api_create_order_refund_data', $data, $order_id, $this ); // Refund amount is required if ( ! isset( $data['amount'] ) ) { return new WP_Error( 'woocommerce_api_invalid_order_refund', __( 'Refund amount is required', 'woocommerce' ), array( 'status' => 400 ) ); } elseif ( 0 > $data['amount'] ) { return new WP_Error( 'woocommerce_api_invalid_order_refund', __( 'Refund amount must be positive', 'woocommerce' ), array( 'status' => 400 ) ); } $data['order_id'] = $order_id; $data['refund_id'] = 0; // Create the refund $refund = wc_create_refund( $data ); if ( ! $refund ) { return new WP_Error( 'woocommerce_api_cannot_create_order_refund', __( 'Cannot create order refund, please try again', 'woocommerce' ), array( 'status' => 500 ) ); } // Refund via API if ( $api_refund ) { if ( WC()->payment_gateways() ) { $payment_gateways = WC()->payment_gateways->payment_gateways(); } $order = wc_get_order( $order_id ); if ( isset( $payment_gateways[ $order->payment_method ] ) && $payment_gateways[ $order->payment_method ]->supports( 'refunds' ) ) { $result = $payment_gateways[ $order->payment_method ]->process_refund( $order_id, $refund->get_refund_amount(), $refund->get_refund_reason() ); if ( is_wp_error( $result ) ) { return $result; } elseif ( ! $result ) { return new WP_Error( 'woocommerce_api_create_order_refund_api_failed', __( 'An error occurred while attempting to create the refund using the payment gateway API', 'woocommerce' ), array( 'status' => 500 ) ); } } } // HTTP 201 Created $this->server->send_status( 201 ); do_action( 'woocommerce_api_create_order_refund', $refund->id, $order_id, $this ); return $this->get_order_refund( $order_id, $refund->id ); } /** * Edit an order refund * * @since 2.2 * @param string $order_id order ID * @param string $id refund ID * @param array $data parsed request data * @return WP_Error|array error or edited refund response data */ public function edit_order_refund( $order_id, $id, $data ) { $data = isset( $data['order_refund'] ) ? $data['order_refund'] : array(); // Validate order ID $order_id = $this->validate_request( $order_id, 'shop_order', 'edit' ); if ( is_wp_error( $order_id ) ) { return $order_id; } // Validate refund ID $id = absint( $id ); if ( empty( $id ) ) { return new WP_Error( 'woocommerce_api_invalid_order_refund_id', __( 'Invalid order refund ID', 'woocommerce' ), array( 'status' => 400 ) ); } // Ensure order ID is valid $refund = get_post( $id ); if ( ! $refund ) { return new WP_Error( 'woocommerce_api_invalid_order_refund_id', __( 'An order refund with the provided ID could not be found', 'woocommerce' ), array( 'status' => 404 ) ); } // Ensure refund ID is associated with given order if ( $refund->post_parent != $order_id ) { return new WP_Error( 'woocommerce_api_invalid_order_refund_id', __( 'The order refund ID provided is not associated with the order', 'woocommerce' ), array( 'status' => 400 ) ); } $data = apply_filters( 'woocommerce_api_edit_order_refund_data', $data, $refund->ID, $order_id, $this ); // Update reason if ( isset( $data['reason'] ) ) { $updated_refund = wp_update_post( array( 'ID' => $refund->ID, 'post_excerpt' => $data['reason'] ) ); if ( is_wp_error( $updated_refund ) ) { return $updated_refund; } } // Update refund amount if ( isset( $data['amount'] ) && 0 < $data['amount'] ) { update_post_meta( $refund->ID, '_refund_amount', wc_format_decimal( $data['amount'] ) ); } do_action( 'woocommerce_api_edit_order_refund', $refund->ID, $order_id, $this ); return $this->get_order_refund( $order_id, $refund->ID ); } /** * Delete order refund * * @since 2.2 * @param string $order_id order ID * @param string $id refund ID * @return WP_Error|array error or deleted message */ public function delete_order_refund( $order_id, $id ) { $order_id = $this->validate_request( $order_id, 'shop_order', 'delete' ); if ( is_wp_error( $order_id ) ) { return $order_id; } // Validate refund ID $id = absint( $id ); if ( empty( $id ) ) { return new WP_Error( 'woocommerce_api_invalid_order_refund_id', __( 'Invalid order refund ID', 'woocommerce' ), array( 'status' => 400 ) ); } // Ensure refund ID is valid $refund = get_post( $id ); if ( ! $refund ) { return new WP_Error( 'woocommerce_api_invalid_order_refund_id', __( 'An order refund with the provided ID could not be found', 'woocommerce' ), array( 'status' => 404 ) ); } // Ensure refund ID is associated with given order if ( $refund->post_parent != $order_id ) { return new WP_Error( 'woocommerce_api_invalid_order_refund_id', __( 'The order refund ID provided is not associated with the order', 'woocommerce' ), array( 'status' => 400 ) ); } wc_delete_shop_order_transients( $order_id ); do_action( 'woocommerce_api_delete_order_refund', $refund->ID, $order_id, $this ); return $this->delete( $refund->ID, 'order', true ); } }