<?php
if ( ! defined( 'ABSPATH' ) ) {
exit;
}
if ( class_exists( 'WC_REST_Connect_Shipping_Label_Controller' ) ) {
return;
}
class WC_REST_Connect_Shipping_Label_Controller extends WC_REST_Connect_Base_Controller {
protected $rest_base = 'connect/label/(?P<order_id>\d+)';
/*
* @var WC_Connect_Shipping_Label
*/
protected $shipping_label;
/*
* @var WC_Connect_Payment_Methods_Store
*/
protected $payment_methods_store;
public function __construct( WC_Connect_API_Client $api_client, WC_Connect_Service_Settings_Store $settings_store, WC_Connect_Logger $logger, WC_Connect_Shipping_Label $shipping_label, WC_Connect_Payment_Methods_Store $payment_methods_store ) {
parent::__construct( $api_client, $settings_store, $logger );
$this->shipping_label = $shipping_label;
$this->payment_methods_store = $payment_methods_store;
}
public function register_routes() {
parent::register_routes();
register_rest_route(
$this->namespace,
'/' . $this->rest_base . '/creation_eligibility',
array(
array(
'methods' => 'GET',
'callback' => array( $this, 'get_creation_eligibility' ),
'permission_callback' => array( $this, 'check_permission' ),
),
)
);
}
public function get( $request ) {
$order_id = $request['order_id'];
$payload = $this->shipping_label->get_label_payload( $order_id );
if ( ! $payload ) {
return new WP_Error( 'not_found', __( 'Order not found', 'woocommerce-services' ), array( 'status' => 404 ) );
}
$payload['success'] = true;
return new WP_REST_Response( $payload, 200 );
}
public function post( $request ) {
$settings = $request->get_json_params();
$order_id = $request['order_id'];
$settings['order_id'] = $order_id;
if ( empty( $settings['payment_method_id'] ) || ! $this->settings_store->can_user_manage_payment_methods() ) {
$settings['payment_method_id'] = $this->settings_store->get_selected_payment_method_id();
} else {
$this->settings_store->set_selected_payment_method_id( $settings['payment_method_id'] );
}
$last_box_id = '';
$last_service_id = '';
$last_carrier_id = '';
$service_names = array();
foreach ( $settings['packages'] as $index => $package ) {
$service_names[] = $package['service_name'];
unset( $package['service_name'] );
$settings['packages'][ $index ] = $package;
if ( empty( $last_box_id ) && ! empty( $package['box_id'] ) ) {
$last_box_id = $package['box_id'];
}
if ( empty( $last_service_id ) && ! empty( $package['service_id'] ) ) {
$last_service_id = $package['service_id'];
}
if ( empty( $last_carrier_id ) && ! empty( $package['carrier_id'] ) ) {
$last_carrier_id = $package['carrier_id'];
}
}
if ( ! empty( $last_box_id ) && 'individual' !== $last_box_id ) {
update_user_meta( get_current_user_id(), 'wc_connect_last_box_id', $last_box_id );
}
if ( ! empty( $last_service_id ) && '' !== $last_service_id ) {
update_user_meta( get_current_user_id(), 'wc_connect_last_service_id', $last_service_id );
}
if ( ! empty( $last_carrier_id ) && '' !== $last_carrier_id ) {
update_user_meta( get_current_user_id(), 'wc_connect_last_carrier_id', $last_carrier_id );
}
$response = $this->api_client->send_shipping_label_request( $settings );
if ( is_wp_error( $response ) ) {
$error = new WP_Error(
$response->get_error_code(),
$response->get_error_message(),
array( 'message' => $response->get_error_message() )
);
$this->logger->log( $error, __CLASS__ );
return $error;
}
$label_ids = array();
$purchased_labels_meta = array();
$package_lookup = $this->settings_store->get_package_lookup();
foreach ( $response->labels as $index => $label_data ) {
if ( isset( $label_data->error ) ) {
$error = new WP_Error(
$label_data->error->code,
$label_data->error->message,
array( 'message' => $label_data->error->message )
);
$this->logger->log( $error, __CLASS__ );
return $error;
}
$label_ids[] = $label_data->label->label_id;
$label_meta = array(
'label_id' => $label_data->label->label_id,
'tracking' => $label_data->label->tracking_id,
'refundable_amount' => $label_data->label->refundable_amount,
'created' => $label_data->label->created,
'carrier_id' => $label_data->label->carrier_id,
'service_name' => $service_names[ $index ],
'status' => $label_data->label->status,
'commercial_invoice_url' => $label_data->label->commercial_invoice_url ?? '',
'is_commercial_invoice_submitted_electronically' => $label_data->label->is_commercial_invoice_submitted_electronically ?? '',
);
$package = $settings['packages'][ $index ];
$box_id = $package['box_id'];
if ( 'individual' === $box_id ) {
$label_meta['package_name'] = __( 'Individual packaging', 'woocommerce-services' );
} elseif ( isset( $package_lookup[ $box_id ] ) ) {
$label_meta['package_name'] = $package_lookup[ $box_id ]['name'];
} else {
$label_meta['package_name'] = __( 'Unknown package', 'woocommerce-services' );
}
$label_meta['is_letter'] = isset( $package['is_letter'] ) ? $package['is_letter'] : false;
$product_names = array();
$product_ids = array();
foreach ( $package['products'] as $product_id ) {
$product = wc_get_product( $product_id );
$product_ids[] = $product_id;
if ( $product ) {
$product_names[] = $product->get_title();
} else {
$order = wc_get_order( $order_id );
$product_names[] = WC_Connect_Utils::get_product_name_from_order( $product_id, $order );
}
}
$label_meta['product_names'] = $product_names;
$label_meta['product_ids'] = $product_ids;
array_unshift( $purchased_labels_meta, $label_meta );
}
$this->settings_store->add_labels_to_order( $order_id, $purchased_labels_meta );
return array(
'labels' => $purchased_labels_meta,
'success' => true,
);
}
/**
* Available params for $request:
* - `can_create_payment_method: Boolean`: optional with default value `true`. If `false`, at least one existing payment method is
* required for label creation.
* - `can_create_package: Boolean`: optional with default value `true`. If `false`, at least one pre-existing
* package (custom or predefined) is required for label creation.
* - `can_create_customs_form: Boolean`: optional with default value `true`. If `false`, the order is eligible for
* label creation if a customs form is not required for the origin and destination address in the US.
*
* @param WP_REST_Request $request API request with optional parameters as above.
* @return WP_REST_Response
*/
public function get_creation_eligibility( $request ) {
$order_id = $request['order_id'];
$order = wc_get_order( $order_id );
if ( ! $order ) {
return new WP_REST_Response(
array(
'is_eligible' => false,
'reason' => 'order_not_found',
),
200
);
}
// Shipping labels should be enabled in account settings.
if ( true !== $this->settings_store->get_account_settings()['enabled'] ) {
return new WP_REST_Response(
array(
'is_eligible' => false,
'reason' => 'account_settings_disabled',
),
200
);
}
// Check if the store is eligible for shipping label creation.
if ( ! $this->shipping_label->is_store_eligible_for_shipping_label_creation() ) {
return new WP_REST_Response(
array(
'is_eligible' => false,
'reason' => 'store_not_eligible',
),
200
);
}
// If the client cannot create a customs form:
// - The store address has to be in the US.
// - The origin and destination addresses have to be in the US.
$client_can_create_customs_form = isset( $request['can_create_customs_form'] ) ? filter_var( $request['can_create_customs_form'], FILTER_VALIDATE_BOOLEAN ) : true;
$store_country = wc_get_base_location()['country'];
if ( ! $client_can_create_customs_form ) {
// The store address has to be in the US.
if ( 'US' !== $store_country ) {
return new WP_REST_Response(
array(
'is_eligible' => false,
'reason' => 'store_country_not_supported_when_customs_form_is_not_supported_by_client',
),
200
);
}
// The origin and destination addresses have to be in the US.
$origin_address = $this->settings_store->get_origin_address();
$destination_address = $order->get_address( 'shipping' );
if ( 'US' !== $origin_address['country'] || 'US' !== $destination_address['country'] ) {
return new WP_REST_Response(
array(
'is_eligible' => false,
'reason' => 'origin_or_destination_country_not_supported_when_customs_form_is_not_supported_by_client',
),
200
);
}
}
// If the client cannot create a package (`can_create_package` param is set to `false`), a pre-existing package
// is required.
$client_can_create_package = isset( $request['can_create_package'] ) ? filter_var( $request['can_create_package'], FILTER_VALIDATE_BOOLEAN ) : true;
if ( ! $client_can_create_package ) {
if ( empty( $this->settings_store->get_packages() ) && empty( $this->settings_store->get_predefined_packages() ) ) {
return new WP_REST_Response(
array(
'is_eligible' => false,
'reason' => 'no_packages_when_client_cannot_create_package',
),
200
);
}
}
// There is at least one non-refunded and shippable product.
if ( ! $this->shipping_label->is_order_eligible_for_shipping_label_creation( $order ) ) {
return new WP_REST_Response(
array(
'is_eligible' => false,
'reason' => 'order_not_eligible',
),
200
);
}
// If the client cannot create a payment method (`can_create_payment_method` param is set to `false`), an existing payment method is required.
$client_can_create_payment_method = isset( $request['can_create_payment_method'] ) ? filter_var( $request['can_create_payment_method'], FILTER_VALIDATE_BOOLEAN ) : true;
if ( ! $client_can_create_payment_method && empty( $this->payment_methods_store->get_payment_methods() ) ) {
return new WP_REST_Response(
array(
'is_eligible' => false,
'reason' => 'no_payment_methods_and_client_cannot_create_one',
),
200
);
}
// There is a pre-selected payment method or the user can manage payment methods.
if ( ! ( $this->settings_store->get_selected_payment_method_id() || $this->settings_store->can_user_manage_payment_methods() ) ) {
return new WP_REST_Response(
array(
'is_eligible' => false,
'reason' => 'no_selected_payment_method_and_user_cannot_manage_payment_methods',
),
200
);
}
return new WP_REST_Response(
array(
'is_eligible' => true,
),
200
);
}
}