Contents
On this page

Create Transfer - Plugixa POS for WooCommerce

POST /plugixa-pos/v1/transfers

Create a draft transfer. Stock moves when you send and receive it.

Needs a user with the plugixa_pos_manage_settings capability (signed in with an Application Password, or the login cookie with an X-WP-Nonce header). Administrators hold it; other roles only when you grant it.

Request

POST https://your-site.example/wp-json/plugixa-pos/v1/transfers

Request body

Content type: application/json

Field Type Required Description
from_outlet integer Yes Sending store.
to_outlet integer Yes Receiving store, a different one.
note string No A note.
lines object[] Yes Up to 500: product_id (not a variable parent, with stock management) and qty above zero.
{
  "from_outlet": 1,
  "to_outlet": 2,
  "note": "Weekly restock",
  "lines": [
    {
      "product_id": 3720,
      "qty": 6
    },
    {
      "product_id": 3745,
      "qty": 6
    }
  ]
}

Responses

201 Created.

{
  "success": true,
  "data": {
    "id": 5,
    "from_outlet": 1,
    "to_outlet": 2,
    "from_name": "Maison Plugixa Marais",
    "to_name": "Maison Plugixa Lyon",
    "status": "draft",
    "note": "Weekly restock",
    "created_at": "2026-11-19 16:00:00",
    "sent_at": null,
    "received_at": null,
    "items": [
      {
        "id": 13,
        "product_id": 3720,
        "name": "House espresso beans 250 g",
        "sku": "COF-HOUSE",
        "qty_sent": 6,
        "qty_received": null
      },
      {
        "id": 15,
        "product_id": 3745,
        "name": "Ceramic bowl",
        "sku": "KIT-BOWL",
        "qty_sent": 6,
        "qty_received": null
      }
    ]
  }
}

Errors

Status Code When
404 plugixa_pos_not_found A store does not exist.
422 plugixa_pos_same_store Both stores are the same.
422 plugixa_pos_empty_transfer No lines.
422 plugixa_pos_invalid_line A line has no valid product or quantity.
409 plugixa_pos_not_stocked A product does not track stock.

Plus the errors every endpoint can return.

Examples

curl -s -X POST "https://your-site.example/wp-json/plugixa-pos/v1/transfers" \
  -u "$WP_USER:$WP_APP_PASSWORD" \
  -H "Content-Type: application/json" \
  -d '{"from_outlet":1,"to_outlet":2,"note":"Weekly restock","lines":[{"product_id":3720,"qty":6},{"product_id":3745,"qty":6}]}'
<?php
$ch = curl_init('https://your-site.example/wp-json/plugixa-pos/v1/transfers');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST  => 'POST',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_USERPWD        => getenv('WP_USER') . ':' . getenv('WP_APP_PASSWORD'),
    CURLOPT_HTTPHEADER     => ['Content-Type: application/json'],
    CURLOPT_POSTFIELDS     => json_encode([
        'from_outlet' => 1,
        'to_outlet'   => 2,
        'note'        => 'Weekly restock',
        'lines'       => [
            [
                'product_id' => 3720,
                'qty'        => 6,
            ],
            [
                'product_id' => 3745,
                'qty'        => 6,
            ],
        ],
    ]),
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);
const response = await fetch('https://your-site.example/wp-json/plugixa-pos/v1/transfers', {
  method: 'POST',
  headers: {
    'Authorization': `Basic ${btoa(`${process.env.WP_USER}:${process.env.WP_APP_PASSWORD}`)}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ from_outlet: 1, to_outlet: 2, note: 'Weekly restock', lines: [{ product_id: 3720, qty: 6 }, { product_id: 3745, qty: 6 }] }),
});
const { data } = await response.json();

Quick Links

Share