Products_Controller::get_collection_params()
Summary
No summary available.Source
File: src/BigCommerce/Rest/Products_Controller.php
public function get_collection_params() { $query_params = parent::get_collection_params(); foreach ( Shortcodes\Products::default_attributes() as $key => $default ) { $params[ $key ] = [ 'type' => is_int( $default ) ? 'integer' : 'string', 'default' => $default, ]; } $query_params['order'] = [ 'description' => __( 'Direction to sort results', 'bigcommerce' ), 'type' => 'string', 'default' => 'asc', 'enum' => [ 'asc', 'desc' ], ]; $query_params['bcid'] = [ 'description' => __( 'BigCommerce product IDs', 'bigcommerce' ), 'type' => 'array', 'items' => [ 'type' => 'integer', ], 'default' => [], ]; $query_params['recent'] = [ 'description' => __( 'Limits results to products updated in the last 2 days', 'bigcommerce' ), 'type' => 'boolean', 'default' => false, ]; $query_params[ Channel::NAME ] = [ 'description' => __( 'Limits results to products from the given channel', 'bigcommerce' ), 'type' => 'integer', 'default' => 0, ]; foreach ( $this->taxonomy_params() as $taxonomy ) { $query_params[ $taxonomy ] = [ /* translators: %s: taxonomy name */ 'description' => sprintf( __( 'Limit result set to all items that have the specified term assigned in the %s taxonomy.', 'bigcommerce' ), $taxonomy ), 'type' => 'array', 'items' => [ 'type' => 'integer', ], 'default' => [], ]; } return $query_params; }