Using the REST API

Requirements #

• PDF Invoices & Packing Slips for WooCommerce – Professional
  • At least v2.15.11

Activate WooCommerce REST API #

Path: WooCommerce > Settings > Advanced > REST API.
Our Invoicing plugin uses the WooCommerce REST API in order to provide REST API functionality.

Enable Invoice REST API option #

Path: WooCommerce > PDF Invoices > Advanced > Settings > REST API > Enable.

REST API endpoints #

This can also be found in our Invoicing plugin.
Path: WooCommerce > Settings > Advanced.

Samples #

Retrieve an order #

GET:

This API lets you retrieve and view a specific order. All document data is under the documents field of the response.

http://your-site/wp-json/wc/v3/orders/<id>

JSON response example – retrieve an order: #

{
    ...
    "documents": {
        "invoice": {
            "number": "1",
            "date": "2024-02-27T15:34:31",
            "date_timestamp": 1709048071
        },
        "proforma": {
            "number": 1,
            "date": "2024-02-23T13:25:50",
            "date_timestamp": 1708694750
        },
        "credit-note": [
            {
                "number": 2,
                "date": "2024-02-28T10:34:31",
                "date_timestamp": 1735893084
            },
            {
                "number": 3,
                "date": "2024-02-28T10:34:32",
                "date_timestamp": 1735892964
            }
        ]
    },
}

NOTE: Since an order can have multiple refunds, and therefore multiple credit notes, the Credit Note output will be an array of documents rather than a single document.

Create or regenerate a document #

This API lets you create or regenerate a document for a specific order and view its details. If the document is already created and the regenerate query parameter is false, it’ll return the current document details.

POST:

http://your-site/wp-json/wc/v3/orders/<id>/documents

Query parameters – create or regenerate a document #

Body form-data – create or regenerate a document #

JSON response example – create or regenerate a document: #

{
    "number": "1078",
    "date": "2024-03-02T13:37:25",
    "date_timestamp": 1709386645
}

Download a document #

This API lets you download a PDF document for a specific order.

GET:

http://your-site/wp-json/wc/v3/orders/<id>/documents

Query parameters – download a document #

Delete a document #

This API lets you delete a document.

Delete:

http://your-site/wp-json/wc/v3/orders/<id>/documents

Query parameters – delete a document #

JSON response example – delete a document: #

{
    "success": "Document deleted."
}