Contents
On this page
Receive Transfer - Plugixa POS for WooCommerce
POST /plugixa-pos/v1/transfers/{id}/receive
Record what arrived: the units go into the receiving store.
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/4/receive
Path parameters
| Name | Type | Description |
|---|---|---|
id |
integer |
The transfer’s id |
Request body
Content type: application/json
| Field | Type | Required | Description |
|---|---|---|---|
received |
object |
No | Quantity received per product id: {"3720": 6}. |
{
"received": {
"3720": 6,
"3745": 5
}
}
Responses
200 OK. data is the transfer.
{
"success": true,
"data": {
"id": 4,
"from_outlet": 1,
"to_outlet": 2,
"from_name": "Maison Plugixa Marais",
"to_name": "Maison Plugixa Lyon",
"status": "received",
"note": "Weekly restock",
"created_at": "2026-11-07 07:30:00",
"sent_at": "2026-11-07 07:50:00",
"received_at": "2026-11-19 16:05:00",
"items": [
{
"id": 13,
"product_id": 3720,
"name": "House espresso beans 250 g",
"sku": "COF-HOUSE",
"qty_sent": 6,
"qty_received": 6
},
{
"id": 15,
"product_id": 3745,
"name": "Ceramic bowl",
"sku": "KIT-BOWL",
"qty_sent": 6,
"qty_received": 5
}
]
}
}
Errors
| Status | Code | When |
|---|---|---|
404 |
plugixa_pos_not_found |
No transfer with that id. |
409 |
plugixa_pos_transfer_status |
The transfer cannot do that in its current state. |
Plus the errors every endpoint can return.
Examples
curl -s -X POST "https://your-site.example/wp-json/plugixa-pos/v1/transfers/4/receive" \
-u "$WP_USER:$WP_APP_PASSWORD" \
-H "Content-Type: application/json" \
-d '{"received":{"3720":6,"3745":5}}'
<?php
$ch = curl_init('https://your-site.example/wp-json/plugixa-pos/v1/transfers/4/receive');
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([
'received' => [
'3720' => 6,
'3745' => 5,
],
]),
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);
const response = await fetch('https://your-site.example/wp-json/plugixa-pos/v1/transfers/4/receive', {
method: 'POST',
headers: {
'Authorization': `Basic ${btoa(`${process.env.WP_USER}:${process.env.WP_APP_PASSWORD}`)}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({ received: { "3720": 6, "3745": 5 } }),
});
const { data } = await response.json();
Quick Links
Share