# WooCommerce REST API

Use this page when something at the till doesn't match your store. Start with what looks wrong:

* **A product's price, stock count or custom field:** [Check a product](#check-a-product). Needs [WCPOS Pro](/pt-BR/getting-started/pro-license.md), as do the **Products**, **Orders**, **Customers** and **Coupons** screens.
* **The order in the cart:** [Check the order in the cart](#check-the-order). Works without Pro.
* **One line's custom fields, such as an engraving:** [Check one line](#check-a-line). Works without Pro.
* **A plugin's change never shows in the POS:** [Why some plugins don't change the POS](#why-dont-some-plugins-work-in-the-pos).

How the POS talks to your store

The POS gets everything through the **WooCommerce REST API**, the way other apps talk to your store. The POS on your till asks your store for products and customers, your store answers in **JSON** (plain text that lists every field by name), and the POS sends each sale back as a WooCommerce order.

SVG not found

In the diagram, **Your Store** is your shop with its till, and **Datacenter** is the server your WooCommerce site runs on. Requests go from the till to your site, and the JSON answers come back.

## What the POS gets from your store[​](#what-the-pos-gets "Link direto para What the POS gets from your store")

* **The API must be there.** When you connect a store, the POS checks that your site offers the WooCommerce REST API. If it doesn't, connecting stops with [AUTH321: WooCommerce missing](/pt-BR/error-codes/AUTH321.md).
* **A copy on the device.** The POS downloads products and variations, categories, tags and brands, customers, tax rates, coupons and orders, and keeps a copy on the device. Searching and selling read that copy, so the till stays fast and keeps working when the internet drops.
* **Sales go back as orders.** A sale, a new customer or a product edit made at the till goes back to your store, and WooCommerce saves it. Each sale becomes a normal WooCommerce order you can open in **WooCommerce > Orders**.
* **Changes come in the background.** The POS checks your store for changes while it runs, so an edit made in WP Admin reaches the till without a restart. [How the Sync Engine Works](/pt-BR/developers/sync-engine.md) explains how.

For developers: the routes the POS calls

The REST API gives each kind of store data its own address under `/wp-json/`: products, orders, customers, coupons and so on. WooCommerce's own routes sit under `wc/v3`.

The WCPOS plugin adds its own `wcpos/v2` routes to your store. These routes pass reads and the till's changes on to WooCommerce's `wc/v3` API inside your site, so the POS gets the same fields as any WooCommerce app and WooCommerce saves each order. Pro's [per-store prices](/pt-BR/manage-store/stores/set-up-stores.md#per-store-pricing), and some extensions, change the values the POS receives. Payments, closing a sale, registers and sessions use the plugin's own routes: see [The REST API](/pt-BR/developers/architecture.md#api-extensions).

## See the data the POS holds[​](#viewing-the-json-data-in-the-pos "Link direto para See the data the POS holds")

Every panel that shows one record has a **JSON** tab beside **Form**: a product, a variation, a customer, a coupon, an order, **Order details** in the cart, and a cart line's **Edit** dialog. It shows the record as this device holds it, in WooCommerce's JSON format. You don't need it to make a sale.

Checking a product needs [WCPOS Pro](/pt-BR/getting-started/pro-license.md). The cart and its lines have a **JSON** tab on every till.

### Check a product[​](#check-a-product "Link direto para Check a product")

Open the product's **JSON** tab, then read [a price](#read-price), [a stock count](#read-stock) or [a custom field](#read-meta-data) and compare it with the product in WP Admin, your store's WordPress dashboard. If you can't sign in to WP Admin, note the value and ask whoever runs your store to compare it.

1. Open **Products** from the menu and search for the product.
2. Tap the open arrow (›) at the end of its row. The panel opens on the **Form** tab.
3. Tap **JSON**.

![The Products screen searched for Aim Analog Watch, with its panel open on the Form tab: Name, Regular Price, SKU, Barcode, Stock and the other fields, with Sync and Close at the foot](/img/2.x/reference/wc-rest-api/en/tablet-light-regular--ref-1-product-form.png)1234

1. **Form** — the fields you can change at the till. The panel opens here.
2. **JSON** — the product as the POS holds it.
3. **Sync** — fetches this product from your store again. Only on the **Form** tab.
4. **Close** — puts the panel away. **✕** at the top does the same.

![The top of the Aim Analog Watch JSON: 73 items, then id 67038, name and slug](/img/2.x/reference/wc-rest-api/en/tablet-light-regular--ref-2-product-json.png)12

1. **73 items** — how many fields your store sent for this product.
2. **id** — the product's ID in WooCommerce.

Fields that contain other fields, such as `categories` or `meta_data`, start folded: tap one to open it. Scroll to see the rest.

#### A price[​](#read-price "Link direto para A price")

Scroll down to `price`. Compare it, `regular_price` and `sale_price` with **Product data > General** on the product in WP Admin. If the product has its own price for this store ([per-store prices](/pt-BR/manage-store/stores/set-up-stores.md#per-store-pricing)), compare with that store's price on the same tab.

![The Aim Analog Watch JSON cropped to its price fields: price 45, regular\_price 45 and an empty sale\_price](/img/2.x/reference/wc-rest-api/en/tablet-light-regular--ref-3-product-price.png)123

1. **price** — the price the product sells for now: the sale price while a sale runs, otherwise the regular price.
2. **regular\_price** — the price without a sale.
3. **sale\_price** — empty when the product has no sale price.

#### A stock count[​](#read-stock "Link direto para A stock count")

Scroll down to `stock_quantity`. It holds a number only when `manage_stock` is `true`; otherwise it is `null` (empty). Compare it with **Product data > Inventory**.

![The Aim Analog Watch JSON cropped to its stock fields: manage\_stock true and stock\_quantity 85](/img/2.x/reference/wc-rest-api/en/tablet-light-regular--ref-4-product-stock.png)12

1. **manage\_stock** — `true`: WooCommerce counts this product's stock.
2. **stock\_quantity** — the count the POS holds: `85`, as on the **Form** tab.

#### A custom field or a plugin's data[​](#read-meta-data "Link direto para A custom field or a plugin's data")

Scroll down to `meta_data` and tap it, then tap an entry. This close-up is from a phone, where a long value wraps onto a second line.

![The Aim Analog Watch JSON on a phone with meta\_data opened, 1 item, and its first entry opened to show its key, \_woocommerce\_pos\_uuid, and its value, wrapped onto two lines](/img/2.x/reference/wc-rest-api/en/phone-light-regular--ref-5-product-meta.png)123

1. **meta\_data** — the product's custom fields, one entry each.
2. **key** — the field's name.
3. **value** — what the field holds.

#### If a value doesn't match WP Admin[​](#value-differs "Link direto para If a value doesn't match WP Admin")

Tap **Form**, then **Sync**, to fetch the product again.

* **If you see Couldn't refresh:** the device kept its old copy. Check your connection and try again.
* **If no error appears but the value still differs:** the POS now holds what your store's API sends. A plugin may be changing the value on your website only: see [Why some plugins don't change the POS](#why-dont-some-plugins-work-in-the-pos).

### Check the order in the cart[​](#check-the-order "Link direto para Check the order in the cart")

1. Tap **⋮** beside **Checkout**. **Order details** opens.
2. Tap **JSON**.

![The POS with one Aim Analog Watch in the cart, the subtotal and taxes, and the ⋮ button beside Checkout $45.00](/img/2.x/reference/wc-rest-api/en/tablet-light-regular--ref-6-cart.png)12

1. **A cart line** — each line's **Edit** dialog has its own **JSON** tab. See [Check one line](#check-a-line).
2. **⋮** — opens **Order details** for the whole order.

![Order details for that cart on the JSON tab: status pos-open, created\_via woocommerce-pos, line\_items with 1 item, total 45 and the other order fields, with Void, Close, Print and Sync order at the foot](/img/2.x/reference/wc-rest-api/en/tablet-light-regular--ref-7-order-json.png)1234567

1. **JSON** — beside **Form**, as on every panel.
2. **status** — `pos-open` while the order is open at the till. This status comes from the WCPOS plugin; WooCommerce shows it as **POS - Open**.
3. **line\_items** — the products in the cart. Tap it to open each line.
4. **total** — the order total, tax included.
5. **Sync order** — sends the order to your store now. A new order has no `id` in its JSON until your store has saved it. See [Sync the order](/pt-BR/sell/cart/order-details.md#sync-order).
6. **Print** — prints the order.
7. **Void** — deletes the order and empties the cart. See [Void the order](/pt-BR/sell/cart/order-details.md#void).

The same fields, closer up, from another cart with one watch:

![Close-up of the order JSON from another cart with one Aim Analog Watch: status pos-open, created\_via woocommerce-pos, line\_items with 1 item, and total 45](/img/2.x/reference/wc-rest-api/en/tablet-light-regular--ref-9-order-json-detail.png)123

1. **status** — reads `pos-open`: the order is still open at the till.
2. **line\_items** — `1 item`: the one watch in the cart.
3. **total** — `45`: one watch at $45.00, tax included.

### Check one line[​](#check-a-line "Link direto para Check one line")

A line's **JSON** tab shows the line as it will be saved on the WooCommerce order, not the product record from your store. Use it to check a line's custom fields, such as an engraving.

1. Tap the line's total to show **Edit** and **Remove**. See [Edit or remove a line](/pt-BR/sell/cart/change-cart-items.md#remove-item) for the other ways.
2. Tap **Edit**, then **JSON**.
3. Tap `meta_data` to open the line's custom fields, then tap an entry to see its `key` and `value`.

![The Edit Aim Analog Watch dialog for a cart line on the JSON tab: 13 items, product\_id 67038, name, quantity 1, sku, and meta\_data opened to 2 entries, the first opened to key \_woocommerce\_pos\_data and its value, then price, total and taxes](/img/2.x/reference/wc-rest-api/en/tablet-light-regular--ref-8-line-json.png)123456

1. **JSON** — beside **Form** in the line's **Edit** dialog.
2. **name** — the product name as saved on this line. With `quantity` and `price` below it, it describes this sale, not the product record.
3. **meta\_data** — the line's custom fields: 2 entries here.
4. **key** — the field's name. `_woocommerce_pos_data` is where WCPOS keeps the line's price, regular price and tax status.
5. **value** — what the field holds. Tap a folded value to open it.
6. **price** — the price of one item before tax: `40.106952` here. Add the line's tax, `total_tax` `4.893048`, and you get the $45.00 in the cart.

Watch the requests in the browser

In the web app you can watch the POS talk to your store with your browser's developer tools:

1. Open the POS in Chrome, Edge or Firefox.
2. Press **F12** (on a Mac, **Option + Command + I**) and choose the **Network** tab.
3. Type `wcpos` in the filter box.
4. Use the POS: search, add a product, check out. Each request your store answers appears in the list. Select one and choose **Response** to read the JSON.

## Why some plugins don't change the POS[​](#why-dont-some-plugins-work-in-the-pos "Link direto para Why some plugins don't change the POS")

The POS works from its copy of your store's data. A plugin that only changes what a web page shows, or works something out while a shopper browses your website, never reaches that copy. The POS sees what the REST API sends, nothing more. Three kinds of plugin run into this most.

### Dynamic pricing[​](#dynamic-pricing "Link direto para Dynamic pricing")

Plugins that set a price per customer, per role or per quantity.

* **At the till:** the POS shows the product's normal price. Most of these plugins calculate the price as a shopper browses your website, so the API never sends it.
* **What to do:** use [discounts at the till](/pt-BR/sell/cart/discounts.md), or a coupon.

### Product add-ons[​](#product-add-ons "Link direto para Product add-ons")

Plugins that add options to a product, such as gift wrap or engraving.

* **At the till:** the options don't appear. Most of these plugins build them on the product page, so they aren't part of the product the API sends.
* **What to do:** add a [fee](/pt-BR/sell/cart.md#fees) for the extra cost, and a [custom field](/pt-BR/sell/cart/change-cart-items.md#meta-data) on the line for the detail.

### Plugins that change the API[​](#api-changing-plugins "Link direto para Plugins that change the API")

Plugins that change what your store sends through the REST API.

* **At the till:** the POS can break. wePOS changes how your store sends variable products, so WCPOS turns itself off while wePOS is active.
* **What to do:** see [wePOS](/pt-BR/manage-store/compatible-plugins.md#wepos).

A plugin that saves its data on the product, the customer or the order (as custom fields) usually does reach the POS. Open the **JSON** tab and look in `meta_data` to check.

## If something goes wrong[​](#goes-wrong "Link direto para If something goes wrong")

* **Connecting fails with AUTH321** — your site isn't offering the WooCommerce REST API. See [AUTH321: WooCommerce missing](/pt-BR/error-codes/AUTH321.md).
* **A price or field at the till doesn't match WP Admin** — see [If a value doesn't match WP Admin](#value-differs).
* **A plugin's change never shows in the POS** — see [Why some plugins don't change the POS](#why-dont-some-plugins-work-in-the-pos).
* **Something stopped working after you installed a plugin** — see [Plugin Conflicts](/pt-BR/troubleshooting/common-problems/plugin-conflicts.md).

## Related Documentation[​](#related-documentation "Link direto para Related Documentation")

[ArchitectureThe plugin, the app and how they fit together](/pt-BR/developers/architecture.md)

[How the Sync Engine WorksHow the POS keeps its copy of your store up to date](/pt-BR/developers/sync-engine.md)

[IntegrationsPlugins that work with WCPOS, and two that don't](/pt-BR/manage-store/compatible-plugins.md)

For developers, WooCommerce documents every endpoint and field in the [WooCommerce REST API docs](https://woocommerce.github.io/woocommerce-rest-api-docs/).