woocommerce/includes/api/class-wc-rest-orders-contro...

1671 lines
55 KiB
PHP
Raw Normal View History

2016-02-17 19:29:09 +00:00
<?php
/**
* REST API Orders controller
*
* Handles requests to the /orders endpoint.
*
* @author WooThemes
* @category API
* @package WooCommerce/API
* @since 2.6.0
*/
if ( ! defined( 'ABSPATH' ) ) {
exit;
}
/**
* REST API Orders controller class.
*
* @package WooCommerce/API
* @extends WC_REST_Posts_Controller
2016-02-17 19:29:09 +00:00
*/
class WC_REST_Orders_Controller extends WC_REST_Posts_Controller {
2016-02-17 19:29:09 +00:00
/**
* Endpoint namespace.
*
* @var string
*/
protected $namespace = 'wc/v1';
2016-02-17 19:29:09 +00:00
/**
* Route base.
*
* @var string
*/
2016-02-22 18:49:38 +00:00
protected $rest_base = 'orders';
2016-02-17 19:29:09 +00:00
/**
* Post type.
2016-02-17 19:29:09 +00:00
*
* @var string
*/
protected $post_type = 'shop_order';
2016-02-17 19:29:09 +00:00
2016-08-16 12:55:10 +00:00
/**
* Stores the request.
* @var array
*/
protected $request = array();
2016-03-23 22:19:08 +00:00
/**
* Initialize orders actions.
*/
public function __construct() {
add_filter( "woocommerce_rest_{$this->post_type}_query", array( $this, 'query_args' ), 10, 2 );
}
2016-02-17 19:29:09 +00:00
/**
* Register the routes for orders.
2016-02-17 19:29:09 +00:00
*/
public function register_routes() {
2016-03-23 11:30:58 +00:00
register_rest_route( $this->namespace, '/' . $this->rest_base, array(
array(
'methods' => WP_REST_Server::READABLE,
'callback' => array( $this, 'get_items' ),
'permission_callback' => array( $this, 'get_items_permissions_check' ),
'args' => $this->get_collection_params(),
),
array(
'methods' => WP_REST_Server::CREATABLE,
'callback' => array( $this, 'create_item' ),
'permission_callback' => array( $this, 'create_item_permissions_check' ),
'args' => $this->get_endpoint_args_for_item_schema( WP_REST_Server::CREATABLE ),
2016-03-23 11:30:58 +00:00
),
'schema' => array( $this, 'get_public_item_schema' ),
) );
register_rest_route( $this->namespace, '/' . $this->rest_base . '/(?P<id>[\d]+)', array(
2016-03-23 11:30:58 +00:00
array(
'methods' => WP_REST_Server::READABLE,
'callback' => array( $this, 'get_item' ),
'permission_callback' => array( $this, 'get_item_permissions_check' ),
'args' => array(
'context' => $this->get_context_param( array( 'default' => 'view' ) ),
),
),
array(
'methods' => WP_REST_Server::EDITABLE,
'callback' => array( $this, 'update_item' ),
'permission_callback' => array( $this, 'update_item_permissions_check' ),
'args' => $this->get_endpoint_args_for_item_schema( WP_REST_Server::EDITABLE ),
),
array(
'methods' => WP_REST_Server::DELETABLE,
'callback' => array( $this, 'delete_item' ),
'permission_callback' => array( $this, 'delete_item_permissions_check' ),
'args' => array(
'force' => array(
'default' => false,
2016-03-28 19:10:05 +00:00
'description' => __( 'Whether to bypass trash and force deletion.', 'woocommerce' ),
),
2016-03-23 11:30:58 +00:00
'reassign' => array(),
),
),
2016-03-23 11:30:58 +00:00
'schema' => array( $this, 'get_public_item_schema' ),
) );
register_rest_route( $this->namespace, '/' . $this->rest_base . '/batch', array(
array(
'methods' => WP_REST_Server::EDITABLE,
'callback' => array( $this, 'batch_items' ),
'permission_callback' => array( $this, 'batch_items_permissions_check' ),
'args' => $this->get_endpoint_args_for_item_schema( WP_REST_Server::EDITABLE ),
),
'schema' => array( $this, 'get_public_batch_schema' ),
) );
2016-02-17 19:29:09 +00:00
}
2016-03-23 11:30:58 +00:00
2016-08-15 16:27:33 +00:00
/**
* Expands an order item to get its data.
2016-08-18 12:30:10 +00:00
* @param WC_Order_item $item
2016-08-15 16:27:33 +00:00
* @return array
*/
protected function get_order_item_data( $item ) {
$data = $item->get_data();
$format_decimal = array( 'subtotal', 'subtotal_tax', 'total', 'total_tax', 'tax_total', 'shipping_tax_total' );
2016-08-18 12:30:10 +00:00
// Format decimal values.
2016-08-15 16:27:33 +00:00
foreach ( $format_decimal as $key ) {
if ( isset( $data[ $key ] ) ) {
2016-08-16 14:18:16 +00:00
$data[ $key ] = wc_format_decimal( $data[ $key ], $this->request['dp'] );
2016-08-15 16:27:33 +00:00
}
}
2016-08-18 12:30:10 +00:00
// Add meta, SKU and PRICE to products.
2016-08-17 10:44:39 +00:00
if ( is_callable( array( $item, 'get_product' ) ) ) {
$data['sku'] = $item->get_product() ? $item->get_product()->get_sku(): null;
$data['price'] = $item->get_total() / max( 1, $item->get_quantity() );
2016-08-18 12:30:10 +00:00
// Format meta data.
2016-08-17 10:44:39 +00:00
if ( isset( $data['meta_data'] ) ) {
$hideprefix = 'true' === $this->request['all_item_meta'] ? null : '_';
$item_meta = $item->get_formatted_meta_data( $hideprefix );
foreach ( $item_meta as $key => $values ) {
2016-08-18 12:30:10 +00:00
// Label was used in previous version of API - set it here.
2016-08-17 10:44:39 +00:00
$item_meta[ $key ]->label = $values->display_key;
unset( $item_meta[ $key ]->display_key );
unset( $item_meta[ $key ]->display_value );
}
2016-08-16 12:55:10 +00:00
2016-08-17 10:44:39 +00:00
$data['meta'] = array_values( $item_meta );
}
2016-08-16 12:55:10 +00:00
}
2016-08-18 12:30:10 +00:00
// Format taxes.
2016-08-16 13:49:30 +00:00
if ( ! empty( $data['taxes']['total'] ) ) {
$taxes = array();
foreach ( $data['taxes']['total'] as $tax_rate_id => $tax ) {
$taxes[] = array(
'id' => $tax_rate_id,
'total' => $tax,
'subtotal' => isset( $data['taxes']['subtotal'][ $tax_rate_id ] ) ? $data['taxes']['subtotal'][ $tax_rate_id ] : '',
);
}
$data['taxes'] = $taxes;
2016-08-17 10:44:39 +00:00
} elseif ( isset( $data['taxes'] ) ) {
2016-08-16 14:18:16 +00:00
$data['taxes'] = array();
2016-08-16 13:49:30 +00:00
}
2016-08-16 14:18:16 +00:00
// Remove props we don't want to expose.
unset( $data['order_id'] );
unset( $data['type'] );
2016-08-15 16:27:33 +00:00
return $data;
}
2016-03-23 11:30:58 +00:00
/**
* Prepare a single order output for response.
2016-03-23 22:19:08 +00:00
*
* @param WP_Post $post Post object.
* @param WP_REST_Request $request Request object.
* @return WP_REST_Response $data
*/
public function prepare_item_for_response( $post, $request ) {
2016-08-16 12:55:10 +00:00
$this->request = $request;
2016-08-15 16:27:33 +00:00
$statuses = wc_get_order_statuses();
$order = wc_get_order( $post );
$data = array_merge( array( 'id' => $order->get_id() ), $order->get_data() );
2016-08-16 14:18:16 +00:00
$format_decimal = array( 'discount_total', 'discount_tax', 'shipping_total', 'shipping_tax', 'shipping_total', 'shipping_tax', 'cart_tax', 'total', 'total_tax' );
2016-12-08 11:19:32 +00:00
$format_date = array( 'date_created', 'date_modified', 'date_completed', 'date_paid' );
2016-08-16 14:18:16 +00:00
$format_line_items = array( 'line_items', 'tax_lines', 'shipping_lines', 'fee_lines', 'coupon_lines' );
2016-08-15 16:27:33 +00:00
2016-08-18 12:30:10 +00:00
// Format decimal values.
2016-08-15 16:27:33 +00:00
foreach ( $format_decimal as $key ) {
2016-08-16 14:18:16 +00:00
$data[ $key ] = wc_format_decimal( $data[ $key ], $this->request['dp'] );
2016-08-15 16:27:33 +00:00
}
2016-08-18 12:30:10 +00:00
// Format date values.
2016-08-15 16:27:33 +00:00
foreach ( $format_date as $key ) {
$data[ $key ] = $data[ $key ] ? wc_rest_prepare_date_response( get_gmt_from_date( date( 'Y-m-d H:i:s', $data[ $key ] ) ) ) : false;
}
2016-08-18 12:30:10 +00:00
// Format the order status.
2016-08-15 16:27:33 +00:00
$data['status'] = 'wc-' === substr( $data['status'], 0, 3 ) ? substr( $data['status'], 3 ) : $data['status'];
2016-08-18 12:30:10 +00:00
// Format line items.
2016-08-15 16:27:33 +00:00
foreach ( $format_line_items as $key ) {
2016-08-16 13:49:30 +00:00
$data[ $key ] = array_values( array_map( array( $this, 'get_order_item_data' ), $data[ $key ] ) );
2016-08-15 16:27:33 +00:00
}
2016-08-18 12:30:10 +00:00
// Refunds.
$data['refunds'] = array();
2016-08-16 12:55:10 +00:00
foreach ( $order->get_refunds() as $refund ) {
$data['refunds'][] = array(
2016-08-22 12:04:57 +00:00
'id' => $refund->get_id(),
'refund' => $refund->get_reason() ? $refund->get_reason() : '',
'total' => '-' . wc_format_decimal( $refund->get_amount(), $this->request['dp'] ),
);
}
2016-08-15 16:27:33 +00:00
$context = ! empty( $request['context'] ) ? $request['context'] : 'view';
$data = $this->add_additional_fields_to_object( $data, $request );
$data = $this->filter_response_by_context( $data, $context );
$response = rest_ensure_response( $data );
$response->add_links( $this->prepare_links( $order, $request ) );
2016-03-23 22:19:08 +00:00
/**
* Filter the data for a response.
*
* The dynamic portion of the hook name, $this->post_type, refers to post_type of the post being
* prepared for the response.
*
* @param WP_REST_Response $response The response object.
* @param WP_Post $post Post object.
* @param WP_REST_Request $request Request object.
*/
return apply_filters( "woocommerce_rest_prepare_{$this->post_type}", $response, $post, $request );
}
/**
* Prepare links for the request.
*
2016-03-29 20:20:15 +00:00
* @param WC_Order $order Order object.
* @param WP_REST_Request $request Request object.
2016-03-23 22:19:08 +00:00
* @return array Links for the given order.
*/
protected function prepare_links( $order, $request ) {
2016-03-23 22:19:08 +00:00
$links = array(
'self' => array(
2016-08-05 14:56:23 +00:00
'href' => rest_url( sprintf( '/%s/%s/%d', $this->namespace, $this->rest_base, $order->get_id() ) ),
2016-03-23 22:19:08 +00:00
),
'collection' => array(
'href' => rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ),
),
);
if ( 0 !== (int) $order->get_user_id() ) {
$links['customer'] = array(
'href' => rest_url( sprintf( '/%s/customers/%d', $this->namespace, $order->get_user_id() ) ),
);
}
2016-08-15 15:56:55 +00:00
if ( 0 !== (int) $order->get_parent_id() ) {
2016-03-23 22:19:08 +00:00
$links['up'] = array(
2016-08-15 15:56:55 +00:00
'href' => rest_url( sprintf( '/%s/orders/%d', $this->namespace, $order->get_parent_id() ) ),
2016-03-23 22:19:08 +00:00
);
}
return $links;
}
/**
* Query args.
2016-03-23 11:30:58 +00:00
*
2016-03-23 22:19:08 +00:00
* @param array $args
* @param WP_REST_Request $request
2016-03-23 11:30:58 +00:00
* @return array
*/
2016-03-23 22:19:08 +00:00
public function query_args( $args, $request ) {
2016-03-30 23:26:51 +00:00
global $wpdb;
2016-03-23 22:19:08 +00:00
// Set post_status.
if ( 'any' !== $request['status'] ) {
$args['post_status'] = 'wc-' . $request['status'];
} else {
$args['post_status'] = 'any';
}
2016-03-30 23:26:51 +00:00
if ( ! empty( $request['customer'] ) ) {
if ( ! empty( $args['meta_query'] ) ) {
$args['meta_query'] = array();
}
$args['meta_query'][] = array(
'key' => '_customer_user',
2016-03-30 23:26:51 +00:00
'value' => $request['customer'],
'type' => 'NUMERIC',
);
}
// Search by product.
2016-03-30 23:26:51 +00:00
if ( ! empty( $request['product'] ) ) {
$order_ids = $wpdb->get_col( $wpdb->prepare( "
SELECT order_id
FROM {$wpdb->prefix}woocommerce_order_items
WHERE order_item_id IN ( SELECT order_item_id FROM {$wpdb->prefix}woocommerce_order_itemmeta WHERE meta_key = '_product_id' AND meta_value = %d )
AND order_item_type = 'line_item'
", $request['product'] ) );
// Force WP_Query return empty if don't found any order.
$order_ids = ! empty( $order_ids ) ? $order_ids : array( 0 );
$args['post__in'] = $order_ids;
}
// Search.
if ( ! empty( $args['s'] ) ) {
$order_ids = wc_order_search( $args['s'] );
if ( ! empty( $order_ids ) ) {
unset( $args['s'] );
$args['post__in'] = array_merge( $order_ids, array( 0 ) );
}
}
2016-03-23 22:19:08 +00:00
return $args;
}
/**
* Prepare a single order for create.
*
2016-08-17 15:53:01 +00:00
* @param WP_REST_Request $request Request object.
* @return WP_Error|WC_Order $data Object.
*/
protected function prepare_item_for_database( $request ) {
2016-08-17 15:53:01 +00:00
$id = isset( $request['id'] ) ? absint( $request['id'] ) : 0;
$order = new WC_Order( $id );
$schema = $this->get_item_schema();
$data_keys = array_keys( array_filter( $schema['properties'], array( $this, 'filter_writable_props' ) ) );
// Handle all writable props
foreach ( $data_keys as $key ) {
2016-08-17 16:25:29 +00:00
$value = $request[ $key ];
2016-08-17 15:53:01 +00:00
if ( ! is_null( $value ) ) {
switch ( $key ) {
case 'billing' :
case 'shipping' :
2016-08-17 16:25:29 +00:00
$this->update_address( $order, $value, $key );
2016-08-17 15:53:01 +00:00
break;
case 'line_items' :
case 'shipping_lines' :
case 'fee_lines' :
case 'coupon_lines' :
if ( is_array( $value ) ) {
foreach ( $value as $item ) {
2016-08-18 16:24:44 +00:00
if ( is_array( $item ) ) {
if ( $this->item_is_null( $item ) || ( isset( $item['quantity'] ) && 0 === $item['quantity'] ) ) {
$order->remove_item( $item['id'] );
} else {
$this->set_item( $order, $key, $item );
}
2016-08-17 15:53:01 +00:00
}
}
}
break;
case 'meta_data' :
if ( is_array( $value ) ) {
foreach ( $value as $meta ) {
$order->update_meta_data( $meta['key'], $meta['value'], $meta['id'] );
2016-08-17 15:53:01 +00:00
}
}
break;
default :
if ( is_callable( array( $order, "set_{$key}" ) ) ) {
$order->{"set_{$key}"}( $value );
}
break;
}
}
}
2016-08-18 12:30:10 +00:00
/**
* Filter the data for the insert.
*
* The dynamic portion of the hook name, $this->post_type, refers to post_type of the post being
* prepared for the response.
*
* @param WC_Order $order The prder object.
* @param WP_REST_Request $request Request object.
*/
2016-08-17 15:53:01 +00:00
return apply_filters( "woocommerce_rest_pre_insert_{$this->post_type}", $order, $request );
}
2016-06-07 15:01:28 +00:00
/**
* Create base WC Order object.
2016-08-17 15:53:01 +00:00
* @deprecated 2.7.0
2016-06-07 15:01:28 +00:00
* @param array $data
* @return WC_Order
*/
2016-06-07 15:03:14 +00:00
protected function create_base_order( $data ) {
return wc_create_order( $data );
2016-06-07 15:01:28 +00:00
}
2016-08-17 15:53:01 +00:00
/**
* Only reutrn writeable props from schema.
* @param array $schema
* @return bool
*/
protected function filter_writable_props( $schema ) {
return empty( $schema['readonly'] );
}
/**
* Create order.
*
* @param WP_REST_Request $request Full details about the request.
* @return int|WP_Error
*/
protected function create_order( $request ) {
try {
// Make sure customer exists.
2016-08-17 16:25:29 +00:00
if ( ! is_null( $request['customer_id'] ) && 0 !== $request['customer_id'] && false === get_user_by( 'id', $request['customer_id'] ) ) {
2016-03-28 12:22:54 +00:00
throw new WC_REST_Exception( 'woocommerce_rest_invalid_customer_id',__( 'Customer ID is invalid.', 'woocommerce' ), 400 );
}
2016-08-17 15:53:01 +00:00
$order = $this->prepare_item_for_database( $request );
2016-08-17 10:44:39 +00:00
$order->set_created_via( 'rest-api' );
$order->set_prices_include_tax( 'yes' === get_option( 'woocommerce_prices_include_tax' ) );
2016-08-17 15:53:01 +00:00
$order->calculate_totals();
$order->save();
2016-03-28 12:22:54 +00:00
2016-08-17 15:53:01 +00:00
// Handle set paid
2016-08-17 16:25:29 +00:00
if ( true === $request['set_paid'] ) {
2016-08-18 12:30:10 +00:00
$order->payment_complete( $request['transaction_id'] );
2016-03-28 12:22:54 +00:00
}
2016-08-17 15:53:01 +00:00
return $order->get_id();
2016-08-18 16:24:44 +00:00
} catch ( WC_Data_Exception $e ) {
return new WP_Error( $e->getErrorCode(), $e->getMessage(), array( 'status' => $e->getCode() ) );
} catch ( WC_REST_Exception $e ) {
2016-08-17 15:53:01 +00:00
return new WP_Error( $e->getErrorCode(), $e->getMessage(), array( 'status' => $e->getCode() ) );
}
}
2016-08-17 10:44:39 +00:00
2016-08-17 15:53:01 +00:00
/**
* Update order.
*
* @param WP_REST_Request $request Full details about the request.
* @return int|WP_Error
*/
protected function update_order( $request ) {
try {
$order = $this->prepare_item_for_database( $request );
$order->save();
2016-08-17 15:53:01 +00:00
// Handle set paid
2016-08-17 16:25:29 +00:00
if ( $order->needs_payment() && true === $request['set_paid'] ) {
2016-08-18 12:30:10 +00:00
$order->payment_complete( $request['transaction_id'] );
2016-03-24 20:55:51 +00:00
}
2016-08-17 15:53:01 +00:00
// If items have changed, recalculate order totals.
if ( isset( $request['billing'], $request['shipping'], $request['line_items'], $request['shipping'], $request['fee'], $request['coupon'] ) ) {
2016-08-17 15:53:01 +00:00
$order->calculate_totals();
2016-08-17 10:44:39 +00:00
}
2016-08-05 14:56:23 +00:00
return $order->get_id();
2016-08-18 16:24:44 +00:00
} catch ( WC_Data_Exception $e ) {
return new WP_Error( $e->getErrorCode(), $e->getMessage(), array( 'status' => $e->getCode() ) );
2016-08-17 15:53:01 +00:00
} catch ( WC_REST_Exception $e ) {
2016-03-28 12:22:54 +00:00
return new WP_Error( $e->getErrorCode(), $e->getMessage(), array( 'status' => $e->getCode() ) );
}
}
/**
* Update address.
*
* @param WC_Order $order
* @param array $posted
* @param string $type
*/
protected function update_address( $order, $posted, $type = 'billing' ) {
2016-08-17 15:53:01 +00:00
foreach ( $posted as $key => $value ) {
if ( is_callable( array( $order, "set_{$type}_{$key}" ) ) ) {
$order->{"set_{$type}_{$key}"}( $value );
}
}
}
2016-03-28 12:22:54 +00:00
/**
2016-08-22 18:58:27 +00:00
* Gets the product ID from the SKU or posted ID.
* @param array $posted Request data
* @return int
2016-03-28 12:22:54 +00:00
*/
2016-08-22 18:58:27 +00:00
protected function get_product_id( $posted ) {
2016-08-17 15:53:01 +00:00
if ( ! empty( $posted['sku'] ) ) {
$product_id = (int) wc_get_product_id_by_sku( $posted['sku'] );
} elseif ( ! empty( $posted['product_id'] ) && empty( $posted['variation_id'] ) ) {
$product_id = (int) $posted['product_id'];
} elseif ( ! empty( $posted['variation_id'] ) ) {
$product_id = (int) $posted['variation_id'];
2016-08-22 18:58:27 +00:00
} else {
throw new WC_REST_Exception( 'woocommerce_rest_required_product_reference', __( 'Product ID or SKU is required.', 'woocommerce' ), 400 );
2016-03-28 12:22:54 +00:00
}
2016-08-22 18:58:27 +00:00
return $product_id;
}
2016-03-28 12:22:54 +00:00
2016-08-22 18:58:27 +00:00
/**
* Maybe set an item prop if the value was posted.
* @param WC_Order_Item $item
* @param string $prop
* @param array $posted Request data.
*/
protected function maybe_set_item_prop( $item, $prop, $posted ) {
if ( isset( $posted[ $prop ] ) ) {
$item->{"set_$prop"}( $posted[ $prop ] );
}
}
/**
* Maybe set item props if the values were posted.
* @param WC_Order_Item $item
* @param string[] $props
* @param array $posted Request data.
*/
protected function maybe_set_item_props( $item, $props, $posted ) {
foreach ( $props as $prop ) {
$this->maybe_set_item_prop( $item, $prop, $posted );
}
}
2016-12-22 10:29:57 +00:00
/**
* Maybe set item meta if posted.
* @param WC_Order_Item $item
* @param array $posted Request data.
*/
protected function maybe_set_item_meta_data( $item, $posted ) {
2016-12-22 12:10:36 +00:00
if ( ! empty( $posted['meta_data'] ) && is_array( $posted['meta_data'] ) ) {
2016-12-22 10:29:57 +00:00
foreach ( $posted['meta_data'] as $meta ) {
if ( isset( $meta['key'], $meta['value'] ) ) {
$item->update_meta_data( $meta['key'], $meta['value'], isset( $meta['id'] ) ? $meta['id'] : '' );
}
}
}
}
2016-08-22 18:58:27 +00:00
/**
* Create or update a line item.
*
* @param array $posted Line item data.
* @param string $action 'create' to add line item or 'update' to update it.
* @throws WC_REST_Exception Invalid data, server error.
*/
protected function prepare_line_items( $posted, $action = 'create' ) {
2016-08-17 15:53:01 +00:00
$item = new WC_Order_Item_Product( ! empty( $posted['id'] ) ? $posted['id'] : '' );
2016-08-22 18:58:27 +00:00
$product = wc_get_product( $this->get_product_id( $posted ) );
2016-03-28 12:22:54 +00:00
2016-08-17 15:53:01 +00:00
if ( $product !== $item->get_product() ) {
$item->set_product( $product );
2016-03-28 12:22:54 +00:00
2016-08-17 15:53:01 +00:00
if ( 'create' === $action ) {
$quantity = isset( $posted['quantity'] ) ? $posted['quantity'] : 1;
$total = wc_get_price_excluding_tax( $product, array( 'qty' => $quantity ) );
2016-08-22 18:58:27 +00:00
$item->set_total( $total );
$item->set_subtotal( $total );
2016-08-17 15:53:01 +00:00
}
2016-03-28 12:22:54 +00:00
}
2016-08-22 18:58:27 +00:00
$this->maybe_set_item_props( $item, array( 'name', 'quantity', 'total', 'subtotal', 'tax_class' ), $posted );
2016-12-22 10:29:57 +00:00
$this->maybe_set_item_meta_data( $item, $posted );
2016-03-28 12:22:54 +00:00
2016-08-17 15:53:01 +00:00
return $item;
2016-03-28 12:22:54 +00:00
}
/**
* Create or update an order shipping method.
*
2016-08-17 15:53:01 +00:00
* @param $posted $shipping Item data.
2016-03-28 12:22:54 +00:00
* @param string $action 'create' to add shipping or 'update' to update it.
* @throws WC_REST_Exception Invalid data, server error.
*/
2016-08-17 15:53:01 +00:00
protected function prepare_shipping_lines( $posted, $action ) {
$item = new WC_Order_Item_Shipping( ! empty( $posted['id'] ) ? $posted['id'] : '' );
2016-03-28 12:22:54 +00:00
if ( 'create' === $action ) {
2016-08-17 15:53:01 +00:00
if ( empty( $posted['method_id'] ) ) {
2016-03-28 12:22:54 +00:00
throw new WC_REST_Exception( 'woocommerce_rest_invalid_shipping_item', __( 'Shipping method ID is required.', 'woocommerce' ), 400 );
}
2016-08-17 15:53:01 +00:00
}
2016-03-28 12:22:54 +00:00
2016-08-22 18:58:27 +00:00
$this->maybe_set_item_props( $item, array( 'method_id', 'method_title', 'total' ), $posted );
2016-12-22 10:29:57 +00:00
$this->maybe_set_item_meta_data( $item, $posted );
2016-08-17 15:53:01 +00:00
return $item;
2016-03-28 12:22:54 +00:00
}
/**
* Create or update an order fee.
*
2016-08-17 15:53:01 +00:00
* @param array $posted Item data.
2016-03-28 12:22:54 +00:00
* @param string $action 'create' to add fee or 'update' to update it.
* @throws WC_REST_Exception Invalid data, server error.
*/
2016-08-17 15:53:01 +00:00
protected function prepare_fee_lines( $posted, $action ) {
$item = new WC_Order_Item_Fee( ! empty( $posted['id'] ) ? $posted['id'] : '' );
2016-03-28 12:22:54 +00:00
2016-08-17 15:53:01 +00:00
if ( 'create' === $action ) {
if ( empty( $posted['name'] ) ) {
2016-03-28 12:22:54 +00:00
throw new WC_REST_Exception( 'woocommerce_rest_invalid_fee_item', __( 'Fee name is required.', 'woocommerce' ), 400 );
}
2016-08-17 15:53:01 +00:00
}
2016-03-28 12:22:54 +00:00
2016-08-22 18:58:27 +00:00
$this->maybe_set_item_props( $item, array( 'name', 'tax_class', 'tax_status', 'total' ), $posted );
2016-12-22 10:29:57 +00:00
$this->maybe_set_item_meta_data( $item, $posted );
2016-08-17 15:53:01 +00:00
return $item;
2016-03-28 12:22:54 +00:00
}
/**
* Create or update an order coupon.
*
2016-08-17 15:53:01 +00:00
* @param array $posted Item data.
2016-03-28 12:22:54 +00:00
* @param string $action 'create' to add coupon or 'update' to update it.
* @throws WC_REST_Exception Invalid data, server error.
*/
2016-08-17 15:53:01 +00:00
protected function prepare_coupon_lines( $posted, $action ) {
$item = new WC_Order_Item_Coupon( ! empty( $posted['id'] ) ? $posted['id'] : '' );
2016-03-28 12:22:54 +00:00
if ( 'create' === $action ) {
2016-08-17 15:53:01 +00:00
if ( empty( $posted['code'] ) ) {
2016-03-28 12:22:54 +00:00
throw new WC_REST_Exception( 'woocommerce_rest_invalid_coupon_coupon', __( 'Coupon code is required.', 'woocommerce' ), 400 );
}
}
2016-08-22 18:58:27 +00:00
$this->maybe_set_item_props( $item, array( 'code', 'discount' ), $posted );
2016-12-22 10:29:57 +00:00
$this->maybe_set_item_meta_data( $item, $posted );
2016-08-17 15:53:01 +00:00
return $item;
}
2016-03-28 19:04:24 +00:00
/**
* Wrapper method to create/update order items.
* When updating, the item ID provided is checked to ensure it is associated
* with the order.
*
* @param WC_Order $order order
* @param string $item_type
2016-08-17 15:53:01 +00:00
* @param array $posted item provided in the request body
2016-03-28 19:04:24 +00:00
* @throws WC_REST_Exception If item ID is not associated with order
*/
2016-08-17 15:53:01 +00:00
protected function set_item( $order, $item_type, $posted ) {
2016-03-28 19:04:24 +00:00
global $wpdb;
2016-08-17 15:53:01 +00:00
if ( ! empty( $posted['id'] ) ) {
$action = 'update';
} else {
$action = 'create';
}
$method = 'prepare_' . $item_type;
2016-03-28 19:04:24 +00:00
// 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",
2016-08-17 15:53:01 +00:00
absint( $posted['id'] ),
2016-08-05 14:56:23 +00:00
absint( $order->get_id() )
2016-03-28 19:04:24 +00:00
) );
if ( is_null( $result ) ) {
throw new WC_REST_Exception( 'woocommerce_rest_invalid_item_id', __( 'Order item ID provided is not associated with order.', 'woocommerce' ), 400 );
}
}
2016-08-17 15:53:01 +00:00
// Prepare item data
$item = $this->$method( $posted, $action );
/**
* Action hook to adjust item before save.
* @since 2.7.0
*/
do_action( 'woocommerce_rest_set_order_item', $item, $posted );
2016-08-17 15:53:01 +00:00
// Save or add to order
if ( 'create' === $action ) {
$order->add_item( $item );
} else {
$item->save();
}
2016-03-28 19:04:24 +00:00
}
/**
* 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.
*
* @param array $item Item provided in the request body.
* @return bool True if the item resource ID is null, false otherwise.
*/
protected function item_is_null( $item ) {
$keys = array( 'product_id', 'method_id', 'method_title', 'name', 'code' );
2016-03-28 19:04:24 +00:00
foreach ( $keys as $key ) {
if ( array_key_exists( $key, $item ) && is_null( $item[ $key ] ) ) {
return true;
}
}
return false;
}
/**
2016-08-17 15:53:01 +00:00
* Create a single item.
2016-03-28 19:04:24 +00:00
*
* @param WP_REST_Request $request Full details about the request.
* @return WP_Error|WP_REST_Response
*/
2016-08-17 15:53:01 +00:00
public function create_item( $request ) {
if ( ! empty( $request['id'] ) ) {
2016-10-29 17:32:38 +00:00
/* translators: %s: post type */
2016-08-17 15:53:01 +00:00
return new WP_Error( "woocommerce_rest_{$this->post_type}_exists", sprintf( __( 'Cannot create existing %s.', 'woocommerce' ), $this->post_type ), array( 'status' => 400 ) );
2016-03-28 19:04:24 +00:00
}
2016-08-17 15:53:01 +00:00
$order_id = $this->create_order( $request );
2016-03-28 19:04:24 +00:00
if ( is_wp_error( $order_id ) ) {
return $order_id;
}
$post = get_post( $order_id );
$this->update_additional_fields_for_object( $post, $request );
/**
* Fires after a single item is created or updated via the REST API.
*
* @param object $post Inserted object (not a WP_Post object).
* @param WP_REST_Request $request Request object.
* @param boolean $creating True when creating item, false when updating.
*/
2016-08-17 15:53:01 +00:00
do_action( "woocommerce_rest_insert_{$this->post_type}", $post, $request, true );
2016-03-28 19:04:24 +00:00
$request->set_param( 'context', 'edit' );
$response = $this->prepare_item_for_response( $post, $request );
2016-08-17 15:53:01 +00:00
$response = rest_ensure_response( $response );
$response->set_status( 201 );
$response->header( 'Location', rest_url( sprintf( '/%s/%s/%d', $this->namespace, $this->rest_base, $post->ID ) ) );
return $response;
}
/**
* Update a single order.
*
* @param WP_REST_Request $request Full details about the request.
* @return WP_Error|WP_REST_Response
*/
public function update_item( $request ) {
try {
$post_id = (int) $request['id'];
2016-09-09 00:14:28 +00:00
if ( empty( $post_id ) || get_post_type( $post_id ) !== $this->post_type ) {
2016-08-17 15:53:01 +00:00
return new WP_Error( "woocommerce_rest_{$this->post_type}_invalid_id", __( 'ID is invalid.', 'woocommerce' ), array( 'status' => 400 ) );
}
2016-08-17 16:25:29 +00:00
$order_id = $this->update_order( $request );
2016-08-17 15:53:01 +00:00
if ( is_wp_error( $order_id ) ) {
return $order_id;
}
$post = get_post( $order_id );
$this->update_additional_fields_for_object( $post, $request );
/**
* Fires after a single item is created or updated via the REST API.
*
* @param object $post Inserted object (not a WP_Post object).
* @param WP_REST_Request $request Request object.
* @param boolean $creating True when creating item, false when updating.
*/
do_action( "woocommerce_rest_insert_{$this->post_type}", $post, $request, false );
$request->set_param( 'context', 'edit' );
$response = $this->prepare_item_for_response( $post, $request );
return rest_ensure_response( $response );
} catch ( Exception $e ) {
return new WP_Error( $e->getErrorCode(), $e->getMessage(), array( 'status' => $e->getCode() ) );
}
2016-03-28 19:04:24 +00:00
}
2016-03-23 22:19:08 +00:00
/**
2016-08-17 10:44:39 +00:00
* Get order statuses without prefixes.
2016-03-23 22:19:08 +00:00
* @return array
*/
protected function get_order_statuses() {
2016-03-23 11:30:58 +00:00
$order_statuses = array();
foreach ( array_keys( wc_get_order_statuses() ) as $status ) {
$order_statuses[] = str_replace( 'wc-', '', $status );
}
2016-03-23 22:19:08 +00:00
return $order_statuses;
}
/**
* Get the Order's schema, conforming to JSON Schema.
*
* @return array
*/
public function get_item_schema() {
2016-03-23 11:30:58 +00:00
$schema = array(
'$schema' => 'http://json-schema.org/draft-04/schema#',
'title' => $this->post_type,
'type' => 'object',
'properties' => array(
'id' => array(
'description' => __( 'Unique identifier for the resource.', 'woocommerce' ),
'type' => 'integer',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
2016-03-23 12:46:34 +00:00
'parent_id' => array(
'description' => __( 'Parent order ID.', 'woocommerce' ),
2016-03-23 11:30:58 +00:00
'type' => 'integer',
'context' => array( 'view', 'edit' ),
2016-03-23 12:46:34 +00:00
),
'status' => array(
'description' => __( 'Order status.', 'woocommerce' ),
'type' => 'string',
'default' => 'pending',
2016-03-23 22:19:08 +00:00
'enum' => $this->get_order_statuses(),
2016-03-23 12:46:34 +00:00
'context' => array( 'view', 'edit' ),
2016-03-23 11:30:58 +00:00
),
'order_key' => array(
'description' => __( 'Order key.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
2016-03-23 12:46:34 +00:00
'currency' => array(
'description' => __( 'Currency the order was created with, in ISO format.', 'woocommerce' ),
'type' => 'string',
'default' => get_woocommerce_currency(),
2016-03-23 12:46:34 +00:00
'enum' => array_keys( get_woocommerce_currencies() ),
2016-03-23 11:30:58 +00:00
'context' => array( 'view', 'edit' ),
),
2016-03-23 12:46:34 +00:00
'version' => array(
'description' => __( 'Version of WooCommerce when the order was made.', 'woocommerce' ),
'type' => 'integer',
2016-03-23 11:30:58 +00:00
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
2016-03-23 12:46:34 +00:00
'prices_include_tax' => array(
2016-08-17 10:44:39 +00:00
'description' => __( 'True the prices included tax during checkout.', 'woocommerce' ),
2016-03-23 12:46:34 +00:00
'type' => 'boolean',
2016-03-23 11:30:58 +00:00
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
2016-03-23 12:46:34 +00:00
'date_created' => array(
'description' => __( "The date the order was created, in the site's timezone.", 'woocommerce' ),
'type' => 'date-time',
2016-03-23 11:30:58 +00:00
'context' => array( 'view', 'edit' ),
),
2016-03-23 12:46:34 +00:00
'date_modified' => array(
'description' => __( "The date the order was last modified, in the site's timezone.", 'woocommerce' ),
'type' => 'date-time',
2016-03-23 11:30:58 +00:00
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
2016-03-23 12:46:34 +00:00
'customer_id' => array(
'description' => __( 'User ID who owns the order. 0 for guests.', 'woocommerce' ),
2016-03-23 11:30:58 +00:00
'type' => 'integer',
2016-03-23 12:46:34 +00:00
'default' => 0,
2016-03-23 11:30:58 +00:00
'context' => array( 'view', 'edit' ),
),
2016-03-23 12:46:34 +00:00
'discount_total' => array(
'description' => __( 'Total discount amount for the order.', 'woocommerce' ),
2016-03-23 22:19:08 +00:00
'type' => 'string',
2016-03-23 11:30:58 +00:00
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
2016-03-23 12:46:34 +00:00
'discount_tax' => array(
'description' => __( 'Total discount tax amount for the order.', 'woocommerce' ),
2016-03-23 22:19:08 +00:00
'type' => 'string',
2016-03-23 11:30:58 +00:00
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
2016-03-23 12:46:34 +00:00
'shipping_total' => array(
'description' => __( 'Total shipping amount for the order.', 'woocommerce' ),
2016-03-23 22:19:08 +00:00
'type' => 'string',
2016-03-23 11:30:58 +00:00
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'shipping_tax' => array(
2016-03-23 12:46:34 +00:00
'description' => __( 'Total shipping tax amount for the order.', 'woocommerce' ),
2016-03-23 22:19:08 +00:00
'type' => 'string',
2016-03-23 11:30:58 +00:00
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
2016-03-23 12:46:34 +00:00
'cart_tax' => array(
'description' => __( 'Sum of line item taxes only.', 'woocommerce' ),
2016-03-23 22:19:08 +00:00
'type' => 'string',
2016-03-23 11:30:58 +00:00
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
2016-03-23 12:46:34 +00:00
'total' => array(
'description' => __( 'Grand total.', 'woocommerce' ),
2016-03-23 22:19:08 +00:00
'type' => 'string',
2016-03-23 11:30:58 +00:00
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
2016-03-23 12:46:34 +00:00
'total_tax' => array(
'description' => __( 'Sum of all taxes.', 'woocommerce' ),
2016-03-23 22:19:08 +00:00
'type' => 'string',
2016-03-23 11:30:58 +00:00
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
2016-03-23 12:46:34 +00:00
'billing' => array(
2016-03-23 11:30:58 +00:00
'description' => __( 'Billing address.', 'woocommerce' ),
'type' => 'object',
2016-03-23 11:30:58 +00:00
'context' => array( 'view', 'edit' ),
'properties' => array(
'first_name' => array(
'description' => __( 'First name.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'last_name' => array(
'description' => __( 'Last name.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'company' => array(
'description' => __( 'Company name.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'address_1' => array(
'description' => __( 'Address 1', 'woocommerce' ),
2016-03-23 11:30:58 +00:00
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'address_2' => array(
'description' => __( 'Address 2', 'woocommerce' ),
2016-03-23 11:30:58 +00:00
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'city' => array(
'description' => __( 'City name.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'state' => array(
'description' => __( 'ISO code or name of the state, province or district.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'postcode' => array(
'description' => __( 'Postal code.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'country' => array(
2016-03-23 12:46:34 +00:00
'description' => __( 'Country code in ISO 3166-1 alpha-2 format.', 'woocommerce' ),
2016-03-23 11:30:58 +00:00
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'email' => array(
'description' => __( 'Email address.', 'woocommerce' ),
'type' => 'string',
'format' => 'email',
'context' => array( 'view', 'edit' ),
),
'phone' => array(
'description' => __( 'Phone number.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
),
),
2016-03-23 12:46:34 +00:00
'shipping' => array(
2016-03-23 11:30:58 +00:00
'description' => __( 'Shipping address.', 'woocommerce' ),
'type' => 'object',
2016-03-23 11:30:58 +00:00
'context' => array( 'view', 'edit' ),
'properties' => array(
'first_name' => array(
'description' => __( 'First name.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'last_name' => array(
'description' => __( 'Last name.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'company' => array(
'description' => __( 'Company name.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'address_1' => array(
'description' => __( 'Address 1', 'woocommerce' ),
2016-03-23 11:30:58 +00:00
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'address_2' => array(
'description' => __( 'Address 2', 'woocommerce' ),
2016-03-23 11:30:58 +00:00
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'city' => array(
'description' => __( 'City name.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'state' => array(
'description' => __( 'ISO code or name of the state, province or district.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'postcode' => array(
'description' => __( 'Postal code.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'country' => array(
2016-03-23 12:46:34 +00:00
'description' => __( 'Country code in ISO 3166-1 alpha-2 format.', 'woocommerce' ),
2016-03-23 11:30:58 +00:00
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
),
),
2016-03-23 12:46:34 +00:00
'payment_method' => array(
'description' => __( 'Payment method ID.', 'woocommerce' ),
2016-03-23 11:30:58 +00:00
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
2016-03-23 12:46:34 +00:00
'payment_method_title' => array(
'description' => __( 'Payment method title.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'transaction_id' => array(
'description' => __( 'Unique transaction ID.', 'woocommerce' ),
'type' => 'string',
2016-03-23 12:46:34 +00:00
'context' => array( 'view', 'edit' ),
),
'customer_ip_address' => array(
'description' => __( "Customer's IP address.", 'woocommerce' ),
2016-03-23 11:30:58 +00:00
'type' => 'string',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'customer_user_agent' => array(
2016-03-23 12:46:34 +00:00
'description' => __( 'User agent of the customer.', 'woocommerce' ),
2016-03-23 11:30:58 +00:00
'type' => 'string',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
2016-03-23 12:46:34 +00:00
'created_via' => array(
'description' => __( 'Shows where the order was created.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'customer_note' => array(
'description' => __( 'Note left by customer during checkout.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'date_completed' => array(
'description' => __( "The date the order was completed, in the site's timezone.", 'woocommerce' ),
'type' => 'date-time',
'context' => array( 'view', 'edit' ),
),
'date_paid' => array(
'description' => __( "The date the order has been paid, in the site's timezone.", 'woocommerce' ),
'type' => 'date-time',
2016-03-23 11:30:58 +00:00
'context' => array( 'view', 'edit' ),
2016-03-23 12:46:34 +00:00
),
'cart_hash' => array(
'description' => __( 'MD5 hash of cart items to ensure orders are not modified.', 'woocommerce' ),
'type' => 'string',
2016-03-23 12:46:34 +00:00
'context' => array( 'view', 'edit' ),
'readonly' => true,
2016-03-23 11:30:58 +00:00
),
2016-08-17 10:44:39 +00:00
'number' => array(
'description' => __( 'Order number.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'meta_data' => array(
'description' => __( 'Order meta data.', 'woocommerce' ),
2016-12-07 12:20:56 +00:00
'type' => 'array',
2016-08-17 10:44:39 +00:00
'context' => array( 'view', 'edit' ),
2016-12-07 14:24:44 +00:00
'items' => array(
'type' => 'object',
'properties' => array(
'id' => array(
'description' => __( 'Meta ID.', 'woocommerce' ),
2016-12-07 18:13:17 +00:00
'type' => 'integer',
2016-12-07 14:24:44 +00:00
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'key' => array(
'description' => __( 'Meta key.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'value' => array(
'description' => __( 'Meta value.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
2016-08-17 10:44:39 +00:00
),
),
),
2016-03-23 11:30:58 +00:00
'line_items' => array(
2016-03-28 19:17:11 +00:00
'description' => __( 'Line items data.', 'woocommerce' ),
2016-12-07 12:20:56 +00:00
'type' => 'array',
2016-03-23 11:30:58 +00:00
'context' => array( 'view', 'edit' ),
2016-12-07 14:24:44 +00:00
'items' => array(
'type' => 'object',
'properties' => array(
'id' => array(
'description' => __( 'Item ID.', 'woocommerce' ),
'type' => 'integer',
'context' => array( 'view', 'edit' ),
'readonly' => true,
2016-08-17 10:44:39 +00:00
),
2016-12-07 14:24:44 +00:00
'name' => array(
'description' => __( 'Product name.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
2016-03-23 22:19:08 +00:00
),
2016-12-07 14:24:44 +00:00
'product_id' => array(
'description' => __( 'Product ID.', 'woocommerce' ),
'type' => 'integer',
'context' => array( 'view', 'edit' ),
),
'variation_id' => array(
'description' => __( 'Variation ID, if applicable.', 'woocommerce' ),
'type' => 'integer',
'context' => array( 'view', 'edit' ),
),
'quantity' => array(
'description' => __( 'Quantity ordered.', 'woocommerce' ),
'type' => 'integer',
'context' => array( 'view', 'edit' ),
),
'tax_class' => array(
'description' => __( 'Tax class of product.', 'woocommerce' ),
'type' => 'integer',
'context' => array( 'view', 'edit' ),
),
'subtotal' => array(
'description' => __( 'Line subtotal (before discounts).', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'subtotal_tax' => array(
'description' => __( 'Line subtotal tax (before discounts).', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'total' => array(
'description' => __( 'Line total (after discounts).', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'total_tax' => array(
'description' => __( 'Line total tax (after discounts).', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'taxes' => array(
'description' => __( 'Line taxes.', 'woocommerce' ),
'type' => 'array',
'context' => array( 'view', 'edit' ),
'readonly' => true,
'items' => array(
'type' => 'object',
'properties' => array(
'id' => array(
'description' => __( 'Tax rate ID.', 'woocommerce' ),
'type' => 'integer',
'context' => array( 'view', 'edit' ),
),
'total' => array(
'description' => __( 'Tax total.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'subtotal' => array(
'description' => __( 'Tax subtotal.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
),
2016-03-23 22:19:08 +00:00
),
2016-12-07 14:24:44 +00:00
),
'meta_data' => array(
'description' => __( 'Order item meta data.', 'woocommerce' ),
'type' => 'array',
'context' => array( 'view', 'edit' ),
'items' => array(
'type' => 'object',
'properties' => array(
'id' => array(
'description' => __( 'Meta ID.', 'woocommerce' ),
2016-12-07 18:13:17 +00:00
'type' => 'integer',
2016-12-07 14:24:44 +00:00
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'key' => array(
'description' => __( 'Meta key.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'value' => array(
'description' => __( 'Meta value.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
),
2016-03-23 22:19:08 +00:00
),
2016-12-07 14:24:44 +00:00
),
'sku' => array(
'description' => __( 'Product SKU.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'price' => array(
'description' => __( 'Product price.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'meta' => array(
'description' => __( 'Order item meta data (formatted).', 'woocommerce' ),
'type' => 'array',
'context' => array( 'view', 'edit' ),
'readonly' => true,
'items' => array(
'type' => 'object',
'properties' => array(
'key' => array(
'description' => __( 'Meta key.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'label' => array(
'description' => __( 'Meta label.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'value' => array(
'description' => __( 'Meta value.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
),
2016-03-23 22:19:08 +00:00
),
),
),
2016-03-23 11:30:58 +00:00
),
),
2016-03-23 22:19:08 +00:00
'tax_lines' => array(
2016-03-28 19:17:11 +00:00
'description' => __( 'Tax lines data.', 'woocommerce' ),
2016-12-07 12:20:56 +00:00
'type' => 'array',
2016-03-23 11:30:58 +00:00
'context' => array( 'view', 'edit' ),
2016-03-23 22:19:08 +00:00
'readonly' => true,
2016-12-07 14:24:44 +00:00
'items' => array(
'type' => 'object',
'properties' => array(
'id' => array(
'description' => __( 'Item ID.', 'woocommerce' ),
'type' => 'integer',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'rate_code' => array(
'description' => __( 'Tax rate code.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'rate_id' => array(
'description' => __( 'Tax rate ID.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'label' => array(
'description' => __( 'Tax rate label.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'compound' => array(
'description' => __( 'Show if is a compound tax rate.', 'woocommerce' ),
'type' => 'boolean',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'tax_total' => array(
'description' => __( 'Tax total (not including shipping taxes).', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'shipping_tax_total' => array(
'description' => __( 'Shipping tax total.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'meta_data' => array(
'description' => __( 'Order item meta data.', 'woocommerce' ),
'type' => 'array',
'context' => array( 'view', 'edit' ),
'items' => array(
'type' => 'object',
'properties' => array(
'id' => array(
'description' => __( 'Meta ID.', 'woocommerce' ),
2016-12-07 18:13:17 +00:00
'type' => 'integer',
2016-12-07 14:24:44 +00:00
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'key' => array(
'description' => __( 'Meta key.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'value' => array(
'description' => __( 'Meta value.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
),
2016-08-17 10:44:39 +00:00
),
),
),
2016-03-23 11:30:58 +00:00
),
),
2016-03-23 22:19:08 +00:00
'shipping_lines' => array(
2016-03-28 19:17:11 +00:00
'description' => __( 'Shipping lines data.', 'woocommerce' ),
2016-12-07 12:20:56 +00:00
'type' => 'array',
2016-03-23 11:30:58 +00:00
'context' => array( 'view', 'edit' ),
2016-12-07 14:24:44 +00:00
'items' => array(
'type' => 'object',
'properties' => array(
'id' => array(
'description' => __( 'Item ID.', 'woocommerce' ),
'type' => 'integer',
'context' => array( 'view', 'edit' ),
'readonly' => true,
2016-03-23 22:19:08 +00:00
),
2016-12-07 14:24:44 +00:00
'method_title' => array(
'description' => __( 'Shipping method name.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'method_id' => array(
'description' => __( 'Shipping method ID.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'total' => array(
'description' => __( 'Line total (after discounts).', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'total_tax' => array(
'description' => __( 'Line total tax (after discounts).', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'taxes' => array(
'description' => __( 'Line taxes.', 'woocommerce' ),
'type' => 'array',
'context' => array( 'view', 'edit' ),
'readonly' => true,
'items' => array(
'type' => 'object',
'properties' => array(
'id' => array(
'description' => __( 'Tax rate ID.', 'woocommerce' ),
'type' => 'integer',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'total' => array(
'description' => __( 'Tax total.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
),
2016-08-17 10:44:39 +00:00
),
2016-12-07 14:24:44 +00:00
),
'meta_data' => array(
'description' => __( 'Order item meta data.', 'woocommerce' ),
'type' => 'array',
'context' => array( 'view', 'edit' ),
'items' => array(
'type' => 'object',
'properties' => array(
'id' => array(
'description' => __( 'Meta ID.', 'woocommerce' ),
2016-12-07 18:13:17 +00:00
'type' => 'integer',
2016-12-07 14:24:44 +00:00
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'key' => array(
'description' => __( 'Meta key.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'value' => array(
'description' => __( 'Meta value.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
),
2016-08-17 10:44:39 +00:00
),
),
),
2016-03-23 11:30:58 +00:00
),
),
'fee_lines' => array(
2016-03-28 19:17:11 +00:00
'description' => __( 'Fee lines data.', 'woocommerce' ),
2016-12-07 12:20:56 +00:00
'type' => 'array',
2016-03-23 11:30:58 +00:00
'context' => array( 'view', 'edit' ),
2016-12-07 14:24:44 +00:00
'items' => array(
'type' => 'object',
'properties' => array(
'id' => array(
'description' => __( 'Item ID.', 'woocommerce' ),
'type' => 'integer',
'context' => array( 'view', 'edit' ),
'readonly' => true,
2016-03-23 22:19:08 +00:00
),
2016-12-07 14:24:44 +00:00
'name' => array(
'description' => __( 'Fee name.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'tax_class' => array(
'description' => __( 'Tax class of fee.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'tax_status' => array(
'description' => __( 'Tax status of fee.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
'enum' => array( 'taxable', 'none' ),
),
'total' => array(
'description' => __( 'Line total (after discounts).', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'total_tax' => array(
'description' => __( 'Line total tax (after discounts).', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'taxes' => array(
'description' => __( 'Line taxes.', 'woocommerce' ),
'type' => 'array',
'context' => array( 'view', 'edit' ),
'readonly' => true,
'items' => array(
'type' => 'object',
'properties' => array(
'id' => array(
'description' => __( 'Tax rate ID.', 'woocommerce' ),
'type' => 'integer',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'total' => array(
'description' => __( 'Tax total.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'subtotal' => array(
'description' => __( 'Tax subtotal.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
),
2016-08-17 10:44:39 +00:00
),
2016-12-07 14:24:44 +00:00
),
'meta_data' => array(
'description' => __( 'Order item meta data.', 'woocommerce' ),
'type' => 'array',
'context' => array( 'view', 'edit' ),
'items' => array(
'type' => 'object',
'properties' => array(
'id' => array(
'description' => __( 'Meta ID.', 'woocommerce' ),
2016-12-07 18:13:17 +00:00
'type' => 'integer',
2016-12-07 14:24:44 +00:00
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'key' => array(
'description' => __( 'Meta key.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'value' => array(
'description' => __( 'Meta value.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
),
2016-08-17 10:44:39 +00:00
),
),
),
2016-03-23 11:30:58 +00:00
),
),
'coupon_lines' => array(
2016-03-28 19:17:11 +00:00
'description' => __( 'Coupons line data.', 'woocommerce' ),
2016-12-07 12:20:56 +00:00
'type' => 'array',
2016-03-23 11:30:58 +00:00
'context' => array( 'view', 'edit' ),
2016-12-07 14:24:44 +00:00
'items' => array(
'type' => 'object',
'properties' => array(
'id' => array(
'description' => __( 'Item ID.', 'woocommerce' ),
'type' => 'integer',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'code' => array(
'description' => __( 'Coupon code.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'discount' => array(
'description' => __( 'Discount total.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'discount_tax' => array(
'description' => __( 'Discount total tax.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'meta_data' => array(
'description' => __( 'Order item meta data.', 'woocommerce' ),
'type' => 'array',
'context' => array( 'view', 'edit' ),
'items' => array(
'type' => 'object',
'properties' => array(
'id' => array(
'description' => __( 'Meta ID.', 'woocommerce' ),
2016-12-07 18:13:17 +00:00
'type' => 'integer',
2016-12-07 14:24:44 +00:00
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'key' => array(
'description' => __( 'Meta key.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'value' => array(
'description' => __( 'Meta value.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
),
2016-08-17 10:44:39 +00:00
),
),
),
2016-03-23 11:30:58 +00:00
),
),
'refunds' => array(
'description' => __( 'List of refunds.', 'woocommerce' ),
2016-12-07 12:20:56 +00:00
'type' => 'array',
'context' => array( 'view', 'edit' ),
'readonly' => true,
2016-12-07 14:24:44 +00:00
'items' => array(
'type' => 'object',
'properties' => array(
'id' => array(
'description' => __( 'Refund ID.', 'woocommerce' ),
'type' => 'integer',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'reason' => array(
'description' => __( 'Refund reason.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'total' => array(
'description' => __( 'Refund total.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
),
),
),
2016-08-17 10:44:39 +00:00
'set_paid' => array(
'description' => __( 'Define if the order is paid. It will set the status to processing and reduce stock items.', 'woocommerce' ),
'type' => 'boolean',
'default' => false,
'context' => array( 'edit' ),
),
2016-03-23 11:30:58 +00:00
),
);
return $this->add_additional_fields_schema( $schema );
}
2016-03-23 22:19:08 +00:00
/**
* Get the query params for collections.
2016-03-23 22:19:08 +00:00
*
* @return array
*/
public function get_collection_params() {
$params = parent::get_collection_params();
$params['status'] = array(
'default' => 'any',
'description' => __( 'Limit result set to orders assigned a specific status.', 'woocommerce' ),
'type' => 'string',
'enum' => array_merge( array( 'any' ), $this->get_order_statuses() ),
'sanitize_callback' => 'sanitize_key',
'validate_callback' => 'rest_validate_request_arg',
);
2016-03-30 23:26:51 +00:00
$params['customer'] = array(
'description' => __( 'Limit result set to orders assigned a specific customer.', 'woocommerce' ),
'type' => 'integer',
'sanitize_callback' => 'absint',
'validate_callback' => 'rest_validate_request_arg',
);
2016-03-30 23:26:51 +00:00
$params['product'] = array(
'description' => __( 'Limit result set to orders assigned a specific product.', 'woocommerce' ),
'type' => 'integer',
'sanitize_callback' => 'absint',
'validate_callback' => 'rest_validate_request_arg',
);
$params['dp'] = array(
'default' => 2,
'description' => __( 'Number of decimal points to use in each resource.', 'woocommerce' ),
'type' => 'integer',
'sanitize_callback' => 'absint',
'validate_callback' => 'rest_validate_request_arg',
);
2016-03-23 22:19:08 +00:00
return $params;
}
2016-02-17 19:29:09 +00:00
}