Inventory

Update inventory quantities for product variants. Changes are stored locally and periodically synced to Shopify.

Update Product Inventory

patch

Updates inventory quantities for one or more variants of a product. Inventory changes are stored locally and synced to Shopify periodically. Brand data always takes precedence over Shopify data.

Authorizations

ApiKeyAuth

X-MaisonSafqa-Api-KeystringRequired

API key for authentication. Use 'ms_test_...' keys for development/testing and 'ms_live_...' keys for production. Keys are environment-specific and will only work in their respective environments.

Path parameters

product_idstringRequired

Product identifier (format: product_XXXXXXXXXXXXXXXX)

Example: {"value":"product_1234567890123456"}

Body

application/json

Responses

200

Inventory updated successfully

application/json

400

Validation errors

application/json

401

Unauthorized

application/json

403

Access denied

application/json

404

Product not found

application/json

429

Rate limit exceeded

application/json

patch

/products/{product_id}/inventory

HTTPcURLJavaScriptPython

PATCH /v1/products/{product_id}/inventory HTTP/1.1
Host: api.maisonsafqa.com
X-MaisonSafqa-Api-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 65

{
  "variants": [
    {
      "sku": "COTTON-TEE-001-S",
      "inventory_quantity": 15
    }
  ]
}

{
  "error": null,
  "results": [
    {
      "sku": "text",
      "success": true,
      "old_quantity": 1,
      "new_quantity": 1,
      "error": "text"
    }
  ],
  "message": "Inventory updated: 3/3 variants successful"
}

Bulk Update Inventory

patch

Updates inventory for multiple products in a single request. Maximum 500 products per request.

Authorizations

ApiKeyAuth

X-MaisonSafqa-Api-KeystringRequired

API key for authentication. Use 'ms_test_...' keys for development/testing and 'ms_live_...' keys for production. Keys are environment-specific and will only work in their respective environments.

Body

application/json

Responses

200

All inventory updates successful

application/json

successbooleanOptional

True if all updates were successful

messagestringOptional

Summary message

Example: Inventory updated: 48/50 products successful

207

Partial success - some updates succeeded, some failed

application/json

400

Validation errors

application/json

401

Unauthorized

application/json

429

Rate limit exceeded

application/json

patch

/inventory/bulk

HTTPcURLJavaScriptPython

PATCH /v1/inventory/bulk HTTP/1.1
Host: api.maisonsafqa.com
X-MaisonSafqa-Api-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 120

{
  "products": [
    {
      "product_id": "product_1234567890123456",
      "variants": [
        {
          "sku": "COTTON-TEE-001-S",
          "inventory_quantity": 15
        }
      ]
    }
  ]
}

{
  "success": true,
  "message": "Inventory updated: 48/50 products successful",
  "results": [
    {
      "product_id": "text",
      "success": true,
      "variants": [
        {
          "sku": "text",
          "success": true,
          "old_quantity": 1,
          "new_quantity": 1,
          "error": "text"
        }
      ],
      "error": "text"
    }
  ]
}