WooCommerce

https://woocommerce.com/document/
Admin
WooCommerce is a flexible, open-source e-commerce platform for WordPress that enables businesses to...
Tokens:6,026,911
Snippets:60,417
Trust Score:10
Update:1 week ago
Show doc for...
Tokens:
Raw
### Get Product Tickets - Example Request

Source: https://woocommerce.com/document/ticket-checkin/qr-code-tickets-and-check-in-for-woocommerce-rest-api-documentation

Example request to get all tickets for a specific product, with optional status and pagination parameters.

```http
GET /products/123/tickets?status=valid&per_page=20
```

--------------------------------

### Example query string for wc_am_action=product_list

Source: https://woocommerce.com/document/api-documentation

Use this query string to call the product_list action. It requires the api_key and instance parameters; the instance ID is used only for caching the response for one hour and is not tied to an API Key activation.

```http
https://wc/?wc-api=wc-am-api&wc_am_action=product_list&api_key=b9dc373c7983cda3897c1502574b1bf929e02a53&instance=p1uOusaNM5ub3
```

--------------------------------

### Get All Tickets - Example Response

Source: https://woocommerce.com/document/ticket-checkin/qr-code-tickets-and-check-in-for-woocommerce-rest-api-documentation

Example response for the Get All Tickets endpoint, showing a ticket object with fields like ticket_code, status, and checkin details.

```json
{
  "success": true,
  "data": [
    {
      "id": 1,
      "ticket_code": "TKT-8X7K9M2P",
      "order_id": 45,
      "product_id": 123,
      "product_name": "Conference Pass",
      "customer_name": "John Doe",
      "customer_email": "john@example.com",
      "status": "Valid",
      "status_class": "valid",
      "is_checked_in": false,
      "is_expired": false,
      "checkin_type": "single_entry",
      "checkin_count": 0,
      "max_checkins": 1,
      "expires_at": "2025-12-31 23:59:59",
      "created_at": "2025-01-15 10:30:00",
      "qr_code_url": "https://api.qrserver.com/..."
    }
  ]
}
```

--------------------------------

### Status API Key - Example Query String

Source: https://woocommerce.com/document/api-documentation

Query string for the wc_am_action=status action. Requires api_key, product_id, and instance parameters. Optional version parameter.

```http
https://wc/?wc-api=wc-am-api&wc_am_action=status&instance=p1uOusaNM5ub3&product_id=62912&api_key=448567cf667c299bb706df6fe64ed2b44c7d37ba
```

--------------------------------

### Get schedule by ID example

Source: https://woocommerce.com/document/store-vacation

Example request for a single schedule with ID 123.

```http
GET https://your-domain.com/wp-json/store-vacation/v1/schedule/123
```

--------------------------------

### paypal_standard_subscription_args() example: Build PayPal Standard subscription request

Source: https://woocommerce.com/document/payment-gateway-integration-guide

Example from the bundled WC_PayPal_Standard_Subscriptions class showing how to access subscription details and build a PayPal Standard request. It extracts order ID and key, checks if the order contains a subscription, and sets PayPal arguments for subscriptions, including trial periods, sign-up fees, recurring payments, and return URL behavior. Note the use of HTML entities (&gt;, &amp;) in the source code.

```php
extract( self::get_order_id_and_key( $paypal_args ) );

if ( WC_Subscriptions_Order::order_contains_subscription( $order_id ) ) {

    $order = new WC_Order( $order_id );

    $order_items = $order-&gt;get_items();

    // Only one subscription allowed in the cart when PayPal Standard is active
    $product = $order-&gt;get_product_from_item( $order_items[0] );

    // It's a subscription
    $paypal_args['cmd'] = '_xclick-subscriptions';

    if ( count( $order-&gt;get_items() ) &gt; 1 ) {

        foreach ( $order-&gt;get_items() as $item ) {
            if ( $item['qty'] &gt; 1 )
                $item_names[] = $item['qty'] . ' x ' . $item['name'];
            else if ( $item['qty'] &gt; 0 )
                $item_names[] = $item['name'];
        }

        $paypal_args['item_name'] = sprintf( __( 'Order %s', WC_Subscriptions::$text_domain ), $order-&gt;get_order_number() );

    } else {

        $paypal_args['item_name'] = $product-&gt;get_title();

    }

    $unconverted_periods = array(
        'billing_period' =&gt; WC_Subscriptions_Order::get_subscription_period( $order ),
        'trial_period'   =&gt; WC_Subscriptions_Order::get_subscription_trial_period( $order )
    );

    $converted_periods = array();

    // Convert period strings into PayPay's format
    foreach ( $unconverted_periods as $key =&gt; $period ) {
        switch( strtolower( $period ) ) {
            case 'day':
                $converted_periods[$key] = 'D';
                break;
            case 'week':
                $converted_periods[$key] = 'W';
                break;
            case 'year':
                $converted_periods[$key] = 'Y';
                break;
            case 'month':
            default:
                $converted_periods[$key] = 'M';
                break;
        }
    }

    $sign_up_fee = WC_Subscriptions_Order::get_sign_up_fee( $order );

    $initial_payment = WC_Subscriptions_Order::get_total_initial_payment( $order );

    $price_per_period = WC_Subscriptions_Order::get_recurring_total( $order );

    $subscription_interval = WC_Subscriptions_Order::get_subscription_interval( $order );

    $subscription_installments = WC_Subscriptions_Order::get_subscription_length( $order ) / $subscription_interval;

    $subscription_trial_length = WC_Subscriptions_Order::get_subscription_trial_length( $order );

    if ( $subscription_trial_length &gt; 0 ) { // Specify a free trial period

        $paypal_args['a1'] = ( $sign_up_fee &gt; 0 ) ? $sign_up_fee : 0; // Maybe add the sign up fee to the free trial period

        // Trial period length
        $paypal_args['p1'] = $subscription_trial_length;

        // Trial period
        $paypal_args['t1'] = $converted_periods['trial_period'];

    } elseif ( $sign_up_fee &gt; 0 ) { // No trial period, so charge sign up fee and per period price for the first period

        if ( $subscription_installments == 1 )
            $param_number = 3;
        else
            $param_number = 1;

        $paypal_args['a'.$param_number] = $initial_payment;

        // Sign Up interval
        $paypal_args['p'.$param_number] = $subscription_interval;

        // Sign Up unit of duration
        $paypal_args['t'.$param_number] = $converted_periods['billing_period'];

    }

    // We have a recurring payment
    if ( ! isset( $param_number ) || $param_number == 1 ) {

        // Subscription price
        $paypal_args['a3'] = $price_per_period;

        // Subscription duration
        $paypal_args['p3'] = $subscription_interval;

        // Subscription period
        $paypal_args['t3'] = $converted_periods['billing_period'];

    }

    // Recurring payments
    if ( $subscription_installments == 1 || ( $sign_up_fee &gt; 0 &amp;&amp; $subscription_trial_length == 0 &amp;&amp; $subscription_installments == 2 ) ) {

        // Non-recurring payments
        $paypal_args['src'] = 0;

    } else {

        $paypal_args['src'] = 1;

        if ( $subscription_installments &gt; 0 ) {
            if ( $sign_up_fee &gt; 0 &amp;&amp; $subscription_trial_length == 0 ) // An initial period is being used to charge a sign-up fee
                $subscription_installments--;

            $paypal_args['srt'] = $subscription_installments;

        }
    }

    // Force return URL so that order description &amp; instructions display
    $paypal_args['rm'] = 2;

}
```

--------------------------------

### Get All Tickets - Example Request

Source: https://woocommerce.com/document/ticket-checkin/qr-code-tickets-and-check-in-for-woocommerce-rest-api-documentation

Example request to list all tickets with pagination and filtering by status.

```http
GET /tickets?status=valid&per_page=20&page=1
```

--------------------------------

### host command output example

Source: https://woocommerce.com/document/woocommerce-distance-rate-shipping

Example output from the host command showing the server's IPv4 and IPv6 addresses. Use these addresses to configure IP-based restrictions for your Google API key, e.g., xxx.xxx.xx.xxx/32 for IPv4 or xxxx:xxxx:x::xxx/128 for IPv6.

```text
yourdomain.com has address xxx.xxx.xx.xxx
yourdomain.com has IPv6 address xxxx:xxxx:x::xxx

```

--------------------------------

### Get a single weekday schedule example

Source: https://woocommerce.com/document/store-vacation

Example request for a single Weekday schedule by ID.

```http
GET https://your-domain.com/wp-json/store-vacation/v1/weekday/123
```
Tokens:
Raw