POS Product Sync API Documentation

This document describes the REST API provided by the Pos Product Sync WordPress plugin for syncing products between your POS system and WooCommerce.

Base URL

The API endpoint is registered under the WordPress REST API infrastructure.

POST /wp-json/pos/v1/product

Authentication

Every request must include an Authorization header with a specific Bearer token.

Header Format:

Authorization: Bearer {token}

Required Token:

eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ0ZXN0LXVzZXIiLCJhdWQiOiJhcGkuZXhhbXBsZS5jb20iLCJpYXQiOjE2OTg1NjAwMDAsImV4cCI6MTY5ODU2MzYwMH0.4JcF5yO3z5uBvFhOQwI8JrR6qJ8tP9x7yQnPjG4kHhA

Endpoint Details

All operations (Create, Update, Delete) use the exact same endpoint. The action to perform is determined by the eventType field in the JSON request body.

1. Create a Product

Creates a new WooCommerce product and syncs POS-specific metadata.

Request Body (JSON):

Example Request:

{
  "eventType": "create",
  "Id": "POS-1001",
  "Name": "Sample T-Shirt",
  "Price": 25.99,
  "Code": "TSHIRT-001",
  "Description": "A cool cotton t-shirt",
  "CurrentStock": 50,
  "CategoryName": "Clothing",
  "BrandName": "AwesomeBrand",
  "ProductBarcode": "123456789012",
  "CostPrice": 10.00,
  "ImagePath": "https://example.com/images/tshirt.jpg"
}

Success Response (201 Created):

{
  "success": true,
  "message": "Product created successfully",
  "data": {
    "product_id": 123
  }
}

Error Responses:

• 422 Unprocessable Entity: "Product Id required"
• 409 Conflict: "Product already exists"
• 500 Internal Server Error: "Failed to create product"

2. Update a Product

Updates an existing WooCommerce product that is synced with the provided POS ID.

Request Body (JSON):

Note: Omitted fields will generally retain their existing values in WooCommerce.

Example Request:

{
  "eventType": "update",
  "Id": "POS-1001",
  "Price": 19.99,
  "CurrentStock": 35
}

Success Response (200 OK):

{
  "success": true,
  "message": "Product updated successfully",
  "data": {
    "product_id": 123
  }
}

Error Responses:

• 422 Unprocessable Entity: "Product Id required"
• 404 Not Found: "Product not found"
• 500 Internal Server Error: "Failed to load product" / "Failed to update product"

3. Delete a Product

Permanently deletes a WooCommerce product connected to the specific POS ID. It bypasses the trash bin.

Request Body (JSON):

Example Request:

{
  "eventType": "delete",
  "Id": "POS-1001"
}

Success Response (200 OK):

{
  "success": true,
  "message": "Product deleted successfully",
  "data": []
}

Error Responses:

• 422 Unprocessable Entity: "Product Id required"
• 404 Not Found: "Product not found"
• 500 Internal Server Error: "Failed to load product"