{"id":19974370,"url":"https://github.com/corcel/woocommerce","last_synced_at":"2025-04-05T17:06:46.854Z","repository":{"id":39423617,"uuid":"101505977","full_name":"corcel/woocommerce","owner":"corcel","description":"Corcel WooCommerce Plugin","archived":false,"fork":false,"pushed_at":"2024-06-16T17:00:34.000Z","size":219,"stargazers_count":107,"open_issues_count":8,"forks_count":31,"subscribers_count":10,"default_branch":"master","last_synced_at":"2025-03-29T16:05:16.213Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/corcel.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-08-26T18:46:06.000Z","updated_at":"2025-03-26T22:37:11.000Z","dependencies_parsed_at":"2024-05-15T22:02:42.440Z","dependency_job_id":"3f527ac3-25cc-406f-81d6-cab137b89945","html_url":"https://github.com/corcel/woocommerce","commit_stats":{"total_commits":51,"total_committers":7,"mean_commits":7.285714285714286,"dds":0.5294117647058824,"last_synced_commit":"b0af08471c34de655f3d0b185a14f113351ef6a0"},"previous_names":[],"tags_count":15,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/corcel%2Fwoocommerce","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/corcel%2Fwoocommerce/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/corcel%2Fwoocommerce/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/corcel%2Fwoocommerce/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/corcel","download_url":"https://codeload.github.com/corcel/woocommerce/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247369952,"owners_count":20927928,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-13T03:14:47.317Z","updated_at":"2025-04-05T17:06:46.828Z","avatar_url":"https://github.com/corcel.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://raw.githubusercontent.com/corcel/woocommerce/master/.github/logo.jpg\" alt=\"Corcel WooCommerce logo\" /\u003e\n\u003c/p\u003e\n\n**A collection of Laravel models for WooCommerce.**\n\nThis plugin extends base [Corcel](https://github.com/corcel/corcel) package and allows fetching WooCommerce data from WordPress database. Currently this plugin implements the following models:\n\n* [Customer](#customer-model) - wrapper for User model\n* [Order](#order-model) - wrapper for Post model\n* [Product](#product-model) - wrapper for Post model\n* [Item](#item-model)\n* Product Category - wrapper for Taxonomy model\n* Product Tag - wrapper for Taxonomy model\n* Product Attribute - helper model for getting product attributes (should not be used directly)\n* Product Type - helper model for getting product types (should not be used directly)\n\nSome meta values are collected into helper classes:\n\n* [BillingAddress](#billingaddress-helper) - helper for customer and order billing address\n* [ShippingAddress](#shippingaddress-helper) - helper for customer and order shipping address\n* [Payment](#payment-helper) - helper for order payment\n\n## Compatibility list\n\n| Corcel WooCommerce                                    | Laravel        | PHP version   | Supported          |\n| ----------------------------------------------------- | -------------- | ------------- | ------------------ |\n| 5.x (master)                                          | 10.x, 11.x     | \u003e= 8.2        | :white_check_mark: |\n| [4.x](https://github.com/corcel/woocommerce/tree/4.x) | 10.x           | \u003e= 8.1        | :white_check_mark: |\n| [3.x](https://github.com/corcel/woocommerce/tree/3.x) | 9.x            | \u003e= 8.0.3      | :x:                |\n| [2.x](https://github.com/corcel/woocommerce/tree/2.x) | 6.x, 7.x, 8.x  | \u003e= 7.3 \\| 8.0 | :x:                |\n| [1.x](https://github.com/corcel/woocommerce/tree/1.x) | 6.x, 7.x       | \u003e= 7.2        | :x:                |\n\n## Installation\n\n```bash\ncomposer require corcel/woocommerce\n```\n\n## Models list\n\n### Customer model\n\n#### Get customer by id\n\n```php\n$customer = Customer::find(1);\n```\n\n#### Customer relation\n\n```php\n$customer = Customer::find(1);\n\n$customerOrders = $customer-\u003eorders;\n```\n\n#### Customer properties\n\n```php\n$customer = Customer::find(1);\n\n$customer-\u003eorder_count;      // e.g. 10\n$customer-\u003ebilling_address;  // \\Corcel\\WooCommerce\\Support\\BillingAddress class instance\n$customer-\u003eshipping_address; // \\Corcel\\WooCommerce\\Support\\ShippingAddress class instance\n```\n\n### Order model\n\n#### Get order by id\n\n```php\n$order = Order::find(1);\n```\n\n#### Get completed orders\n\n```php\n$completedOrders = Order::completed()-\u003eget();\n```\n\n*For other statuses methods please check [OrderBuilder.php](src/Model/Builder/OrderBuilder.php).*\n\n#### Order relations\n\n```php\n$order = Order::find(1);\n\n$orderItems    = $order-\u003eitems;\n$orderCustomer = $order-\u003ecustomer;\n```\n\n#### Order properties\n\n```php\n$order = Order::find(1);\n\n$order-\u003ecurrency;         // e.g. EUR\n$order-\u003etotal;            // e.g. 10.20\n$order-\u003etax;              // e.g. 0.50\n$order-\u003eshipping_tax;     // e.g. 0.20\n$order-\u003estatus;           // e.g. completed\n$order-\u003edate_completed;   // e.g. 2020-06-01 10:00:00\n$order-\u003edate_paid;        // e.g. 2020-06-01 10:00:00\n$order-\u003epayment;          // \\Corcel\\WooCommerce\\Support\\Payment class instance\n$order-\u003ebilling_address;  // \\Corcel\\WooCommerce\\Support\\BillingAddress class instance\n$order-\u003eshipping_address; // \\Corcel\\WooCommerce\\Support\\ShippingAddress class instance\n```\n\n### Item model\n\n#### Get item by id\n\n```php\n$item = Item::find(1);\n```\n\n#### Item relations\n\n```php\n$item = Item::find(1);\n\n$itemOrder   = $item-\u003eorder;\n$itemProduct = $item-\u003eproduct;\n```\n\n#### Item properties\n\n```php\n$item = Item::find(1);\n\n$item-\u003eorder_item_id;\n$item-\u003eorder_item_name;\n$item-\u003eorder_item_type;\n$item-\u003eorder_id;\n$item-\u003eproduct_id;\n$item-\u003evariation_id;\n$item-\u003equantity;          // e.g. 2\n$item-\u003etax_class;\n$item-\u003eline_subtotal;     // e.g. 5.50\n$item-\u003eline_subtotal_tax; // e.g. 0.50\n$item-\u003eline_total;        // e.g. 10.50\n$item-\u003eline_tax;          // e.g. 2.00\n```\n\n### Product model\n\n#### Get product by id\n\n```php\n$product = Product::find(1);\n```\n\n#### Product relations\n\n```php\n$product = Product::find(1);\n\n$product-\u003ecategories;\n$product-\u003eitems;\n$product-\u003etags;\n```\n\n#### Product properties\n\n```php\n$product = Product::find(1);\n\n$product-\u003eprice;\n$product-\u003eregular_price;\n$product-\u003esale_price;\n$product-\u003eon_sale;\n$product-\u003esku;\n$product-\u003etax_status;\n$product-\u003eis_taxable;\n$product-\u003eweight;\n$product-\u003elength;\n$product-\u003ewidth;\n$product-\u003eheight;\n$product-\u003eis_virtual;\n$product-\u003eis_downloadable;\n$product-\u003estock;\n$product-\u003ein_stock;\n$product-\u003etype;\n$product-\u003eattributes; // Collection of (variation) attributes\n$product-\u003ecrosssells; // Collection of cross-sell products\n$product-\u003eupsells;    // Collection of up-sell products\n$product-\u003egallery;    // Collection of gallery attachments\n```\n\n## Helper classes list\n\n### BillingAddress helper\n\nThis class collects customer and order meta related to billing address.\n\n```php\n$order   = Order::find(1);\n$address = $order-\u003ebillingAddress;\n\n$address-\u003efirst_name;\n$address-\u003elast_name;\n$address-\u003ecompany;\n$address-\u003eaddress_1;\n$address-\u003eaddress_2;\n$address-\u003ecity;\n$address-\u003estate;\n$address-\u003epostcode;\n$address-\u003ecountry;\n$address-\u003eemail;\n$address-\u003ephone;\n```\n\n### ShippingAddress helper\n\nThis class collects customer and order meta related to billing address.\n\n```php\n$order   = Order::find(1);\n$address = $order-\u003eshippingAddress;\n\n$address-\u003efirst_name;\n$address-\u003elast_name;\n$address-\u003ecompany;\n$address-\u003eaddress_1;\n$address-\u003eaddress_2;\n$address-\u003ecity;\n$address-\u003estate;\n$address-\u003epostcode;\n$address-\u003ecountry;\n```\n\n### Payment helper\n\nThis class collects order meta related to payment.\n\n```php\n$order   = Order::find(1);\n$payment = $order-\u003epayment;\n\n$payment-\u003emethod;\n$payment-\u003emethod_title;\n$payment-\u003etransaction_id;\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcorcel%2Fwoocommerce","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcorcel%2Fwoocommerce","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcorcel%2Fwoocommerce/lists"}